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
#define BUFFER_INLINE EXTERN_INLINE

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

Paul Eggert's avatar
Paul Eggert committed
32 33
#include <verify.h>

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

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

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

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

61
struct buffer alignas (GCALIGNMENT) buffer_defaults;
Roland McGrath's avatar
Roland McGrath committed
62 63 64 65 66 67 68 69 70 71 72

/* 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,
73 74
   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
75 76 77 78 79 80 81 82 83 84 85 86 87

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

88
struct buffer alignas (GCALIGNMENT) buffer_local_symbols;
Kenichi Handa's avatar
Kenichi Handa committed
89

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

93 94 95 96 97 98
/* 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))

99 100 101
/* Maximum length of an overlay vector.  */
#define OVERLAY_COUNT_MAX						\
  ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM,				\
102
		    min (PTRDIFF_MAX, SIZE_MAX) / word_size))
103

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

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

110
int last_per_buffer_idx;
111

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;
Roland McGrath's avatar
Roland McGrath committed
131

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

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

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

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

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

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

146
Lisp_Object Qpriority, Qbefore_string, Qafter_string;
147

148
static Lisp_Object Qevaporate;
149

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

154
static void alloc_buffer_text (struct buffer *, ptrdiff_t);
155 156
static void free_buffer_text (struct buffer *b);
static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
157
static void modify_overlay (struct buffer *, ptrdiff_t, ptrdiff_t);
Andreas Schwab's avatar
Andreas Schwab committed
158
static Lisp_Object buffer_lisp_local_variables (struct buffer *, int);
159

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

163
void
164
nsberror (Lisp_Object spec)
Roland McGrath's avatar
Roland McGrath committed
165
{
166
  if (STRINGP (spec))
167
    error ("No buffer named %s", SDATA (spec));
Roland McGrath's avatar
Roland McGrath committed
168 169 170
  error ("Invalid buffer argument");
}

Paul Eggert's avatar
Paul Eggert committed
171
DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
172 173
       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
174
  (Lisp_Object object)
175
{
Tom Tromey's avatar
Tom Tromey committed
176
  return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
177 178 179
	  ? Qt : Qnil);
}

180
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
181
       doc: /* Return a list of all existing live buffers.
182 183 184
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
185
  (Lisp_Object frame)
Roland McGrath's avatar
Roland McGrath committed
186
{
187
  Lisp_Object general;
188 189 190 191
  general = Fmapcar (Qcdr, Vbuffer_alist);

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

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

200 201
      /* Remove from GENERAL any buffer that duplicates one in
         FRAMELIST or PREVLIST.  */
202
      tail = framelist;
203
      while (CONSP (tail))
204
	{
205 206
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
207
	}
208 209 210 211 212 213 214 215 216 217 218
      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);
219
    }
220 221
  else
    return general;
Roland McGrath's avatar
Roland McGrath committed
222 223
}

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

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

Paul Eggert's avatar
Paul Eggert committed
243
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
244 245 246 247
       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
248
  (register Lisp_Object buffer_or_name)
