buffer.c 197 KB
Newer Older
Roland McGrath's avatar
Roland McGrath committed
1
/* Buffer manipulation primitives for GNU Emacs.
2

3
Copyright (C) 1985-1989, 1993-1995, 1997-2012  Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Roland McGrath's avatar
Roland McGrath committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Roland McGrath's avatar
Roland McGrath committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Roland McGrath's avatar
Roland McGrath committed
19

20
#include <config.h>
Roland McGrath's avatar
Roland McGrath committed
21

22 23
#include <sys/types.h>
#include <sys/stat.h>
Roland McGrath's avatar
Roland McGrath committed
24
#include <sys/param.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
25
#include <errno.h>
Dave Love's avatar
Dave Love committed
26
#include <stdio.h>
27
#include <setjmp.h>
Andreas Schwab's avatar
Andreas Schwab committed
28
#include <unistd.h>
29

Paul Eggert's avatar
Paul Eggert committed
30 31
#include <verify.h>

Roland McGrath's avatar
Roland McGrath committed
32
#include "lisp.h"
33
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
34 35 36
#include "window.h"
#include "commands.h"
#include "buffer.h"
37
#include "character.h"
38
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
39
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
40
#include "blockinput.h"
41
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
42
#include "keymap.h"
43
#include "frame.h"
Roland McGrath's avatar
Roland McGrath committed
44 45 46 47

struct buffer *current_buffer;		/* the current buffer */

/* First buffer in chain of all buffers (in reverse order of creation).
48
   Threaded through ->header.next.buffer.  */
Roland McGrath's avatar
Roland McGrath committed
49 50 51 52 53 54 55 56 57 58

struct buffer *all_buffers;

/* This structure holds the default values of the buffer-local variables
   defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
   The default value occupies the same slot in this structure
   as an individual buffer's value occupies in that buffer.
   Setting the default value also goes through the alist of buffers
   and stores into each buffer that does not say it has a local value.  */

Kenichi Handa's avatar
Kenichi Handa committed
59
DECL_ALIGN (struct buffer, buffer_defaults);
Roland McGrath's avatar
Roland McGrath committed
60 61 62 63 64 65 66 67 68 69 70

/* A Lisp_Object pointer to the above, used for staticpro */

static Lisp_Object Vbuffer_defaults;

/* This structure marks which slots in a buffer have corresponding
   default values in buffer_defaults.
   Each such slot has a nonzero value in this structure.
   The value has only one nonzero bit.

   When a buffer has its own local value for a slot,
71 72
   the entry for that slot (found in the same slot in this structure)
   is turned on in the buffer's local_flags array.
Roland McGrath's avatar
Roland McGrath committed
73 74 75 76 77 78 79 80 81 82 83 84 85

   If a slot in this structure is -1, then even though there may
   be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
   and the corresponding slot in buffer_defaults is not used.

   If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
   zero, that is a bug */

struct buffer buffer_local_flags;

/* This structure holds the names of symbols whose values may be
   buffer-local.  It is indexed and accessed in the same way as the above. */

Kenichi Handa's avatar
Kenichi Handa committed
86 87
DECL_ALIGN (struct buffer, buffer_local_symbols);

Roland McGrath's avatar
Roland McGrath committed
88 89 90
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

91 92 93 94 95 96
/* Return the symbol of the per-buffer variable at offset OFFSET in
   the buffer structure.  */

#define PER_BUFFER_SYMBOL(OFFSET) \
      (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))

97 98 99 100 101
/* Maximum length of an overlay vector.  */
#define OVERLAY_COUNT_MAX						\
  ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM,				\
		    min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)))

102 103
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
104
static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
105 106 107

/* Number of per-buffer variables used.  */

108
int last_per_buffer_idx;
109

110 111
static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
static Lisp_Object Fdelete_overlay (Lisp_Object);
112 113 114 115 116
static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
                                    int after, Lisp_Object arg1,
                                    Lisp_Object arg2, Lisp_Object arg3);
