buffer.c 198 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-2011  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

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

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

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

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
57
DECL_ALIGN (struct buffer, buffer_defaults);
Roland McGrath's avatar
Roland McGrath committed
58 59 60 61 62 63 64 65 66 67 68

/* 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,
69 70
   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
71 72 73 74 75 76 77 78 79 80 81 82 83

   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
84 85
DECL_ALIGN (struct buffer, buffer_local_symbols);

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

89 90 91 92 93 94
/* 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))

95 96
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
97
static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
98 99 100

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

101
int last_per_buffer_idx;
102

103 104
static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
static Lisp_Object Fdelete_overlay (Lisp_Object);
105 106 107 108 109
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
110 111 112 113 114 115

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

116
static Lisp_Object Qkill_buffer_query_functions;
117

118
/* Hook run before changing a major mode.  */
119
static Lisp_Object Qchange_major_mode_hook;
120

Jim Blandy's avatar
Jim Blandy committed
121
Lisp_Object Qfirst_change_hook;
122 123
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
124
static Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
125

126 127
static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
static Lisp_Object Qpermanent_local_hook;
Roland McGrath's avatar
Roland McGrath committed
128

129
static Lisp_Object Qprotected_field;
Roland McGrath's avatar
Roland McGrath committed
130

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

133
static Lisp_Object Qkill_buffer_hook;
134
static Lisp_Object Qbuffer_list_update_hook;
Roland McGrath's avatar
Roland McGrath committed
135

136
static Lisp_Object Qget_file_buffer;
Richard M. Stallman's avatar
Richard M. Stallman committed
137

138
static Lisp_Object Qoverlayp;
Jim Blandy's avatar
Jim Blandy committed
139

140
Lisp_Object Qpriority, Qbefore_string, Qafter_string;
141

142
static Lisp_Object Qevaporate;
143

144 145 146 147
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

148 149 150 151 152
static void alloc_buffer_text (struct buffer *, size_t);
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 *);
153

Roland McGrath's avatar
Roland McGrath committed
154 155 156
/* For debugging; temporary.  See set_buffer_internal.  */
/* Lisp_Object Qlisp_mode, Vcheck_symbol; */

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

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

  if (FRAMEP (frame))
    {
186 187
      Lisp_Object framelist, prevlist, tail;
      Lisp_Object args[3];
188

189
      CHECK_FRAME (frame);
190
      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
191 192
      prevlist = Fnreverse (Fcopy_sequence
			    (XFRAME (frame)->buried_buffer_list));
193

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

218 219 220 221 222
/* Like Fassoc, but use Fstring_equal to compare
   (which ignores text properties),
   and don't ever QUIT.  */

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

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

248
  return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
249 250 251
}

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

261
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
262 263
  filename = Fexpand_file_name (filename, Qnil);

Richard M. Stallman's avatar
Richard M. Stallman committed
264 265
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
266
  handler = Ffind_file_name_handler (filename, Qget_file_buffer);
Richard M. Stallman's avatar
Richard M. Stallman committed
267 268 269
  if (!NILP (handler))
    return call2 (handler, Qget_file_buffer, filename);

270
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
271
    {
272
      buf = Fcdr (XCAR (tail));
273
      if (!BUFFERP (buf)) continue;
Tom Tromey's avatar
Tom Tromey committed
274 275
      if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
      tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
Jim Blandy's avatar
Jim Blandy committed
276
      if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
277 278 279 280 281
	return buf;
    }
  return Qnil;
}

282
Lisp_Object
283
get_truename_buffer (register Lisp_Object filename)
284 285 286
{
  register Lisp_Object tail, buf, tem;

287
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
288
    {
289
      buf = Fcdr (XCAR (tail));
290
      if (!BUFFERP (buf)) continue;
Tom Tromey's avatar
Tom Tromey committed
291 292
      if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
      tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
293 294 295 296 297 298
      if (!NILP (tem))
	return buf;
    }
  return Qnil;
}

Paul Eggert's avatar
Paul Eggert committed
299
DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
300 301 302 303 304 305 306 307
       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
308
  (register Lisp_Object buffer_or_name)
