undo.c 15.5 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* undo handling for GNU Emacs.
2
   Copyright (C) 1990, 1993-1994, 2000-2014 Free Software Foundation,
3
   Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
11

Jim Blandy's avatar
Jim Blandy committed
12
GNU Emacs is distributed in the hope that it will be useful,
13 14 15 16 17
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19 20


21
#include <config.h>
22

Jim Blandy's avatar
Jim Blandy committed
23
#include "lisp.h"
24
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
25
#include "buffer.h"
26
#include "commands.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
27
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
28 29

/* Last buffer for which undo information was recorded.  */
30
/* BEWARE: This is not traced by the GC, so never dereference it!  */
31
static struct buffer *last_undo_buffer;
32 33

/* Position of point last time we inserted a boundary.  */
34
static struct buffer *last_boundary_buffer;
35
static ptrdiff_t last_boundary_position;
Jim Blandy's avatar
Jim Blandy committed
36

37 38
Lisp_Object Qinhibit_read_only;

Kim F. Storm's avatar
Kim F. Storm committed
39 40 41 42
/* Marker for function call undo list elements.  */

Lisp_Object Qapply;

43 44 45 46 47
/* The first time a command records something for undo.
   it also allocates the undo-boundary object
   which will be added to the list at the end of the command.
   This ensures we can't run out of space while trying to make
   an undo-boundary.  */
48
static Lisp_Object pending_boundary;
49

Stefan Monnier's avatar
Stefan Monnier committed
50
/* Record point as it was at beginning of this command (if necessary)
51
   and prepare the undo info for recording a change.
Stefan Monnier's avatar
Stefan Monnier committed
52 53
   PT is the position of point that will naturally occur as a result of the
   undo record that will be added just after this command terminates.  */
Jim Blandy's avatar
Jim Blandy committed
54

Stefan Monnier's avatar
Stefan Monnier committed
55
static void
56
record_point (ptrdiff_t pt)
Jim Blandy's avatar
Jim Blandy committed
57
{
Paul Eggert's avatar
Paul Eggert committed
58
  bool at_boundary;
59

60
  /* Don't record position of pt when undo_inhibit_record_point holds.  */
61 62 63
  if (undo_inhibit_record_point)
    return;

64 65 66 67
  /* Allocate a cons cell to be the undo boundary after this command.  */
  if (NILP (pending_boundary))
    pending_boundary = Fcons (Qnil, Qnil);

68 69 70 71 72 73 74
  if ((current_buffer != last_undo_buffer)
      /* Don't call Fundo_boundary for the first change.  Otherwise we
	 risk overwriting last_boundary_position in Fundo_boundary with
	 PT of the current buffer and as a consequence not insert an
	 undo boundary because last_boundary_position will equal pt in
	 the test at the end of the present function (Bug#731).  */
      && (MODIFF > SAVE_MODIFF))
Jim Blandy's avatar
Jim Blandy committed
75
    Fundo_boundary ();
76
  last_undo_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
77

Tom Tromey's avatar
Tom Tromey committed
78
  if (CONSP (BVAR (current_buffer, undo_list)))
Stefan Monnier's avatar
Stefan Monnier committed
79
    {
Paul Eggert's avatar
Paul Eggert committed
80
      /* Set AT_BOUNDARY only when we have nothing other than
Stefan Monnier's avatar
Stefan Monnier committed
81 82
         marker adjustment before undo boundary.  */

Tom Tromey's avatar
Tom Tromey committed
83
      Lisp_Object tail = BVAR (current_buffer, undo_list), elt;
Stefan Monnier's avatar
Stefan Monnier committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

      while (1)
	{
	  if (NILP (tail))
	    elt = Qnil;
	  else
	    elt = XCAR (tail);
	  if (NILP (elt) || ! (CONSP (elt) && MARKERP (XCAR (elt))))
	    break;
	  tail = XCDR (tail);
	}
      at_boundary = NILP (elt);
    }
  else
    at_boundary = 1;

100
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
101 102
    record_first_change ();

103
  /* If we are just after an undo boundary, and
Stefan Monnier's avatar
Stefan Monnier committed
104 105
     point wasn't at start of deleted range, record where it was.  */
  if (at_boundary
106 107
      && current_buffer == last_boundary_buffer
      && last_boundary_position != pt)
Paul Eggert's avatar
Paul Eggert committed
108 109 110
    bset_undo_list (current_buffer,
		    Fcons (make_number (last_boundary_position),
			   BVAR (current_buffer, undo_list)));
Stefan Monnier's avatar
Stefan Monnier committed
111 112 113 114 115 116 117 118
}

