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

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

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

52 53 54 55
  /* 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
56 57
  if (current_buffer != XBUFFER (last_undo_buffer))
    Fundo_boundary ();
58
  XSETBUFFER (last_undo_buffer, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
59

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

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

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

/* 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;
92
  int at_boundary;
Jim Blandy's avatar
Jim Blandy committed
93

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

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

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

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

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

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

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

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
/* 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
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
/* 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.  */

record_first_change ()
{
  Lisp_Object high, low;
174
  struct buffer *base_buffer = current_buffer;
175 176 177 178 179 180

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

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

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

191 192 193 194 195 196 197 198 199 200 201
/* Record a change in property PROP (whose old value was VAL)
   for LENGTH characters starting at position BEG in BUFFER.  */

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;

202
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
203 204
    return;

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

209 210 211 212 213 214 215 216 217 218
  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 ();

219
  if (MODIFF <= SAVE_MODIFF)
220 221
    record_first_change ();

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

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
276 277 278
     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
279 280
     Skip, skip, skip the undo, skip to the undo bound'ry. 
     (Get it?  "Skip to my Loo?")  */
281
  if (CONSP (next) && NILP (XCONS (next)->car))
Jim Blandy's avatar
Jim Blandy committed
282 283 284 285 286 287 288 289
    {
      /* 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;
    }
290
  while (CONSP (next) && ! NILP (XCONS (next)->car))
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296
    {
      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);
297
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
298 299
	{
	  size_so_far += sizeof (struct Lisp_Cons);
300
	  if (STRINGP (XCONS (elt)->car))
Jim Blandy's avatar
Jim Blandy committed
301 302 303 304 305 306 307 308
	    size_so_far += (sizeof (struct Lisp_String) - 1
			    + XSTRING (XCONS (elt)->car)->size);
	}

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

312
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
313 314 315 316 317 318 319 320
    {
      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
321
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327 328 329 330 331
	{
	  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);
332
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
333 334
	{
	  size_so_far += sizeof (struct Lisp_Cons);
335
	  if (STRINGP (XCONS (elt)->car))
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340 341 342 343 344 345
	    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
346
  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
347 348 349
    return list;

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

380 381 382 383 384
  CHECK_NUMBER (n, 0);
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);

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

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

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
416
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
417 418 419 420

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

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

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

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

503
  UNGCPRO;
504
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
505 506 507 508
}

syms_of_undo ()
{
509 510 511
  Qinhibit_read_only = intern ("inhibit-read-only");
  staticpro (&Qinhibit_read_only);

512 513 514
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

Jim Blandy's avatar
Jim Blandy committed
515 516 517
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
}