Roland McGrath's avatar
Roland McGrath committed
309
{
310
  register Lisp_Object buffer, name;
Roland McGrath's avatar
Roland McGrath committed
311 312
  register struct buffer *b;

313 314 315
  buffer = Fget_buffer (buffer_or_name);
  if (!NILP (buffer))
    return buffer;
Roland McGrath's avatar
Roland McGrath committed
316

317
  if (SCHARS (buffer_or_name) == 0)
318 319
    error ("Empty string for buffer name is not allowed");

320
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
321

322 323 324 325
  /* 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
326
  BUF_GAP_SIZE (b) = 20;
327
  BLOCK_INPUT;
Karl Heuer's avatar
Karl Heuer committed
328 329
  /* We allocate extra 1-byte at the tail and keep it always '\0' for
     anchoring a search.  */
330
  alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
331
  UNBLOCK_INPUT;
Roland McGrath's avatar
Roland McGrath committed
332
  if (! BUF_BEG_ADDR (b))
Paul Eggert's avatar
Paul Eggert committed
333
    buffer_memory_full (BUF_GAP_SIZE (b) + 1);
Roland McGrath's avatar
Roland McGrath committed
334

335 336 337 338 339 340 341
  b->pt = BEG;
  b->begv = BEG;
  b->zv = BEG;
  b->pt_byte = BEG_BYTE;
  b->begv_byte = BEG_BYTE;
  b->zv_byte = BEG_BYTE;

342 343
  BUF_GPT (b) = BEG;
  BUF_GPT_BYTE (b) = BEG_BYTE;
344 345

  BUF_Z (b) = BEG;
346
  BUF_Z_BYTE (b) = BEG_BYTE;
Roland McGrath's avatar
Roland McGrath committed
347
  BUF_MODIFF (b) = 1;
348
  BUF_CHARS_MODIFF (b) = 1;
349
  BUF_OVERLAY_MODIFF (b) = 1;
350 351
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
352 353 354 355
  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
356
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
Roland McGrath's avatar
Roland McGrath committed
357

358 359
  b->newline_cache = 0;
  b->width_run_cache = 0;
Tom Tromey's avatar
Tom Tromey committed
360
  BVAR (b, width_table) = Qnil;
361
  b->prevent_redisplay_optimizations_p = 1;
362

Roland McGrath's avatar
Roland McGrath committed
363
  /* Put this on the chain of all buffers including killed ones.  */
364
  b->header.next.buffer = all_buffers;
Roland McGrath's avatar
Roland McGrath committed
365 366
  all_buffers = b;

367 368
  /* An ordinary buffer normally doesn't need markers
     to handle BEGV and ZV.  */
Tom Tromey's avatar
Tom Tromey committed
369 370 371
  BVAR (b, pt_marker) = Qnil;
  BVAR (b, begv_marker) = Qnil;
  BVAR (b, zv_marker) = Qnil;
372

373
  name = Fcopy_sequence (buffer_or_name);
374
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Tom Tromey's avatar
Tom Tromey committed
375
  BVAR (b, name) = name;
376

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

  reset_buffer (b);
380
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
381

Tom Tromey's avatar
Tom Tromey committed
382
  BVAR (b, mark) = Fmake_marker ();
383
  BUF_MARKERS (b) = NULL;
Tom Tromey's avatar
Tom Tromey committed
384
  BVAR (b, name) = name;
385

Roland McGrath's avatar
Roland McGrath committed
386
  /* Put this in the alist of all live buffers.  */
387 388
  XSETBUFFER (buffer, b);
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
389 390 391
  /* And run buffer-list-update-hook.  */
  if (!NILP (Vrun_hooks))
    call1 (Vrun_hooks, Qbuffer_list_update_hook);
Roland McGrath's avatar
Roland McGrath committed
392

Juanma Barranquero's avatar
Juanma Barranquero committed
393
  /* An error in calling the function here (should someone redefine it)
Dave Love's avatar
Dave Love committed
394 395
     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
396
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
397 398
    /* buffer is on buffer-alist, so no gcpro.  */
    call1 (Qucs_set_table_for_input, buffer);
Dave Love's avatar
Dave Love committed
399

400
  return buffer;
401 402
}

403

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

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

  XSETBUFFER (buffer, b);

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

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

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

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

446
  return result;
447
}
448

449

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

  XSETBUFFER (to_buffer, to);
464

465 466
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
467
  for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
