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

This file is part of GNU Emacs.

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

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

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


21
#include <config.h>
22

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

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

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

37 38
Lisp_Object Qinhibit_read_only;

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

Lisp_Object Qapply;

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

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

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

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

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

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

78 79
  at_boundary = ! CONSP (BVAR (current_buffer, undo_list))
                || NILP (XCAR (BVAR (current_buffer, undo_list)));
Stefan Monnier's avatar
Stefan Monnier committed
80

81
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
82 83
    record_first_change ();

84
  /* If we are just after an undo boundary, and
Stefan Monnier's avatar
Stefan Monnier committed
85 86
     point wasn't at start of deleted range, record where it was.  */
  if (at_boundary
87 88
      && current_buffer == last_boundary_buffer
      && last_boundary_position != pt)
Paul Eggert's avatar
Paul Eggert committed
89 90 91
    bset_undo_list (current_buffer,
		    Fcons (make_number (last_boundary_position),
			   BVAR (current_buffer, undo_list)));
Stefan Monnier's avatar
Stefan Monnier committed
92 93 94 95 96 97 98 99
}

/* 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
100
record_insert (ptrdiff_t beg, ptrdiff_t length)
Stefan Monnier's avatar
Stefan Monnier committed
101 102 103
{
  Lisp_Object lbeg, lend;

Tom Tromey's avatar
Tom Tromey committed
104
  if (EQ (BVAR (current_buffer, undo_list), Qt))
Stefan Monnier's avatar
Stefan Monnier committed
105 106 107 108
    return;

  record_point (beg);

Jim Blandy's avatar
Jim Blandy committed
109 110
  /* If this is following another insertion and consecutive with it
     in the buffer, combine the two.  */
Tom Tromey's avatar
Tom Tromey committed
111
  if (CONSP (BVAR (current_buffer, undo_list)))
Jim Blandy's avatar
Jim Blandy committed
112 113
    {
      Lisp_Object elt;
Tom Tromey's avatar
Tom Tromey committed
114
      elt = XCAR (BVAR (current_buffer, undo_list));
115
      if (CONSP (elt)
116 117 118
	  && INTEGERP (XCAR (elt))
	  && INTEGERP (XCDR (elt))
	  && XINT (XCDR (elt)) == beg)
Jim Blandy's avatar
Jim Blandy committed
119
	{
120
	  XSETCDR (elt, make_number (beg + length));
Jim Blandy's avatar
Jim Blandy committed
121 122 123 124
	  return;
	}
    }

125 126
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
Paul Eggert's avatar
Paul Eggert committed
127 128
  bset_undo_list (current_buffer,
		  Fcons (Fcons (lbeg, lend), BVAR (current_buffer, undo_list)));
Jim Blandy's avatar
Jim Blandy committed
129 130
}

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
/* Record the fact that markers in the region of FROM, TO are about to
   be adjusted.  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.  */

static void
record_marker_adjustments (ptrdiff_t from, ptrdiff_t to)
{
  Lisp_Object marker;
  register struct Lisp_Marker *m;
  register ptrdiff_t charpos, adjustment;

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

  if (current_buffer != last_undo_buffer)
    Fundo_boundary ();
  last_undo_buffer = current_buffer;

  for (m = BUF_MARKERS (current_buffer); m; m = m->next)
    {
      charpos = m->charpos;
      eassert (charpos <= Z);

      if (from <= charpos && charpos <= to)
        {
          /* insertion_type nil markers will end up at the beginning of
             the re-inserted text after undoing a deletion, and must be
             adjusted to move them to the correct place.

             insertion_type t markers will automatically move forward
             upon re-inserting the deleted text, so we have to arrange
             for them to move backward to the correct position.  */
          adjustment = (m->insertion_type ? to : from) - charpos;

          if (adjustment)
            {
              XSETMISC (marker, m);
              bset_undo_list
                (current_buffer,
                 Fcons (Fcons (marker, make_number (adjustment)),
                        BVAR (current_buffer, undo_list)));
            }
        }
    }
}

/* Record that a deletion is about to take place, of the characters in
   STRING, at location BEG.  Optionally record adjustments for markers
   in the region STRING occupies in the current buffer.  */
Jim Blandy's avatar
Jim Blandy committed
183

