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

Stefan Monnier's avatar
Stefan Monnier committed
39 40 41 42
/* Record point as it was at beginning of this command (if necessary)
   And prepare the undo info for recording a change.
   PT is the position of point that will naturally occur as a result of the
   undo record that will be added just after this command terminates.  */
Jim Blandy's avatar
Jim Blandy committed
43

Stefan Monnier's avatar
Stefan Monnier committed
44 45
static void
record_point (pt)
Dave Love's avatar
Dave Love committed
46
     int pt;
Jim Blandy's avatar
Jim Blandy committed
47
{
Stefan Monnier's avatar
Stefan Monnier committed
48
  int at_boundary;
49

50 51 52 53
  /* Allocate a cons cell to be the undo boundary after this command.  */
  if (NILP (pending_boundary))
    pending_boundary = Fcons (Qnil, Qnil);

54 55
  if (!BUFFERP (last_undo_buffer)
      || current_buffer != XBUFFER (last_undo_buffer))
Jim Blandy's avatar
Jim Blandy committed
56
    Fundo_boundary ();
57
  XSETBUFFER (last_undo_buffer, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
58

Stefan Monnier's avatar
Stefan Monnier committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
  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)
	{
	  if (NILP (tail))
	    elt = Qnil;
	  else
	    elt = XCAR (tail);
	  if (NILP (elt) || ! (CONSP (elt) && MARKERP (XCAR (elt))))
	    break;
	  tail = XCDR (tail);
	}
      at_boundary = NILP (elt);
    }
  else
    at_boundary = 1;

81
  if (MODIFF <= SAVE_MODIFF)
Jim Blandy's avatar
Jim Blandy committed
82 83
    record_first_change ();

84
  /* If we are just after an undo boundary, and
Stefan Monnier's avatar
Stefan Monnier committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
     point wasn't at start of deleted range, record where it was.  */
  if (at_boundary
      && last_point_position != pt
      /* If we're called from batch mode, this could be nil.  */
      && BUFFERP (last_point_position_buffer)
      && current_buffer == XBUFFER (last_point_position_buffer))
    current_buffer->undo_list
      = Fcons (make_number (last_point_position), current_buffer->undo_list);
}

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

void
record_insert (beg, length)
     int beg, length;
{
  Lisp_Object lbeg, lend;

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

  record_point (beg);

Jim Blandy's avatar
Jim Blandy committed
111 112
  /* If this is following another insertion and consecutive with it
     in the buffer, combine the two.  */
113
  if (CONSP (current_buffer->undo_list))
Jim Blandy's avatar
Jim Blandy committed
114 115
    {
      Lisp_Object elt;
116
      elt = XCAR (current_buffer->undo_list);
117
      if (CONSP (elt)
118 119 120
	  && INTEGERP (XCAR (elt))
	  && INTEGERP (XCDR (elt))
	  && XINT (XCDR (elt)) == beg)
Jim Blandy's avatar
Jim Blandy committed
121
	{
122
	  XSETCDR (elt, make_number (beg + length));
Jim Blandy's avatar
Jim Blandy committed
123 124 125 126
	  return;
	}
    }

127 128
  XSETFASTINT (lbeg, beg);
  XSETINT (lend, beg + length);
129 130
  current_buffer->undo_list = Fcons (Fcons (lbeg, lend),
                                     current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
131 132 133
}

/* Record that a deletion is about to take place,
134
   of the characters in STRING, at location BEG.  */
Jim Blandy's avatar
Jim Blandy committed
135

136
void
137 138 139
record_delete (beg, string)
     int beg;
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
140
{
141
  Lisp_Object sbeg;
Jim Blandy's avatar
Jim Blandy committed
142

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

146
  if (PT == beg + SCHARS (string))
147
    {
Stefan Monnier's avatar
Stefan Monnier committed
148 149
      XSETINT (sbeg, -beg);
      record_point (PT);
150 151
    }
  else
Stefan Monnier's avatar
Stefan Monnier committed
152 153 154 155
    {
      XSETFASTINT (sbeg, beg);
      record_point (beg);
    }
156

Jim Blandy's avatar
Jim Blandy committed
157
  current_buffer->undo_list
158
    = Fcons (Fcons (string, sbeg), current_buffer->undo_list);
Jim Blandy's avatar
Jim Blandy committed
159 160
}

161 162 163 164 165
/* 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.  */

166
void
167 168 169 170 171 172 173 174 175 176 177
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);

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

