undo.c 13.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 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

This file is part of GNU Emacs.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY.  No author or distributor
accepts responsibility to anyone for the consequences of using it
or for whether it serves any particular purpose or works at all,
unless he says so in writing.  Refer to the GNU Emacs General Public
License for full details.

Everyone is granted permission to copy, modify and redistribute
GNU Emacs, but only under the conditions described in the
GNU Emacs General Public License.   A copy of this license is
supposed to have been given to you along with GNU Emacs so you
can know your rights and responsibilities.  It should be in a
file named COPYING.  Among other things, the copyright notice
and this notice must be preserved on all copies.  */


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 45 46 47 48
/* 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)
     Lisp_Object beg, length;
{
  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 61 62 63 64

  if (MODIFF <= current_buffer->save_modified)
    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) == XINT (beg))
Jim Blandy's avatar
Jim Blandy committed
73
	{
74
	  XSETINT (XCONS (elt)->cdr, XINT (beg) + XINT (length));
Jim Blandy's avatar
Jim Blandy committed
75 76 77 78
	  return;
	}
    }

79
  lbeg = beg;
80
  XSETINT (lend, XINT (beg) + XINT (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));

Jim Blandy's avatar
Jim Blandy committed
108 109 110 111
  if (MODIFF <= current_buffer->save_modified)
    record_first_change ();

  if (point == 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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
  current_buffer->undo_list
    = Fcons (Fcons (Fbuffer_substring (lbeg, lend), sbeg),
	     current_buffer->undo_list);
}

/* 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;
149 150 151 152 153 154

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

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

157 158
  XSETFASTINT (high, (current_buffer->modtime >> 16) & 0xffff);
  XSETFASTINT (low, current_buffer->modtime & 0xffff);
Jim Blandy's avatar
Jim Blandy committed
159 160 161
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

162 163 164 165 166 167 168 169 170 171 172
/* 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;

173
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
174 175
    return;

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

180 181 182 183 184 185 186 187 188 189 190 191 192
  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 ();

  if (MODIFF <= current_buffer->save_modified)
    record_first_change ();

193 194
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
195 196 197 198 199 200
  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
201 202 203 204 205 206 207 208 209 210
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
211
  if (!NILP (tem))
212 213 214 215 216 217 218 219 220 221 222 223 224
    {
      /* 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
225 226 227 228 229 230
  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
231 232
   In practice, these are the values of undo-limit and
   undo-strong-limit.  */
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246

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
247 248 249
     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
250 251
     Skip, skip, skip the undo, skip to the undo bound'ry. 
     (Get it?  "Skip to my Loo?")  */
252
  if (CONSP (next) && NILP (XCONS (next)->car))
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256 257 258 259 260
    {
      /* 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;
    }
261
  while (CONSP (next) && ! NILP (XCONS (next)->car))
Jim Blandy's avatar
Jim Blandy committed
262 263 264 265 266 267
    {
      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);
268
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
269 270
	{
	  size_so_far += sizeof (struct Lisp_Cons);
271
	  if (STRINGP (XCONS (elt)->car))
Jim Blandy's avatar
Jim Blandy committed
272 273 274 275 276 277 278 279
	    size_so_far += (sizeof (struct Lisp_String) - 1
			    + XSTRING (XCONS (elt)->car)->size);
	}

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

283
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287 288 289 290 291
    {
      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
292
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
293 294 295 296 297 298 299 300 301 302
	{
	  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);
303
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
304 305
	{
	  size_so_far += sizeof (struct Lisp_Cons);
306
	  if (STRINGP (XCONS (elt)->car))
Jim Blandy's avatar
Jim Blandy committed
307 308 309 310 311 312 313 314 315 316
	    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
317
  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
318 319 320
    return list;

  /* Truncate at the boundary where we decided to truncate.  */
Jim Blandy's avatar
Jim Blandy committed
321
  if (!NILP (last_boundary))
Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327 328 329 330 331 332
    {
      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.")
333 334
  (n, list)
     Lisp_Object n, list;
Jim Blandy's avatar
Jim Blandy committed
335
{
336 337
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
338
  int count = specpdl_ptr - specpdl;
339
  register int arg;
Jim Blandy's avatar
Jim Blandy committed
340 341 342 343 344 345 346
#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
347
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
348 349 350
    list = Fcdr (list);
#endif

351 352 353 354 355
  CHECK_NUMBER (n, 0);
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);

356 357 358 359
  /* 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
360 361 362 363 364 365
  while (arg > 0)
    {
      while (1)
	{
	  next = Fcar (list);
	  list = Fcdr (list);
366
	  /* Exit inner loop at undo boundary.  */
Jim Blandy's avatar
Jim Blandy committed
367
	  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
368
	    break;
369
	  /* Handle an integer by setting point to that value.  */
370
	  if (INTEGERP (next))
371
	    SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
372
	  else if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
373
	    {
374 375 376 377 378
	      Lisp_Object car, cdr;

	      car = Fcar (next);
	      cdr = Fcdr (next);
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
379
		{
380 381 382 383 384 385
		  /* Element (t high . low) records previous modtime.  */
		  Lisp_Object high, low;
		  int mod_time;

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
386
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
387 388 389 390 391
		  /* If this records an obsolete save
		     (not matching the actual disk file)
		     then don't mark unmodified.  */
		  if (mod_time != current_buffer->modtime)
		    break;
392
#ifdef CLASH_DETECTION
393
		  Funlock_buffer ();
394
#endif /* CLASH_DETECTION */
395
		  Fset_buffer_modified_p (Qnil);
Jim Blandy's avatar
Jim Blandy committed
396
		}
397 398
#ifdef USE_TEXT_PROPERTIES
	      else if (EQ (car, Qnil))
399
		{
400
		  /* Element (nil prop val beg . end) is property change.  */
401 402 403 404 405 406 407 408 409 410 411
		  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);
		}
412
#endif /* USE_TEXT_PROPERTIES */
413
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
414
		{
415 416 417 418 419
		  /* Element (BEG . END) means range was inserted.  */
		  Lisp_Object end;

		  if (XINT (car) < BEGV
		      || XINT (cdr) > ZV)
Jim Blandy's avatar
Jim Blandy committed
420
		    error ("Changes to be undone are outside visible portion of buffer");
421 422
		  /* Set point first thing, so that undoing this undo
		     does not send point back to where it is now.  */
423
		  Fgoto_char (car);
424
		  Fdelete_region (car, cdr);
425
		}
426
	      else if (STRINGP (car) && INTEGERP (cdr))
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
		{
		  /* 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);

		      /* Insert before markers so that if the mark is
			 currently on the boundary of this deletion, it
			 ends up on the other side of the now-undeleted
			 text from point.  Since undo doesn't even keep
			 track of the mark, this isn't really necessary,
			 but it may lead to better behavior in certain
			 situations.  */
		      Finsert_before_markers (1, &membuf);
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460 461
		}
	    }
	}
      arg--;
    }

462
  UNGCPRO;
463
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
464 465 466 467
}

syms_of_undo ()
{
468 469 470
  Qinhibit_read_only = intern ("inhibit-read-only");
  staticpro (&Qinhibit_read_only);

471 472 473
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

Jim Blandy's avatar
Jim Blandy committed
474 475 476
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
}