static void swap_out_buffer_local_variables (struct buffer *b);
static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
Roland McGrath's avatar
Roland McGrath committed
117 118 119 120 121 122

/* Alist of all buffer names vs the buffers. */
/* This used to be a variable, but is no longer,
 to prevent lossage due to user rplac'ing this alist or its elements.  */
Lisp_Object Vbuffer_alist;

123
static Lisp_Object Qkill_buffer_query_functions;
124

125
/* Hook run before changing a major mode.  */
126
static Lisp_Object Qchange_major_mode_hook;
127

Jim Blandy's avatar
Jim Blandy committed
128
Lisp_Object Qfirst_change_hook;
129 130
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
131
static Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
132

133 134
static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
static Lisp_Object Qpermanent_local_hook;
Roland McGrath's avatar
Roland McGrath committed
135

136
static Lisp_Object Qprotected_field;
Roland McGrath's avatar
Roland McGrath committed
137

138
static Lisp_Object QSFundamental;	/* A string "Fundamental" */
Roland McGrath's avatar
Roland McGrath committed
139

140
static Lisp_Object Qkill_buffer_hook;
141
static Lisp_Object Qbuffer_list_update_hook;
Roland McGrath's avatar
Roland McGrath committed
142

143
static Lisp_Object Qget_file_buffer;
Richard M. Stallman's avatar
Richard M. Stallman committed
144

145
static Lisp_Object Qoverlayp;
Jim Blandy's avatar
Jim Blandy committed
146

147
Lisp_Object Qpriority, Qbefore_string, Qafter_string;
148

149
static Lisp_Object Qevaporate;
150

151 152 153 154
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

155
static void alloc_buffer_text (struct buffer *, ptrdiff_t);
156 157 158 159
static void free_buffer_text (struct buffer *b);
static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
static Lisp_Object buffer_lisp_local_variables (struct buffer *);
160

Roland McGrath's avatar
Roland McGrath committed
161 162 163
/* For debugging; temporary.  See set_buffer_internal.  */
/* Lisp_Object Qlisp_mode, Vcheck_symbol; */

164
void
165
nsberror (Lisp_Object spec)
Roland McGrath's avatar
Roland McGrath committed
166
{
167
  if (STRINGP (spec))
168
    error ("No buffer named %s", SDATA (spec));
Roland McGrath's avatar
Roland McGrath committed
169 170 171
  error ("Invalid buffer argument");
}

Paul Eggert's avatar
Paul Eggert committed
172
DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
173 174
       doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
Value is nil if OBJECT is not a buffer or if it has been killed.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
175
  (Lisp_Object object)
176
{
Tom Tromey's avatar
Tom Tromey committed
177
  return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
178 179 180
	  ? Qt : Qnil);
}

181
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
182
       doc: /* Return a list of all existing live buffers.
183 184 185
If the optional arg FRAME is a frame, we return the buffer list in the
proper order for that frame: the buffers show in FRAME come first,
followed by the rest of the buffers.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
186
  (Lisp_Object frame)
Roland McGrath's avatar
Roland McGrath committed
187
{
188
  Lisp_Object general;
189 190 191 192
  general = Fmapcar (Qcdr, Vbuffer_alist);

  if (FRAMEP (frame))
    {
193 194
      Lisp_Object framelist, prevlist, tail;
      Lisp_Object args[3];
195

196
      CHECK_FRAME (frame);
197
      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
198 199
      prevlist = Fnreverse (Fcopy_sequence
			    (XFRAME (frame)->buried_buffer_list));
200

201 202
      /* Remove from GENERAL any buffer that duplicates one in
         FRAMELIST or PREVLIST.  */
203
      tail = framelist;
204
      while (CONSP (tail))
205
	{
206 207
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
208
	}
209 210 211 212 213 214 215 216 217 218 219
      tail = prevlist;
      while (CONSP (tail))
	{
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
	}

      args[0] = framelist;
      args[1] = general;
      args[2] = prevlist;
      return Fnconc (3, args);
220
    }
221 222
  else
    return general;
Roland McGrath's avatar
Roland McGrath committed
223 224
}

