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, 1986, 1987, 1988, 1989, 1993, 1994,
                 1995, 1997, 1998, 1999, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
4 5
                 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
6 7 8

This file is part of GNU Emacs.

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

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Roland McGrath's avatar
Roland McGrath committed
21

22
#include <config.h>
Roland McGrath's avatar
Roland McGrath committed
23

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>
Richard M. Stallman's avatar
Richard M. Stallman committed
29

30
#ifndef USE_CRT_DLL
Richard M. Stallman's avatar
Richard M. Stallman committed
31
extern int errno;
32
#endif
Roland McGrath's avatar
Roland McGrath committed
33 34


Andreas Schwab's avatar
Andreas Schwab committed
35 36 37
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
38

Roland McGrath's avatar
Roland McGrath committed
39
#include "lisp.h"
40
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
41 42 43
#include "window.h"
#include "commands.h"
#include "buffer.h"
44
#include "character.h"
45
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
46
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
47
#include "blockinput.h"
48
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
49
#include "keymap.h"
50
#include "frame.h"
Roland McGrath's avatar
Roland McGrath committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

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

/* First buffer in chain of all buffers (in reverse order of creation).
   Threaded through ->next.  */

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
66
DECL_ALIGN (struct buffer, buffer_defaults);
Roland McGrath's avatar
Roland McGrath committed
67 68 69 70 71 72 73 74 75 76 77

/* 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,
78 79
   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
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95

   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 is -2, then there is no DEFVAR_PER_BUFFER for it,
   but there is a default value which is copied into each buffer.

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

Roland McGrath's avatar
Roland McGrath committed
98 99 100
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

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

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

107
int last_per_buffer_idx;
108

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

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

/* Functions to call before and after each text change. */
124 125
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
126

127 128
Lisp_Object Vtransient_mark_mode;

129 130 131 132 133
/* t means ignore all read-only text properties.
   A list means ignore such a property if its value is a member of the list.
   Any non-nil value means ignore buffer-read-only.  */
Lisp_Object Vinhibit_read_only;

134 135 136
/* List of functions to call that can query about killing a buffer.
   If any of these functions returns nil, we don't kill it.  */
Lisp_Object Vkill_buffer_query_functions;
137
Lisp_Object Qkill_buffer_query_functions;
138

139 140 141
/* Hook run before changing a major mode.  */
Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;

Jim Blandy's avatar
Jim Blandy committed
142 143
/* List of functions to call before changing an unmodified buffer.  */
Lisp_Object Vfirst_change_hook;
144

Jim Blandy's avatar
Jim Blandy committed
145
Lisp_Object Qfirst_change_hook;
146 147
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Dave Love's avatar
Dave Love committed
148
Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
149

150 151 152
/* If nonzero, all modification hooks are suppressed.  */
int inhibit_modification_hooks;

Roland McGrath's avatar
Roland McGrath committed
153
Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
154
Lisp_Object Qpermanent_local_hook;
Roland McGrath's avatar
Roland McGrath committed
155 156 157 158 159 160 161

Lisp_Object Qprotected_field;

Lisp_Object QSFundamental;	/* A string "Fundamental" */

Lisp_Object Qkill_buffer_hook;

Richard M. Stallman's avatar
Richard M. Stallman committed
162 163
Lisp_Object Qget_file_buffer;

Jim Blandy's avatar
Jim Blandy committed
164 165
Lisp_Object Qoverlayp;

166
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
167

168 169 170 171
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

172 173
static void alloc_buffer_text P_ ((struct buffer *, size_t));
static void free_buffer_text P_ ((struct buffer *b));
174
static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
175
static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
176
static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
177

Dave Love's avatar
Dave Love committed
178
extern char * emacs_strerror P_ ((int));
179

Roland McGrath's avatar
Roland McGrath committed
180 181 182
/* For debugging; temporary.  See set_buffer_internal.  */
/* Lisp_Object Qlisp_mode, Vcheck_symbol; */

183
void
Roland McGrath's avatar
Roland McGrath committed
184 185 186
nsberror (spec)
     Lisp_Object spec;
{
187
  if (STRINGP (spec))
188
    error ("No buffer named %s", SDATA (spec));
Roland McGrath's avatar
Roland McGrath committed
189 190 191
  error ("Invalid buffer argument");
}

192
DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
193 194 195
       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.  */)
     (object)
196 197 198 199 200 201
     Lisp_Object object;
{
  return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
	  ? Qt : Qnil);
}