/* Record an insertion that just happened or is about to happen,
   for LENGTH characters at position BEG.
   (It is possible to record an insertion before or after the fact
   because we don't need to record the contents.)  */

void
119
record_insert (ptrdiff_t beg, ptrdiff_t length)
Stefan Monnier's avatar
Stefan Monnier committed
120 121 122
{
  Lisp_Object lbeg, lend;

Tom Tromey's avatar
Tom Tromey committed
123
  if (EQ (BVAR (current_buffer, undo_list), Qt))
Stefan Monnier's avatar
Stefan Monnier committed
124 125 126 127
    return;

  record_point (beg);

Jim Blandy's avatar
Jim Blandy committed
128 129
  /* If this is following another insertion and consecutive with it
     in the buffer, combine the two.  */
Tom Tromey's avatar
Tom Tromey committed
130
  if (CONSP (BVAR (current_buffer, undo_list)))
Jim Blandy's avatar
Jim Blandy committed
131 132
    {
      Lisp_Object elt;
Tom Tromey's avatar
Tom Tromey committed
133
      elt = XCAR (BVAR (current_buffer, undo_list));
134
      if (CONSP (elt)
135 136 137
	  && INTEGERP (XCAR (elt))
	  && INTEGERP (XCDR (elt))
	  && XINT (XCDR (elt)) == beg)
Jim Blandy's avatar
Jim Blandy committed
138
	{
139
	  XSETCDR (elt, make_number (beg + length));
Jim Blandy's avatar
Jim Blandy committed
140 141 142 143
	  return;
	}
    }

144 145
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
Paul Eggert's avatar
Paul Eggert committed
146 147
  bset_undo_list (current_buffer,
		  Fcons (Fcons (lbeg, lend), BVAR (current_buffer, undo_list)));
Jim Blandy's avatar
Jim Blandy committed
148 149 150
}

/* Record that a deletion is about to take place,
151
   of the characters in STRING, at location BEG.  */
Jim Blandy's avatar
Jim Blandy committed
152

