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

This file is part of GNU Emacs.

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

Jim Blandy's avatar
Jim Blandy committed
11
GNU Emacs is distributed in the hope that it will be useful,
12 13 14 15 16
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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18 19


20
#include <config.h>
21
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
22 23
#include "lisp.h"
#include "buffer.h"
24
#include "commands.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
25
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
26 27

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

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

35 36
Lisp_Object Qinhibit_read_only;

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

Lisp_Object Qapply;

41 42 43 44 45
/* 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.  */
46
static Lisp_Object pending_boundary;
47

Stefan Monnier's avatar
Stefan Monnier committed
48
/* Record point as it was at beginning of this command (if necessary)
49
   and prepare the undo info for recording a change.
Stefan Monnier's avatar
Stefan Monnier committed
50 51
   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
52

Stefan Monnier's avatar
Stefan Monnier committed
53
static void
54
record_point (EMACS_INT pt)
Jim Blandy's avatar
Jim Blandy committed
55
{
Stefan Monnier's avatar
Stefan Monnier committed
56
  int at_boundary;
57

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

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

66 67 68 69 70 71 72
  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
73
    Fundo_boundary ();
74
  last_undo_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
75

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

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

      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;

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

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

/* 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
116
record_insert (EMACS_INT beg, EMACS_INT length)
Stefan Monnier's avatar
Stefan Monnier committed
117 118 119
{
  Lisp_Object lbeg, lend;

Tom Tromey's avatar
Tom Tromey committed
120
  if (EQ (BVAR (current_buffer, undo_list), Qt))
Stefan Monnier's avatar
Stefan Monnier committed
121 122 123 124
    return;

  record_point (beg);

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

141 142
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
Tom Tromey's avatar
Tom Tromey committed
143 144
  BVAR (current_buffer, undo_list) = Fcons (Fcons (lbeg, lend),
                                     BVAR (current_buffer, undo_list));
Jim Blandy's avatar
Jim Blandy committed
145 146 147
}

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

150
void
151
record_delete (EMACS_INT beg, Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
152
{
153
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
154

Tom Tromey's avatar
Tom Tromey committed
155
  if (EQ (BVAR (current_buffer, undo_list), Qt))
156 157
    return;

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

Tom Tromey's avatar
Tom Tromey committed
169 170
  BVAR (current_buffer, undo_list)
    = Fcons (Fcons (string, sbeg), BVAR (current_buffer, undo_list));
Jim Blandy's avatar
Jim Blandy committed
171 172
}

173 174 175 176 177
/* 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.  */

178
void
179
record_marker_adjustment (Lisp_Object marker, EMACS_INT adjustment)
180
{
Tom Tromey's avatar
Tom Tromey committed
181
  if (EQ (BVAR (current_buffer, undo_list), Qt))
182 183 184 185 186 187
    return;

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

188
  if (current_buffer != last_undo_buffer)
189
    Fundo_boundary ();
190
  last_undo_buffer = current_buffer;
191

Tom Tromey's avatar
Tom Tromey committed
192
  BVAR (current_buffer, undo_list)
193
    = Fcons (Fcons (marker, make_number (adjustment)),
Tom Tromey's avatar
Tom Tromey committed
194
	     BVAR (current_buffer, undo_list));
195 196
}

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

