undo.c 16.3 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* undo handling for GNU Emacs.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1990, 1993-1994, 2000-2015 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 39 40 41
/* 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.  */
42
static Lisp_Object pending_boundary;
43

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

Stefan Monnier's avatar
Stefan Monnier committed
49
static void
50
record_point (ptrdiff_t pt)
Jim Blandy's avatar
Jim Blandy committed
51
{
Paul Eggert's avatar
Paul Eggert committed
52
  bool at_boundary;
53

54
  /* Don't record position of pt when undo_inhibit_record_point holds.  */
55 56 57
  if (undo_inhibit_record_point)
    return;

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

62 63 64 65 66 67 68
  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
69
    Fundo_boundary ();
70
  last_undo_buffer = current_buffer;
Jim Blandy's avatar
Jim Blandy committed
71

72 73
  at_boundary = ! CONSP (BVAR (current_buffer, undo_list))
                || NILP (XCAR (BVAR (current_buffer, undo_list)));
Stefan Monnier's avatar
Stefan Monnier committed
74

75
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
76 77
    record_first_change ();

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

/* 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
94
record_insert (ptrdiff_t beg, ptrdiff_t length)
Stefan Monnier's avatar
Stefan Monnier committed
95 96 97
{
  Lisp_Object lbeg, lend;

Tom Tromey's avatar
Tom Tromey committed
98
  if (EQ (BVAR (current_buffer, undo_list), Qt))
Stefan Monnier's avatar
Stefan Monnier committed
99 100 101 102
    return;

  record_point (beg);

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

119 120
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
Paul Eggert's avatar
Paul Eggert committed
121 122
  bset_undo_list (current_buffer,
		  Fcons (Fcons (lbeg, lend), BVAR (current_buffer, undo_list)));
Jim Blandy's avatar
Jim Blandy committed
123 124
}

125 126 127 128 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
/* 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
177

178
void
179
record_delete (ptrdiff_t beg, Lisp_Object string, bool record_markers)
Jim Blandy's avatar
Jim Blandy committed
180
{
181
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
182

Tom Tromey's avatar
Tom Tromey committed
183
  if (EQ (BVAR (current_buffer, undo_list), Qt))
184 185
    return;

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

197 198 199 200 201
  /* 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));
202

Paul Eggert's avatar
Paul Eggert committed
203 204
  bset_undo_list
    (current_buffer,
205
     Fcons (Fcons (string, sbeg), BVAR (current_buffer, undo_list)));
206 207
}

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

212
void
213
record_change (ptrdiff_t beg, ptrdiff_t length)
Jim Blandy's avatar
Jim Blandy committed
214
{
215
  record_delete (beg, make_buffer_string (beg, beg + length, 1), false);
Jim Blandy's avatar
Jim Blandy committed
216 217 218 219 220 221 222
  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.  */

223
void
224
record_first_change (void)
Jim Blandy's avatar
Jim Blandy committed
225
{
226
  struct buffer *base_buffer = current_buffer;
227

Tom Tromey's avatar
Tom Tromey committed
228
  if (EQ (BVAR (current_buffer, undo_list), Qt))
229 230
    return;

231
  if (current_buffer != last_undo_buffer)
232
    Fundo_boundary ();
233
  last_undo_buffer = current_buffer;
234

235 236 237
  if (base_buffer->base_buffer)
    base_buffer = base_buffer->base_buffer;

Paul Eggert's avatar
Paul Eggert committed
238 239 240
  bset_undo_list (current_buffer,
		  Fcons (Fcons (Qt, Fvisited_file_modtime ()),
			 BVAR (current_buffer, undo_list)));
Jim Blandy's avatar
Jim Blandy committed
241 242
}

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

246
void
247
record_property_change (ptrdiff_t beg, ptrdiff_t length,
248 249
			Lisp_Object prop, Lisp_Object value,
			Lisp_Object buffer)
250 251
{
  Lisp_Object lbeg, lend, entry;
252
  struct buffer *obuf = current_buffer, *buf = XBUFFER (buffer);
Paul Eggert's avatar
Paul Eggert committed
253
  bool boundary = 0;
254

Tom Tromey's avatar
Tom Tromey committed
255
  if (EQ (BVAR (buf, undo_list), Qt))
256 257
    return;

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

262
  if (buf != last_undo_buffer)
263
    boundary = 1;
264
  last_undo_buffer = buf;
265 266

  /* Switch temporarily to the buffer that was changed.  */
267
  current_buffer = buf;
268 269 270 271

  if (boundary)
    Fundo_boundary ();

272
  if (MODIFF <= SAVE_MODIFF)
273 274
    record_first_change ();

275 276
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
277
  entry = Fcons (Qnil, Fcons (prop, Fcons (value, Fcons (lbeg, lend))));
Paul Eggert's avatar
Paul Eggert committed
278 279
  bset_undo_list (current_buffer,
		  Fcons (entry, BVAR (current_buffer, undo_list)));
280 281 282 283

  current_buffer = obuf;
}

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

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

326 327
  /* Make sure that calling undo-outer-limit-function
     won't cause another GC.  */
328
  ptrdiff_t count = inhibit_garbage_collection ();
329 330 331 332

  /* 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.  */
333
  record_unwind_current_buffer ();
334 335
  set_buffer_internal (b);

Tom Tromey's avatar
Tom Tromey committed
336
  list = BVAR (b, undo_list);
337

Jim Blandy's avatar
Jim Blandy committed
338 339 340 341
  prev = Qnil;
  next = list;
  last_boundary = Qnil;

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

353 354 355 356 357 358
  /* 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.  */

359
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
360 361
    {
      Lisp_Object elt;
362
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
363 364 365

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

      /* Advance to next element.  */
      prev = next;
376
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
377
    }
378

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

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

403
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
404 405
    last_boundary = prev;

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

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

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

      /* Advance to next element.  */
      prev = next;
437
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
438 439 440
    }

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

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
451
}
452

453

Andreas Schwab's avatar
Andreas Schwab committed
454
void
455
syms_of_undo (void)
Jim Blandy's avatar
Jim Blandy committed
456
{
457
  DEFSYM (Qinhibit_read_only, "inhibit-read-only");
458 459

  /* Marker for function call undo list elements.  */
460
  DEFSYM (Qapply, "apply");
Kim F. Storm's avatar
Kim F. Storm committed
461

462 463 464
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

465 466 467
  last_undo_buffer = NULL;
  last_boundary_buffer = NULL;

Jim Blandy's avatar
Jim Blandy committed
468
  defsubr (&Sundo_boundary);
469

470
  DEFVAR_INT ("undo-limit", undo_limit,
471 472 473 474 475 476 477
	      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.  */);
478
  undo_limit = 80000;
479

480
  DEFVAR_INT ("undo-strong-limit", undo_strong_limit,
481 482 483 484 485 486 487 488 489
	      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.  */);
490
  undo_strong_limit = 120000;
491

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

498 499 500 501
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.
502 503 504 505 506

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

509
  DEFVAR_LISP ("undo-outer-limit-function", Vundo_outer_limit_function,
510 511 512 513 514 515 516 517 518
	       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;
519

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