153
void
154
record_delete (ptrdiff_t beg, Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
155
{
156
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
157

Tom Tromey's avatar
Tom Tromey committed
158
  if (EQ (BVAR (current_buffer, undo_list), Qt))
159 160
    return;

161
  if (PT == beg + SCHARS (string))
162
    {
Stefan Monnier's avatar
Stefan Monnier committed
163 164
      XSETINT (sbeg, -beg);
      record_point (PT);
165 166
    }
  else
Stefan Monnier's avatar
Stefan Monnier committed
167 168 169 170
    {
      XSETFASTINT (sbeg, beg);
      record_point (beg);
    }
171

Paul Eggert's avatar
Paul Eggert committed
172 173 174
  bset_undo_list
    (current_buffer,
     Fcons (Fcons (string, sbeg), BVAR (current_buffer, undo_list)));
Jim Blandy's avatar
Jim Blandy committed
175 176
}

177 178 179 180 181
/* Record the fact that MARKER is about to be adjusted by ADJUSTMENT.
   This is done only when a marker points within text being deleted,
   because that's the only case where an automatic marker adjustment
   won't be inverted automatically by undoing the buffer modification.  */

182
void
183
record_marker_adjustment (Lisp_Object marker, ptrdiff_t adjustment)
184
{
Tom Tromey's avatar
Tom Tromey committed
185
  if (EQ (BVAR (current_buffer, undo_list), Qt))
186 187 188 189 190 191
    return;

  /* Allocate a cons cell to be the undo boundary after this command.  */
  if (NILP (pending_boundary))
    pending_boundary = Fcons (Qnil, Qnil);

192
  if (current_buffer != last_undo_buffer)
193
    Fundo_boundary ();
194
  last_undo_buffer = current_buffer;
195

Paul Eggert's avatar
Paul Eggert committed
196 197 198 199
  bset_undo_list
    (current_buffer,
     Fcons (Fcons (marker, make_number (adjustment)),
	    BVAR (current_buffer, undo_list)));
200 201
}

Jim Blandy's avatar
Jim Blandy committed
202 203
/* Record that a replacement is about to take place,
   for LENGTH characters at location BEG.
204
   The replacement must not change the number of characters.  */
Jim Blandy's avatar
Jim Blandy committed
205

206
void
207
record_change (ptrdiff_t beg, ptrdiff_t length)
Jim Blandy's avatar
Jim Blandy committed
208
{
209
  record_delete (beg, make_buffer_string (beg, beg + length, 1));
Jim Blandy's avatar
Jim Blandy committed
210 211 212 213 214 215 216
  record_insert (beg, length);
}

/* Record that an unmodified buffer is about to be changed.
   Record the file modification date so that when undoing this entry
   we can tell whether it is obsolete because the file was saved again.  */

217
void
218
record_first_change (void)
Jim Blandy's avatar
Jim Blandy committed
219
{
220
  struct buffer *base_buffer = current_buffer;
221

Tom Tromey's avatar
Tom Tromey committed
222
  if (EQ (BVAR (current_buffer, undo_list), Qt))
223 224
    return;

225
  if (current_buffer != last_undo_buffer)
226
    Fundo_boundary ();
227
  last_undo_buffer = current_buffer;
228

229 230 231
  if (base_buffer->base_buffer)
    base_buffer = base_buffer->base_buffer;

Paul Eggert's avatar
Paul Eggert committed
232 233 234
  bset_undo_list (current_buffer,
		  Fcons (Fcons (Qt, Fvisited_file_modtime ()),
			 BVAR (current_buffer, undo_list)));
Jim Blandy's avatar
Jim Blandy committed
235 236
}

237 238 239
/* Record a change in property PROP (whose old value was VAL)
   for LENGTH characters starting at position BEG in BUFFER.  */

240
void
241
record_property_change (ptrdiff_t beg, ptrdiff_t length,
242 243
			Lisp_Object prop, Lisp_Object value,
			Lisp_Object buffer)
244 245
{
  Lisp_Object lbeg, lend, entry;
246
  struct buffer *obuf = current_buffer, *buf = XBUFFER (buffer);
Paul Eggert's avatar
Paul Eggert committed
247
  bool boundary = 0;
248

Tom Tromey's avatar
Tom Tromey committed
249
  if (EQ (BVAR (buf, undo_list), Qt))
250 251
    return;

252 253 254 255
  /* Allocate a cons cell to be the undo boundary after this command.  */
  if (NILP (pending_boundary))
    pending_boundary = Fcons (Qnil, Qnil);

256
  if (buf != last_undo_buffer)
257
    boundary = 1;
258
  last_undo_buffer = buf;
259 260

  /* Switch temporarily to the buffer that was changed.  */
261
  current_buffer = buf;
262 263 264 265

  if (boundary)
    Fundo_boundary ();

266
  if (MODIFF <= SAVE_MODIFF)
267 268
    record_first_change ();

269 270
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
271
  entry = Fcons (Qnil, Fcons (prop, Fcons (value, Fcons (lbeg, lend))));
Paul Eggert's avatar
Paul Eggert committed
272 273
  bset_undo_list (current_buffer,
		  Fcons (entry, BVAR (current_buffer, undo_list)));
274 275 276 277

  current_buffer = obuf;
}

Paul Eggert's avatar
Paul Eggert committed
278
DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
279 280 281
       doc: /* Mark a boundary between units of undo.
An undo command will stop at this point,
but another undo command will undo to the previous boundary.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
282
  (void)
Jim Blandy's avatar
Jim Blandy committed
283 284
{
  Lisp_Object tem;
Tom Tromey's avatar
Tom Tromey committed
285
  if (EQ (BVAR (current_buffer, undo_list), Qt))
Jim Blandy's avatar
Jim Blandy committed
286
    return Qnil;
Tom Tromey's avatar
Tom Tromey committed
287
  tem = Fcar (BVAR (current_buffer, undo_list));
Jim Blandy's avatar
Jim Blandy committed
288
  if (!NILP (tem))
289 290 291 292 293 294
    {
      /* One way or another, cons nil onto the front of the undo list.  */
      if (!NILP (pending_boundary))
	{
	  /* If we have preallocated the cons cell to use here,
	     use that one.  */
Tom Tromey's avatar
Tom Tromey committed
295
	  XSETCDR (pending_boundary, BVAR (current_buffer, undo_list));
Paul Eggert's avatar
Paul Eggert committed
296
	  bset_undo_list (current_buffer, pending_boundary);
297 298 299
	  pending_boundary = Qnil;
	}
      else
Paul Eggert's avatar
Paul Eggert committed
300 301
	bset_undo_list (current_buffer,
			Fcons (Qnil, BVAR (current_buffer, undo_list)));
302
    }