202
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
203
       doc: /* Return a list of all existing live buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
204 205 206
If the optional arg FRAME is a frame, we return the buffer list
in the proper order for that frame: the buffers in FRAME's `buffer-list'
frame parameter come first, followed by the rest of the buffers.  */)
207
     (frame)
208
     Lisp_Object frame;
Roland McGrath's avatar
Roland McGrath committed
209
{
210
  Lisp_Object general;
211 212 213 214
  general = Fmapcar (Qcdr, Vbuffer_alist);

  if (FRAMEP (frame))
    {
215 216
      Lisp_Object framelist, prevlist, tail;
      Lisp_Object args[3];
217

218
      CHECK_FRAME (frame);
219 220

      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
221
      prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
222

223 224
      /* Remove from GENERAL any buffer that duplicates one in
         FRAMELIST or PREVLIST.  */
225
      tail = framelist;
226
      while (CONSP (tail))
227
	{
228 229
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
230
	}
231 232 233 234 235 236 237 238 239 240 241
      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);
242 243 244
    }

  return general;
Roland McGrath's avatar
Roland McGrath committed
245 246
}

247 248 249 250 251 252 253 254 255 256
/* Like Fassoc, but use Fstring_equal to compare
   (which ignores text properties),
   and don't ever QUIT.  */

static Lisp_Object
assoc_ignore_text_properties (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
257
  for (tail = list; CONSP (tail); tail = XCDR (tail))
258 259
    {
      register Lisp_Object elt, tem;
260
      elt = XCAR (tail);
261 262 263 264 265 266 267
      tem = Fstring_equal (Fcar (elt), key);
      if (!NILP (tem))
	return elt;
    }
  return Qnil;
}

Roland McGrath's avatar
Roland McGrath committed
268
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
269 270 271 272 273 274
       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.  */)
     (buffer_or_name)
     register Lisp_Object buffer_or_name;
Roland McGrath's avatar
Roland McGrath committed
275
{
276 277 278
  if (BUFFERP (buffer_or_name))
    return buffer_or_name;
  CHECK_STRING (buffer_or_name);
Roland McGrath's avatar
Roland McGrath committed
279

280
  return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
281 282 283
}

DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
284
       doc: /* Return the buffer visiting file FILENAME (a string).
Pavel Janík's avatar
Pavel Janík committed
285 286
The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
If there is no such live buffer, return nil.
287 288
See also `find-buffer-visiting'.  */)
     (filename)
Roland McGrath's avatar
Roland McGrath committed
289 290 291
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;
Richard M. Stallman's avatar
Richard M. Stallman committed
292 293
  Lisp_Object handler;

294
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
295 296
  filename = Fexpand_file_name (filename, Qnil);

Richard M. Stallman's avatar
Richard M. Stallman committed
297 298
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
299
  handler = Ffind_file_name_handler (filename, Qget_file_buffer);
Richard M. Stallman's avatar
Richard M. Stallman committed
300 301 302
  if (!NILP (handler))
    return call2 (handler, Qget_file_buffer, filename);

303
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
304
    {
305
      buf = Fcdr (XCAR (tail));
306 307
      if (!BUFFERP (buf)) continue;
      if (!STRINGP (XBUFFER (buf)->filename)) continue;
Roland McGrath's avatar
Roland McGrath committed
308
      tem = Fstring_equal (XBUFFER (buf)->filename, filename);
Jim Blandy's avatar
Jim Blandy committed
309
      if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
310 311 312 313 314
	return buf;
    }
  return Qnil;
}

315 316 317 318 319 320
Lisp_Object
get_truename_buffer (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;

321
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
322
    {
323
      buf = Fcdr (XCAR (tail));
324 325 326 327 328 329 330 331 332
      if (!BUFFERP (buf)) continue;
      if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
      tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
      if (!NILP (tem))
	return buf;
    }
  return Qnil;
}

Roland McGrath's avatar
Roland McGrath committed
333 334 335 336
/* Incremented for each buffer created, to assign the buffer number. */
int buffer_count;

DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
337
       doc: /* Return the buffer named NAME, or create such a buffer and return it.
Pavel Janík's avatar
Pavel Janík committed
338 339 340
A new buffer is created if there is no live buffer named NAME.
If NAME starts with a space, the new buffer does not keep undo information.
If NAME is a buffer instead of a string, then it is the value returned.
341 342
The value is never nil.  */)
     (name)