225 226 227 228 229
/* Like Fassoc, but use Fstring_equal to compare
   (which ignores text properties),
   and don't ever QUIT.  */

static Lisp_Object
230
assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
231 232
{
  register Lisp_Object tail;
233
  for (tail = list; CONSP (tail); tail = XCDR (tail))
234 235
    {
      register Lisp_Object elt, tem;
236
      elt = XCAR (tail);
237 238 239 240 241 242 243
      tem = Fstring_equal (Fcar (elt), key);
      if (!NILP (tem))
	return elt;
    }
  return Qnil;
}

Paul Eggert's avatar
Paul Eggert committed
244
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
245 246 247 248
       doc: /* Return the buffer named BUFFER-OR-NAME.
BUFFER-OR-NAME must be either a string or a buffer.  If BUFFER-OR-NAME
is a string and there is no buffer with that name, return nil.  If
BUFFER-OR-NAME is a buffer, return it as given.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
249
  (register Lisp_Object buffer_or_name)
Roland McGrath's avatar
Roland McGrath committed
250
{
251 252 253
  if (BUFFERP (buffer_or_name))
    return buffer_or_name;
  CHECK_STRING (buffer_or_name);
Roland McGrath's avatar
Roland McGrath committed
254

255
  return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
256 257 258
}

DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
259
       doc: /* Return the buffer visiting file FILENAME (a string).
Pavel Janík's avatar
Pavel Janík committed
260 261
The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
If there is no such live buffer, return nil.
262
See also `find-buffer-visiting'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
263
  (register Lisp_Object filename)
Roland McGrath's avatar
Roland McGrath committed
264 265
{
  register Lisp_Object tail, buf, tem;
Richard M. Stallman's avatar
Richard M. Stallman committed
266 267
  Lisp_Object handler;

268
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
269 270
  filename = Fexpand_file_name (filename, Qnil);

Richard M. Stallman's avatar
Richard M. Stallman committed
271 272
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
273
  handler = Ffind_file_name_handler (filename, Qget_file_buffer);
Richard M. Stallman's avatar
Richard M. Stallman committed
274
  if (!NILP (handler))
275 276 277 278 279
    {
      Lisp_Object handled_buf = call2 (handler, Qget_file_buffer,
				       filename);
      return BUFFERP (handled_buf) ? handled_buf : Qnil;
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
280

281
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
282
    {
283
      buf = Fcdr (XCAR (tail));
284
      if (!BUFFERP (buf)) continue;
Tom Tromey's avatar
Tom Tromey committed
285 286
      if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
      tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
Jim Blandy's avatar
Jim Blandy committed
287
      if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
288 289 290 291 292
	return buf;
    }
  return Qnil;
}

293
Lisp_Object
294
get_truename_buffer (register Lisp_Object filename)
295 296 297
{
  register Lisp_Object tail, buf, tem;

298
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
299
    {
300
      buf = Fcdr (XCAR (tail));
301
      if (!BUFFERP (buf)) continue;
Tom Tromey's avatar
Tom Tromey committed
302 303
      if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
      tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
304 305 306 307 308 309
      if (!NILP (tem))
	return buf;
    }
  return Qnil;
}

Paul Eggert's avatar
Paul Eggert committed
310
DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
311 312 313 314 315 316 317 318
       doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
If BUFFER-OR-NAME is a string and a live buffer with that name exists,
return that buffer.  If no such buffer exists, create a new buffer with
that name and return it.  If BUFFER-OR-NAME starts with a space, the new
buffer does not keep undo information.

If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
even if it is dead.  The return value is never nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
319
  (register Lisp_Object buffer_or_name)
Roland McGrath's avatar
Roland McGrath committed
320
{
321
  register Lisp_Object buffer, name;
Roland McGrath's avatar
Roland McGrath committed
322 323
  register struct buffer *b;

324 325 326
  buffer = Fget_buffer (buffer_or_name);
  if (!NILP (buffer))
    return buffer;
Roland McGrath's avatar
Roland McGrath committed
327

328
  if (SCHARS (buffer_or_name) == 0)
329 330
    error ("Empty string for buffer name is not allowed");

331
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
332

333 334 335 336
  /* An ordinary buffer uses its own struct buffer_text.  */
  b->text = &b->own_text;
  b->base_buffer = 0;