303 304
  last_boundary_position = PT;
  last_boundary_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
305 306 307 308
  return Qnil;
}

/* At garbage collection time, make an undo list shorter at the end,
309 310 311 312 313
   returning the truncated list.  How this is done depends on the
   variables undo-limit, undo-strong-limit and undo-outer-limit.
   In some cases this works by calling undo-outer-limit-function.  */

void
314
truncate_undo_list (struct buffer *b)
Jim Blandy's avatar
Jim Blandy committed
315
{
316
  Lisp_Object list;
Jim Blandy's avatar
Jim Blandy committed
317
  Lisp_Object prev, next, last_boundary;
318
  EMACS_INT size_so_far = 0;
Jim Blandy's avatar
Jim Blandy committed
319

320 321
  /* Make sure that calling undo-outer-limit-function
     won't cause another GC.  */
322
  ptrdiff_t count = inhibit_garbage_collection ();
323 324 325 326

  /* Make the buffer current to get its local values of variables such
     as undo_limit.  Also so that Vundo_outer_limit_function can
     tell which buffer to operate on.  */
327
  record_unwind_current_buffer ();
328 329
  set_buffer_internal (b);

Tom Tromey's avatar
Tom Tromey committed
330
  list = BVAR (b, undo_list);
331

Jim Blandy's avatar
Jim Blandy committed
332 333 334 335
  prev = Qnil;
  next = list;
  last_boundary = Qnil;

336
  /* If the first element is an undo boundary, skip past it.  */
337
  if (CONSP (next) && NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
338 339 340 341 342 343
    {
      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);

      /* Advance to next element.  */
      prev = next;
344
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
345
    }
346

347 348 349 350 351 352
  /* Always preserve at least the most recent undo record
     unless it is really horribly big.

     Skip, skip, skip the undo, skip, skip, skip the undo,
     Skip, skip, skip the undo, skip to the undo bound'ry.  */

353
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
354 355
    {
      Lisp_Object elt;
356
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
357 358 359

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
360
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
361 362
	{
	  size_so_far += sizeof (struct Lisp_Cons);
363
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
364
	    size_so_far += (sizeof (struct Lisp_String) - 1
365
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
366 367 368 369
	}

      /* Advance to next element.  */
      prev = next;
370
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
371
    }
372

373 374
  /* If by the first boundary we have already passed undo_outer_limit,
     we're heading for memory full, so offer to clear out the list.  */
375 376
  if (INTEGERP (Vundo_outer_limit)
      && size_so_far > XINT (Vundo_outer_limit)
377 378
      && !NILP (Vundo_outer_limit_function))
    {
379 380
      Lisp_Object tem;
      struct buffer *temp = last_undo_buffer;
381 382

      /* Normally the function this calls is undo-outer-limit-truncate.  */
383 384
      tem = call1 (Vundo_outer_limit_function, make_number (size_so_far));
      if (! NILP (tem))
385 386 387 388 389 390 391 392 393 394 395 396
	{
	  /* The function is responsible for making
	     any desired changes in buffer-undo-list.  */
	  unbind_to (count, Qnil);
	  return;
	}
      /* That function probably used the minibuffer, and if so, that
	 changed last_undo_buffer.  Change it back so that we don't
	 force next change to make an undo boundary here.  */
      last_undo_buffer = temp;
    }

397
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
398 399
    last_boundary = prev;

400
  /* Keep additional undo data, if it fits in the limits.  */
401
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
402 403
    {
      Lisp_Object elt;
404
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
405 406

      /* When we get to a boundary, decide whether to truncate
407
	 either before or after it.  The lower threshold, undo_limit,
Jim Blandy's avatar
Jim Blandy committed
408
	 tells us to truncate after it.  If its size pushes past
409
	 the higher threshold undo_strong_limit, we truncate before it.  */
Jim Blandy's avatar
Jim Blandy committed
410
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
411
	{
412
	  if (size_so_far > undo_strong_limit)
Jim Blandy's avatar
Jim Blandy committed
413 414
	    break;
	  last_boundary = prev;
415
	  if (size_so_far > undo_limit)
Jim Blandy's avatar
Jim Blandy committed
416 417 418 419 420
	    break;
	}

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
421
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
422 423
	{
	  size_so_far += sizeof (struct Lisp_Cons);
424
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
425
	    size_so_far += (sizeof (struct Lisp_String) - 1
426
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430
	}

      /* Advance to next element.  */
      prev = next;
431
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
432 433 434
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
435
  if (NILP (next))
436
    ;
Jim Blandy's avatar
Jim Blandy committed
437
  /* Truncate at the boundary where we decided to truncate.  */
438 439 440
  else if (!NILP (last_boundary))
    XSETCDR (last_boundary, Qnil);
  /* There's nothing we decided to keep, so clear it out.  */
Jim Blandy's avatar
Jim Blandy committed
441
  else
Paul Eggert's avatar
Paul Eggert committed
442
    bset_undo_list (b, Qnil);
443 444

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
445
}
446

447

Andreas Schwab's avatar
Andreas Schwab committed
448
void
449
syms_of_undo (void)
Jim Blandy's avatar
Jim Blandy committed
450
{
451 452
  DEFSYM (Qinhibit_read_only, "inhibit-read-only");
  DEFSYM (Qapply, "apply");
Kim F. Storm's avatar
Kim F. Storm committed
453

454 455 456
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

457 458 459
  last_undo_buffer = NULL;
  last_boundary_buffer = NULL;

Jim Blandy's avatar
Jim Blandy committed
460
  defsubr (&Sundo_boundary);
461

462
  DEFVAR_INT ("undo-limit", undo_limit,
463 464 465 466 467 468 469
	      doc: /* Keep no more undo information once it exceeds this size.
This limit is applied when garbage collection happens.
When a previous command increases the total undo list size past this
value, the earlier commands that came before it are forgotten.

The size is counted as the number of bytes occupied,
which includes both saved text and other data.  */);
470
  undo_limit = 80000;
471

472
  DEFVAR_INT ("undo-strong-limit", undo_strong_limit,
473 474 475 476 477 478 479 480 481
	      doc: /* Don't keep more than this much size of undo information.
This limit is applied when garbage collection happens.
When a previous command increases the total undo list size past this
value, that command and the earlier commands that came before it are forgotten.
However, the most recent buffer-modifying command's undo info
is never discarded for this reason.

The size is counted as the number of bytes occupied,
which includes both saved text and other data.  */);
482
  undo_strong_limit = 120000;
483

484
  DEFVAR_LISP ("undo-outer-limit", Vundo_outer_limit,
485 486
	      doc: /* Outer limit on size of undo information for one command.
At garbage collection time, if the current command has produced
487 488
more than this much undo information, it discards the info and displays
a warning.  This is a last-ditch limit to prevent memory overflow.
489

490 491 492 493
The size is counted as the number of bytes occupied, which includes
both saved text and other data.  A value of nil means no limit.  In
this case, accumulating one huge undo entry could make Emacs crash as
a result of memory overflow.
494 495 496 497 498

In fact, this calls the function which is the value of
`undo-outer-limit-function' with one argument, the size.
The text above describes the behavior of the function
that variable usually specifies.  */);
499
  Vundo_outer_limit = make_number (12000000);
500

501
  DEFVAR_LISP ("undo-outer-limit-function", Vundo_outer_limit_function,
502 503 504 505 506 507 508 509 510
	       doc: /* Function to call when an undo list exceeds `undo-outer-limit'.
This function is called with one argument, the current undo list size
for the most recent command (since the last undo boundary).
If the function returns t, that means truncation has been fully handled.
If it returns nil, the other forms of truncation are done.

Garbage collection is inhibited around the call to this function,
so it must make sure not to do a lot of consing.  */);
  Vundo_outer_limit_function = Qnil;
511

512
  DEFVAR_BOOL ("undo-inhibit-record-point", undo_inhibit_record_point,
513 514
	       doc: /* Non-nil means do not record `point' in `buffer-undo-list'.  */);
  undo_inhibit_record_point = 0;
Jim Blandy's avatar
Jim Blandy committed
515
}