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

This file is part of GNU Emacs.

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

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

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24
#include "lisp.h"
#include "buffer.h"
25
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
26 27 28 29

/* Last buffer for which undo information was recorded.  */
Lisp_Object last_undo_buffer;

30 31
Lisp_Object Qinhibit_read_only;

32 33 34 35 36 37 38
/* 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;

Jim Blandy's avatar
Jim Blandy committed
39 40 41 42 43
/* 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.)  */

44
void
Jim Blandy's avatar
Jim Blandy committed
45
record_insert (beg, length)
46
     int beg, length;
Jim Blandy's avatar
Jim Blandy committed
47 48 49
{
  Lisp_Object lbeg, lend;

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

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

57 58
  if (!BUFFERP (last_undo_buffer)
      || current_buffer != XBUFFER (last_undo_buffer))
Jim Blandy's avatar
Jim Blandy committed
59
    Fundo_boundary ();
60
  XSETBUFFER (last_undo_buffer, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
61

62
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
63 64 65 66
    record_first_change ();

  /* If this is following another insertion and consecutive with it
     in the buffer, combine the two.  */
67
  if (CONSP (current_buffer->undo_list))
Jim Blandy's avatar
Jim Blandy committed
68 69
    {
      Lisp_Object elt;
70
      elt = XCAR (current_buffer->undo_list);
71
      if (CONSP (elt)
72 73 74
	  && INTEGERP (XCAR (elt))
	  && INTEGERP (XCDR (elt))
	  && XINT (XCDR (elt)) == beg)
Jim Blandy's avatar
Jim Blandy committed
75
	{
76
	  XSETINT (XCDR (elt), beg + length);
Jim Blandy's avatar
Jim Blandy committed
77 78 79 80
	  return;
	}
    }

81 82
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
83 84
  current_buffer->undo_list = Fcons (Fcons (lbeg, lend),
                                     current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
85 86 87
}

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

90
void
91 92 93
record_delete (beg, string)
     int beg;
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
94
{
95
  Lisp_Object sbeg;
96
  int at_boundary;
Jim Blandy's avatar
Jim Blandy committed
97

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

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

Jim Blandy's avatar
Jim Blandy committed
105 106
  if (current_buffer != XBUFFER (last_undo_buffer))
    Fundo_boundary ();
107
  XSETBUFFER (last_undo_buffer, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
108

109 110 111 112 113 114 115 116 117
  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)
	{
118 119 120 121
	  if (NILP (tail))
	    elt = Qnil;
	  else
	    elt = XCAR (tail);
122
	  if (NILP (elt) || ! (CONSP (elt) && MARKERP (XCAR (elt))))
123
	    break;
124
	  tail = XCDR (tail);
125 126 127 128 129
	}
      at_boundary = NILP (elt);
    }
  else
    at_boundary = 0;
130

131
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
132 133
    record_first_change ();

134
  if (PT == beg + XSTRING (string)->size)
135
    XSETINT (sbeg, -beg);
Jim Blandy's avatar
Jim Blandy committed
136
  else
137
    XSETFASTINT (sbeg, beg);
138

139 140 141 142 143
  /* If we are just after an undo boundary, and 
     point wasn't at start of deleted range, record where it was.  */
  if (at_boundary
      && last_point_position != XFASTINT (sbeg)
      && current_buffer == XBUFFER (last_point_position_buffer))
144
    current_buffer->undo_list
145
      = Fcons (make_number (last_point_position), current_buffer->undo_list);
146

Jim Blandy's avatar
Jim Blandy committed
147
  current_buffer->undo_list
148
    = Fcons (Fcons (string, sbeg), current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
149 150
}

151 152 153 154 155
/* 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.  */

156
void
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
record_marker_adjustment (marker, adjustment)
     Lisp_Object marker;
     int adjustment;
{
  if (EQ (current_buffer->undo_list, Qt))
    return;

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

  if (current_buffer != XBUFFER (last_undo_buffer))
    Fundo_boundary ();
  XSETBUFFER (last_undo_buffer, current_buffer);

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

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

181
void
Jim Blandy's avatar
Jim Blandy committed
182 183 184
record_change (beg, length)
     int beg, length;
{
185
  record_delete (beg, make_buffer_string (beg, beg + length, 1));
Jim Blandy's avatar
Jim Blandy committed
186 187 188 189 190 191 192
  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.  */

193
void
Jim Blandy's avatar
Jim Blandy committed
194 195 196
record_first_change ()
{
  Lisp_Object high, low;
197
  struct buffer *base_buffer = current_buffer;
198 199 200 201 202 203

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

  if (current_buffer != XBUFFER (last_undo_buffer))
    Fundo_boundary ();
204
  XSETBUFFER (last_undo_buffer, current_buffer);
205

206 207 208 209 210
  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
211 212 213
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

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

217
void
218 219 220 221 222 223 224 225
record_property_change (beg, length, prop, value, buffer)
     int beg, length;
     Lisp_Object prop, value, buffer;
{
  Lisp_Object lbeg, lend, entry;
  struct buffer *obuf = current_buffer;
  int boundary = 0;

226
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
227 228
    return;

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

233 234 235 236 237 238 239 240 241 242
  if (!EQ (buffer, last_undo_buffer))
    boundary = 1;
  last_undo_buffer = buffer;

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

  if (boundary)
    Fundo_boundary ();

243
  if (MODIFF <= SAVE_MODIFF)
244 245
    record_first_change ();

246 247
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
248 249 250 251 252 253
  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
254 255 256 257 258 259 260 261 262 263
DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
  "Mark a boundary between units of undo.\n\
An undo command will stop at this point,\n\
but another undo command will undo to the previous boundary.")
  ()
{
  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
264
  if (!NILP (tem))
265 266 267 268 269 270
    {
      /* 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.  */
271
	  XCDR (pending_boundary) = current_buffer->undo_list;
272 273 274 275 276 277
	  current_buffer->undo_list = pending_boundary;
	  pending_boundary = Qnil;
	}
      else
	current_buffer->undo_list = Fcons (Qnil, current_buffer->undo_list);
    }
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281 282 283
  return Qnil;
}

/* At garbage collection time, make an undo list shorter at the end,
   returning the truncated list.
   MINSIZE and MAXSIZE are the limits on size allowed, as described below.
Jim Blandy's avatar
Jim Blandy committed
284 285
   In practice, these are the values of undo-limit and
   undo-strong-limit.  */
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299

Lisp_Object
truncate_undo_list (list, minsize, maxsize)
     Lisp_Object list;
     int minsize, maxsize;
{
  Lisp_Object prev, next, last_boundary;
  int size_so_far = 0;

  prev = Qnil;
  next = list;
  last_boundary = Qnil;

  /* Always preserve at least the most recent undo record.
Jim Blandy's avatar
Jim Blandy committed
300 301 302
     If the first element is an undo boundary, skip past it.

     Skip, skip, skip the undo, skip, skip, skip the undo,
Jim Blandy's avatar
Jim Blandy committed
303 304
     Skip, skip, skip the undo, skip to the undo bound'ry. 
     (Get it?  "Skip to my Loo?")  */
305
  if (CONSP (next) && NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
306 307 308 309 310 311
    {
      /* 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;
312
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
313
    }
314
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
315 316
    {
      Lisp_Object elt;
317
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
318 319 320

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
321
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
322 323
	{
	  size_so_far += sizeof (struct Lisp_Cons);
324
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
325
	    size_so_far += (sizeof (struct Lisp_String) - 1
326
			    + XSTRING (XCAR (elt))->size);
Jim Blandy's avatar
Jim Blandy committed
327 328 329 330
	}

      /* Advance to next element.  */
      prev = next;
331
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
332
    }
333
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
334 335
    last_boundary = prev;

336
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
337 338
    {
      Lisp_Object elt;
339
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
340 341 342 343 344

      /* When we get to a boundary, decide whether to truncate
	 either before or after it.  The lower threshold, MINSIZE,
	 tells us to truncate after it.  If its size pushes past
	 the higher threshold MAXSIZE as well, we truncate before it.  */
Jim Blandy's avatar
Jim Blandy committed
345
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351 352 353 354 355
	{
	  if (size_so_far > maxsize)
	    break;
	  last_boundary = prev;
	  if (size_so_far > minsize)
	    break;
	}

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
356
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
357 358
	{
	  size_so_far += sizeof (struct Lisp_Cons);
359
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
360
	    size_so_far += (sizeof (struct Lisp_String) - 1
361
			    + XSTRING (XCAR (elt))->size);
Jim Blandy's avatar
Jim Blandy committed
362 363 364 365
	}

      /* Advance to next element.  */
      prev = next;
366
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
367 368 369
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
370
  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
371 372 373
    return list;

  /* Truncate at the boundary where we decided to truncate.  */
Jim Blandy's avatar
Jim Blandy committed
374
  if (!NILP (last_boundary))
Jim Blandy's avatar
Jim Blandy committed
375
    {
376
      XCDR (last_boundary) = Qnil;
Jim Blandy's avatar
Jim Blandy committed
377 378 379 380 381 382 383 384 385
      return list;
    }
  else
    return Qnil;
}

DEFUN ("primitive-undo", Fprimitive_undo, Sprimitive_undo, 2, 2, 0,
  "Undo N records from the front of the list LIST.\n\
Return what remains of the list.")
386 387
  (n, list)
     Lisp_Object n, list;
Jim Blandy's avatar
Jim Blandy committed
388
{
389 390
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
391
  int count = specpdl_ptr - specpdl;
392
  register int arg;
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397 398 399
#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
400
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
401 402 403
    list = Fcdr (list);
#endif

404 405 406 407 408
  CHECK_NUMBER (n, 0);
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);

409 410 411 412
  /* Don't let read-only properties interfere with undo.  */
  if (NILP (current_buffer->read_only))
    specbind (Qinhibit_read_only, Qt);

Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417 418
  while (arg > 0)
    {
      while (1)
	{
	  next = Fcar (list);
	  list = Fcdr (list);
419
	  /* Exit inner loop at undo boundary.  */
Jim Blandy's avatar
Jim Blandy committed
420
	  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
421
	    break;
422
	  /* Handle an integer by setting point to that value.  */
423
	  if (INTEGERP (next))
424
	    SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
425
	  else if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
426
	    {
427 428 429 430 431
	      Lisp_Object car, cdr;

	      car = Fcar (next);
	      cdr = Fcdr (next);
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
432
		{
433 434 435
		  /* Element (t high . low) records previous modtime.  */
		  Lisp_Object high, low;
		  int mod_time;
436
		  struct buffer *base_buffer = current_buffer;
437 438 439

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
440
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
441 442 443 444

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

445 446 447
		  /* If this records an obsolete save
		     (not matching the actual disk file)
		     then don't mark unmodified.  */
448
		  if (mod_time != base_buffer->modtime)
449
		    continue;
450
#ifdef CLASH_DETECTION
451
		  Funlock_buffer ();
452
#endif /* CLASH_DETECTION */
453
		  Fset_buffer_modified_p (Qnil);
Jim Blandy's avatar
Jim Blandy committed
454
		}
455
	      else if (EQ (car, Qnil))
456
		{
457
		  /* Element (nil prop val beg . end) is property change.  */
458 459 460 461 462 463 464 465 466 467 468
		  Lisp_Object beg, end, prop, val;

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

		  Fput_text_property (beg, end, prop, val, Qnil);
		}
469
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
470
		{
471 472 473 474 475
		  /* Element (BEG . END) means range was inserted.  */
		  Lisp_Object end;

		  if (XINT (car) < BEGV
		      || XINT (cdr) > ZV)
Jim Blandy's avatar
Jim Blandy committed
476
		    error ("Changes to be undone are outside visible portion of buffer");
477 478
		  /* Set point first thing, so that undoing this undo
		     does not send point back to where it is now.  */
479
		  Fgoto_char (car);
480
		  Fdelete_region (car, cdr);
481
		}
482
	      else if (STRINGP (car) && INTEGERP (cdr))
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
		{
		  /* Element (STRING . POS) means STRING was deleted.  */
		  Lisp_Object membuf;
		  int pos = XINT (cdr);

		  membuf = car;
		  if (pos < 0)
		    {
		      if (-pos < BEGV || -pos > ZV)
			error ("Changes to be undone are outside visible portion of buffer");
		      SET_PT (-pos);
		      Finsert (1, &membuf);
		    }
		  else
		    {
		      if (pos < BEGV || pos > ZV)
			error ("Changes to be undone are outside visible portion of buffer");
		      SET_PT (pos);

502 503 504 505 506 507
		      /* 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);
508 509
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
510
		}
511 512 513 514 515 516 517 518 519
	      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
520 521 522 523 524
	    }
	}
      arg--;
    }

525
  UNGCPRO;
526
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
527 528
}

Andreas Schwab's avatar
Andreas Schwab committed
529
void
Jim Blandy's avatar
Jim Blandy committed
530 531
syms_of_undo ()
{
532 533 534
  Qinhibit_read_only = intern ("inhibit-read-only");
  staticpro (&Qinhibit_read_only);

535 536 537
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

Jim Blandy's avatar
Jim Blandy committed
538 539 540
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
}