Roland McGrath's avatar
Roland McGrath committed
337
  BUF_GAP_SIZE (b) = 20;
338
  BLOCK_INPUT;
Karl Heuer's avatar
Karl Heuer committed
339 340
  /* We allocate extra 1-byte at the tail and keep it always '\0' for
     anchoring a search.  */
341
  alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
342
  UNBLOCK_INPUT;
Roland McGrath's avatar
Roland McGrath committed
343
  if (! BUF_BEG_ADDR (b))
Paul Eggert's avatar
Paul Eggert committed
344
    buffer_memory_full (BUF_GAP_SIZE (b) + 1);
Roland McGrath's avatar
Roland McGrath committed
345

346 347 348 349 350 351 352
  b->pt = BEG;
  b->begv = BEG;
  b->zv = BEG;
  b->pt_byte = BEG_BYTE;
  b->begv_byte = BEG_BYTE;
  b->zv_byte = BEG_BYTE;

353 354
  BUF_GPT (b) = BEG;
  BUF_GPT_BYTE (b) = BEG_BYTE;
355 356

  BUF_Z (b) = BEG;
357
  BUF_Z_BYTE (b) = BEG_BYTE;
Roland McGrath's avatar
Roland McGrath committed
358
  BUF_MODIFF (b) = 1;
359
  BUF_CHARS_MODIFF (b) = 1;
360
  BUF_OVERLAY_MODIFF (b) = 1;
361 362
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
363 364 365 366
  BUF_UNCHANGED_MODIFIED (b) = 1;
  BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
  BUF_END_UNCHANGED (b) = 0;
  BUF_BEG_UNCHANGED (b) = 0;
Karl Heuer's avatar
Karl Heuer committed
367
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
368
  b->text->inhibit_shrinking = 0;
Roland McGrath's avatar
Roland McGrath committed
369

370 371
  b->newline_cache = 0;
  b->width_run_cache = 0;
Tom Tromey's avatar
Tom Tromey committed
372
  BVAR (b, width_table) = Qnil;
373
  b->prevent_redisplay_optimizations_p = 1;
374

Roland McGrath's avatar
Roland McGrath committed
375
  /* Put this on the chain of all buffers including killed ones.  */
376
  b->header.next.buffer = all_buffers;
Roland McGrath's avatar
Roland McGrath committed
377 378
  all_buffers = b;

379 380
  /* An ordinary buffer normally doesn't need markers
     to handle BEGV and ZV.  */
Tom Tromey's avatar
Tom Tromey committed
381 382 383
  BVAR (b, pt_marker) = Qnil;
  BVAR (b, begv_marker) = Qnil;
  BVAR (b, zv_marker) = Qnil;
384

385
  name = Fcopy_sequence (buffer_or_name);
386
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Tom Tromey's avatar
Tom Tromey committed
387
  BVAR (b, name) = name;
388

Tom Tromey's avatar
Tom Tromey committed
389
  BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
Roland McGrath's avatar
Roland McGrath committed
390 391

  reset_buffer (b);
392
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
393

Tom Tromey's avatar
Tom Tromey committed
394
  BVAR (b, mark) = Fmake_marker ();
395
  BUF_MARKERS (b) = NULL;
Tom Tromey's avatar
Tom Tromey committed
396
  BVAR (b, name) = name;
397

Roland McGrath's avatar
Roland McGrath committed
398
  /* Put this in the alist of all live buffers.  */
399 400
  XSETBUFFER (buffer, b);
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
401 402 403
  /* And run buffer-list-update-hook.  */
  if (!NILP (Vrun_hooks))
    call1 (Vrun_hooks, Qbuffer_list_update_hook);
Roland McGrath's avatar
Roland McGrath committed
404

