undo.c 21.6 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,
3
                 2005, 2006, 2007, 2008, 2009, 2010, 2011  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>
22
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
23 24
#include "lisp.h"
#include "buffer.h"
25
#include "commands.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
26
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
27

28 29 30 31
/* Limits controlling how much undo information to keep.  */

EMACS_INT undo_limit;
EMACS_INT undo_strong_limit;
32 33

Lisp_Object Vundo_outer_limit;
34 35 36 37 38

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

Lisp_Object Vundo_outer_limit_function;

Jim Blandy's avatar
Jim Blandy committed
39
/* Last buffer for which undo information was recorded.  */
40 41 42 43 44 45
/* 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
46

47 48
Lisp_Object Qinhibit_read_only;

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

Lisp_Object Qapply;

53 54 55 56 57 58 59
/* 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;

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

int undo_inhibit_record_point;

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

Stefan Monnier's avatar
Stefan Monnier committed
69
static void
70
record_point (EMACS_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
}

/* 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
132
record_insert (EMACS_INT beg, EMACS_INT length)
Stefan Monnier's avatar
Stefan Monnier committed
133 134 135 136 137 138 139 140
{
  Lisp_Object lbeg, lend;

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

  record_point (beg);

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

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

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

166
void
167
record_delete (EMACS_INT beg, Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
168
{
169
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
170

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

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

Jim Blandy's avatar
Jim Blandy committed
185
  current_buffer->undo_list
186
    = Fcons (Fcons (string, sbeg), current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
187 188
}

189 190 191 192 193
/* 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.  */

194
void
195
record_marker_adjustment (Lisp_Object marker, EMACS_INT adjustment)
196 197 198 199 200 201 202 203
{
  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);

204
  if (current_buffer != last_undo_buffer)
205
    Fundo_boundary ();
206
  last_undo_buffer = current_buffer;
207 208 209 210 211 212

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

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

