undo.c 14.3 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);

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

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

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

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

/* Record that a deletion is about to take place,
   for LENGTH characters at location BEG.  */

record_delete (beg, length)
     int beg, length;
{
  Lisp_Object lbeg, lend, sbeg;
93
  int at_boundary;
Jim Blandy's avatar
Jim Blandy committed
94

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

98 99 100 101
  /* 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
102 103
  if (current_buffer != XBUFFER (last_undo_buffer))
    Fundo_boundary ();
104
  XSETBUFFER (last_undo_buffer, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
105

106 107 108
  at_boundary = (CONSP (current_buffer->undo_list)
		 && NILP (XCONS (current_buffer->undo_list)->car));

109
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
110 111
    record_first_change ();

112
  if (PT == beg + length)
113
    XSETINT (sbeg, -beg);
Jim Blandy's avatar
Jim Blandy committed
114
  else
115 116 117
    XSETFASTINT (sbeg, beg);
  XSETFASTINT (lbeg, beg);
  XSETFASTINT (lend, beg + length);
118

119 120 121 122 123
  /* 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))
124
    current_buffer->undo_list
125
      = Fcons (make_number (last_point_position), current_buffer->undo_list);
126

Jim Blandy's avatar
Jim Blandy committed
127 128 129 130 131
  current_buffer->undo_list
    = Fcons (Fcons (Fbuffer_substring (lbeg, lend), sbeg),
	     current_buffer->undo_list);
}

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
/* 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.  */

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
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
/* Record that a replacement is about to take place,
   for LENGTH characters at location BEG.
   The replacement does not change the number of characters.  */

record_change (beg, length)
     int beg, length;
{
  record_delete (beg, length);
  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.  */

172
void
Jim Blandy's avatar
Jim Blandy committed
173 174 175
record_first_change ()
{
  Lisp_Object high, low;
176
  struct buffer *base_buffer = current_buffer;
177 178 179 180 181 182

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

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

185 186 187 188 189
  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
190 191 192
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

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

196
void
197 198 199 200 201 202 203 204
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;

205
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
206 207
    return;

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

212 213 214 215 216 217 218 219 220 221
  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 ();

222
  if (MODIFF <= SAVE_MODIFF)
223 224
    record_first_change ();

225 226
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
227 228 229 230 231 232
  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
233 234 235 236 237 238 239 240 241 242
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
243
  if (!NILP (tem))
244 245 246 247 248 249 250 251 252 253 254 255 256
    {
      /* 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.  */
	  XCONS (pending_boundary)->cdr = current_buffer->undo_list;
	  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
257 258 259 260 261 262
  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
263 264
   In practice, these are the values of undo-limit and
   undo-strong-limit.  */
Jim Blandy's avatar
Jim Blandy committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278

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
279 280 281
     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
282 283
     Skip, skip, skip the undo, skip to the undo bound'ry. 
     (Get it?  "Skip to my Loo?")  */
284
  if (CONSP (next) && NILP (XCONS (next)->car))
Jim Blandy's avatar
Jim Blandy committed
285 286 287 288 289 290 291 292
    {
      /* 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;
      next = XCONS (next)->cdr;
    }
293
  while (CONSP (next) && ! NILP (XCONS (next)->car))
Jim Blandy's avatar
Jim Blandy committed
294 295 296 297 298 299
    {
      Lisp_Object elt;
      elt = XCONS (next)->car;

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
300
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
301 302
	{
	  size_so_far += sizeof (struct Lisp_Cons);
303
	  if (STRINGP (XCONS (elt)->car))
Jim Blandy's avatar
Jim Blandy committed
304 305 306 307 308 309 310 311
	    size_so_far += (sizeof (struct Lisp_String) - 1
			    + XSTRING (XCONS (elt)->car)->size);
	}

      /* Advance to next element.  */
      prev = next;
      next = XCONS (next)->cdr;
    }
312
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
313 314
    last_boundary = prev;

315
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320 321 322 323
    {
      Lisp_Object elt;
      elt = XCONS (next)->car;

      /* 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
324
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
325 326 327 328 329 330 331 332 333 334
	{
	  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);
335
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
336 337
	{
	  size_so_far += sizeof (struct Lisp_Cons);
338
	  if (STRINGP (XCONS (elt)->car))
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344 345 346 347 348
	    size_so_far += (sizeof (struct Lisp_String) - 1
			    + XSTRING (XCONS (elt)->car)->size);
	}

      /* Advance to next element.  */
      prev = next;
      next = XCONS (next)->cdr;
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
349
  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
350 351 352
    return list;

  /* Truncate at the boundary where we decided to truncate.  */
Jim Blandy's avatar
Jim Blandy committed
353
  if (!NILP (last_boundary))
Jim Blandy's avatar
Jim Blandy committed
354 355 356 357 358 359 360 361 362 363 364
    {
      XCONS (last_boundary)->cdr = Qnil;
      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.")
365 366
  (n, list)
     Lisp_Object n, list;
Jim Blandy's avatar
Jim Blandy committed
367
{
368 369
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
370
  int count = specpdl_ptr - specpdl;
371
  register int arg;
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375 376 377 378
#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
379
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
380 381 382
    list = Fcdr (list);
#endif

383 384 385 386 387
  CHECK_NUMBER (n, 0);
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);

388 389 390 391
  /* 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
392 393 394 395 396 397
  while (arg > 0)
    {
      while (1)
	{
	  next = Fcar (list);
	  list = Fcdr (list);
398
	  /* Exit inner loop at undo boundary.  */
Jim Blandy's avatar
Jim Blandy committed
399
	  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
400
	    break;
401
	  /* Handle an integer by setting point to that value.  */
402
	  if (INTEGERP (next))
403
	    SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
404
	  else if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
405
	    {
406 407 408 409 410
	      Lisp_Object car, cdr;

	      car = Fcar (next);
	      cdr = Fcdr (next);
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
411
		{
412 413 414
		  /* Element (t high . low) records previous modtime.  */
		  Lisp_Object high, low;
		  int mod_time;
415
		  struct buffer *base_buffer = current_buffer;
416 417 418

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
419
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
420 421 422 423

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

424 425 426
		  /* If this records an obsolete save
		     (not matching the actual disk file)
		     then don't mark unmodified.  */
427
		  if (mod_time != base_buffer->modtime)
428
		    continue;
429
#ifdef CLASH_DETECTION
430
		  Funlock_buffer ();
431
#endif /* CLASH_DETECTION */
432
		  Fset_buffer_modified_p (Qnil);
Jim Blandy's avatar
Jim Blandy committed
433
		}
434 435
#ifdef USE_TEXT_PROPERTIES
	      else if (EQ (car, Qnil))
436
		{
437
		  /* Element (nil prop val beg . end) is property change.  */
438 439 440 441 442 443 444 445 446 447 448
		  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);
		}
449
#endif /* USE_TEXT_PROPERTIES */
450
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
451
		{
452 453 454 455 456
		  /* Element (BEG . END) means range was inserted.  */
		  Lisp_Object end;

		  if (XINT (car) < BEGV
		      || XINT (cdr) > ZV)
Jim Blandy's avatar
Jim Blandy committed
457
		    error ("Changes to be undone are outside visible portion of buffer");
458 459
		  /* Set point first thing, so that undoing this undo
		     does not send point back to where it is now.  */
460
		  Fgoto_char (car);
461
		  Fdelete_region (car, cdr);
462
		}
463
	      else if (STRINGP (car) && INTEGERP (cdr))
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
		{
		  /* 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);

483 484 485 486 487 488
		      /* 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);
489 490
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
491
		}
492 493 494 495 496 497 498 499 500
	      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
501 502 503 504 505
	    }
	}
      arg--;
    }

506
  UNGCPRO;
507
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511
}

syms_of_undo ()
{
512 513 514
  Qinhibit_read_only = intern ("inhibit-read-only");
  staticpro (&Qinhibit_read_only);

515 516 517
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

Jim Blandy's avatar
Jim Blandy committed
518 519 520
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
}