buffer.c 200 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,
4
                 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
5
                 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>
29
#include <setjmp.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
30

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


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

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

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

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

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

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

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 115 116 117
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
118 119 120 121 122 123 124

/* 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. */
125 126
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
127

128 129
Lisp_Object Vtransient_mark_mode;

130 131 132 133 134
/* 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;

135 136 137
/* 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;
138
Lisp_Object Qkill_buffer_query_functions;
139

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

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

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

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

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

Lisp_Object Qprotected_field;

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

Lisp_Object Qkill_buffer_hook;

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

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

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

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

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

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

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

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

203
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
204
       doc: /* Return a list of all existing live buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
205 206 207
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.  */)
208
     (frame)
209
     Lisp_Object frame;
Roland McGrath's avatar
Roland McGrath committed
210
{
211
  Lisp_Object general;
212 213 214 215
  general = Fmapcar (Qcdr, Vbuffer_alist);

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

219
      CHECK_FRAME (frame);
220 221

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

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

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

248 249 250 251 252 253 254 255 256 257
/* 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;
258
  for (tail = list; CONSP (tail); tail = XCDR (tail))
259 260
    {
      register Lisp_Object elt, tem;
261
      elt = XCAR (tail);
262 263 264 265 266 267 268
      tem = Fstring_equal (Fcar (elt), key);
      if (!NILP (tem))
	return elt;
    }
  return Qnil;
}

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

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

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

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

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

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

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

322
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
323
    {
324
      buf = Fcdr (XCAR (tail));
325 326 327 328 329 330 331 332 333
      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
334 335 336 337
/* 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,
338 339 340 341 342 343 344 345 346 347
       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.  */)
     (buffer_or_name)
     register Lisp_Object buffer_or_name;
Roland McGrath's avatar
Roland McGrath committed
348
{
349
  register Lisp_Object buffer, name;
Roland McGrath's avatar
Roland McGrath committed
350 351
  register struct buffer *b;

352 353 354
  buffer = Fget_buffer (buffer_or_name);
  if (!NILP (buffer))
    return buffer;
Roland McGrath's avatar
Roland McGrath committed
355

356
  if (SCHARS (buffer_or_name) == 0)
357 358
    error ("Empty string for buffer name is not allowed");

359
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
360

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

374 375 376 377 378 379 380 381 382 383
  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
384
  BUF_MODIFF (b) = 1;
385
  BUF_CHARS_MODIFF (b) = 1;
386
  BUF_OVERLAY_MODIFF (b) = 1;
387 388
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
389 390 391 392
  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
393
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
Roland McGrath's avatar
Roland McGrath committed
394

395 396 397
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
398
  b->prevent_redisplay_optimizations_p = 1;
399

Roland McGrath's avatar
Roland McGrath committed
400 401 402 403
  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

404 405 406 407 408
  /* 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;
409

410
  name = Fcopy_sequence (buffer_or_name);
411
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Roland McGrath's avatar
Roland McGrath committed
412
  b->name = name;
413

414
  b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
Roland McGrath's avatar
Roland McGrath committed
415 416

  reset_buffer (b);
417
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
418

419
  b->mark = Fmake_marker ();
420
  BUF_MARKERS (b) = NULL;
421 422
  b->name = name;

Roland McGrath's avatar
Roland McGrath committed
423
  /* Put this in the alist of all live buffers.  */
424 425
  XSETBUFFER (buffer, b);
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
Roland McGrath's avatar
Roland McGrath committed
426

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

434
  return buffer;
435 436
}

437

438 439 440
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

441
static struct Lisp_Overlay *
442 443
copy_overlays (b, list)
     struct buffer *b;
444
     struct Lisp_Overlay *list;
445
{
446 447
  Lisp_Object buffer;
  struct Lisp_Overlay *result = NULL, *tail = NULL;
448 449 450

  XSETBUFFER (buffer, b);

451
  for (; list; list = list->next)
452 453
    {
      Lisp_Object overlay, start, end, old_overlay;
454
      EMACS_INT charpos;
455

456
      XSETMISC (old_overlay, list);
457 458
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
459
      Fset_marker (start, make_number (charpos), buffer);
460 461 462 463 464
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

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

476 477 478 479
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
480 481
    }

482
  return result;
483
}
484