Roland McGrath's avatar
Roland McGrath committed
343 344
     register Lisp_Object name;
{
345
  register Lisp_Object buf;
Roland McGrath's avatar
Roland McGrath committed
346 347 348
  register struct buffer *b;

  buf = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
349
  if (!NILP (buf))
Roland McGrath's avatar
Roland McGrath committed
350 351
    return buf;

352
  if (SCHARS (name) == 0)
353 354
    error ("Empty string for buffer name is not allowed");

355
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
356

357 358 359 360
  /* 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
361
  BUF_GAP_SIZE (b) = 20;
362
  BLOCK_INPUT;
Karl Heuer's avatar
Karl Heuer committed
363 364
  /* We allocate extra 1-byte at the tail and keep it always '\0' for
     anchoring a search.  */
365
  alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
366
  UNBLOCK_INPUT;
Roland McGrath's avatar
Roland McGrath committed
367
  if (! BUF_BEG_ADDR (b))
368
    buffer_memory_full ();
Roland McGrath's avatar
Roland McGrath committed
369

370 371 372 373 374 375 376 377 378 379
  BUF_PT (b) = BEG;
  BUF_GPT (b) = BEG;
  BUF_BEGV (b) = BEG;
  BUF_ZV (b) = BEG;
  BUF_Z (b) = BEG;
  BUF_PT_BYTE (b) = BEG_BYTE;
  BUF_GPT_BYTE (b) = BEG_BYTE;
  BUF_BEGV_BYTE (b) = BEG_BYTE;
  BUF_ZV_BYTE (b) = BEG_BYTE;
  BUF_Z_BYTE (b) = BEG_BYTE;
Roland McGrath's avatar
Roland McGrath committed
380
  BUF_MODIFF (b) = 1;
381
  BUF_CHARS_MODIFF (b) = 1;
382
  BUF_OVERLAY_MODIFF (b) = 1;
383 384
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
385 386 387 388
  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
389
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
Roland McGrath's avatar
Roland McGrath committed
390

391 392 393
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
394
  b->prevent_redisplay_optimizations_p = 1;
395

Roland McGrath's avatar
Roland McGrath committed
396 397 398 399
  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

400 401 402 403 404
  /* An ordinary buffer normally doesn't need markers
     to handle BEGV and ZV.  */
  b->pt_marker = Qnil;
  b->begv_marker = Qnil;
  b->zv_marker = Qnil;
405 406

  name = Fcopy_sequence (name);
407
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Roland McGrath's avatar
Roland McGrath committed
408
  b->name = name;
409

410
  b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
Roland McGrath's avatar
Roland McGrath committed
411 412

  reset_buffer (b);
413
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
414

415
  b->mark = Fmake_marker ();
416
  BUF_MARKERS (b) = NULL;
417 418
  b->name = name;

Roland McGrath's avatar
Roland McGrath committed
419
  /* Put this in the alist of all live buffers.  */
420
  XSETBUFFER (buf, b);
Roland McGrath's avatar
Roland McGrath committed
421 422
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));

Juanma Barranquero's avatar
Juanma Barranquero committed
423
  /* An error in calling the function here (should someone redefine it)
Dave Love's avatar
Dave Love committed
424 425
     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
426
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
Dave Love's avatar
Dave Love committed
427
    /* buf is on buffer-alist, so no gcpro.  */
Dave Love's avatar
Dave Love committed
428 429
    call1 (Qucs_set_table_for_input, buf);

430 431 432
  return buf;
}

433

434 435 436
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

437
static struct Lisp_Overlay *
438 439
copy_overlays (b, list)
     struct buffer *b;
440
     struct Lisp_Overlay *list;
441
{
442 443
  Lisp_Object buffer;
  struct Lisp_Overlay *result = NULL, *tail = NULL;
444 445 446

  XSETBUFFER (buffer, b);

447
  for (; list; list = list->next)
448 449
    {
      Lisp_Object overlay, start, end, old_overlay;
450
      EMACS_INT charpos;
451

452
      XSETMISC (old_overlay, list);
453 454
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
455
      Fset_marker (start, make_number (charpos), buffer);
456 457 458 459 460
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
461
      Fset_marker (end, make_number (charpos), buffer);
462 463 464 465 466 467 468 469
      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));
470
      XOVERLAY (overlay)->next = NULL;
471

472 473 474 475
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
476 477
    }

478
  return result;
479
}
480

481