Juanma Barranquero's avatar
Juanma Barranquero committed
405
  /* An error in calling the function here (should someone redefine it)
Dave Love's avatar
Dave Love committed
406 407
     can lead to infinite regress until you run out of stack.  rms
     says that's not worth protecting against.  */
Dave Love's avatar
Dave Love committed
408
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
409 410
    /* buffer is on buffer-alist, so no gcpro.  */
    call1 (Qucs_set_table_for_input, buffer);
Dave Love's avatar
Dave Love committed
411

412
  return buffer;
413 414
}

415

416 417 418
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

419
static struct Lisp_Overlay *
420
copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
421
{
422 423
  Lisp_Object buffer;
  struct Lisp_Overlay *result = NULL, *tail = NULL;
424 425 426

  XSETBUFFER (buffer, b);

427
  for (; list; list = list->next)
428 429
    {
      Lisp_Object overlay, start, end, old_overlay;
430
      EMACS_INT charpos;
431

432
      XSETMISC (old_overlay, list);
433 434
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
435
      Fset_marker (start, make_number (charpos), buffer);
436 437 438 439 440
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
441
      Fset_marker (end, make_number (charpos), buffer);
442 443 444 445 446 447 448 449
      XMARKER (end)->insertion_type
	= XMARKER (OVERLAY_END (old_overlay))->insertion_type;

      overlay = allocate_misc ();
      XMISCTYPE (overlay) = Lisp_Misc_Overlay;
      OVERLAY_START (overlay) = start;
      OVERLAY_END (overlay) = end;
      OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
450
      XOVERLAY (overlay)->next = NULL;
451

452 453 454 455
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
456 457
    }

458
  return result;
459
}
460

461

462 463 464 465 466 467 468 469
/* Clone per-buffer values of buffer FROM.

   Buffer TO gets the same per-buffer values as FROM, with the
   following exceptions: (1) TO's name is left untouched, (2) markers
   are copied and made to refer to TO, and (3) overlay lists are
   copied.  */

static void
470
clone_per_buffer_values (struct buffer *from, struct buffer *to)
471
{
472
  Lisp_Object to_buffer;
473 474 475
  int offset;

  XSETBUFFER (to_buffer, to);
476

477 478
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
479 480
  for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
       offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
481 482 483 484
       offset += sizeof (Lisp_Object))
    {
      Lisp_Object obj;

485 486 487 488
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

489
      obj = PER_BUFFER_VALUE (from, offset);
490
      if (MARKERP (obj) && XMARKER (obj)->buffer == from)
491 492 493 494 495 496 497 498 499 500
	{
	  struct Lisp_Marker *m = XMARKER (obj);
	  obj = Fmake_marker ();
	  XMARKER (obj)->insertion_type = m->insertion_type;
	  set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
	}

      PER_BUFFER_VALUE (to, offset) = obj;
    }

501
  memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
502

503 504
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
505

506 507
  /* Get (a copy of) the alist of Lisp-level local variables of FROM
     and install that in TO.  */
Tom Tromey's avatar
Tom Tromey committed
508
  BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
509 510
}

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557

/* If buffer B has markers to record PT, BEGV and ZV when it is not
   current, update these markers.  */

static void
record_buffer_markers (struct buffer *b)
{
  if (! NILP (BVAR (b, pt_marker)))
    {
      Lisp_Object buffer;

      eassert (!NILP (BVAR (b, begv_marker)));
      eassert (!NILP (BVAR (b, zv_marker)));

      XSETBUFFER (buffer, b);
      set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
      set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
      set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
    }
}


/* If buffer B has markers to record PT, BEGV and ZV when it is not
   current, fetch these values into B->begv etc.  */

static void
fetch_buffer_markers (struct buffer *b)
{
  if (! NILP (BVAR (b, pt_marker)))
    {
      Lisp_Object m;

      eassert (!NILP (BVAR (b, begv_marker)));
      eassert (!NILP (BVAR (b, zv_marker)));

      m = BVAR (b, pt_marker);
      SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));

      m = BVAR (b, begv_marker);
      SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));

      m = BVAR (b, zv_marker);
      SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
    }
}


