undo.c 14.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* undo handling for GNU Emacs.
Gerd Moellmann's avatar
Gerd Moellmann committed
2
   Copyright (C) 1990, 1993, 1994, 2000 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
	  XSETCDR (elt, make_number (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);

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

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

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

135
  if (PT == beg + XSTRING (string)->size)
136
    XSETINT (sbeg, -beg);
Jim Blandy's avatar
Jim Blandy committed
137
  else
138
    XSETFASTINT (sbeg, beg);
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)
144 145
      /* If we're called from batch mode, this could be nil.  */
      && BUFFERP (last_point_position_buffer)
146
      && current_buffer == XBUFFER (last_point_position_buffer))
147
    current_buffer->undo_list
148
      = Fcons (make_number (last_point_position), current_buffer->undo_list);
149

Jim Blandy's avatar
Jim Blandy committed
150
  current_buffer->undo_list
151
    = Fcons (Fcons (string, sbeg), current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
152 153
}

154 155 156 157 158
/* 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.  */

159
void
160 161 162 163 164 165 166 167 168 169 170
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);

171 172
  if (!BUFFERP (last_undo_buffer) 
      || current_buffer != XBUFFER (last_undo_buffer))
173 174 175 176 177 178 179 180
    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
181 182
/* Record that a replacement is about to take place,
   for LENGTH characters at location BEG.
183
   The replacement must not change the number of characters.  */
Jim Blandy's avatar
Jim Blandy committed
184

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

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

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

206 207
  if (!BUFFERP (last_undo_buffer)
      || current_buffer != XBUFFER (last_undo_buffer))
208
    Fundo_boundary ();
209
  XSETBUFFER (last_undo_buffer, current_buffer);
210

211 212 213 214 215
  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
216 217 218
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

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

222
void
223 224 225 226 227 228 229 230
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;

231
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
232 233
    return;

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

238 239 240 241 242 243 244 245 246 247
  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 ();

248
  if (MODIFF <= SAVE_MODIFF)
249 250
    record_first_change ();

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

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

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

      /* Advance to next element.  */
      prev = next;
336
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
337
    }
338
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
339 340
    last_boundary = prev;

341
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
342 343
    {
      Lisp_Object elt;
344
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
345 346 347 348 349

      /* 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
350
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
351 352 353 354 355 356 357 358 359 360
	{
	  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);
361
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
362 363
	{
	  size_so_far += sizeof (struct Lisp_Cons);
364
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
365
	    size_so_far += (sizeof (struct Lisp_String) - 1
366
			    + XSTRING (XCAR (elt))->size);
Jim Blandy's avatar
Jim Blandy committed
367 368 369 370
	}

      /* Advance to next element.  */
      prev = next;
371
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
372 373 374
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
375
  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
376 377 378
    return list;

  /* Truncate at the boundary where we decided to truncate.  */
Jim Blandy's avatar
Jim Blandy committed
379
  if (!NILP (last_boundary))
Jim Blandy's avatar
Jim Blandy committed
380
    {
381
      XSETCDR (last_boundary, Qnil);
Jim Blandy's avatar
Jim Blandy committed
382 383 384 385 386 387 388 389 390
      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.")
391 392
  (n, list)
     Lisp_Object n, list;
Jim Blandy's avatar
Jim Blandy committed
393
{
394 395
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
396
  int count = BINDING_STACK_SIZE ();
397
  register int arg;
398
  
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404 405
#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
406
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
407 408 409
    list = Fcdr (list);
#endif

410 411 412 413 414
  CHECK_NUMBER (n, 0);
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);

415 416 417
  /* In a writable buffer, enable undoing read-only text that is so
     because of text properties.  */
  if (NILP (current_buffer->read_only))
418 419
    specbind (Qinhibit_read_only, Qt);

420 421 422
  /* Don't let `intangible' properties interfere with undo.  */
  specbind (Qinhibit_point_motion_hooks, Qt);

Jim Blandy's avatar
Jim Blandy committed
423 424
  while (arg > 0)
    {
425
      while (CONSP (list))
Jim Blandy's avatar
Jim Blandy committed
426
	{
427 428
	  next = XCAR (list);
	  list = XCDR (list);
429
	  /* Exit inner loop at undo boundary.  */
Jim Blandy's avatar
Jim Blandy committed
430
	  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
431
	    break;
432
	  /* Handle an integer by setting point to that value.  */
433
	  if (INTEGERP (next))
434
	    SET_PT (clip_to_bounds (BEGV, XINT (next), ZV));
435
	  else if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
436
	    {
437 438
	      Lisp_Object car, cdr;

439 440
	      car = XCAR (next);
	      cdr = XCDR (next);
441
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
442
		{
443 444 445
		  /* Element (t high . low) records previous modtime.  */
		  Lisp_Object high, low;
		  int mod_time;
446
		  struct buffer *base_buffer = current_buffer;
447 448 449

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
450
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
451 452 453 454

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

455 456 457
		  /* If this records an obsolete save
		     (not matching the actual disk file)
		     then don't mark unmodified.  */
458
		  if (mod_time != base_buffer->modtime)
459
		    continue;
460
#ifdef CLASH_DETECTION
461
		  Funlock_buffer ();
462
#endif /* CLASH_DETECTION */
463
		  Fset_buffer_modified_p (Qnil);
Jim Blandy's avatar
Jim Blandy committed
464
		}
465
	      else if (EQ (car, Qnil))
466
		{
467
		  /* Element (nil prop val beg . end) is property change.  */
468 469 470 471 472 473 474 475 476 477 478
		  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);
		}
479
	      else if (INTEGERP (car) && INTEGERP (cdr))
Jim Blandy's avatar
Jim Blandy committed
480
		{
481 482 483 484
		  /* Element (BEG . END) means range was inserted.  */

		  if (XINT (car) < BEGV
		      || XINT (cdr) > ZV)
Jim Blandy's avatar
Jim Blandy committed
485
		    error ("Changes to be undone are outside visible portion of buffer");
486 487
		  /* Set point first thing, so that undoing this undo
		     does not send point back to where it is now.  */
488
		  Fgoto_char (car);
489
		  Fdelete_region (car, cdr);
490
		}
491
	      else if (STRINGP (car) && INTEGERP (cdr))
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
		{
		  /* 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);

511 512 513 514 515 516
		      /* 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);
517 518
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
519
		}
520 521 522 523 524 525 526 527 528
	      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
529 530 531 532 533
	    }
	}
      arg--;
    }

534
  UNGCPRO;
535
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
536 537
}

Andreas Schwab's avatar
Andreas Schwab committed
538
void
Jim Blandy's avatar
Jim Blandy committed
539 540
syms_of_undo ()
{
541 542 543
  Qinhibit_read_only = intern ("inhibit-read-only");
  staticpro (&Qinhibit_read_only);

544 545 546
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

Jim Blandy's avatar
Jim Blandy committed
547 548 549
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
}