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
#include "window.h"
#include "commands.h"
36
#include "character.h"
37
#include "buffer.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 112 113 114
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
115 116 117 118 119 120

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

121
static Lisp_Object Qkill_buffer_query_functions;
122

123
/* Hook run before changing a major mode.  */
124
static Lisp_Object Qchange_major_mode_hook;
125

Jim Blandy's avatar
Jim Blandy committed
126
Lisp_Object Qfirst_change_hook;
127 128
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
129

130 131
static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
static Lisp_Object Qpermanent_local_hook;
Roland McGrath's avatar
Roland McGrath committed
132

133
static Lisp_Object Qprotected_field;
Roland McGrath's avatar
Roland McGrath committed
134

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

137
static Lisp_Object Qkill_buffer_hook;
138
static Lisp_Object Qbuffer_list_update_hook;
Roland McGrath's avatar
Roland McGrath committed
139

140
static Lisp_Object Qget_file_buffer;
Richard M. Stallman's avatar
Richard M. Stallman committed
141

142
static Lisp_Object Qoverlayp;
Jim Blandy's avatar
Jim Blandy committed
143

144
Lisp_Object Qpriority, Qbefore_string, Qafter_string;
145

146
static Lisp_Object Qevaporate;
147

148 149 150 151
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

290
Lisp_Object
291
get_truename_buffer (register Lisp_Object filename)
292 293 294
{
  register Lisp_Object tail, buf, tem;

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

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

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

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

328
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
329

330 331 332 333
  /* 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
334
  BUF_GAP_SIZE (b) = 20;
335
  BLOCK_INPUT;
Karl Heuer's avatar
Karl Heuer committed
336 337
  /* We allocate extra 1-byte at the tail and keep it always '\0' for
     anchoring a search.  */
338
  alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
339
  UNBLOCK_INPUT;
Roland McGrath's avatar
Roland McGrath committed
340
  if (! BUF_BEG_ADDR (b))
Paul Eggert's avatar
Paul Eggert committed
341
    buffer_memory_full (BUF_GAP_SIZE (b) + 1);
Roland McGrath's avatar
Roland McGrath committed
342

343 344 345 346 347 348 349
  b->pt = BEG;
  b->begv = BEG;
  b->zv = BEG;
  b->pt_byte = BEG_BYTE;
  b->begv_byte = BEG_BYTE;
  b->zv_byte = BEG_BYTE;

350 351
  BUF_GPT (b) = BEG;
  BUF_GPT_BYTE (b) = BEG_BYTE;
352 353

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

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

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

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

382
  name = Fcopy_sequence (buffer_or_name);
383
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Tom Tromey's avatar
Tom Tromey committed
384
  BVAR (b, name) = name;
385

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

  reset_buffer (b);
389
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
390

Tom Tromey's avatar
Tom Tromey committed
391
  BVAR (b, mark) = Fmake_marker ();
392
  BUF_MARKERS (b) = NULL;
393

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

401
  return buffer;
402 403
}

404

405 406 407
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

408
static struct Lisp_Overlay *
409
copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
410
{
411 412
  Lisp_Object buffer;
  struct Lisp_Overlay *result = NULL, *tail = NULL;
413 414 415

  XSETBUFFER (buffer, b);

416
  for (; list; list = list->next)
417 418
    {
      Lisp_Object overlay, start, end, old_overlay;
419
      ptrdiff_t charpos;
420

421
      XSETMISC (old_overlay, list);
422 423
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
424
      Fset_marker (start, make_number (charpos), buffer);
425 426 427 428 429
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
430
      Fset_marker (end, make_number (charpos), buffer);
431 432 433 434 435 436 437 438
      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));
439
      XOVERLAY (overlay)->next = NULL;
440

441 442 443 444
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
445 446
    }

447
  return result;
448
}
449

450