Roland McGrath's avatar
Roland McGrath committed
249
{
250 251 252
  if (BUFFERP (buffer_or_name))
    return buffer_or_name;
  CHECK_STRING (buffer_or_name);
Roland McGrath's avatar
Roland McGrath committed
253

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
270 271
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
272
  handler = Ffind_file_name_handler (filename, Qget_file_buffer);
Richard M. Stallman's avatar
Richard M. Stallman committed
273
  if (!NILP (handler))
274 275 276 277 278
    {
      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
279

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

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

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

Paul Eggert's avatar
Paul Eggert committed
309
DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
310 311 312 313 314 315 316 317
       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
318
  (register Lisp_Object buffer_or_name)
Roland McGrath's avatar
Roland McGrath committed
319
{
320
  register Lisp_Object buffer, name;
Roland McGrath's avatar
Roland McGrath committed
321 322
  register struct buffer *b;

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

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

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

332 333
  /* An ordinary buffer uses its own struct buffer_text.  */
  b->text = &b->own_text;
334 335 336
  b->base_buffer = NULL;
  /* No one shares the text with us now.  */
  b->indirections = 0;
337

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

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

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

  BUF_Z (b) = BEG;
358
  BUF_Z_BYTE (b) = BEG_BYTE;
Roland McGrath's avatar
Roland McGrath committed
359
  BUF_MODIFF (b) = 1;
360
  BUF_CHARS_MODIFF (b) = 1;
361
  BUF_OVERLAY_MODIFF (b) = 1;
362
  BUF_SAVE_MODIFF (b) = 1;
Dmitry Antipov's avatar
Dmitry Antipov committed
363
  BUF_INTERVALS (b) = NULL;
364 365 366 367
  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
368
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
369
  b->text->inhibit_shrinking = 0;
Roland McGrath's avatar
Roland McGrath committed
370

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

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

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

386
  name = Fcopy_sequence (buffer_or_name);
Dmitry Antipov's avatar
Dmitry Antipov committed
387
  STRING_SET_INTERVALS (name, NULL);
Tom Tromey's avatar
Tom Tromey committed
388
  BVAR (b, name) = name;
389

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

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

Tom Tromey's avatar
Tom Tromey committed
395
  BVAR (b, mark) = Fmake_marker ();
396
  BUF_MARKERS (b) = NULL;
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

405
  return buffer;
406 407
}

408

409 410 411
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

412
static struct Lisp_Overlay *
413
copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
414
{
415
  struct Lisp_Overlay *result = NULL, *tail = NULL;
416

417
  for (; list; list = list->next)
418
    {
Dmitry Antipov's avatar
Dmitry Antipov committed
419 420
      Lisp_Object overlay, start, end;
      struct Lisp_Marker *m;
421

422 423
      eassert (MARKERP (list->start));
      m = XMARKER (list->start);
Dmitry Antipov's avatar
Dmitry Antipov committed
424 425
      start = build_marker (b, m->charpos, m->bytepos);
      XMARKER (start)->insertion_type = m->insertion_type;
426

427 428
      eassert (MARKERP (list->end));
      m = XMARKER (list->end);
Dmitry Antipov's avatar
Dmitry Antipov committed
429 430
      end = build_marker (b, m->charpos, m->bytepos);
      XMARKER (end)->insertion_type = m->insertion_type;
431

432
      overlay = build_overlay (start, end, Fcopy_sequence (list->plist));
433 434 435 436
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
437 438
    }

439
  return result;
440
}
441

442

443 444 445 446 447 448 449 450
/* 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
451
clone_per_buffer_values (struct buffer *from, struct buffer *to)
452 453 454
{
  int offset;

455
  FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
456 457 458
    {
      Lisp_Object obj;

459 460 461 462
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

463
      obj = PER_BUFFER_VALUE (from, offset);
464
      if (MARKERP (obj) && XMARKER (obj)->buffer == from)
465 466
	{
	  struct Lisp_Marker *m = XMARKER (obj);
467 468

	  obj = build_marker (to, m->charpos, m->bytepos);
469 470 471 472 473 474
	  XMARKER (obj)->insertion_type = m->insertion_type;
	}

      PER_BUFFER_VALUE (to, offset) = obj;
    }

475
  memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
476

477 478
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
479

480 481
  /* Get (a copy of) the alist of Lisp-level local variables of FROM
     and install that in TO.  */
Andreas Schwab's avatar
Andreas Schwab committed
482
  BVAR (to, local_var_alist) = buffer_lisp_local_variables (from, 1);
483 484
}

485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531

/* 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));
    }
}


532 533
DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
534
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
535
       doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
Kenichi Handa's avatar
Kenichi Handa committed
536
BASE-BUFFER should be a live buffer, or the name of an existing buffer.
Pavel Janík's avatar
Pavel Janík committed
537 538 539
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.
540
CLONE nil means the indirect buffer's state is reset to default values.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
541
  (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
542
{
Kenichi Handa's avatar
Kenichi Handa committed
543
  Lisp_Object buf, tem;
544
  struct buffer *b;
545

Kenichi Handa's avatar
Kenichi Handa committed
546
  CHECK_STRING (name);
547 548
  buf = Fget_buffer (name);
  if (!NILP (buf))
549
    error ("Buffer name `%s' is in use", SDATA (name));
550

Kenichi Handa's avatar
Kenichi Handa committed
551
  tem = base_buffer;
552 553
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
Kenichi Handa's avatar
Kenichi Handa committed
554
    error ("No such buffer: `%s'", SDATA (tem));
Tom Tromey's avatar
Tom Tromey committed
555
  if (NILP (BVAR (XBUFFER (base_buffer), name)))
Kenichi Handa's avatar
Kenichi Handa committed
556
    error ("Base buffer has been killed");
557

558
  if (SCHARS (name) == 0)
559 560
    error ("Empty string for buffer name is not allowed");

561
  b = allocate_buffer ();
562

563 564
  /* No double indirection - if base buffer is indirect,
     new buffer becomes an indirect to base's base.  */
565 566 567
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
568 569 570

  /* Use the base buffer's text object.  */
  b->text = b->base_buffer->text;
571 572 573 574
  /* We have no own text.  */
  b->indirections = -1;
  /* Notify base buffer that we share the text now.  */
  b->base_buffer->indirections++;
575

576 577 578 579 580 581
  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;
582 583 584

  b->newline_cache = 0;
  b->width_run_cache = 0;
Tom Tromey's avatar
Tom Tromey committed
585
  BVAR (b, width_table) = Qnil;
586 587

  /* Put this on the chain of all buffers including killed ones.  */
588
  b->header.next.buffer = all_buffers;
589 590 591
  all_buffers = b;

  name = Fcopy_sequence (name);
Dmitry Antipov's avatar
Dmitry Antipov committed
592
  STRING_SET_INTERVALS (name, NULL);
Tom Tromey's avatar
Tom Tromey committed
593
  BVAR (b, name) = name;
594 595

  reset_buffer (b);
596
  reset_buffer_local_variables (b, 1);
597 598 599 600 601

  /* 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
602
  BVAR (b, mark) = Fmake_marker ();
603

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

607
  /* Make sure the base buffer has markers for its narrowing.  */
Tom Tromey's avatar
Tom Tromey committed
608
  if (NILP (BVAR (b->base_buffer, pt_marker)))
609
    {
610 611
      eassert (NILP (BVAR (b->base_buffer, begv_marker)));
      eassert (NILP (BVAR (b->base_buffer, zv_marker)));
612

613
      BVAR (b->base_buffer, pt_marker)
614 615 616 617
	= build_marker (b->base_buffer, b->base_buffer->pt, b->base_buffer->pt_byte);

      BVAR (b->base_buffer, begv_marker)
	= build_marker (b->base_buffer, b->base_buffer->begv, b->base_buffer->begv_byte);
618

619 620
      BVAR (b->base_buffer, zv_marker)
	= build_marker (b->base_buffer, b->base_buffer->zv, b->base_buffer->zv_byte);
621

Tom Tromey's avatar
Tom Tromey committed
622
      XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
623 624
    }

625 626 627
  if (NILP (clone))
    {
      /* Give the indirect buffer markers for its narrowing.  */
628 629 630
      BVAR (b, pt_marker) = build_marker (b, b->pt, b->pt_byte);
      BVAR (b, begv_marker) = build_marker (b, b->begv, b->begv_byte);
      BVAR (b, zv_marker) = build_marker (b, b->zv, b->zv_byte);
Tom Tromey's avatar
Tom Tromey committed
631
      XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
632 633
    }
  else
634 635 636 637
    {
      struct buffer *old_b = current_buffer;

      clone_per_buffer_values (b->base_buffer, b);
Tom Tromey's avatar
Tom Tromey committed
638 639 640 641 642
      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;
643 644 645 646 647 648
      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);
    }