558 559
DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
560
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
561
       doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
Kenichi Handa's avatar
Kenichi Handa committed
562
BASE-BUFFER should be a live buffer, or the name of an existing buffer.
Pavel Janík's avatar
Pavel Janík committed
563 564 565
NAME should be a string which is not the name of an existing buffer.
Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
such as major and minor modes, in the indirect buffer.
566
CLONE nil means the indirect buffer's state is reset to default values.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
567
  (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
568
{
Kenichi Handa's avatar
Kenichi Handa committed
569
  Lisp_Object buf, tem;
570
  struct buffer *b;
571

Kenichi Handa's avatar
Kenichi Handa committed
572
  CHECK_STRING (name);
573 574
  buf = Fget_buffer (name);
  if (!NILP (buf))
575
    error ("Buffer name `%s' is in use", SDATA (name));
576

Kenichi Handa's avatar
Kenichi Handa committed
577
  tem = base_buffer;
578 579
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
Kenichi Handa's avatar
Kenichi Handa committed
580
    error ("No such buffer: `%s'", SDATA (tem));
Tom Tromey's avatar
Tom Tromey committed
581
  if (NILP (BVAR (XBUFFER (base_buffer), name)))
Kenichi Handa's avatar
Kenichi Handa committed
582
    error ("Base buffer has been killed");
583

584
  if (SCHARS (name) == 0)
585 586
    error ("Empty string for buffer name is not allowed");

587
  b = allocate_buffer ();
588

589 590 591
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
592 593 594 595

  /* Use the base buffer's text object.  */
  b->text = b->base_buffer->text;

596 597 598 599 600 601
  b->pt = b->base_buffer->pt;
  b->begv = b->base_buffer->begv;
  b->zv = b->base_buffer->zv;
  b->pt_byte = b->base_buffer->pt_byte;
  b->begv_byte = b->base_buffer->begv_byte;
  b->zv_byte = b->base_buffer->zv_byte;
602 603 604

  b->newline_cache = 0;
  b->width_run_cache = 0;
Tom Tromey's avatar
Tom Tromey committed
605
  BVAR (b, width_table) = Qnil;
606 607

  /* Put this on the chain of all buffers including killed ones.  */
608
  b->header.next.buffer = all_buffers;
609 610 611
  all_buffers = b;

  name = Fcopy_sequence (name);
612
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Tom Tromey's avatar
Tom Tromey committed
613
  BVAR (b, name) = name;
614 615

  reset_buffer (b);
616
  reset_buffer_local_variables (b, 1);
617 618 619 620 621

  /* Put this in the alist of all live buffers.  */
  XSETBUFFER (buf, b);
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));

Tom Tromey's avatar
Tom Tromey committed
622 623
  BVAR (b, mark) = Fmake_marker ();
  BVAR (b, name) = name;
624

625
  /* The multibyte status belongs to the base buffer.  */
Tom Tromey's avatar
Tom Tromey committed
626
  BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
627

628
  /* Make sure the base buffer has markers for its narrowing.  */
Tom Tromey's avatar
Tom Tromey committed
629
  if (NILP (BVAR (b->base_buffer, pt_marker)))
630
    {
631 632
      eassert (NILP (BVAR (b->base_buffer, begv_marker)));
      eassert (NILP (BVAR (b->base_buffer, zv_marker)));
633

Tom Tromey's avatar
Tom Tromey committed
634 635
      BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
      set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
636 637 638
		       b->base_buffer->pt,
		       b->base_buffer->pt_byte);

Tom Tromey's avatar
Tom Tromey committed
639 640
      BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
      set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
641 642 643
		       b->base_buffer->begv,
		       b->base_buffer->begv_byte);

Tom Tromey's avatar
Tom Tromey committed
644 645
      BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
      set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
646 647
		       b->base_buffer->zv,
		       b->base_buffer->zv_byte);
Tom Tromey's avatar
Tom Tromey committed
648
      XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