451 452 453 454 455 456 457 458
/* 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
459
clone_per_buffer_values (struct buffer *from, struct buffer *to)
460 461 462
{
  int offset;

463
  FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
464 465 466
    {
      Lisp_Object obj;

467 468 469 470
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

471
      obj = PER_BUFFER_VALUE (from, offset);
472
      if (MARKERP (obj) && XMARKER (obj)->buffer == from)
473 474
	{
	  struct Lisp_Marker *m = XMARKER (obj);
475 476

	  obj = build_marker (to, m->charpos, m->bytepos);
477 478 479 480 481 482
	  XMARKER (obj)->insertion_type = m->insertion_type;
	}

      PER_BUFFER_VALUE (to, offset) = obj;
    }

483
  memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
484

485 486
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
487

488 489
  /* 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
490
  BVAR (to, local_var_alist) = buffer_lisp_local_variables (from, 1);
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 532 533 534 535 536 537 538 539

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


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

Kenichi Handa's avatar
Kenichi Handa committed
554
  CHECK_STRING (name);
555 556
  buf = Fget_buffer (name);
  if (!NILP (buf))
557
    error ("Buffer name `%s' is in use", SDATA (name));
558

Kenichi Handa's avatar
Kenichi Handa committed
559
  tem = base_buffer;
560 561
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
Kenichi Handa's avatar
Kenichi Handa committed
562
    error ("No such buffer: `%s'", SDATA (tem));
Tom Tromey's avatar
Tom Tromey committed
563
  if (NILP (BVAR (XBUFFER (base_buffer), name)))
Kenichi Handa's avatar
Kenichi Handa committed
564
    error ("Base buffer has been killed");
565

566
  if (SCHARS (name) == 0)
567 568
    error ("Empty string for buffer name is not allowed");

569
  b = allocate_buffer ();
570

571 572 573
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
574 575 576 577

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

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

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

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

  name = Fcopy_sequence (name);
594
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Tom Tromey's avatar
Tom Tromey committed
595
  BVAR (b, name) = name;
596 597

  reset_buffer (b);
598
  reset_buffer_local_variables (b, 1);
599 600 601 602 603

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

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

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

615
      BVAR (b->base_buffer, pt_marker)
616 617 618 619
	= 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);
620

621 622
      BVAR (b->base_buffer, zv_marker)
	= build_marker (b->base_buffer, b->base_buffer->zv, b->base_buffer->zv_byte);
623

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

627 628 629
  if (NILP (clone))
    {
      /* Give the indirect buffer markers for its narrowing.  */
630 631 632
      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
633
      XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
634 635
    }
  else
636 637 638 639
    {
      struct buffer *old_b = current_buffer;

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

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

656
  return buf;
Roland McGrath's avatar
Roland McGrath committed
657 658
}

659 660 661 662 663 664 665 666 667 668 669 670 671 672
/* Mark OV as no longer associated with B.  */

static void
drop_overlay (struct buffer *b, struct Lisp_Overlay *ov)
{
  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);

}

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

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

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

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

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

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

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

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

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

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

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

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

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

774
  /* Reset all (or most) per-buffer variables to their defaults.  */
775
  if (permanent_too)
Tom Tromey's avatar
Tom Tromey committed
776
    BVAR (b, local_var_alist) = Qnil;
777 778
  else
    {
779
      Lisp_Object tmp, prop, last = Qnil;
Tom Tromey's avatar
Tom Tromey committed
780
      for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
781
	if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
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 808
	  {
	    /* 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.  */
809
	else if (NILP (last))
Tom Tromey's avatar
Tom Tromey committed
810
	  BVAR (b, local_var_alist) = XCDR (tmp);
811 812 813 814
	else
	  XSETCDR (last, XCDR (tmp));
    }

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

819
  /* For each slot that has a default value, copy that into the slot.  */
820
  FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
821
    {
822
      int idx = PER_BUFFER_IDX (offset);
823 824
      if ((idx > 0
	   && (permanent_too
825
	       || buffer_permanent_local_flags[idx] == 0)))
826
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
827
    }
Roland McGrath's avatar
Roland McGrath committed
828 829
}