undo.c 21.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* undo handling for GNU Emacs.
2
   Copyright (C) 1990, 1993, 1994, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
                 2005, 2006, 2007, 2008, 2009  Free Software Foundation, 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>
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 28 29 30
/* Limits controlling how much undo information to keep.  */

EMACS_INT undo_limit;
EMACS_INT undo_strong_limit;
31 32

Lisp_Object Vundo_outer_limit;
33 34 35 36 37

/* Function to call when undo_outer_limit is exceeded.  */

Lisp_Object Vundo_outer_limit_function;

Jim Blandy's avatar
Jim Blandy committed
38
/* Last buffer for which undo information was recorded.  */
39 40 41 42 43 44
/* BEWARE: This is not traced by the GC, so never dereference it!  */
struct buffer *last_undo_buffer;

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

46 47
Lisp_Object Qinhibit_read_only;

Kim F. Storm's avatar
Kim F. Storm committed
48 49 50 51
/* Marker for function call undo list elements.  */

Lisp_Object Qapply;

52 53 54 55 56 57 58
/* 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.  */
Lisp_Object pending_boundary;

59 60 61 62
/* Nonzero means do not record point in record_point.  */

int undo_inhibit_record_point;

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

Stefan Monnier's avatar
Stefan Monnier committed
68 69
static void
record_point (pt)
Dave Love's avatar
Dave Love committed
70
     int pt;