184
void
185
record_delete (ptrdiff_t beg, Lisp_Object string, bool record_markers)
Jim Blandy's avatar
Jim Blandy committed
186
{
187
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
188

Tom Tromey's avatar
Tom Tromey committed
189
  if (EQ (BVAR (current_buffer, undo_list), Qt))
190 191
    return;

192
  if (PT == beg + SCHARS (string))
193
    {
Stefan Monnier's avatar
Stefan Monnier committed
194 195
      XSETINT (sbeg, -beg);
      record_point (PT);
196 197
    }
  else
Stefan Monnier's avatar
Stefan Monnier committed
198 199 200 201
    {
      XSETFASTINT (sbeg, beg);
      record_point (beg);
    }
202

203 204 205 206 207
  /* primitive-undo assumes marker adjustments are recorded
     immediately before the deletion is recorded.  See bug 16818
     discussion.  */
  if (record_markers)
    record_marker_adjustments (beg, beg + SCHARS (string));
208

Paul Eggert's avatar
Paul Eggert committed
209 210
  bset_undo_list
    (current_buffer,
211
     Fcons (Fcons (string, sbeg), BVAR (current_buffer, undo_list)));
212 213
}

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

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

229
void
230
record_first_change (void)
Jim Blandy's avatar
Jim Blandy committed
231
{
232
  struct buffer *base_buffer = current_buffer;
233

Tom Tromey's avatar
Tom Tromey committed
234
  if (EQ (BVAR (current_buffer, undo_list), Qt))
235 236
    return;

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

241 242 243
  if (base_buffer->base_buffer)
    base_buffer = base_buffer->base_buffer;

Paul Eggert's avatar
Paul Eggert committed
244 245 246
  bset_undo_list (current_buffer,
		  Fcons (Fcons (Qt, Fvisited_file_modtime ()),
			 BVAR (current_buffer, undo_list)));
Jim Blandy's avatar
Jim Blandy committed
247 248
}

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
record_property_change (ptrdiff_t beg, ptrdiff_t length,
254 255
			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);
Paul Eggert's avatar
Paul Eggert committed
259
  bool boundary = 0;
260

Tom Tromey's avatar
Tom Tromey committed
261
  if (EQ (BVAR (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
  entry = Fcons (Qnil, Fcons (prop, Fcons (value, Fcons (lbeg, lend))));
Paul Eggert's avatar
Paul Eggert committed
284 285
  bset_undo_list (current_buffer,
		  Fcons (entry, BVAR (current_buffer, undo_list)));
286 287 288 289

  current_buffer = obuf;
}

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

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

332 333
  /* Make sure that calling undo-outer-limit-function
     won't cause another GC.  */
334
  ptrdiff_t count = inhibit_garbage_collection ();
335 336 337 338

  /* 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.  */
339
  record_unwind_current_buffer ();
340 341
  set_buffer_internal (b);

Tom Tromey's avatar
Tom Tromey committed
342
  list = BVAR (b, undo_list);
343

Jim Blandy's avatar
Jim Blandy committed
344 345 346 347
  prev = Qnil;
  next = list;
  last_boundary = Qnil;

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

359 360 361 362 363 364
  /* 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.  */

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

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

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

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

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

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

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

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

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

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

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

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
457
}
458

459

Andreas Schwab's avatar
Andreas Schwab committed
460
void
461
syms_of_undo (void)
Jim Blandy's avatar
Jim Blandy committed
462
{
463 464
  DEFSYM (Qinhibit_read_only, "inhibit-read-only");
  DEFSYM (Qapply, "apply");
Kim F. Storm's avatar
Kim F. Storm committed
465

466 467 468
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

469 470 471
  last_undo_buffer = NULL;
  last_boundary_buffer = NULL;

Jim Blandy's avatar
Jim Blandy committed
472
  defsubr (&Sundo_boundary);
473

474
  DEFVAR_INT ("undo-limit", undo_limit,
475 476 477 478 479 480 481
	      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.  */);
482
  undo_limit = 80000;
483

484
  DEFVAR_INT ("undo-strong-limit", undo_strong_limit,
485 486 487 488 489 490 491 492 493
	      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.  */);
494
  undo_strong_limit = 120000;
495

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

502 503 504 505
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.
506 507 508 509 510

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

513
  DEFVAR_LISP ("undo-outer-limit-function", Vundo_outer_limit_function,
514 515 516 517 518 519 520 521 522
	       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;
523

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