201
void
202
record_change (EMACS_INT beg, EMACS_INT length)
Jim Blandy's avatar
Jim Blandy committed
203
{
204
  record_delete (beg, make_buffer_string (beg, beg + length, 1));
Jim Blandy's avatar
Jim Blandy committed
205 206 207 208 209 210 211
  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.  */

212
void
213
record_first_change (void)
Jim Blandy's avatar
Jim Blandy committed
214
{
215
  struct buffer *base_buffer = current_buffer;
216

Tom Tromey's avatar
Tom Tromey committed
217
  if (EQ (BVAR (current_buffer, undo_list), Qt))
218 219
    return;

220
  if (current_buffer != last_undo_buffer)
221
    Fundo_boundary ();
222
  last_undo_buffer = current_buffer;
223

224 225 226
  if (base_buffer->base_buffer)
    base_buffer = base_buffer->base_buffer;

227 228 229
  BVAR (current_buffer, undo_list) =
    Fcons (Fcons (Qt, INTEGER_TO_CONS (base_buffer->modtime)),
	   BVAR (current_buffer, undo_list));
Jim Blandy's avatar
Jim Blandy committed
230 231
}

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

235
void
236 237 238
record_property_change (EMACS_INT beg, EMACS_INT length,
			Lisp_Object prop, Lisp_Object value,
			Lisp_Object buffer)
239 240
{
  Lisp_Object lbeg, lend, entry;
241
  struct buffer *obuf = current_buffer, *buf = XBUFFER (buffer);
242 243
  int boundary = 0;

Tom Tromey's avatar
Tom Tromey committed
244
  if (EQ (BVAR (buf, undo_list), Qt))
245 246
    return;

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

251
  if (buf != last_undo_buffer)
252
    boundary = 1;
253
  last_undo_buffer = buf;
254 255

  /* Switch temporarily to the buffer that was changed.  */
256
  current_buffer = buf;
257 258 259 260

  if (boundary)
    Fundo_boundary ();

261
  if (MODIFF <= SAVE_MODIFF)
262 263
    record_first_change ();

264 265
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
266
  entry = Fcons (Qnil, Fcons (prop, Fcons (value, Fcons (lbeg, lend))));
Tom Tromey's avatar
Tom Tromey committed
267
  BVAR (current_buffer, undo_list) = Fcons (entry, BVAR (current_buffer, undo_list));
268 269 270 271

  current_buffer = obuf;
}

Paul Eggert's avatar
Paul Eggert committed
272
DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
273 274 275
       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
276
  (void)
Jim Blandy's avatar
Jim Blandy committed
277 278
{
  Lisp_Object tem;
Tom Tromey's avatar
Tom Tromey committed
279
  if (EQ (BVAR (current_buffer, undo_list), Qt))
Jim Blandy's avatar
Jim Blandy committed
280
    return Qnil;
Tom Tromey's avatar
Tom Tromey committed
281
  tem = Fcar (BVAR (current_buffer, undo_list));
Jim Blandy's avatar
Jim Blandy committed
282
  if (!NILP (tem))
283 284 285 286 287 288
    {
      /* 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
289 290
	  XSETCDR (pending_boundary, BVAR (current_buffer, undo_list));
	  BVAR (current_buffer, undo_list) = pending_boundary;
291 292 293
	  pending_boundary = Qnil;
	}
      else
Tom Tromey's avatar
Tom Tromey committed
294
	BVAR (current_buffer, undo_list) = Fcons (Qnil, BVAR (current_buffer, undo_list));
295
    }
296 297
  last_boundary_position = PT;
  last_boundary_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
298 299 300 301
  return Qnil;
}

/* At garbage collection time, make an undo list shorter at the end,
302 303 304 305 306
   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
307
truncate_undo_list (struct buffer *b)
Jim Blandy's avatar
Jim Blandy committed
308
{
309
  Lisp_Object list;
Jim Blandy's avatar
Jim Blandy committed
310 311 312
  Lisp_Object prev, next, last_boundary;
  int size_so_far = 0;

313 314 315 316 317 318 319 320 321 322
  /* Make sure that calling undo-outer-limit-function
     won't cause another GC.  */
  int count = inhibit_garbage_collection ();

  /* 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.  */
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
  set_buffer_internal (b);

Tom Tromey's avatar
Tom Tromey committed
323
  list = BVAR (b, undo_list);
324

Jim Blandy's avatar
Jim Blandy committed
325 326 327 328
  prev = Qnil;
  next = list;
  last_boundary = Qnil;

329
  /* If the first element is an undo boundary, skip past it.  */
330
  if (CONSP (next) && NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336
    {
      /* 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;
337
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
338
    }
339

340 341 342 343 344 345
  /* 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.  */

346
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
347 348
    {
      Lisp_Object elt;
349
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
350 351 352

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
353
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
354 355
	{
	  size_so_far += sizeof (struct Lisp_Cons);
356
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
357
	    size_so_far += (sizeof (struct Lisp_String) - 1
358
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
359 360 361 362
	}

      /* Advance to next element.  */
      prev = next;
363
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
364
    }
365

366 367
  /* 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.  */
368 369
  if (INTEGERP (Vundo_outer_limit)
      && size_so_far > XINT (Vundo_outer_limit)
370 371
      && !NILP (Vundo_outer_limit_function))
    {
372 373
      Lisp_Object tem;
      struct buffer *temp = last_undo_buffer;
374 375

      /* Normally the function this calls is undo-outer-limit-truncate.  */
376 377
      tem = call1 (Vundo_outer_limit_function, make_number (size_so_far));
      if (! NILP (tem))
378 379 380 381 382 383 384 385 386 387 388 389
	{
	  /* 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;
    }

390
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
391 392
    last_boundary = prev;

393
  /* Keep additional undo data, if it fits in the limits.  */
394
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
395 396
    {
      Lisp_Object elt;
397
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
398 399

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

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
414
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
415 416
	{
	  size_so_far += sizeof (struct Lisp_Cons);
417
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
418
	    size_so_far += (sizeof (struct Lisp_String) - 1
419
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
420 421 422 423
	}

      /* Advance to next element.  */
      prev = next;
424
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
425 426 427
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
428
  if (NILP (next))
429
    ;
Jim Blandy's avatar
Jim Blandy committed
430
  /* Truncate at the boundary where we decided to truncate.  */
431 432 433
  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
434
  else
Tom Tromey's avatar
Tom Tromey committed
435
    BVAR (b, undo_list) = Qnil;
436 437

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
438 439 440
}

DEFUN ("primitive-undo", Fprimitive_undo, Sprimitive_undo, 2, 2, 0,
441 442
       doc: /* Undo N records from the front of the list LIST.
Return what remains of the list.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
443
  (Lisp_Object n, Lisp_Object list)
Jim Blandy's avatar
Jim Blandy committed
444
{
445 446
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
447
  int count = SPECPDL_INDEX ();
448
  register int arg;
449 450
  Lisp_Object oldlist;
  int did_apply = 0;
451

Jim Blandy's avatar
Jim Blandy committed
452 453 454 455 456 457 458
#if 0  /* This is a good feature, but would make undo-start
	  unable to do what is expected.  */
  Lisp_Object tem;

  /* If the head of the list is a boundary, it is the boundary
     preceding this command.  Get rid of it and don't count it.  */
  tem = Fcar (list);
Jim Blandy's avatar
Jim Blandy committed
459
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
460 461 462
    list = Fcdr (list);
#endif

463
  CHECK_NUMBER (n);
464 465 466
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);
467 468
  /* I don't think we need to gcpro oldlist, as we use it only
     to check for EQ.  ++kfs  */
469

470 471
  /* In a writable buffer, enable undoing read-only text that is so
     because of text properties.  */
Tom Tromey's avatar
Tom Tromey committed
472
  if (NILP (BVAR (current_buffer, read_only)))
473 474
    specbind (Qinhibit_read_only, Qt);

475 476 477
  /* Don't let `intangible' properties interfere with undo.  */
  specbind (Qinhibit_point_motion_hooks, Qt);

Tom Tromey's avatar
Tom Tromey committed
478
  oldlist = BVAR (current_buffer, undo_list);
479

Jim Blandy's avatar
Jim Blandy committed
480 481
  while (arg > 0)
    {
482
      while (CONSP (list))
Jim Blandy's avatar
Jim Blandy committed
483
	{
484 485
	  next = XCAR (list);
	  list = XCDR (list);
486
	  /* Exit inner loop at undo boundary.  */
Jim Blandy's avatar
Jim Blandy committed
487
	  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
488
	    break;
489
	  /* Handle an integer by setting point to that value.  */
490
	  if (INTEGERP (next))
491
	    SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
492
	  else if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
493
	    {
494 495
	      Lisp_Object car, cdr;

496 497
	      car = XCAR (next);
	      cdr = XCDR (next);
498
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
499
		{
500
		  /* Element (t high . low) records previous modtime.  */
501
		  struct buffer *base_buffer = current_buffer;
502 503
		  time_t mod_time;
		  CONS_TO_INTEGER (cdr, time_t, mod_time);
504 505 506 507

		  if (current_buffer->base_buffer)
		    base_buffer = current_buffer->base_buffer;

508 509 510
		  /* If this records an obsolete save
		     (not matching the actual disk file)
		     then don't mark unmodified.  */
511
		  if (mod_time != base_buffer->modtime)
512
		    continue;
513
#ifdef CLASH_DETECTION
514
		  Funlock_buffer ();
515
#endif /* CLASH_DETECTION */
516
		  Fset_buffer_modified_p (Qnil);
Jim Blandy's avatar
Jim Blandy committed
517
		}
518
	      else if (EQ (car, Qnil))
519
		{
520
		  /* Element (nil PROP VAL BEG . END) is property change.  */
521 522 523 524 525 526 527 528 529
		  Lisp_Object beg, end, prop, val;

		  prop = Fcar (cdr);
		  cdr = Fcdr (cdr);
		  val = Fcar (cdr);
		  cdr = Fcdr (cdr);
		  beg = Fcar (cdr);
		  end = Fcdr (cdr);

530 531
		  if (XINT (beg) < BEGV || XINT (end) > ZV)
		    error ("Changes to be undone are outside visible portion of buffer");
532 533
		  Fput_text_property (beg, end, prop, val, Qnil);
		}
534
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
535
		{
536 537 538 539
		  /* Element (BEG . END) means range was inserted.  */

		  if (XINT (car) < BEGV
		      || XINT (cdr) > ZV)
Jim Blandy's avatar
Jim Blandy committed
540
		    error ("Changes to be undone are outside visible portion of buffer");
541 542
		  /* Set point first thing, so that undoing this undo
		     does not send point back to where it is now.  */
543
		  Fgoto_char (car);
544
		  Fdelete_region (car, cdr);
545
		}
Kim F. Storm's avatar
Kim F. Storm committed
546
	      else if (EQ (car, Qapply))
547
		{
548
		  /* Element (apply FUN . ARGS) means call FUN to undo.  */
549 550
		  struct buffer *save_buffer = current_buffer;

Kim F. Storm's avatar
Kim F. Storm committed
551
		  car = Fcar (cdr);
552
		  cdr = Fcdr (cdr);
Kim F. Storm's avatar
Kim F. Storm committed
553 554
		  if (INTEGERP (car))
		    {
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
		      /* Long format: (apply DELTA START END FUN . ARGS).  */
		      Lisp_Object delta = car;
		      Lisp_Object start = Fcar (cdr);
		      Lisp_Object end   = Fcar (Fcdr (cdr));
		      Lisp_Object start_mark = Fcopy_marker (start, Qnil);
		      Lisp_Object end_mark   = Fcopy_marker (end, Qt);

		      cdr = Fcdr (Fcdr (cdr));
		      apply1 (Fcar (cdr), Fcdr (cdr));

		      /* Check that the function did what the entry said it
			 would do.  */
		      if (!EQ (start, Fmarker_position (start_mark))
			  || (XINT (delta) + XINT (end)
			      != marker_position (end_mark)))
			error ("Changes to be undone by function different than announced");
		      Fset_marker (start_mark, Qnil, Qnil);
		      Fset_marker (end_mark, Qnil, Qnil);
Kim F. Storm's avatar
Kim F. Storm committed
573
		    }
574 575
		  else
		    apply1 (car, cdr);
576 577 578

		  if (save_buffer != current_buffer)
		    error ("Undo function switched buffer");
579
		  did_apply = 1;
580
		}
581
	      else if (STRINGP (car) && INTEGERP (cdr))
582 583 584
		{
		  /* Element (STRING . POS) means STRING was deleted.  */
		  Lisp_Object membuf;
585
		  EMACS_INT pos = XINT (cdr);
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600

		  membuf = car;
		  if (pos < 0)
		    {
		      if (-pos < BEGV || -pos > ZV)
			error ("Changes to be undone are outside visible portion of buffer");
		      SET_PT (-pos);
		      Finsert (1, &membuf);
		    }
		  else
		    {
		      if (pos < BEGV || pos > ZV)
			error ("Changes to be undone are outside visible portion of buffer");
		      SET_PT (pos);

601 602 603 604 605 606
		      /* Now that we record marker adjustments
			 (caused by deletion) for undo,
			 we should always insert after markers,
			 so that undoing the marker adjustments
			 put the markers back in the right place.  */
		      Finsert (1, &membuf);
607 608
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
609
		}
610 611 612 613 614 615 616 617 618
	      else if (MARKERP (car) && INTEGERP (cdr))
		{
		  /* (MARKER . INTEGER) means a marker MARKER
		     was adjusted by INTEGER.  */
		  if (XMARKER (car)->buffer)
		    Fset_marker (car,
				 make_number (marker_position (car) - XINT (cdr)),
				 Fmarker_buffer (car));
		}
Jim Blandy's avatar
Jim Blandy committed
619 620 621 622 623
	    }
	}
      arg--;
    }

624 625 626 627 628

  /* Make sure an apply entry produces at least one undo entry,
     so the test in `undo' for continuing an undo series
     will work right.  */
  if (did_apply
Tom Tromey's avatar
Tom Tromey committed
629 630 631
      && EQ (oldlist, BVAR (current_buffer, undo_list)))
    BVAR (current_buffer, undo_list)
      = Fcons (list3 (Qapply, Qcdr, Qnil), BVAR (current_buffer, undo_list));
632

633
  UNGCPRO;
634
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
635
}
636

Andreas Schwab's avatar
Andreas Schwab committed
637
void
638
syms_of_undo (void)
Jim Blandy's avatar
Jim Blandy committed
639
{
640 641
  DEFSYM (Qinhibit_read_only, "inhibit-read-only");
  DEFSYM (Qapply, "apply");
Kim F. Storm's avatar
Kim F. Storm committed
642

643 644 645
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

646 647 648
  last_undo_buffer = NULL;
  last_boundary_buffer = NULL;

Jim Blandy's avatar
Jim Blandy committed
649 650
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
651

652
  DEFVAR_INT ("undo-limit", undo_limit,
653 654 655 656 657 658 659
	      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.  */);
660
  undo_limit = 80000;
661

662
  DEFVAR_INT ("undo-strong-limit", undo_strong_limit,
663 664 665 666 667 668 669 670 671
	      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.  */);
672
  undo_strong_limit = 120000;
673

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

680 681 682 683
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.
684 685 686 687 688

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.  */);
689
  Vundo_outer_limit = make_number (12000000);
690

691
  DEFVAR_LISP ("undo-outer-limit-function", Vundo_outer_limit_function,
692 693 694 695 696 697 698 699 700
	       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;
701

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