undo.c 14.5 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
	  elt = XCAR (tail);
	  if (NILP (elt) || ! (CONSP (elt) && MARKERP (XCAR (elt))))
120
	    break;
121
	  tail = XCDR (tail);
122 123 124 125 126
	}
      at_boundary = NILP (elt);
    }
  else
    at_boundary = 0;
127

128
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
129 130
    record_first_change ();

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

136 137 138 139 140
  /* 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))
141
    current_buffer->undo_list
142
      = Fcons (make_number (last_point_position), current_buffer->undo_list);
143

Jim Blandy's avatar
Jim Blandy committed
144
  current_buffer->undo_list
145
    = Fcons (Fcons (string, sbeg), current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
146 147
}

148 149 150 151 152
/* 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.  */

153
void
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
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
174 175
/* Record that a replacement is about to take place,
   for LENGTH characters at location BEG.
176
   The replacement must not change the number of characters.  */
Jim Blandy's avatar
Jim Blandy committed
177

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

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

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

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

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

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

214
void
215 216 217 218 219 220 221 222
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;

223
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
224 225
    return;

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

230 231 232 233 234 235 236 237 238 239
  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 ();

240
  if (MODIFF <= SAVE_MODIFF)
241 242
    record_first_change ();

243 244
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
245 246 247 248 249 250
  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
251 252 253 254 255 256 257 258 259 260
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
261
  if (!NILP (tem))
262 263 264 265 266 267
    {
      /* 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.  */
268
	  XCDR (pending_boundary) = current_buffer->undo_list;
269 270 271 272 273 274
	  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
275 276 277 278 279 280
  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
281 282
   In practice, these are the values of undo-limit and
   undo-strong-limit.  */
Jim Blandy's avatar
Jim Blandy committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296

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

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

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

333
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
334 335
    {
      Lisp_Object elt;
336
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
337 338 339 340 341

      /* 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
342
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
343 344 345 346 347 348 349 350 351 352
	{
	  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);
353
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
354 355
	{
	  size_so_far += sizeof (struct Lisp_Cons);
356
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
357
	    size_so_far += (sizeof (struct Lisp_String) - 1
358
			    + XSTRING (XCAR (elt))->size);
Jim Blandy's avatar
Jim Blandy committed
359 360 361 362
	}

      /* Advance to next element.  */
      prev = next;
363
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
364 365 366
    }

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

  /* Truncate at the boundary where we decided to truncate.  */
Jim Blandy's avatar
Jim Blandy committed
371
  if (!NILP (last_boundary))
Jim Blandy's avatar
Jim Blandy committed
372
    {
373
      XCDR (last_boundary) = Qnil;
Jim Blandy's avatar
Jim Blandy committed
374 375 376 377 378 379 380 381 382
      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.")
383 384
  (n, list)
     Lisp_Object n, list;
Jim Blandy's avatar
Jim Blandy committed
385
{
386 387
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
388
  int count = specpdl_ptr - specpdl;
389
  register int arg;
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393 394 395 396
#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
397
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
398 399 400
    list = Fcdr (list);
#endif

401 402 403 404 405
  CHECK_NUMBER (n, 0);
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);

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

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

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
437
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
438 439 440 441

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

442 443 444
		  /* If this records an obsolete save
		     (not matching the actual disk file)
		     then don't mark unmodified.  */
445
		  if (mod_time != base_buffer->modtime)
446
		    continue;
447
#ifdef CLASH_DETECTION
448
		  Funlock_buffer ();
449
#endif /* CLASH_DETECTION */
450
		  Fset_buffer_modified_p (Qnil);
Jim Blandy's avatar
Jim Blandy committed
451
		}
452
	      else if (EQ (car, Qnil))
453
		{
454
		  /* Element (nil prop val beg . end) is property change.  */
455 456 457 458 459 460 461 462 463 464 465
		  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);
		}
466
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
467
		{
468 469 470 471 472
		  /* Element (BEG . END) means range was inserted.  */
		  Lisp_Object end;

		  if (XINT (car) < BEGV
		      || XINT (cdr) > ZV)
Jim Blandy's avatar
Jim Blandy committed
473
		    error ("Changes to be undone are outside visible portion of buffer");
474 475
		  /* Set point first thing, so that undoing this undo
		     does not send point back to where it is now.  */
476
		  Fgoto_char (car);
477
		  Fdelete_region (car, cdr);
478
		}
479
	      else if (STRINGP (car) && INTEGERP (cdr))
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
		{
		  /* 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);

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

522
  UNGCPRO;
523
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
524 525
}

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

532 533 534
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

Jim Blandy's avatar
Jim Blandy committed
535 536 537
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
}