649

650 651 652 653
  /* Run buffer-list-update-hook.  */
  if (!NILP (Vrun_hooks))
    call1 (Vrun_hooks, Qbuffer_list_update_hook);

654
  return buf;
Roland McGrath's avatar
Roland McGrath committed
655 656
}

657 658 659 660 661
/* Mark OV as no longer associated with B.  */

static void
drop_overlay (struct buffer *b, struct Lisp_Overlay *ov)
{
662 663 664 665 666
  eassert (b == XBUFFER (Fmarker_buffer (ov->start)));
  modify_overlay (b, marker_position (ov->start),
		  marker_position (ov->end));
  Fset_marker (ov->start, Qnil, Qnil);
  Fset_marker (ov->end, Qnil, Qnil);
667 668 669 670 671

}

/* Delete all overlays of B and reset it's overlay lists.  */

672
void
673
delete_all_overlays (struct buffer *b)
674
{
675
  struct Lisp_Overlay *ov, *next;
676

677
  for (ov = b->overlays_before; ov; ov = next)
678
    {
679 680 681
      drop_overlay (b, ov);
      next = ov->next;
      ov->next = NULL;
682
    }
683 684

  for (ov = b->overlays_after; ov; ov = next)
685
    {
686 687 688
      drop_overlay (b, ov);
      next = ov->next;
      ov->next = NULL;
689
    }
690 691

  b->overlays_before = b->overlays_after = NULL;
692 693
}