485

486 487 488 489 490 491 492 493 494 495 496
/* 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;
{
497
  Lisp_Object to_buffer;
498 499 500
  int offset;

  XSETBUFFER (to_buffer, to);
501

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

510 511 512 513
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

514 515 516 517 518 519 520 521 522 523 524 525 526
      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);
527

528 529
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
530

531 532 533
  /* 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);
534 535 536 537
}

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

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

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

563
  if (SCHARS (name) == 0)
564 565
    error ("Empty string for buffer name is not allowed");

566
  b = allocate_buffer ();
567

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

  /* 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);
578 579 580
  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);
581 582 583 584 585 586 587 588 589 590

  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);
591
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
592 593 594
  b->name = name;

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

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

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

604 605 606
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

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

631 632 633 634 635 636 637 638 639 640 641 642
  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
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
    {
      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);
    }
658

659
  return buf;
Roland McGrath's avatar
Roland McGrath committed
660 661
}

662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
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);
}

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

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

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
726 727
}

728 729 730
/* 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.
731 732
   Instead, use Fkill_all_local_variables.

733
   If PERMANENT_TOO is 1, then we reset permanent
734 735
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
736

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

  /* 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;
753 754 755 756 757 758 759 760

  /* 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
761
  b->downcase_table = Vascii_downcase_table;
762 763 764
  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];
765
  b->invisibility_spec = Qt;
766 767 768
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
769

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

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

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

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

Roland McGrath's avatar
Roland McGrath committed
836 837 838 839 840
/* 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,
841
       1, 2, 0,
842
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
843 844
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
845
\(starting at 2) until an unused name is found, and then return that name.
Juanma Barranquero's avatar
Juanma Barranquero committed
846 847
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.  */)
848
     (name, ignore)
849
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
850 851 852 853 854
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

855
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
856

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

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


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
880
       doc: /* Return the name of BUFFER, as a string.
881 882
BUFFER defaults to the current buffer.
Return nil if BUFFER has been killed.  */)
883
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
884 885
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
886
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
887
    return current_buffer->name;
888
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
889 890 891 892
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
893 894 895
       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
896 897
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
898
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
899
    return current_buffer->filename;
900
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
901 902 903
  return XBUFFER (buffer)->filename;
}

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

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
919
      CHECK_BUFFER (buffer);
920 921 922 923 924 925 926 927 928
      base = XBUFFER (buffer)->base_buffer;
    }

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

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

942
  CHECK_SYMBOL (variable);
943
  CHECK_BUFFER (buffer);
944 945
  buf = XBUFFER (buffer);

Stefan Monnier's avatar
Stefan Monnier committed
946 947
  sym = indirect_variable (XSYMBOL (variable));
  XSETSYMBOL (variable, sym);
948

949
  /* Look in local_var_list */
950
  result = Fassoc (variable, buf->local_var_alist);
951
  if (NILP (result))
952 953 954 955 956
    {
      int offset, idx;
      int found = 0;

      /* Look in special slots */
957 958 959
      /* 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);
960 961 962 963 964 965
	   offset < sizeof (struct buffer);
	   /* sizeof EMACS_INT == sizeof Lisp_Object */
	   offset += (sizeof (EMACS_INT)))
	{
	  idx = PER_BUFFER_IDX (offset);
	  if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
966
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset))
967
	      && EQ (PER_BUFFER_SYMBOL (offset), variable))
968 969 970 971 972 973 974 975
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
976
	result = Fdefault_value (variable);
977 978
    }
  else
979 980 981 982 983
    {
      Lisp_Object valcontents;
      Lisp_Object current_alist_element;

      /* What binding is loaded right now?  */
Stefan Monnier's avatar
Stefan Monnier committed
984
      valcontents = sym->value;
985 986 987 988 989 990 991 992 993 994 995 996 997 998
      current_alist_element
	= XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);

      /* The value of the currently loaded binding is not
	 stored in it, but rather in the realvalue slot.
	 Store that value into the binding it belongs to
	 in case that is the one we are about to use.  */

      Fsetcdr (current_alist_element,
	       do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));

      /* Now get the (perhaps updated) value out of the binding.  */
      result = XCDR (result);
    }
999

1000 1001
  if (!EQ (result, Qunbound))
    return result;