482 483 484 485 486 487 488 489 490 491 492
/* 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
clone_per_buffer_values (from, to)
     struct buffer *from, *to;
{
493
  Lisp_Object to_buffer;
494 495 496
  int offset;

  XSETBUFFER (to_buffer, to);
497

498 499
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
500
  for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
501 502 503 504 505
       offset < sizeof *to;
       offset += sizeof (Lisp_Object))
    {
      Lisp_Object obj;

506 507 508 509
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

510 511 512 513 514 515 516 517 518 519 520 521 522
      obj = PER_BUFFER_VALUE (from, offset);
      if (MARKERP (obj))
	{
	  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;
    }

  bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
523

524 525
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
526

527 528 529
  /* Get (a copy of) the alist of Lisp-level local variables of FROM
     and install that in TO.  */
  to->local_var_alist = buffer_lisp_local_variables (from);
530 531 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 541
CLONE nil means the indirect buffer's state is reset to default values.  */)
     (base_buffer, name, clone)
542
     Lisp_Object base_buffer, name, clone;
543
{
Kenichi Handa's avatar
Kenichi Handa committed
544
  Lisp_Object buf, tem;
545
  struct buffer *b;
546

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

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

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

562
  b = allocate_buffer ();
563

564 565 566
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
567 568 569 570 571 572 573

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

  BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
  BUF_ZV (b) = BUF_ZV (b->base_buffer);
  BUF_PT (b) = BUF_PT (b->base_buffer);
574 575 576
  BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
  BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
  BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
577 578 579 580 581 582 583 584 585 586

  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;

  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

  name = Fcopy_sequence (name);
587
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
588 589 590
  b->name = name;

  reset_buffer (b);
591
  reset_buffer_local_variables (b, 1);
592 593 594 595 596 597

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

  b->mark = Fmake_marker ();
Roland McGrath's avatar
Roland McGrath committed
598
  b->name = name;
599

600 601 602
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

603 604 605 606
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
607 608 609
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
610 611 612 613
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
614 615 616
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
617 618 619 620
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
621 622 623
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
624
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
625 626
    }

627 628 629 630 631 632 633 634 635 636 637 638
  if (NILP (clone))
    {
      /* Give the indirect buffer markers for its narrowing.  */
      b->pt_marker = Fmake_marker ();
      set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
      b->begv_marker = Fmake_marker ();
      set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
      b->zv_marker = Fmake_marker ();
      set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
      XMARKER (b->zv_marker)->insertion_type = 1;
    }
  else
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
    {
      struct buffer *old_b = current_buffer;

      clone_per_buffer_values (b->base_buffer, b);
      b->filename = Qnil;
      b->file_truename = Qnil;
      b->display_count = make_number (0);
      b->backed_up = Qnil;
      b->auto_save_file_name = Qnil;
      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);
    }
654

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

658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
void
delete_all_overlays (b)
     struct buffer *b;
{
  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);
}

682
/* Reinitialize everything about a buffer except its name and contents
Kenichi Handa's avatar
Kenichi Handa committed
683
   and local variables.
684 685 686 687
   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
688 689 690 691 692 693

void
reset_buffer (b)
     register struct buffer *b;
{
  b->filename = Qnil;
694
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
695 696
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
697
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
698
  b->last_window_start = 1;
699
  /* It is more conservative to start out "changed" than "unchanged".  */
700 701
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
702 703
  b->backed_up = Qnil;
  b->auto_save_modified = 0;
704
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
705 706
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
707 708
  b->overlays_before = NULL;
  b->overlays_after = NULL;
709
  b->overlay_center = BEG;
710
  b->mark_active = Qnil;
711
  b->point_before_scroll = Qnil;
712
  b->file_format = Qnil;
713
  b->auto_save_file_format = Qt;
714
  b->last_selected_window = Qnil;
715
  XSETINT (b->display_count, 0);
716
  b->display_time = Qnil;
717
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
718
  b->cursor_type = buffer_defaults.cursor_type;
719
  b->extra_line_spacing = buffer_defaults.extra_line_spacing;
720 721

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
722 723
}

724 725 726
/* 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.
727 728
   Instead, use Fkill_all_local_variables.

729
   If PERMANENT_TOO is 1, then we reset permanent
730 731
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
732

733 734
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
735
     register struct buffer *b;
736
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
737 738
{
  register int offset;
739
  int i;
Roland McGrath's avatar
Roland McGrath committed
740 741 742 743 744 745 746 747 748

  /* 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.  */
  b->major_mode = Qfundamental_mode;
  b->keymap = Qnil;
  b->mode_name = QSFundamental;
  b->minor_modes = Qnil;