217
void
218
record_change (EMACS_INT beg, EMACS_INT length)
Jim Blandy's avatar
Jim Blandy committed
219
{
220
  record_delete (beg, make_buffer_string (beg, beg + length, 1));
Jim Blandy's avatar
Jim Blandy committed
221 222 223 224 225 226 227
  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.  */

228
void
229
record_first_change (void)
Jim Blandy's avatar
Jim Blandy committed
230 231
{
  Lisp_Object high, low;
232
  struct buffer *base_buffer = current_buffer;
233 234 235 236

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

237
  if (current_buffer != last_undo_buffer)
238
    Fundo_boundary ();
239
  last_undo_buffer = current_buffer;
240

241 242 243 244 245
  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
246 247 248
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

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

252
void
253 254 255
record_property_change (EMACS_INT beg, EMACS_INT length,
			Lisp_Object prop, Lisp_Object value,
			Lisp_Object buffer)
256 257
{
  Lisp_Object lbeg, lend, entry;
258
  struct buffer *obuf = current_buffer, *buf = XBUFFER (buffer);
259 260
  int boundary = 0;

261
  if (EQ (buf->undo_list, Qt))
262 263
    return;

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

268
  if (buf != last_undo_buffer)
269
    boundary = 1;
270
  last_undo_buffer = buf;
271 272

  /* Switch temporarily to the buffer that was changed.  */
273
  current_buffer = buf;
274 275 276 277

  if (boundary)
    Fundo_boundary ();

278
  if (MODIFF <= SAVE_MODIFF)
279 280
    record_first_change ();

281 282
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
283 284 285 286 287 288
  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
289
DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
290 291 292
       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
293
  (void)
Jim Blandy's avatar
Jim Blandy committed
294 295 296 297 298
{
  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
299
  if (!NILP (tem))
300 301 302 303 304 305
    {
      /* 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.  */
306
	  XSETCDR (pending_boundary, current_buffer->undo_list);
307 308 309 310 311 312
	  current_buffer->undo_list = pending_boundary;
	  pending_boundary = Qnil;
	}
      else
	current_buffer->undo_list = Fcons (Qnil, current_buffer->undo_list);
    }
313 314
  last_boundary_position = PT;
  last_boundary_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318
  return Qnil;
}

/* At garbage collection time, make an undo list shorter at the end,
319 320 321 322 323
   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
324
truncate_undo_list (struct buffer *b)
Jim Blandy's avatar
Jim Blandy committed
325
{
326
  Lisp_Object list;
Jim Blandy's avatar
Jim Blandy committed
327 328 329
  Lisp_Object prev, next, last_boundary;
  int size_so_far = 0;

330 331 332 333 334 335 336 337 338 339 340 341
  /* 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
342 343 344 345
  prev = Qnil;
  next = list;
  last_boundary = Qnil;

346
  /* If the first element is an undo boundary, skip past it.  */
347
  if (CONSP (next) && NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
348 349 350 351 352 353
    {
      /* 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;
354
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
355
    }
356

357 358 359 360 361 362
  /* 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.  */

363
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
364 365
    {
      Lisp_Object elt;
366
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
367 368 369

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
370
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
371 372
	{
	  size_so_far += sizeof (struct Lisp_Cons);
373
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
374
	    size_so_far += (sizeof (struct Lisp_String) - 1
375
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
376 377 378 379
	}

      /* Advance to next element.  */
      prev = next;
380
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
381
    }
382

383 384
  /* 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.  */
385 386
  if (INTEGERP (Vundo_outer_limit)
      && size_so_far > XINT (Vundo_outer_limit)
387 388
      && !NILP (Vundo_outer_limit_function))
    {
389 390
      Lisp_Object tem;
      struct buffer *temp = last_undo_buffer;
391 392

      /* Normally the function this calls is undo-outer-limit-truncate.  */
393 394
      tem = call1 (Vundo_outer_limit_function, make_number (size_so_far));
      if (! NILP (tem))
395 396 397 398 399 400 401 402 403 404 405 406
	{
	  /* 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;
    }

407
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
408 409
    last_boundary = prev;

410
  /* Keep additional undo data, if it fits in the limits.  */
411
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
412 413
    {
      Lisp_Object elt;
414
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
415 416

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

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
431
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
432 433
	{
	  size_so_far += sizeof (struct Lisp_Cons);
434
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
435
	    size_so_far += (sizeof (struct Lisp_String) - 1
436
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440
	}

      /* Advance to next element.  */
      prev = next;
441
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
442 443 444
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
445
  if (NILP (next))
446
    ;
Jim Blandy's avatar
Jim Blandy committed
447
  /* Truncate at the boundary where we decided to truncate.  */
448 449 450
  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
451
  else
452 453 454
    b->undo_list = Qnil;

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
455 456 457
}

DEFUN ("primitive-undo", Fprimitive_undo, Sprimitive_undo, 2, 2, 0,
458 459
       doc: /* Undo N records from the front of the list LIST.
Return what remains of the list.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
460
  (Lisp_Object n, Lisp_Object list)
Jim Blandy's avatar
Jim Blandy committed
461
{
462 463
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
464
  int count = SPECPDL_INDEX ();
465
  register int arg;
466 467
  Lisp_Object oldlist;
  int did_apply = 0;
468

Jim Blandy's avatar
Jim Blandy committed
469 470 471 472 473 474 475
#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
476
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
477 478 479
    list = Fcdr (list);
#endif

480
  CHECK_NUMBER (n);
481 482 483
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);
484 485
  /* I don't think we need to gcpro oldlist, as we use it only
     to check for EQ.  ++kfs  */
486

487 488 489
  /* In a writable buffer, enable undoing read-only text that is so
     because of text properties.  */
  if (NILP (current_buffer->read_only))
490 491
    specbind (Qinhibit_read_only, Qt);

492 493 494
  /* Don't let `intangible' properties interfere with undo.  */
  specbind (Qinhibit_point_motion_hooks, Qt);

495 496
  oldlist = current_buffer->undo_list;

Jim Blandy's avatar
Jim Blandy committed
497 498
  while (arg > 0)
    {
499
      while (CONSP (list))
Jim Blandy's avatar
Jim Blandy committed
500
	{
501 502
	  next = XCAR (list);
	  list = XCDR (list);
503
	  /* Exit inner loop at undo boundary.  */
Jim Blandy's avatar
Jim Blandy committed
504
	  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
505
	    break;
506
	  /* Handle an integer by setting point to that value.  */
507
	  if (INTEGERP (next))
508
	    SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
509
	  else if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
510
	    {
511 512
	      Lisp_Object car, cdr;

513 514
	      car = XCAR (next);
	      cdr = XCDR (next);
515
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
516
		{
517 518 519
		  /* Element (t high . low) records previous modtime.  */
		  Lisp_Object high, low;
		  int mod_time;
520
		  struct buffer *base_buffer = current_buffer;
521 522 523

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
524
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
525 526 527 528

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

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

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

551 552
		  if (XINT (beg) < BEGV || XINT (end) > ZV)
		    error ("Changes to be undone are outside visible portion of buffer");
553 554
		  Fput_text_property (beg, end, prop, val, Qnil);
		}
555
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
556
		{
557 558 559 560
		  /* Element (BEG . END) means range was inserted.  */

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

Kim F. Storm's avatar
Kim F. Storm committed
572
		  car = Fcar (cdr);
573
		  cdr = Fcdr (cdr);
Kim F. Storm's avatar
Kim F. Storm committed
574 575
		  if (INTEGERP (car))
		    {
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
		      /* 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
594
		    }
595 596
		  else
		    apply1 (car, cdr);
597 598 599

		  if (save_buffer != current_buffer)
		    error ("Undo function switched buffer");
600
		  did_apply = 1;
601
		}
602
	      else if (STRINGP (car) && INTEGERP (cdr))
603 604 605
		{
		  /* Element (STRING . POS) means STRING was deleted.  */
		  Lisp_Object membuf;
606
		  EMACS_INT pos = XINT (cdr);
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621

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

622 623 624 625 626 627
		      /* 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);
628 629
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
630
		}
631 632 633 634 635 636 637 638 639
	      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
640 641 642 643 644
	    }
	}
      arg--;
    }

645 646 647 648 649 650 651 652 653

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

654
  UNGCPRO;
655
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
656
}
657

Andreas Schwab's avatar
Andreas Schwab committed
658
void
659
syms_of_undo (void)
Jim Blandy's avatar
Jim Blandy committed
660
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
661
  Qinhibit_read_only = intern_c_string ("inhibit-read-only");
662 663
  staticpro (&Qinhibit_read_only);

Dan Nicolaescu's avatar
Dan Nicolaescu committed
664
  Qapply = intern_c_string ("apply");
Kim F. Storm's avatar
Kim F. Storm committed
665 666
  staticpro (&Qapply);

667 668 669
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

670 671 672
  last_undo_buffer = NULL;
  last_boundary_buffer = NULL;

Jim Blandy's avatar
Jim Blandy committed
673 674
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
675 676 677 678 679 680 681 682 683

  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.  */);
684
  undo_limit = 80000;
685 686 687 688 689 690 691 692 693 694 695

  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.  */);
696
  undo_strong_limit = 120000;
697

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

704 705 706 707
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.
708 709 710 711 712

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.  */);
713
  Vundo_outer_limit = make_number (12000000);
714 715 716 717 718 719 720 721 722 723 724

  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;
725 726 727 728

  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
729
}
Miles Bader's avatar
Miles Bader committed
730