192
void
Jim Blandy's avatar
Jim Blandy committed
193 194 195
record_change (beg, length)
     int beg, length;
{
196
  record_delete (beg, make_buffer_string (beg, beg + length, 1));
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200 201 202 203
  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.  */

204
void
Jim Blandy's avatar
Jim Blandy committed
205 206 207
record_first_change ()
{
  Lisp_Object high, low;
208
  struct buffer *base_buffer = current_buffer;
209 210 211 212

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

213 214
  if (!BUFFERP (last_undo_buffer)
      || current_buffer != XBUFFER (last_undo_buffer))
215
    Fundo_boundary ();
216
  XSETBUFFER (last_undo_buffer, current_buffer);
217

218 219 220 221 222
  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
223 224 225
  current_buffer->undo_list = Fcons (Fcons (Qt, Fcons (high, low)), current_buffer->undo_list);
}

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

229
void
230 231 232 233 234 235 236 237
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;

238
  if (EQ (XBUFFER (buffer)->undo_list, Qt))
239 240
    return;

241 242 243 244
  /* Allocate a cons cell to be the undo boundary after this command.  */
  if (NILP (pending_boundary))
    pending_boundary = Fcons (Qnil, Qnil);

245 246 247 248 249 250 251 252 253 254
  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 ();

255
  if (MODIFF <= SAVE_MODIFF)
256 257
    record_first_change ();

258 259
  XSETINT (lbeg, beg);
  XSETINT (lend, beg + length);
260 261 262 263 264 265
  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
266
DEFUN ("undo-boundary", Fundo_boundary, Sundo_boundary, 0, 0, 0,
267 268 269 270
       doc: /* Mark a boundary between units of undo.
An undo command will stop at this point,
but another undo command will undo to the previous boundary.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274 275
{
  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
276
  if (!NILP (tem))
277 278 279 280 281 282
    {
      /* 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.  */
283
	  XSETCDR (pending_boundary, current_buffer->undo_list);
284 285 286 287 288 289
	  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
290 291 292 293 294 295
  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
296 297
   In practice, these are the values of undo-limit and
   undo-strong-limit.  */
Jim Blandy's avatar
Jim Blandy committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311

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
312 313 314
     If the first element is an undo boundary, skip past it.

     Skip, skip, skip the undo, skip, skip, skip the undo,
315
     Skip, skip, skip the undo, skip to the undo bound'ry.
Jim Blandy's avatar
Jim Blandy committed
316
     (Get it?  "Skip to my Loo?")  */
317
  if (CONSP (next) && NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
318 319 320 321 322 323
    {
      /* 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;
324
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
325
    }
326
  while (CONSP (next) && ! NILP (XCAR (next)))
Jim Blandy's avatar
Jim Blandy committed
327 328
    {
      Lisp_Object elt;
329
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
330 331 332

      /* Add in the space occupied by this element and its chain link.  */
      size_so_far += sizeof (struct Lisp_Cons);
333
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
334 335
	{
	  size_so_far += sizeof (struct Lisp_Cons);
336
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
337
	    size_so_far += (sizeof (struct Lisp_String) - 1
338
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342
	}

      /* Advance to next element.  */
      prev = next;
343
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
344
    }
345
  if (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
346 347
    last_boundary = prev;

348
  while (CONSP (next))
Jim Blandy's avatar
Jim Blandy committed
349 350
    {
      Lisp_Object elt;
351
      elt = XCAR (next);
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355 356

      /* 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
357
      if (NILP (elt))
Jim Blandy's avatar
Jim Blandy committed
358 359 360 361 362 363 364 365 366 367
	{
	  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);
368
      if (CONSP (elt))
Jim Blandy's avatar
Jim Blandy committed
369 370
	{
	  size_so_far += sizeof (struct Lisp_Cons);
371
	  if (STRINGP (XCAR (elt)))
Jim Blandy's avatar
Jim Blandy committed
372
	    size_so_far += (sizeof (struct Lisp_String) - 1
373
			    + SCHARS (XCAR (elt)));
Jim Blandy's avatar
Jim Blandy committed
374 375 376 377
	}

      /* Advance to next element.  */
      prev = next;
378
      next = XCDR (next);
Jim Blandy's avatar
Jim Blandy committed
379 380 381
    }

  /* If we scanned the whole list, it is short enough; don't change it.  */
Jim Blandy's avatar
Jim Blandy committed
382
  if (NILP (next))
Jim Blandy's avatar
Jim Blandy committed
383 384 385
    return list;

  /* Truncate at the boundary where we decided to truncate.  */
Jim Blandy's avatar
Jim Blandy committed
386
  if (!NILP (last_boundary))
Jim Blandy's avatar
Jim Blandy committed
387
    {
388
      XSETCDR (last_boundary, Qnil);
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394 395
      return list;
    }
  else
    return Qnil;
}

DEFUN ("primitive-undo", Fprimitive_undo, Sprimitive_undo, 2, 2, 0,
396 397 398
       doc: /* Undo N records from the front of the list LIST.
Return what remains of the list.  */)
     (n, list)
399
     Lisp_Object n, list;
Jim Blandy's avatar
Jim Blandy committed
400
{
401 402
  struct gcpro gcpro1, gcpro2;
  Lisp_Object next;
403
  int count = SPECPDL_INDEX ();
404
  register int arg;
405

Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410 411 412
#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
413
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
414 415 416
    list = Fcdr (list);
#endif

417
  CHECK_NUMBER (n);
418 419 420 421
  arg = XINT (n);
  next = Qnil;
  GCPRO2 (next, list);

422 423 424
  /* In a writable buffer, enable undoing read-only text that is so
     because of text properties.  */
  if (NILP (current_buffer->read_only))
425 426
    specbind (Qinhibit_read_only, Qt);

427 428 429
  /* Don't let `intangible' properties interfere with undo.  */
  specbind (Qinhibit_point_motion_hooks, Qt);

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

446 447
	      car = XCAR (next);
	      cdr = XCDR (next);
448
	      if (EQ (car, Qt))
Jim Blandy's avatar
Jim Blandy committed
449
		{
450 451 452
		  /* Element (t high . low) records previous modtime.  */
		  Lisp_Object high, low;
		  int mod_time;
453
		  struct buffer *base_buffer = current_buffer;
454 455 456

		  high = Fcar (cdr);
		  low = Fcdr (cdr);
457
		  mod_time = (XFASTINT (high) << 16) + XFASTINT (low);
458 459 460 461

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

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

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

518 519 520 521 522 523
		      /* 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);
524 525
		      SET_PT (pos);
		    }
Jim Blandy's avatar
Jim Blandy committed
526
		}
527 528 529 530 531 532 533 534 535
	      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
536 537 538 539 540
	    }
	}
      arg--;
    }

541
  UNGCPRO;
542
  return unbind_to (count, list);
Jim Blandy's avatar
Jim Blandy committed
543 544
}

Andreas Schwab's avatar
Andreas Schwab committed
545
void
Jim Blandy's avatar
Jim Blandy committed
546 547
syms_of_undo ()
{
548 549 550
  Qinhibit_read_only = intern ("inhibit-read-only");
  staticpro (&Qinhibit_read_only);

551 552 553
  pending_boundary = Qnil;
  staticpro (&pending_boundary);

Jim Blandy's avatar
Jim Blandy committed
554 555 556
  defsubr (&Sprimitive_undo);
  defsubr (&Sundo_boundary);
}
Miles Bader's avatar
Miles Bader committed
557 558 559

/* arch-tag: d546ee01-4aed-4ffb-bb8b-eefaae50d38a
   (do not change this comment) */