649 650
    }

651 652 653
  if (NILP (clone))
    {
      /* Give the indirect buffer markers for its narrowing.  */
Tom Tromey's avatar
Tom Tromey committed
654
      BVAR (b, pt_marker) = Fmake_marker ();
655
      set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
Tom Tromey's avatar
Tom Tromey committed
656
      BVAR (b, begv_marker) = Fmake_marker ();
657
      set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
Tom Tromey's avatar
Tom Tromey committed
658
      BVAR (b, zv_marker) = Fmake_marker ();
659
      set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
Tom Tromey's avatar
Tom Tromey committed
660
      XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
661 662
    }
  else
663 664 665 666
    {
      struct buffer *old_b = current_buffer;

      clone_per_buffer_values (b->base_buffer, b);
Tom Tromey's avatar
Tom Tromey committed
667 668 669 670 671
      BVAR (b, filename) = Qnil;
      BVAR (b, file_truename) = Qnil;
      BVAR (b, display_count) = make_number (0);
      BVAR (b, backed_up) = Qnil;
      BVAR (b, auto_save_file_name) = Qnil;
672 673 674 675 676 677
      set_buffer_internal_1 (b);
      Fset (intern ("buffer-save-without-query"), Qnil);
      Fset (intern ("buffer-file-number"), Qnil);
      Fset (intern ("buffer-stale-function"), Qnil);
      set_buffer_internal_1 (old_b);
    }
678

679 680 681 682
  /* Run buffer-list-update-hook.  */
  if (!NILP (Vrun_hooks))
    call1 (Vrun_hooks, Qbuffer_list_update_hook);

683
  return buf;
Roland McGrath's avatar
Roland McGrath committed
684 685
}

686
void
687
delete_all_overlays (struct buffer *b)
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
{
  Lisp_Object overlay;

  /* `reset_buffer' blindly sets the list of overlays to NULL, so we
     have to empty the list, otherwise we end up with overlays that
     think they belong to this buffer while the buffer doesn't know about
     them any more.  */
  while (b->overlays_before)
    {
      XSETMISC (overlay, b->overlays_before);
      Fdelete_overlay (overlay);
    }
  while (b->overlays_after)
    {
      XSETMISC (overlay, b->overlays_after);
      Fdelete_overlay (overlay);
    }
  eassert (b->overlays_before == NULL);
  eassert (b->overlays_after == NULL);
}

709
/* Reinitialize everything about a buffer except its name and contents
Kenichi Handa's avatar
Kenichi Handa committed
710
   and local variables.
711 712 713 714
   If called on an already-initialized buffer, the list of overlays
   should be deleted before calling this function, otherwise we end up
   with overlays that claim to belong to the buffer but the buffer
   claims it doesn't belong to it.  */
Roland McGrath's avatar
Roland McGrath committed
715 716

void
717
reset_buffer (register struct buffer *b)
Roland McGrath's avatar
Roland McGrath committed
718
{
Tom Tromey's avatar
Tom Tromey committed
719 720 721
  BVAR (b, filename) = Qnil;
  BVAR (b, file_truename) = Qnil;
  BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
Roland McGrath's avatar
Roland McGrath committed
722
  b->modtime = 0;
723
  b->modtime_size = -1;
Tom Tromey's avatar
Tom Tromey committed
724
  XSETFASTINT (BVAR (b, save_length), 0);
Roland McGrath's avatar
Roland McGrath committed
725
  b->last_window_start = 1;
726
  /* It is more conservative to start out "changed" than "unchanged".  */
727 728
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Tom Tromey's avatar
Tom Tromey committed
729
  BVAR (b, backed_up) = Qnil;
730
  BUF_AUTOSAVE_MODIFF (b) = 0;
731
  b->auto_save_failure_time = 0;
Tom Tromey's avatar
Tom Tromey committed
732 733
  BVAR (b, auto_save_file_name) = Qnil;
  BVAR (b, read_only) = Qnil;
734 735
  b->overlays_before = NULL;
  b->overlays_after = NULL;
736
  b->overlay_center = BEG;
Tom Tromey's avatar
Tom Tromey committed
737 738 739 740 741 742 743 744 745 746
  BVAR (b, mark_active) = Qnil;
  BVAR (b, point_before_scroll) = Qnil;
  BVAR (b, file_format) = Qnil;
  BVAR (b, auto_save_file_format) = Qt;
  BVAR (b, last_selected_window) = Qnil;
  XSETINT (BVAR (b, display_count), 0);
  BVAR (b, display_time) = Qnil;
  BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
  BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
  BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
747 748

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
749 750
}

