Fix a typo in a comment.
[emacs.git] / src / undo.c
blob2626fd4ccfed2d06a1da572794b5b708017aa9b5
1 /* undo handling for GNU Emacs.
2 Copyright (C) 1990, 1993-1994, 2000-2013 Free Software Foundation,
3 Inc.
5 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 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 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/>. */
21 #include <config.h>
23 #include "lisp.h"
24 #include "character.h"
25 #include "buffer.h"
26 #include "commands.h"
27 #include "window.h"
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;
33 /* Position of point last time we inserted a boundary. */
34 static struct buffer *last_boundary_buffer;
35 static ptrdiff_t last_boundary_position;
37 Lisp_Object Qinhibit_read_only;
39 /* Marker for function call undo list elements. */
41 Lisp_Object Qapply;
43 /* The first time a command records something for undo.
44 it also allocates the undo-boundary object
45 which will be added to the list at the end of the command.
46 This ensures we can't run out of space while trying to make
47 an undo-boundary. */
48 static Lisp_Object pending_boundary;
50 /* Record point as it was at beginning of this command (if necessary)
51 and prepare the undo info for recording a change.
52 PT is the position of point that will naturally occur as a result of the
53 undo record that will be added just after this command terminates. */
55 static void
56 record_point (ptrdiff_t pt)
58 int at_boundary;
60 /* Don't record position of pt when undo_inhibit_record_point holds. */
61 if (undo_inhibit_record_point)
62 return;
64 /* Allocate a cons cell to be the undo boundary after this command. */
65 if (NILP (pending_boundary))
66 pending_boundary = Fcons (Qnil, Qnil);
68 if ((current_buffer != last_undo_buffer)
69 /* Don't call Fundo_boundary for the first change. Otherwise we
70 risk overwriting last_boundary_position in Fundo_boundary with
71 PT of the current buffer and as a consequence not insert an
72 undo boundary because last_boundary_position will equal pt in
73 the test at the end of the present function (Bug#731). */
74 && (MODIFF > SAVE_MODIFF))
75 Fundo_boundary ();
76 last_undo_buffer = current_buffer;
78 if (CONSP (BVAR (current_buffer, undo_list)))
80 /* Set AT_BOUNDARY to 1 only when we have nothing other than
81 marker adjustment before undo boundary. */
83 Lisp_Object tail = BVAR (current_buffer, undo_list), elt;
85 while (1)
87 if (NILP (tail))
88 elt = Qnil;
89 else
90 elt = XCAR (tail);
91 if (NILP (elt) || ! (CONSP (elt) && MARKERP (XCAR (elt))))
92 break;
93 tail = XCDR (tail);
95 at_boundary = NILP (elt);
97 else
98 at_boundary = 1;
100 if (MODIFF <= SAVE_MODIFF)
101 record_first_change ();
103 /* If we are just after an undo boundary, and
104 point wasn't at start of deleted range, record where it was. */
105 if (at_boundary
106 && current_buffer == last_boundary_buffer
107 && last_boundary_position != pt)
108 bset_undo_list (current_buffer,
109 Fcons (make_number (last_boundary_position),
110 BVAR (current_buffer, undo_list)));
113 /* Record an insertion that just happened or is about to happen,
114 for LENGTH characters at position BEG.
115 (It is possible to record an insertion before or after the fact
116 because we don't need to record the contents.) */
118 void
119 record_insert (ptrdiff_t beg, ptrdiff_t length)
121 Lisp_Object lbeg, lend;
123 if (EQ (BVAR (current_buffer, undo_list), Qt))
124 return;
126 record_point (beg);
128 /* If this is following another insertion and consecutive with it
129 in the buffer, combine the two. */
130 if (CONSP (BVAR (current_buffer, undo_list)))
132 Lisp_Object elt;
133 elt = XCAR (BVAR (current_buffer, undo_list));
134 if (CONSP (elt)
135 && INTEGERP (XCAR (elt))
136 && INTEGERP (XCDR (elt))
137 && XINT (XCDR (elt)) == beg)
139 XSETCDR (elt, make_number (beg + length));
140 return;
144 XSETFASTINT (lbeg, beg);
145 XSETINT (lend, beg + length);
146 bset_undo_list (current_buffer,
147 Fcons (Fcons (lbeg, lend), BVAR (current_buffer, undo_list)));
150 /* Record that a deletion is about to take place,
151 of the characters in STRING, at location BEG. */
153 void
154 record_delete (ptrdiff_t beg, Lisp_Object string)
156 Lisp_Object sbeg;
158 if (EQ (BVAR (current_buffer, undo_list), Qt))
159 return;
161 if (PT == beg + SCHARS (string))
163 XSETINT (sbeg, -beg);
164 record_point (PT);
166 else
168 XSETFASTINT (sbeg, beg);
169 record_point (beg);
172 bset_undo_list
173 (current_buffer,
174 Fcons (Fcons (string, sbeg), BVAR (current_buffer, undo_list)));
177 /* Record the fact that MARKER is about to be adjusted by ADJUSTMENT.
178 This is done only when a marker points within text being deleted,
179 because that's the only case where an automatic marker adjustment
180 won't be inverted automatically by undoing the buffer modification. */
182 void
183 record_marker_adjustment (Lisp_Object marker, ptrdiff_t adjustment)
185 if (EQ (BVAR (current_buffer, undo_list), Qt))
186 return;
188 /* Allocate a cons cell to be the undo boundary after this command. */
189 if (NILP (pending_boundary))
190 pending_boundary = Fcons (Qnil, Qnil);
192 if (current_buffer != last_undo_buffer)
193 Fundo_boundary ();
194 last_undo_buffer = current_buffer;
196 bset_undo_list
197 (current_buffer,
198 Fcons (Fcons (marker, make_number (adjustment)),
199 BVAR (current_buffer, undo_list)));
202 /* Record that a replacement is about to take place,
203 for LENGTH characters at location BEG.
204 The replacement must not change the number of characters. */
206 void
207 record_change (ptrdiff_t beg, ptrdiff_t length)
209 record_delete (beg, make_buffer_string (beg, beg + length, 1));
210 record_insert (beg, length);
213 /* Record that an unmodified buffer is about to be changed.
214 Record the file modification date so that when undoing this entry
215 we can tell whether it is obsolete because the file was saved again. */
217 void
218 record_first_change (void)
220 struct buffer *base_buffer = current_buffer;
222 if (EQ (BVAR (current_buffer, undo_list), Qt))
223 return;
225 if (current_buffer != last_undo_buffer)
226 Fundo_boundary ();
227 last_undo_buffer = current_buffer;
229 if (base_buffer->base_buffer)
230 base_buffer = base_buffer->base_buffer;
232 bset_undo_list
233 (current_buffer,
234 Fcons (Fcons (Qt, make_lisp_time (base_buffer->modtime)),
235 BVAR (current_buffer, undo_list)));
238 /* Record a change in property PROP (whose old value was VAL)
239 for LENGTH characters starting at position BEG in BUFFER. */
241 void
242 record_property_change (ptrdiff_t beg, ptrdiff_t length,
243 Lisp_Object prop, Lisp_Object value,
244 Lisp_Object buffer)
246 Lisp_Object lbeg, lend, entry;
247 struct buffer *obuf = current_buffer, *buf = XBUFFER (buffer);
248 int boundary = 0;
250 if (EQ (BVAR (buf, undo_list), Qt))
251 return;
253 /* Allocate a cons cell to be the undo boundary after this command. */
254 if (NILP (pending_boundary))
255 pending_boundary = Fcons (Qnil, Qnil);
257 if (buf != last_undo_buffer)
258 boundary = 1;
259 last_undo_buffer = buf;
261 /* Switch temporarily to the buffer that was changed. */
262 current_buffer = buf;
264 if (boundary)
265 Fundo_boundary ();
267 if (MODIFF <= SAVE_MODIFF)
268 record_first_change ();
270 XSETINT (lbeg, beg);
271 XSETINT (lend, beg + length);
272 entry = Fcons (Qnil, Fcons (prop, Fcons (value, Fcons (lbeg, lend))));
273 bset_undo_list (current_buffer,
274 Fcons (entry, BVAR (current_buffer, undo_list)));
276 current_buffer = obuf;
279 DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
280 doc: /* Mark a boundary between units of undo.
281 An undo command will stop at this point,
282 but another undo command will undo to the previous boundary. */)
283 (void)
285 Lisp_Object tem;
286 if (EQ (BVAR (current_buffer, undo_list), Qt))
287 return Qnil;
288 tem = Fcar (BVAR (current_buffer, undo_list));
289 if (!NILP (tem))
291 /* One way or another, cons nil onto the front of the undo list. */
292 if (!NILP (pending_boundary))
294 /* If we have preallocated the cons cell to use here,
295 use that one. */
296 XSETCDR (pending_boundary, BVAR (current_buffer, undo_list));
297 bset_undo_list (current_buffer, pending_boundary);
298 pending_boundary = Qnil;
300 else
301 bset_undo_list (current_buffer,
302 Fcons (Qnil, BVAR (current_buffer, undo_list)));
304 last_boundary_position = PT;
305 last_boundary_buffer = current_buffer;
306 return Qnil;
309 /* At garbage collection time, make an undo list shorter at the end,
310 returning the truncated list. How this is done depends on the
311 variables undo-limit, undo-strong-limit and undo-outer-limit.
312 In some cases this works by calling undo-outer-limit-function. */
314 void
315 truncate_undo_list (struct buffer *b)
317 Lisp_Object list;
318 Lisp_Object prev, next, last_boundary;
319 EMACS_INT size_so_far = 0;
321 /* Make sure that calling undo-outer-limit-function
322 won't cause another GC. */
323 ptrdiff_t count = inhibit_garbage_collection ();
325 /* Make the buffer current to get its local values of variables such
326 as undo_limit. Also so that Vundo_outer_limit_function can
327 tell which buffer to operate on. */
328 record_unwind_current_buffer ();
329 set_buffer_internal (b);
331 list = BVAR (b, undo_list);
333 prev = Qnil;
334 next = list;
335 last_boundary = Qnil;
337 /* If the first element is an undo boundary, skip past it. */
338 if (CONSP (next) && NILP (XCAR (next)))
340 /* Add in the space occupied by this element and its chain link. */
341 size_so_far += sizeof (struct Lisp_Cons);
343 /* Advance to next element. */
344 prev = next;
345 next = XCDR (next);
348 /* Always preserve at least the most recent undo record
349 unless it is really horribly big.
351 Skip, skip, skip the undo, skip, skip, skip the undo,
352 Skip, skip, skip the undo, skip to the undo bound'ry. */
354 while (CONSP (next) && ! NILP (XCAR (next)))
356 Lisp_Object elt;
357 elt = XCAR (next);
359 /* Add in the space occupied by this element and its chain link. */
360 size_so_far += sizeof (struct Lisp_Cons);
361 if (CONSP (elt))
363 size_so_far += sizeof (struct Lisp_Cons);
364 if (STRINGP (XCAR (elt)))
365 size_so_far += (sizeof (struct Lisp_String) - 1
366 + SCHARS (XCAR (elt)));
369 /* Advance to next element. */
370 prev = next;
371 next = XCDR (next);
374 /* If by the first boundary we have already passed undo_outer_limit,
375 we're heading for memory full, so offer to clear out the list. */
376 if (INTEGERP (Vundo_outer_limit)
377 && size_so_far > XINT (Vundo_outer_limit)
378 && !NILP (Vundo_outer_limit_function))
380 Lisp_Object tem;
381 struct buffer *temp = last_undo_buffer;
383 /* Normally the function this calls is undo-outer-limit-truncate. */
384 tem = call1 (Vundo_outer_limit_function, make_number (size_so_far));
385 if (! NILP (tem))
387 /* The function is responsible for making
388 any desired changes in buffer-undo-list. */
389 unbind_to (count, Qnil);
390 return;
392 /* That function probably used the minibuffer, and if so, that
393 changed last_undo_buffer. Change it back so that we don't
394 force next change to make an undo boundary here. */
395 last_undo_buffer = temp;
398 if (CONSP (next))
399 last_boundary = prev;
401 /* Keep additional undo data, if it fits in the limits. */
402 while (CONSP (next))
404 Lisp_Object elt;
405 elt = XCAR (next);
407 /* When we get to a boundary, decide whether to truncate
408 either before or after it. The lower threshold, undo_limit,
409 tells us to truncate after it. If its size pushes past
410 the higher threshold undo_strong_limit, we truncate before it. */
411 if (NILP (elt))
413 if (size_so_far > undo_strong_limit)
414 break;
415 last_boundary = prev;
416 if (size_so_far > undo_limit)
417 break;
420 /* Add in the space occupied by this element and its chain link. */
421 size_so_far += sizeof (struct Lisp_Cons);
422 if (CONSP (elt))
424 size_so_far += sizeof (struct Lisp_Cons);
425 if (STRINGP (XCAR (elt)))
426 size_so_far += (sizeof (struct Lisp_String) - 1
427 + SCHARS (XCAR (elt)));
430 /* Advance to next element. */
431 prev = next;
432 next = XCDR (next);
435 /* If we scanned the whole list, it is short enough; don't change it. */
436 if (NILP (next))
438 /* Truncate at the boundary where we decided to truncate. */
439 else if (!NILP (last_boundary))
440 XSETCDR (last_boundary, Qnil);
441 /* There's nothing we decided to keep, so clear it out. */
442 else
443 bset_undo_list (b, Qnil);
445 unbind_to (count, Qnil);
448 static _Noreturn void
449 user_error (const char *msg)
451 xsignal1 (Quser_error, build_string (msg));
455 DEFUN ("primitive-undo", Fprimitive_undo, Sprimitive_undo, 2, 2, 0,
456 doc: /* Undo N records from the front of the list LIST.
457 Return what remains of the list. */)
458 (Lisp_Object n, Lisp_Object list)
460 struct gcpro gcpro1, gcpro2;
461 Lisp_Object next;
462 ptrdiff_t count = SPECPDL_INDEX ();
463 register EMACS_INT arg;
464 Lisp_Object oldlist;
465 int did_apply = 0;
467 #if 0 /* This is a good feature, but would make undo-start
468 unable to do what is expected. */
469 Lisp_Object tem;
471 /* If the head of the list is a boundary, it is the boundary
472 preceding this command. Get rid of it and don't count it. */
473 tem = Fcar (list);
474 if (NILP (tem))
475 list = Fcdr (list);
476 #endif
478 CHECK_NUMBER (n);
479 arg = XINT (n);
480 next = Qnil;
481 GCPRO2 (next, list);
482 /* I don't think we need to gcpro oldlist, as we use it only
483 to check for EQ. ++kfs */
485 /* In a writable buffer, enable undoing read-only text that is so
486 because of text properties. */
487 if (NILP (BVAR (current_buffer, read_only)))
488 specbind (Qinhibit_read_only, Qt);
490 /* Don't let `intangible' properties interfere with undo. */
491 specbind (Qinhibit_point_motion_hooks, Qt);
493 oldlist = BVAR (current_buffer, undo_list);
495 while (arg > 0)
497 while (CONSP (list))
499 next = XCAR (list);
500 list = XCDR (list);
501 /* Exit inner loop at undo boundary. */
502 if (NILP (next))
503 break;
504 /* Handle an integer by setting point to that value. */
505 if (INTEGERP (next))
506 SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
507 else if (CONSP (next))
509 Lisp_Object car, cdr;
511 car = XCAR (next);
512 cdr = XCDR (next);
513 if (EQ (car, Qt))
515 /* Element (t . TIME) records previous modtime.
516 Preserve any flag of NONEXISTENT_MODTIME_NSECS or
517 UNKNOWN_MODTIME_NSECS. */
518 struct buffer *base_buffer = current_buffer;
519 EMACS_TIME mod_time;
521 if (CONSP (cdr)
522 && CONSP (XCDR (cdr))
523 && CONSP (XCDR (XCDR (cdr)))
524 && CONSP (XCDR (XCDR (XCDR (cdr))))
525 && INTEGERP (XCAR (XCDR (XCDR (XCDR (cdr)))))
526 && XINT (XCAR (XCDR (XCDR (XCDR (cdr))))) < 0)
527 mod_time =
528 (make_emacs_time
529 (0, XINT (XCAR (XCDR (XCDR (XCDR (cdr))))) / 1000));
530 else
531 mod_time = lisp_time_argument (cdr);
533 if (current_buffer->base_buffer)
534 base_buffer = current_buffer->base_buffer;
536 /* If this records an obsolete save
537 (not matching the actual disk file)
538 then don't mark unmodified. */
539 if (EMACS_TIME_NE (mod_time, base_buffer->modtime))
540 continue;
541 #ifdef CLASH_DETECTION
542 Funlock_buffer ();
543 #endif /* CLASH_DETECTION */
544 Fset_buffer_modified_p (Qnil);
546 else if (EQ (car, Qnil))
548 /* Element (nil PROP VAL BEG . END) is property change. */
549 Lisp_Object beg, end, prop, val;
551 prop = Fcar (cdr);
552 cdr = Fcdr (cdr);
553 val = Fcar (cdr);
554 cdr = Fcdr (cdr);
555 beg = Fcar (cdr);
556 end = Fcdr (cdr);
558 if (XINT (beg) < BEGV || XINT (end) > ZV)
559 user_error ("Changes to be undone are outside visible portion of buffer");
560 Fput_text_property (beg, end, prop, val, Qnil);
562 else if (INTEGERP (car) && INTEGERP (cdr))
564 /* Element (BEG . END) means range was inserted. */
566 if (XINT (car) < BEGV
567 || XINT (cdr) > ZV)
568 user_error ("Changes to be undone are outside visible portion of buffer");
569 /* Set point first thing, so that undoing this undo
570 does not send point back to where it is now. */
571 Fgoto_char (car);
572 Fdelete_region (car, cdr);
574 else if (EQ (car, Qapply))
576 /* Element (apply FUN . ARGS) means call FUN to undo. */
577 struct buffer *save_buffer = current_buffer;
579 car = Fcar (cdr);
580 cdr = Fcdr (cdr);
581 if (INTEGERP (car))
583 /* Long format: (apply DELTA START END FUN . ARGS). */
584 Lisp_Object delta = car;
585 Lisp_Object start = Fcar (cdr);
586 Lisp_Object end = Fcar (Fcdr (cdr));
587 Lisp_Object start_mark = Fcopy_marker (start, Qnil);
588 Lisp_Object end_mark = Fcopy_marker (end, Qt);
590 cdr = Fcdr (Fcdr (cdr));
591 apply1 (Fcar (cdr), Fcdr (cdr));
593 /* Check that the function did what the entry said it
594 would do. */
595 if (!EQ (start, Fmarker_position (start_mark))
596 || (XINT (delta) + XINT (end)
597 != marker_position (end_mark)))
598 error ("Changes to be undone by function different than announced");
599 Fset_marker (start_mark, Qnil, Qnil);
600 Fset_marker (end_mark, Qnil, Qnil);
602 else
603 apply1 (car, cdr);
605 if (save_buffer != current_buffer)
606 error ("Undo function switched buffer");
607 did_apply = 1;
609 else if (STRINGP (car) && INTEGERP (cdr))
611 /* Element (STRING . POS) means STRING was deleted. */
612 Lisp_Object membuf;
613 EMACS_INT pos = XINT (cdr);
615 membuf = car;
616 if (pos < 0)
618 if (-pos < BEGV || -pos > ZV)
619 user_error ("Changes to be undone are outside visible portion of buffer");
620 SET_PT (-pos);
621 Finsert (1, &membuf);
623 else
625 if (pos < BEGV || pos > ZV)
626 user_error ("Changes to be undone are outside visible portion of buffer");
627 SET_PT (pos);
629 /* Now that we record marker adjustments
630 (caused by deletion) for undo,
631 we should always insert after markers,
632 so that undoing the marker adjustments
633 put the markers back in the right place. */
634 Finsert (1, &membuf);
635 SET_PT (pos);
638 else if (MARKERP (car) && INTEGERP (cdr))
640 /* (MARKER . INTEGER) means a marker MARKER
641 was adjusted by INTEGER. */
642 if (XMARKER (car)->buffer)
643 Fset_marker (car,
644 make_number (marker_position (car) - XINT (cdr)),
645 Fmarker_buffer (car));
649 arg--;
653 /* Make sure an apply entry produces at least one undo entry,
654 so the test in `undo' for continuing an undo series
655 will work right. */
656 if (did_apply
657 && EQ (oldlist, BVAR (current_buffer, undo_list)))
658 bset_undo_list
659 (current_buffer,
660 Fcons (list3 (Qapply, Qcdr, Qnil), BVAR (current_buffer, undo_list)));
662 UNGCPRO;
663 return unbind_to (count, list);
666 void
667 syms_of_undo (void)
669 DEFSYM (Qinhibit_read_only, "inhibit-read-only");
670 DEFSYM (Qapply, "apply");
672 pending_boundary = Qnil;
673 staticpro (&pending_boundary);
675 last_undo_buffer = NULL;
676 last_boundary_buffer = NULL;
678 defsubr (&Sprimitive_undo);
679 defsubr (&Sundo_boundary);
681 DEFVAR_INT ("undo-limit", undo_limit,
682 doc: /* Keep no more undo information once it exceeds this size.
683 This limit is applied when garbage collection happens.
684 When a previous command increases the total undo list size past this
685 value, the earlier commands that came before it are forgotten.
687 The size is counted as the number of bytes occupied,
688 which includes both saved text and other data. */);
689 undo_limit = 80000;
691 DEFVAR_INT ("undo-strong-limit", undo_strong_limit,
692 doc: /* Don't keep more than this much size of undo information.
693 This limit is applied when garbage collection happens.
694 When a previous command increases the total undo list size past this
695 value, that command and the earlier commands that came before it are forgotten.
696 However, the most recent buffer-modifying command's undo info
697 is never discarded for this reason.
699 The size is counted as the number of bytes occupied,
700 which includes both saved text and other data. */);
701 undo_strong_limit = 120000;
703 DEFVAR_LISP ("undo-outer-limit", Vundo_outer_limit,
704 doc: /* Outer limit on size of undo information for one command.
705 At garbage collection time, if the current command has produced
706 more than this much undo information, it discards the info and displays
707 a warning. This is a last-ditch limit to prevent memory overflow.
709 The size is counted as the number of bytes occupied, which includes
710 both saved text and other data. A value of nil means no limit. In
711 this case, accumulating one huge undo entry could make Emacs crash as
712 a result of memory overflow.
714 In fact, this calls the function which is the value of
715 `undo-outer-limit-function' with one argument, the size.
716 The text above describes the behavior of the function
717 that variable usually specifies. */);
718 Vundo_outer_limit = make_number (12000000);
720 DEFVAR_LISP ("undo-outer-limit-function", Vundo_outer_limit_function,
721 doc: /* Function to call when an undo list exceeds `undo-outer-limit'.
722 This function is called with one argument, the current undo list size
723 for the most recent command (since the last undo boundary).
724 If the function returns t, that means truncation has been fully handled.
725 If it returns nil, the other forms of truncation are done.
727 Garbage collection is inhibited around the call to this function,
728 so it must make sure not to do a lot of consing. */);
729 Vundo_outer_limit_function = Qnil;
731 DEFVAR_BOOL ("undo-inhibit-record-point", undo_inhibit_record_point,
732 doc: /* Non-nil means do not record `point' in `buffer-undo-list'. */);
733 undo_inhibit_record_point = 0;