Jim Blandy's avatar
Jim Blandy committed
71
{
Stefan Monnier's avatar
Stefan Monnier committed
72
  int at_boundary;
73

74
  /* Don't record position of pt when undo_inhibit_record_point holds.  */
75 76 77
  if (undo_inhibit_record_point)
    return;

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

82 83 84 85 86 87 88
  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
89
    Fundo_boundary ();
90
  last_undo_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
91

Stefan Monnier's avatar
Stefan Monnier committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
  if (CONSP (current_buffer->undo_list))
    {
      /* Set AT_BOUNDARY to 1 only when we have nothing other than
         marker adjustment before undo boundary.  */

      Lisp_Object tail = current_buffer->undo_list, elt;

      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;

114
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
115 116
    record_first_change ();

117
  /* If we are just after an undo boundary, and
Stefan Monnier's avatar
Stefan Monnier committed
118 119
     point wasn't at start of deleted range, record where it was.  */
  if (at_boundary
120 121 122 123
      && current_buffer == last_boundary_buffer
      && last_boundary_position != pt)
    current_buffer->undo_list
      = Fcons (make_number (last_boundary_position), current_buffer->undo_list);
Stefan Monnier's avatar
Stefan Monnier committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
}

/* 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
record_insert (beg, length)
     int beg, length;
{
  Lisp_Object lbeg, lend;

  if (EQ (current_buffer->undo_list, Qt))
    return;

  record_point (beg);

Jim Blandy's avatar
Jim Blandy committed
142 143
  /* If this is following another insertion and consecutive with it
     in the buffer, combine the two.  */
144
  if (CONSP (current_buffer->undo_list))
Jim Blandy's avatar
Jim Blandy committed
145 146
    {
      Lisp_Object elt;
147
      elt = XCAR (current_buffer->undo_list);
148
      if (CONSP (elt)
149 150 151
	  && INTEGERP (XCAR (elt))
	  && INTEGERP (XCDR (elt))
	  && XINT (XCDR (elt)) == beg)
Jim Blandy's avatar
Jim Blandy committed
152
	{
153
	  XSETCDR (elt, make_number (beg + length));
Jim Blandy's avatar
Jim Blandy committed
154 155 156 157
	  return;
	}
    }

158 159
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
160 161
  current_buffer->undo_list = Fcons (Fcons (lbeg, lend),
                                     current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
162 163 164
}

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

167
void
168 169 170
record_delete (beg, string)
     int beg;
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
171
{
172
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
173

174 175 176
  if (EQ (current_buffer->undo_list, Qt))
    return;

177
  if (PT == beg + SCHARS (string))
178
    {
Stefan Monnier's avatar
Stefan Monnier committed
179 180
      XSETINT (sbeg, -beg);
      record_point (PT);
181 182
    }
  else
Stefan Monnier's avatar
Stefan Monnier committed
183 184 185 186
    {
      XSETFASTINT (sbeg, beg);
      record_point (beg);
    }
187

Jim Blandy's avatar
Jim Blandy committed
188
  current_buffer->undo_list
189
    = Fcons (Fcons (string, sbeg), current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
190 191
}

192 193 194 195 196
/* 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.  */

197
void
198 199 200 201 202 203 204 205 206 207 208
record_marker_adjustment (marker, adjustment)
     Lisp_Object marker;
     int adjustment;
{
  if (EQ (current_buffer->undo_list, Qt))
    return;

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

209
  if (current_buffer != last_undo_buffer)
210
    Fundo_boundary ();
211
  last_undo_buffer = current_buffer;
212 213 214 215 216 217

  current_buffer->undo_list
    = Fcons (Fcons (marker, make_number (adjustment)),
	     current_buffer->undo_list);
}

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

222
void
Jim Blandy's avatar
Jim Blandy committed
223 224 225
record_change (beg, length)
     int beg, length;
{
226
  record_delete (beg, make_buffer_string (beg, beg + length, 1));
Jim Blandy's avatar
Jim Blandy committed
227 228 229 230 231 232 233
  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.  */

234
void
Jim Blandy's avatar
Jim Blandy committed
235 236 237
record_first_change ()
{
  Lisp_Object high, low;
238
  struct buffer *base_buffer = current_buffer;
239 240 241 242

  if (EQ (current_buffer->undo_list, Qt))
    return;

243
  if (current_buffer != last_undo_buffer)
244
    Fundo_boundary ();
245
  last_undo_buffer = current_buffer;
246

247 248 249 250 251
  if (base_buffer->base_buffer)
    base_buffer = base_buffer->base_buffer;

  XSETFASTINT (high, (base_buffer->modtime >> 16) & 0xffff);
  XSETFASTINT (low, base_buffer->modtime & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
252 253 254
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

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

258
void
259 260 261 262 263
record_property_change (beg, length, prop, value, buffer)
     int beg, length;
     Lisp_Object prop, value, buffer;
{
  Lisp_Object lbeg, lend, entry;
264
  struct buffer *obuf = current_buffer, *buf = XBUFFER (buffer);
265 266
  int boundary = 0;

267
  if (EQ (buf->undo_list, Qt))
268 269
    return;

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

274
  if (buf != last_undo_buffer)
275
    boundary = 1;
276
  last_undo_buffer = buf;
277 278

  /* Switch temporarily to the buffer that was changed.  */
279
  current_buffer = buf;
280 281 282 283

  if (boundary)
    Fundo_boundary ();

284
  if (MODIFF <= SAVE_MODIFF)
285 286
    record_first_change ();

287 288
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
289 290 291 292 293 294
  entry = Fcons (Qnil, Fcons (prop, Fcons (value, Fcons (lbeg, lend))));
  current_buffer->undo_list = Fcons (entry, current_buffer->undo_list);

  current_buffer = obuf;
}

Jim Blandy's avatar
Jim Blandy committed
295
DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
296 297 298 299
       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.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
300 301 302 303 304
{
  Lisp_Object tem;
  if (EQ (current_buffer->undo_list, Qt))
    return Qnil;
  tem = Fcar (current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
305
  if (!NILP (tem))
306 307 308 309 310 311
    {
      /* 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.  */
312
	  XSETCDR (pending_boundary, current_buffer->undo_list);
313 314 315 316 317 318
	  current_buffer->undo_list = pending_boundary;
	  pending_boundary = Qnil;
	}
      else
	current_buffer->undo_list = Fcons (Qnil, current_buffer->undo_list);
    }
319 320
  last_boundary_position = PT;
  last_boundary_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
321 322 323 324
  return Qnil;
}

/* At garbage collection time, make an undo list shorter at the end,
325 326 327 328 329 330 331
   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
truncate_undo_list (b)
     struct buffer *b;
Jim Blandy's avatar
Jim Blandy committed
332
{
333
  Lisp_Object list;
Jim Blandy's avatar
Jim Blandy committed
334 335 336
  Lisp_Object prev, next, last_boundary;
  int size_so_far = 0;

337 338 339 340 341 342 343 344 345 346 347 348
  /* 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);

  list = b->undo_list;

Jim Blandy's avatar
Jim Blandy committed
349 350 351 352
  prev = Qnil;
  next = list;
  last_boundary = Qnil;

353
  /* If the first element is an undo boundary, skip past it.  */
354
  if (CONSP (next) && NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358 359 360
    {
      /* 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;
361
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
362
    }
363

364 365 366 367 368 369
  /* 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.  */

370
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
371 372
    {
      Lisp_Object elt;
373
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
374 375 376

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
377
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
378 379
	{
	  size_so_far += sizeof (struct Lisp_Cons);
380
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
381
	    size_so_far += (sizeof (struct Lisp_String) - 1
382
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
383 384 385 386
	}

      /* Advance to next element.  */
      prev = next;
387
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
388
    }
389

390 391
  /* 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.  */
392 393
  if (INTEGERP (Vundo_outer_limit)
      && size_so_far > XINT (Vundo_outer_limit)
394 395
      && !NILP (Vundo_outer_limit_function))
    {
396 397
      Lisp_Object tem;
      struct buffer *temp = last_undo_buffer;
398 399

      /* Normally the function this calls is undo-outer-limit-truncate.  */
400 401
      tem = call1 (Vundo_outer_limit_function, make_number (size_so_far));
      if (! NILP (tem))
402 403 404 405 406 407 408 409 410 411 412 413
	{
	  /* 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;
    }

414
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
415 416
    last_boundary = prev;

417
  /* Keep additional undo data, if it fits in the limits.  */
418
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
419 420
    {
      Lisp_Object elt;
421
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
422 423

      /* When we get to a boundary, decide whether to truncate
424
	 either before or after it.  The lower threshold, undo_limit,
Jim Blandy's avatar
Jim Blandy committed
425
	 tells us to truncate after it.  If its size pushes past
426
	 the higher threshold undo_strong_limit, we truncate before it.  */
Jim Blandy's avatar
Jim Blandy committed
427
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
428
	{
429
	  if (size_so_far > undo_strong_limit)
Jim Blandy's avatar
Jim Blandy committed
430 431
	    break;
	  last_boundary = prev;
432
	  if (size_so_far > undo_limit)
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437
	    break;
	}

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
438
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
439 440
	{
	  size_so_far += sizeof (struct Lisp_Cons);
441
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
442
	    size_so_far += (sizeof (struct Lisp_String) - 1
443
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
444 445 446 447
	}

      /* Advance to next element.  */
      prev = next;
448
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
449 450 451
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
452
  if (NILP (next))
453
    ;
Jim Blandy's avatar
Jim Blandy committed
454
  /* Truncate at the boundary where we decided to truncate.  */
455 456 457
  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
458
  else
459 460 461
    b->undo_list = Qnil;

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
462 463 464
}

DEFUN ("primitive-undo", Fprimitive_undo, Sprimitive_undo, 2, 2, 0,
465 466 467
       doc: /* Undo N records from the front of the list LIST.
Return what remains of the list.  */)
     (n, list)
468
     Lisp_Object n, list;
Jim Blandy's avatar
Jim Blandy committed
469
{
470 471
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
472
  int count = SPECPDL_INDEX ();
473
  register int arg;
474 475
  Lisp_Object oldlist;
  int did_apply = 0;
476

Jim Blandy's avatar
Jim Blandy committed
477 478 479 480 481 482 483
#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
484
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
485 486 487
    list = Fcdr (list);
#endif

488
  CHECK_NUMBER (n);
489 490 491
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);
492 493
  /* I don't think we need to gcpro oldlist, as we use it only
     to check for EQ.  ++kfs  */
494

495 496 497
  /* In a writable buffer, enable undoing read-only text that is so
     because of text properties.  */
  if (NILP (current_buffer->read_only))
498 499
    specbind (Qinhibit_read_only, Qt);

500 501 502
  /* Don't let `intangible' properties interfere with undo.  */
  specbind (Qinhibit_point_motion_hooks, Qt);

503 504
  oldlist = current_buffer->undo_list;

Jim Blandy's avatar
Jim Blandy committed
505 506
  while (arg > 0)
    {
507
      while (CONSP (list))
Jim Blandy's avatar
Jim Blandy committed
508
	{
509 510
	  next = XCAR (list);
	  list = XCDR (list);
511
	  /* Exit inner loop at undo boundary.  */
Jim Blandy's avatar
Jim Blandy committed
512
	  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
513
	    break;
514
	  /* Handle an integer by setting point to that value.  */
515
	  if (INTEGERP (next))
516
	    SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
517
	  else if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
518
	    {
519 520
	      Lisp_Object car, cdr;

521 522
	      car = XCAR (next);
	      cdr = XCDR (next);
523
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
524
		{
525 526 527
		  /* Element (t high . low) records previous modtime.  */
		  Lisp_Object high, low;
		  int mod_time;
528
		  struct buffer *base_buffer = current_buffer;
529 530 531

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
532
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
533 534 535 536

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

537 538 539
		  /* If this records an obsolete save
		     (not matching the actual disk file)
		     then don't mark unmodified.  */
540
		  if (mod_time != base_buffer->modtime)
541
		    continue;
542
#ifdef CLASH_DETECTION
543
		  Funlock_buffer ();
544
#endif /* CLASH_DETECTION */
545
		  Fset_buffer_modified_p (Qnil);
Jim Blandy's avatar
Jim Blandy committed
546
		}
547
	      else if (EQ (car, Qnil))
548
		{
549
		  /* Element (nil PROP VAL BEG . END) is property change.  */
550 551 552 553 554 555 556 557 558
		  Lisp_Object beg, end, prop, val;

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

559 560
		  if (XINT (beg) < BEGV || XINT (end) > ZV)
		    error ("Changes to be undone are outside visible portion of buffer");
561 562
		  Fput_text_property (beg, end, prop, val, Qnil);
		}
563
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
564
		{
565 566 567 568
		  /* Element (BEG . END) means range was inserted.  */

		  if (XINT (car) < BEGV
		      || XINT (cdr) > ZV)
Jim Blandy's avatar
Jim Blandy committed
569
		    error ("Changes to be undone are outside visible portion of buffer");
570 571
		  /* Set point first thing, so that undoing this undo
		     does not send point back to where it is now.  */
572
		  Fgoto_char (car);
573
		  Fdelete_region (car, cdr);
574
		}
Kim F. Storm's avatar
Kim F. Storm committed
575
	      else if (EQ (car, Qapply))
576
		{
577
		  /* Element (apply FUN . ARGS) means call FUN to undo.  */
578 579
		  struct buffer *save_buffer = current_buffer;

Kim F. Storm's avatar
Kim F. Storm committed
580
		  car = Fcar (cdr);
581
		  cdr = Fcdr (cdr);
Kim F. Storm's avatar
Kim F. Storm committed
582 583
		  if (INTEGERP (car))
		    {
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
		      /* 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
602
		    }
603 604
		  else
		    apply1 (car, cdr);
605 606 607

		  if (save_buffer != current_buffer)
		    error ("Undo function switched buffer");
608
		  did_apply = 1;
609
		}
610
	      else if (STRINGP (car) && INTEGERP (cdr))
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
		{
		  /* Element (STRING . POS) means STRING was deleted.  */
		  Lisp_Object membuf;
		  int pos = XINT (cdr);

		  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);

630 631 632 633 634 635
		      /* 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);
636 637
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
638
		}
639 640 641 642 643 644 645 646 647
	      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
648 649 650 651 652
	    }
	}
      arg--;
    }

653 654 655 656 657 658 659 660 661

  /* 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
      && EQ (oldlist, current_buffer->undo_list))
    current_buffer->undo_list
      = Fcons (list3 (Qapply, Qcdr, Qnil), current_buffer->undo_list);

662
  UNGCPRO;
663
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
664
}
665

Andreas Schwab's avatar
Andreas Schwab committed
666
void
Jim Blandy's avatar
Jim Blandy committed
667 668
syms_of_undo ()
{
669 670 671
  Qinhibit_read_only = intern ("inhibit-read-only");
  staticpro (&Qinhibit_read_only);

Kim F. Storm's avatar
Kim F. Storm committed
672 673 674
  Qapply = intern ("apply");
  staticpro (&Qapply);

675 676 677
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

678 679 680
  last_undo_buffer = NULL;
  last_boundary_buffer = NULL;

Jim Blandy's avatar
Jim Blandy committed
681 682
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

  DEFVAR_INT ("undo-limit", &undo_limit,
	      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.  */);
  undo_limit = 20000;

  DEFVAR_INT ("undo-strong-limit", &undo_strong_limit,
	      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.  */);
  undo_strong_limit = 30000;

706
  DEFVAR_LISP ("undo-outer-limit", &Vundo_outer_limit,
707 708
	      doc: /* Outer limit on size of undo information for one command.
At garbage collection time, if the current command has produced
709 710
more than this much undo information, it discards the info and displays
a warning.  This is a last-ditch limit to prevent memory overflow.
711

712 713 714 715
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.
716 717 718 719 720

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.  */);
721
  Vundo_outer_limit = make_number (3000000);
722 723 724 725 726 727 728 729 730 731 732

  DEFVAR_LISP ("undo-outer-limit-function", &Vundo_outer_limit_function,
	       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;
733 734 735 736

  DEFVAR_BOOL ("undo-inhibit-record-point", &undo_inhibit_record_point,
	       doc: /* Non-nil means do not record `point' in `buffer-undo-list'.  */);
  undo_inhibit_record_point = 0;
Jim Blandy's avatar
Jim Blandy committed
737
}
Miles Bader's avatar
Miles Bader committed
738 739 740

/* arch-tag: d546ee01-4aed-4ffb-bb8b-eefaae50d38a
   (do not change this comment) */