undo.c 21.8 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  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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 18
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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25
#include "lisp.h"
#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 30 31 32
/* Limits controlling how much undo information to keep.  */

EMACS_INT undo_limit;
EMACS_INT undo_strong_limit;
33 34

Lisp_Object Vundo_outer_limit;
35 36 37 38 39

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

Lisp_Object Vundo_outer_limit_function;

Jim Blandy's avatar
Jim Blandy committed
40 41 42
/* Last buffer for which undo information was recorded.  */
Lisp_Object last_undo_buffer;

43 44
Lisp_Object Qinhibit_read_only;

Kim F. Storm's avatar
Kim F. Storm committed
45 46 47 48
/* Marker for function call undo list elements.  */

Lisp_Object Qapply;

49 50 51 52 53 54 55
/* 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;

56 57 58 59
/* Nonzero means do not record point in record_point.  */

int undo_inhibit_record_point;

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

Stefan Monnier's avatar
Stefan Monnier committed
65 66
static void
record_point (pt)
Dave Love's avatar
Dave Love committed
67
     int pt;
Jim Blandy's avatar
Jim Blandy committed
68
{
Stefan Monnier's avatar
Stefan Monnier committed
69
  int at_boundary;
70

71 72 73 74 75 76 77 78
  /* Don't record position of pt when undo_inhibit_record_point holds.
     Needed to avoid inserting a position record in buffer-undo-list
     when last_point_position has not been set up correctly by
     command_loop_1, for example, when running a repeat-repeat-char
     event.  */
  if (undo_inhibit_record_point)
    return;

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

83 84
  if (!BUFFERP (last_undo_buffer)
      || current_buffer != XBUFFER (last_undo_buffer))
Jim Blandy's avatar
Jim Blandy committed
85
    Fundo_boundary ();
86
  XSETBUFFER (last_undo_buffer, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
87

Stefan Monnier's avatar
Stefan Monnier committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
  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;

110
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
111 112
    record_first_change ();

113
  /* If we are just after an undo boundary, and
Stefan Monnier's avatar
Stefan Monnier committed
114 115 116
     point wasn't at start of deleted range, record where it was.  */
  if (at_boundary
      && BUFFERP (last_point_position_buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
117
      /* If we're called from batch mode, this could be nil.  */
Stefan Monnier's avatar
Stefan Monnier committed
118
      && current_buffer == XBUFFER (last_point_position_buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
119 120 121 122 123 124 125 126 127 128
    {
      /* If we have switched windows, use the point value
	 from the window we are in.  */
      if (! EQ (last_point_position_window, selected_window))
	last_point_position = marker_position (XWINDOW (selected_window)->pointm);

      if (last_point_position != pt)
	current_buffer->undo_list
	  = Fcons (make_number (last_point_position), current_buffer->undo_list);
    }
Stefan Monnier's avatar
Stefan Monnier committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
}

/* 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
147 148
  /* If this is following another insertion and consecutive with it
     in the buffer, combine the two.  */
149
  if (CONSP (current_buffer->undo_list))
Jim Blandy's avatar
Jim Blandy committed
150 151
    {
      Lisp_Object elt;
152
      elt = XCAR (current_buffer->undo_list);
153
      if (CONSP (elt)
154 155 156
	  && INTEGERP (XCAR (elt))
	  && INTEGERP (XCDR (elt))
	  && XINT (XCDR (elt)) == beg)
Jim Blandy's avatar
Jim Blandy committed
157
	{
158
	  XSETCDR (elt, make_number (beg + length));
Jim Blandy's avatar
Jim Blandy committed
159 160 161 162
	  return;
	}
    }

163 164
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
165 166
  current_buffer->undo_list = Fcons (Fcons (lbeg, lend),
                                     current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
167 168 169
}

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

172
void
173 174 175
record_delete (beg, string)
     int beg;
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
176
{
177
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
178

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

182
  if (PT == beg + SCHARS (string))
183
    {
Stefan Monnier's avatar
Stefan Monnier committed
184 185
      XSETINT (sbeg, -beg);
      record_point (PT);
186 187
    }
  else
Stefan Monnier's avatar
Stefan Monnier committed
188 189 190 191
    {
      XSETFASTINT (sbeg, beg);
      record_point (beg);
    }
192

Jim Blandy's avatar
Jim Blandy committed
193
  current_buffer->undo_list
194
    = Fcons (Fcons (string, sbeg), current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
195 196
}

197 198 199 200 201
/* 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.  */

202
void
203 204 205 206 207 208 209 210 211 212 213
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);

214
  if (!BUFFERP (last_undo_buffer)
215
      || current_buffer != XBUFFER (last_undo_buffer))
216 217 218 219 220 221 222 223
    Fundo_boundary ();
  XSETBUFFER (last_undo_buffer, current_buffer);

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

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

228
void
Jim Blandy's avatar
Jim Blandy committed
229 230 231
record_change (beg, length)
     int beg, length;
{
232
  record_delete (beg, make_buffer_string (beg, beg + length, 1));
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239
  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.  */

240
void
Jim Blandy's avatar
Jim Blandy committed
241 242 243
record_first_change ()
{
  Lisp_Object high, low;
244
  struct buffer *base_buffer = current_buffer;
245 246 247 248

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

249 250
  if (!BUFFERP (last_undo_buffer)
      || current_buffer != XBUFFER (last_undo_buffer))
251
    Fundo_boundary ();
252
  XSETBUFFER (last_undo_buffer, current_buffer);
253

254 255 256 257 258
  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
259 260 261
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

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

265
void
266 267 268 269 270 271 272 273
record_property_change (beg, length, prop, value, buffer)
     int beg, length;
     Lisp_Object prop, value, buffer;
{
  Lisp_Object lbeg, lend, entry;
  struct buffer *obuf = current_buffer;
  int boundary = 0;

274
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
275 276
    return;

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

281 282 283 284 285 286 287 288 289 290
  if (!EQ (buffer, last_undo_buffer))
    boundary = 1;
  last_undo_buffer = buffer;

  /* Switch temporarily to the buffer that was changed.  */
  current_buffer = XBUFFER (buffer);

  if (boundary)
    Fundo_boundary ();

291
  if (MODIFF <= SAVE_MODIFF)
292 293
    record_first_change ();

294 295
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
296 297 298 299 300 301
  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
302
DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
303 304 305 306
       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
307 308 309 310 311
{
  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
312
  if (!NILP (tem))
313 314 315 316 317 318
    {
      /* 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.  */
319
	  XSETCDR (pending_boundary, current_buffer->undo_list);
320 321 322 323 324 325
	  current_buffer->undo_list = pending_boundary;
	  pending_boundary = Qnil;
	}
      else
	current_buffer->undo_list = Fcons (Qnil, current_buffer->undo_list);
    }
Jim Blandy's avatar
Jim Blandy committed
326 327 328 329
  return Qnil;
}

/* At garbage collection time, make an undo list shorter at the end,
330 331 332 333 334 335 336
   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
337
{
338
  Lisp_Object list;
Jim Blandy's avatar
Jim Blandy committed
339 340 341
  Lisp_Object prev, next, last_boundary;
  int size_so_far = 0;

342 343 344 345 346 347 348 349 350 351 352 353
  /* 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
354 355 356 357
  prev = Qnil;
  next = list;
  last_boundary = Qnil;

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

369 370 371 372 373 374
  /* 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.  */

375
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
376 377
    {
      Lisp_Object elt;
378
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
379 380 381

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

      /* Advance to next element.  */
      prev = next;
392
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
393
    }
394

395 396
  /* 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.  */
397 398
  if (INTEGERP (Vundo_outer_limit)
      && size_so_far > XINT (Vundo_outer_limit)
399 400
      && !NILP (Vundo_outer_limit_function))
    {
401
      Lisp_Object temp = last_undo_buffer, tem;
402 403

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

418
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
419 420
    last_boundary = prev;

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

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

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

      /* Advance to next element.  */
      prev = next;
452
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
453 454 455
    }

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

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

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

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

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

504 505 506
  /* Don't let `intangible' properties interfere with undo.  */
  specbind (Qinhibit_point_motion_hooks, Qt);

507 508
  oldlist = current_buffer->undo_list;

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

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

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
536
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
537 538 539 540

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

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

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

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

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

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

		  if (save_buffer != current_buffer)
		    error ("Undo function switched buffer");
612
		  did_apply = 1;
613
		}
614
	      else if (STRINGP (car) && INTEGERP (cdr))
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
		{
		  /* 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);

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

657 658 659 660 661 662 663 664 665

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

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

Kim F. Storm's avatar
Kim F. Storm committed
676 677 678
  Qapply = intern ("apply");
  staticpro (&Qapply);

679 680 681
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

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

  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;

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

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

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

  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;
734 735 736 737

  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
738
}
Miles Bader's avatar
Miles Bader committed
739 740 741

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