751 752 753
/* Reset buffer B's local variables info.
   Don't use this on a buffer that has already been in use;
   it does not treat permanent locals consistently.
754 755
   Instead, use Fkill_all_local_variables.

756
   If PERMANENT_TOO is 1, then we reset permanent
757 758
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
759

760
static void
761
reset_buffer_local_variables (register struct buffer *b, int permanent_too)
Roland McGrath's avatar
Roland McGrath committed
762 763
{
  register int offset;
764
  int i;
Roland McGrath's avatar
Roland McGrath committed
765 766 767 768 769

  /* Reset the major mode to Fundamental, together with all the
     things that depend on the major mode.
     default-major-mode is handled at a higher level.
     We ignore it here.  */
Tom Tromey's avatar
Tom Tromey committed
770 771 772 773
  BVAR (b, major_mode) = Qfundamental_mode;
  BVAR (b, keymap) = Qnil;
  BVAR (b, mode_name) = QSFundamental;
  BVAR (b, minor_modes) = Qnil;
774 775 776 777 778 779 780 781

  /* If the standard case table has been altered and invalidated,
     fix up its insides first.  */
  if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
	 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
	 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
    Fset_standard_case_table (Vascii_downcase_table);

Tom Tromey's avatar
Tom Tromey committed
782 783 784 785 786
  BVAR (b, downcase_table) = Vascii_downcase_table;
  BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
  BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
  BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
  BVAR (b, invisibility_spec) = Qt;
787

788
  /* Reset all (or most) per-buffer variables to their defaults.  */
789
  if (permanent_too)
Tom Tromey's avatar
Tom Tromey committed
790
    BVAR (b, local_var_alist) = Qnil;
791 792
  else
    {
793
      Lisp_Object tmp, prop, last = Qnil;
Tom Tromey's avatar
Tom Tromey committed
794
      for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
795
	if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
	  {
	    /* If permanent-local, keep it.  */
	    last = tmp;
	    if (EQ (prop, Qpermanent_local_hook))
	      {
		/* This is a partially permanent hook variable.
		   Preserve only the elements that want to be preserved.  */
		Lisp_Object list, newlist;
		list = XCDR (XCAR (tmp));
		if (!CONSP (list))
		  newlist = list;
		else
		  for (newlist = Qnil; CONSP (list); list = XCDR (list))
		    {
		      Lisp_Object elt = XCAR (list);
		      /* Preserve element ELT if it's t,
			 if it is a function with a `permanent-local-hook' property,
			 or if it's not a symbol.  */
		      if (! SYMBOLP (elt)
			  || EQ (elt, Qt)
			  || !NILP (Fget (elt, Qpermanent_local_hook)))
			newlist = Fcons (elt, newlist);
		    }
		XSETCDR (XCAR (tmp), Fnreverse (newlist));
	      }
	  }
	/* Delete this local variable.  */
823
	else if (NILP (last))
Tom Tromey's avatar
Tom Tromey committed
824
	  BVAR (b, local_var_alist) = XCDR (tmp);
825 826 827 828
	else
	  XSETCDR (last, XCDR (tmp));
    }

829
  for (i = 0; i < last_per_buffer_idx; ++i)
830
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
831
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
832 833 834 835

  /* For each slot that has a default value,
     copy that into the slot.  */

836 837
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
838 839
  for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
       offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
840
       offset += sizeof (Lisp_Object))
841
    {
842
      int idx = PER_BUFFER_IDX (offset);
843