749 750 751 752 753 754 755 756

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

Roland McGrath's avatar
Roland McGrath committed
757
  b->downcase_table = Vascii_downcase_table;
758 759 760
  b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
  b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
  b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
761
  b->invisibility_spec = Qt;
762 763 764
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
765

766
  /* Reset all (or most) per-buffer variables to their defaults.  */
767 768 769 770
  if (permanent_too)
    b->local_var_alist = Qnil;
  else
    {
771
      Lisp_Object tmp, prop, last = Qnil;
772 773 774
      for (tmp = b->local_var_alist; CONSP (tmp); tmp = XCDR (tmp))
	if (CONSP (XCAR (tmp))
	    && SYMBOLP (XCAR (XCAR (tmp)))
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
	    && !NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
	  {
	    /* 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.  */
803 804 805 806 807 808
	else if (NILP (last))
	  b->local_var_alist = XCDR (tmp);
	else
	  XSETCDR (last, XCDR (tmp));
    }

809
  for (i = 0; i < last_per_buffer_idx; ++i)
810
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
811
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
812 813 814 815

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

816 817 818
  /* 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);
819 820
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
821
    {
822
      int idx = PER_BUFFER_IDX (offset);
823 824 825 826 827
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
828
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
829
    }
Roland McGrath's avatar
Roland McGrath committed
830 831
}

Roland McGrath's avatar
Roland McGrath committed
832 833 834 835 836
/* 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.  */

DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
837
       1, 2, 0,
838
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
839 840
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
Kenichi Handa's avatar
Kenichi Handa committed
841
\(starting at 2) until an unused name is found, and then return that name.
Juanma Barranquero's avatar
Juanma Barranquero committed
842 843
Optional second argument IGNORE specifies a name that is okay to use (if
it is in the sequence to be tried) even if a buffer with that name exists.  */)
844
     (name, ignore)
845
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
846 847 848 849 850
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

851
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
852

Kenichi Handa's avatar
Kenichi Handa committed
853 854 855
  tem = Fstring_equal (name, ignore);
  if (!NILP (tem))
    return name;
Roland McGrath's avatar
Roland McGrath committed
856
  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
857
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
858
    return name;
Roland McGrath's avatar
Roland McGrath committed
859 860 861 862 863 864

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
865
      tem = Fstring_equal (gentemp, ignore);
866 867
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
868
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
869
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
870
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
871 872 873 874 875
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
876 877 878
       doc: /* Return the name of BUFFER, as a string.
With no argument or nil as argument, return the name of the current buffer.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
879 880
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
881
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
882
    return current_buffer->name;
883
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
884 885 886 887
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
888 889 890
       doc: /* Return name of file BUFFER is visiting, or nil if none.
No argument or nil as argument means use the current buffer.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
891 892
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
893
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
894
    return current_buffer->filename;
895
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
896 897 898
  return XBUFFER (buffer)->filename;
}

899 900
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
901
       doc: /* Return the base buffer of indirect buffer BUFFER.
902 903
If BUFFER is not indirect, return nil.
BUFFER defaults to the current buffer.  */)
904
     (buffer)
905 906 907 908 909 910 911 912 913
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
914
      CHECK_BUFFER (buffer);
915 916 917 918 919 920 921 922 923
      base = XBUFFER (buffer)->base_buffer;
    }

  if (! base)
    return Qnil;
  XSETBUFFER (base_buffer, base);
  return base_buffer;
}

924
DEFUN ("buffer-local-value", Fbuffer_local_value,
925
       Sbuffer_local_value, 2, 2, 0,
926 927
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value
928 929 930
is the default binding of the variable. */)
     (variable, buffer)
     register Lisp_Object variable;
931 932 933 934
     register Lisp_Object buffer;
{
  register struct buffer *buf;
  register Lisp_Object result;
Stefan Monnier's avatar
Stefan Monnier committed
935
  struct Lisp_Symbol *sym;
936

937
  CHECK_SYMBOL (variable);
938
  CHECK_BUFFER (buffer);
939 940
  buf = XBUFFER (buffer);

Stefan Monnier's avatar
Stefan Monnier committed
941 942
  sym = indirect_variable (XSYMBOL (variable));
  XSETSYMBOL (variable, sym);
943

944
  /* Look in local_var_list */
945
  result = Fassoc (variable, buf->local_var_alist);
946
  if (NILP (result))
947 948 949