694
/* Reinitialize everything about a buffer except its name and contents
Kenichi Handa's avatar
Kenichi Handa committed
695
   and local variables.
696 697 698 699
   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
700 701

void
702
reset_buffer (register struct buffer *b)
Roland McGrath's avatar
Roland McGrath committed
703
{
Tom Tromey's avatar
Tom Tromey committed
704 705 706
  BVAR (b, filename) = Qnil;
  BVAR (b, file_truename) = Qnil;
  BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
707
  b->modtime = make_emacs_time (0, UNKNOWN_MODTIME_NSECS);
708
  b->modtime_size = -1;
Tom Tromey's avatar
Tom Tromey committed
709
  XSETFASTINT (BVAR (b, save_length), 0);
Roland McGrath's avatar
Roland McGrath committed
710
  b->last_window_start = 1;
711
  /* It is more conservative to start out "changed" than "unchanged".  */
712 713
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Tom Tromey's avatar
Tom Tromey committed
714
  BVAR (b, backed_up) = Qnil;
715
  BUF_AUTOSAVE_MODIFF (b) = 0;
716
  b->auto_save_failure_time = 0;
Tom Tromey's avatar
Tom Tromey committed
717 718
  BVAR (b, auto_save_file_name) = Qnil;
  BVAR (b, read_only) = Qnil;
719 720
  b->overlays_before = NULL;
  b->overlays_after = NULL;
721
  b->overlay_center = BEG;
Tom Tromey's avatar
Tom Tromey committed
722 723 724 725 726 727 728 729 730 731
  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);
732 733

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
734 735
}

736 737 738
/* 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.
739 740
   Instead, use Fkill_all_local_variables.

741
   If PERMANENT_TOO is 1, then we reset permanent
742 743
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
744

745
static void
746
reset_buffer_local_variables (register struct buffer *b, int permanent_too)
Roland McGrath's avatar
Roland McGrath committed
747 748
{
  register int offset;
749
  int i;
Roland McGrath's avatar
Roland McGrath committed
750 751 752 753 754

  /* 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
755 756 757 758
  BVAR (b, major_mode) = Qfundamental_mode;
  BVAR (b, keymap) = Qnil;
  BVAR (b, mode_name) = QSFundamental;
  BVAR (b, minor_modes) = Qnil;
759 760 761 762 763 764 765 766

  /* 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
767 768 769 770 771
  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;
772

773
  /* Reset all (or most) per-buffer variables to their defaults.  */
774
  if (permanent_too)
Tom Tromey's avatar
Tom Tromey committed
775
    BVAR (b, local_var_alist) = Qnil;
776 777
  else
    {
778
      Lisp_Object tmp, prop, last = Qnil;
Tom Tromey's avatar
Tom Tromey committed
779
      for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
780
	if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
	  {
	    /* 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.  */
808
	else if (NILP (last))
Tom Tromey's avatar
Tom Tromey committed
809
	  BVAR (b, local_var_alist) = XCDR (tmp);
810 811 812 813
	else
	  XSETCDR (last, XCDR (tmp));
    }

814
  for (i = 0; i < last_per_buffer_idx; ++i)
815
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
816
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
817

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