468 469 470 471 472
       offset < sizeof *to;
       offset += sizeof (Lisp_Object))
    {
      Lisp_Object obj;

473 474 475 476
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

477
      obj = PER_BUFFER_VALUE (from, offset);
478
      if (MARKERP (obj) && XMARKER (obj)->buffer == from)
479 480 481 482 483 484 485 486 487 488
	{
	  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;
    }

489
  memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
490

491 492
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
493

494 495
  /* 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
496
  BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
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 540 541 542 543 544 545

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


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

Kenichi Handa's avatar
Kenichi Handa committed
560
  CHECK_STRING (name);
561 562
  buf = Fget_buffer (name);
  if (!NILP (buf))
563
    error ("Buffer name `%s' is in use", SDATA (name));
564

Kenichi Handa's avatar
Kenichi Handa committed
565
  tem = base_buffer;
566 567
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
Kenichi Handa's avatar
Kenichi Handa committed
568
    error ("No such buffer: `%s'", SDATA (tem));
Tom Tromey's avatar
Tom Tromey committed
569
  if (NILP (BVAR (XBUFFER (base_buffer), name)))
Kenichi Handa's avatar
Kenichi Handa committed
570
    error ("Base buffer has been killed");
571

572
  if (SCHARS (name) == 0)
573 574
    error ("Empty string for buffer name is not allowed");

575
  b = allocate_buffer ();
576

577 578 579
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
580 581 582 583

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

584 585 586 587 588 589
  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;
590 591 592

  b->newline_cache = 0;
  b->width_run_cache = 0;
Tom Tromey's avatar
Tom Tromey committed
593
  BVAR (b, width_table) = Qnil;
594 595

  /* Put this on the chain of all buffers including killed ones.  */
596
  b->header.next.buffer = all_buffers;
597 598 599
  all_buffers = b;

  name = Fcopy_sequence (name);
600
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Tom Tromey's avatar
Tom Tromey committed
601
  BVAR (b, name) = name;
602 603

  reset_buffer (b);
604
  reset_buffer_local_variables (b, 1);
605 606 607 608 609

  /* 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
610 611
  BVAR (b, mark) = Fmake_marker ();
  BVAR (b, name) = name;
612

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

616
  /* Make sure the base buffer has markers for its narrowing.  */
Tom Tromey's avatar
Tom Tromey committed
617
  if (NILP (BVAR (b->base_buffer, pt_marker)))
618
    {
619 620
      eassert (NILP (BVAR (b->base_buffer, begv_marker)));
      eassert (NILP (BVAR (b->base_buffer, zv_marker)));
621

Tom Tromey's avatar
Tom Tromey committed
622 623
      BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
      set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
624 625 626
		       b->base_buffer->pt,
		       b->base_buffer->pt_byte);

Tom Tromey's avatar
Tom Tromey committed
627 628
      BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
      set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
629 630 631
		       b->base_buffer->begv,
		       b->base_buffer->begv_byte);

Tom Tromey's avatar
Tom Tromey committed
632 633
      BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
      set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
634 635
		       b->base_buffer->zv,
		       b->base_buffer->zv_byte);
Tom Tromey's avatar
Tom Tromey committed
636
      XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
637 638
    }

639 640 641
  if (NILP (clone))
    {
      /* Give the indirect buffer markers for its narrowing.  */
Tom Tromey's avatar
Tom Tromey committed
642
      BVAR (b, pt_marker) = Fmake_marker ();
643
      set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
Tom Tromey's avatar
Tom Tromey committed
644
      BVAR (b, begv_marker) = Fmake_marker ();
645
      set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
Tom Tromey's avatar
Tom Tromey committed
646
      BVAR (b, zv_marker) = Fmake_marker ();
647
      set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
Tom Tromey's avatar
Tom Tromey committed
648
      XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
649 650
    }
  else
651 652 653 654
    {
      struct buffer *old_b = current_buffer;

      clone_per_buffer_values (b->base_buffer, b);
Tom Tromey's avatar
Tom Tromey committed
655 656 657 658 659
      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;
660 661 662 663 664 665
      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);
    }
666

667 668 669 670
  /* Run buffer-list-update-hook.  */
  if (!NILP (Vrun_hooks))
    call1 (Vrun_hooks, Qbuffer_list_update_hook);

671
  return buf;
Roland McGrath's avatar
Roland McGrath committed
672 673
}

674
void
675
delete_all_overlays (struct buffer *b)
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
{
  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);
}

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

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

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
737 738
}

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

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

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

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

  /* 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
770 771 772 773 774
  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;
775

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

817
  for (i = 0; i < last_per_buffer_idx; ++i)
818
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
819
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
820 821 822 823

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

824 825 826
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
  for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
827 828
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
829
    {
830
      int idx = PER_BUFFER_IDX (offset);
831 832
      if ((idx > 0
	   && (permanent_too
833
	       || buffer_permanent_local_flags[idx] == 0)))
834
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
835
    }
Roland McGrath's avatar
Roland McGrath committed
836 837
}

Roland McGrath's avatar
Roland McGrath committed
838 839 840 841
/* We split this away from generate-new-buffer, because rename-buffer
   and set-visited-file-name ought to be able to use this to really
   rename the buffer properly.  */

Paul Eggert's avatar
Paul Eggert committed
842
DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
843
       Sgenerate_new_buffer_name, 1,