buffer.c 193 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
                 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
5 6 7 8 9

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Roland McGrath's avatar
Roland McGrath committed
22

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

25 26
#include <sys/types.h>
#include <sys/stat.h>
Roland McGrath's avatar
Roland McGrath committed
27
#include <sys/param.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
28
#include <errno.h>
Dave Love's avatar
Dave Love committed
29
#include <stdio.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"
Karl Heuer's avatar
Karl Heuer committed
45
#include "charset.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.  */

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

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 104 105
/* This structure holds the required types for the values in the
   buffer-local slots.  If a slot contains Qnil, then the
   corresponding buffer slot may contain a value of any type.  If a
   slot contains an integer, then prospective values' tags must be
106 107 108 109 110
   equal to that integer (except nil is always allowed).
   When a tag does not match, the function
   buffer_slot_type_mismatch will signal an error.

   If a slot here contains -1, the corresponding variable is read-only.  */
111 112
struct buffer buffer_local_types;

113 114
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
115
static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
116 117 118

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

119
int last_per_buffer_idx;
120

Roland McGrath's avatar
Roland McGrath committed
121
Lisp_Object Fset_buffer ();
Roland McGrath's avatar
Roland McGrath committed
122
void set_buffer_internal ();
123
void set_buffer_internal_1 ();
124
static void call_overlay_mod_hooks ();
125
static void swap_out_buffer_local_variables ();
126
static void reset_buffer_local_variables ();
Roland McGrath's avatar
Roland McGrath committed
127 128 129 130 131 132 133

/* 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. */
134 135
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
136

137 138
Lisp_Object Vtransient_mark_mode;

139 140 141 142 143
/* 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;

144 145 146
/* 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;
147
Lisp_Object Qkill_buffer_query_functions;
148

149 150 151
/* Hook run before changing a major mode.  */
Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;

Jim Blandy's avatar
Jim Blandy committed
152 153
/* List of functions to call before changing an unmodified buffer.  */
Lisp_Object Vfirst_change_hook;
154

Jim Blandy's avatar
Jim Blandy committed
155
Lisp_Object Qfirst_change_hook;
156 157
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Dave Love's avatar
Dave Love committed
158
Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
159

160 161 162
/* If nonzero, all modification hooks are suppressed.  */
int inhibit_modification_hooks;

Roland McGrath's avatar
Roland McGrath committed
163 164 165 166 167 168 169 170
Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;

Lisp_Object Qprotected_field;

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

Lisp_Object Qkill_buffer_hook;

Richard M. Stallman's avatar
Richard M. Stallman committed
171 172
Lisp_Object Qget_file_buffer;

Jim Blandy's avatar
Jim Blandy committed
173 174
Lisp_Object Qoverlayp;

175
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
176

177 178 179 180
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

181 182
static void alloc_buffer_text P_ ((struct buffer *, size_t));
static void free_buffer_text P_ ((struct buffer *b));
183
static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
184
static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
185
static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
186 187


Roland McGrath's avatar
Roland McGrath committed
188 189 190
/* For debugging; temporary.  See set_buffer_internal.  */
/* Lisp_Object Qlisp_mode, Vcheck_symbol; */

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

210
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
211
       doc: /* Return a list of all existing live buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
212 213 214
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.  */)
215
     (frame)
216
     Lisp_Object frame;
Roland McGrath's avatar
Roland McGrath committed
217
{
218
  Lisp_Object general;
219 220 221 222
  general = Fmapcar (Qcdr, Vbuffer_alist);

  if (FRAMEP (frame))
    {
223 224
      Lisp_Object framelist, prevlist, tail;
      Lisp_Object args[3];
225

226
      CHECK_FRAME (frame);
227 228

      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
229
      prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
230

231 232
      /* Remove from GENERAL any buffer that duplicates one in
         FRAMELIST or PREVLIST.  */
233
      tail = framelist;
234
      while (CONSP (tail))
235
	{
236 237
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
238
	}
239 240 241 242 243 244 245 246 247 248 249
      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);
250 251 252
    }

  return general;
Roland McGrath's avatar
Roland McGrath committed
253 254
}

255 256 257 258 259 260 261 262 263 264
/* 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;
265
  for (tail = list; CONSP (tail); tail = XCDR (tail))
266 267
    {
      register Lisp_Object elt, tem;
268
      elt = XCAR (tail);
269 270 271 272 273 274 275
      tem = Fstring_equal (Fcar (elt), key);
      if (!NILP (tem))
	return elt;
    }
  return Qnil;
}

Roland McGrath's avatar
Roland McGrath committed
276
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
277
       doc: /* Return the buffer named NAME (a string).
Pavel Janík's avatar
Pavel Janík committed
278
If there is no live buffer named NAME, return nil.
279 280
NAME may also be a buffer; if so, the value is that buffer.  */)
     (name)
Roland McGrath's avatar
Roland McGrath committed
281 282
     register Lisp_Object name;
{
283
  if (BUFFERP (name))
Roland McGrath's avatar
Roland McGrath committed
284
    return name;
285
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
286

287
  return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
288 289 290
}

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

301
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
302 303
  filename = Fexpand_file_name (filename, Qnil);

Richard M. Stallman's avatar
Richard M. Stallman committed
304 305
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
306
  handler = Ffind_file_name_handler (filename, Qget_file_buffer);
Richard M. Stallman's avatar
Richard M. Stallman committed
307 308 309
  if (!NILP (handler))
    return call2 (handler, Qget_file_buffer, filename);

310
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
311
    {
312
      buf = Fcdr (XCAR (tail));
313 314
      if (!BUFFERP (buf)) continue;
      if (!STRINGP (XBUFFER (buf)->filename)) continue;
Roland McGrath's avatar
Roland McGrath committed
315
      tem = Fstring_equal (XBUFFER (buf)->filename, filename);
Jim Blandy's avatar
Jim Blandy committed
316
      if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
317 318 319 320 321
	return buf;
    }
  return Qnil;
}

322 323 324 325 326 327
Lisp_Object
get_truename_buffer (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;

328
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
329
    {
330
      buf = Fcdr (XCAR (tail));
331 332 333 334 335 336 337 338 339
      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
340 341 342 343
/* 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,
344
       doc: /* Return the buffer named NAME, or create such a buffer and return it.
Pavel Janík's avatar
Pavel Janík committed
345 346 347
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.
348 349
The value is never nil.  */)
     (name)
Roland McGrath's avatar
Roland McGrath committed
350 351
     register Lisp_Object name;
{
352
  register Lisp_Object buf;
Roland McGrath's avatar
Roland McGrath committed
353 354 355
  register struct buffer *b;

  buf = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
356
  if (!NILP (buf))
Roland McGrath's avatar
Roland McGrath committed
357 358
    return buf;

359
  if (SCHARS (name) == 0)
360 361
    error ("Empty string for buffer name is not allowed");

362
  b = (struct buffer *) allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
363

364 365 366 367 368 369
  b->size = sizeof (struct buffer) / sizeof (EMACS_INT);

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

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

400 401 402
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
403
  b->prevent_redisplay_optimizations_p = 1;
404

Roland McGrath's avatar
Roland McGrath committed
405 406 407 408
  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

409 410 411 412 413
  /* 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;
414 415

  name = Fcopy_sequence (name);
416
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Roland McGrath's avatar
Roland McGrath committed
417
  b->name = name;
418

419
  if (SREF (name, 0) != ' ')
Roland McGrath's avatar
Roland McGrath committed
420 421 422 423 424
    b->undo_list = Qnil;
  else
    b->undo_list = Qt;

  reset_buffer (b);
425
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
426

427
  b->mark = Fmake_marker ();
428
  BUF_MARKERS (b) = NULL;
429 430
  b->name = name;

Roland McGrath's avatar
Roland McGrath committed
431
  /* Put this in the alist of all live buffers.  */
432
  XSETPVECTYPE (b, PVEC_BUFFER);
433
  XSETBUFFER (buf, b);
Roland McGrath's avatar
Roland McGrath committed
434 435
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));

Juanma Barranquero's avatar
Juanma Barranquero committed
436
  /* An error in calling the function here (should someone redefine it)
Dave Love's avatar
Dave Love committed
437 438
     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
439
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
Dave Love's avatar
Dave Love committed
440
    /* buf is on buffer-alist, so no gcpro.  */
Dave Love's avatar
Dave Love committed
441 442
    call1 (Qucs_set_table_for_input, buf);

443 444 445
  return buf;
}

446

447 448 449
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

450
static struct Lisp_Overlay *
451 452
copy_overlays (b, list)
     struct buffer *b;
453
     struct Lisp_Overlay *list;
454
{
455 456
  Lisp_Object buffer;
  struct Lisp_Overlay *result = NULL, *tail = NULL;
457 458 459

  XSETBUFFER (buffer, b);

460
  for (; list; list = list->next)
461 462
    {
      Lisp_Object overlay, start, end, old_overlay;
463
      EMACS_INT charpos;
464

465
      XSETMISC (old_overlay, list);
466 467
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
468
      Fset_marker (start, make_number (charpos), buffer);
469 470 471 472 473
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
474
      Fset_marker (end, make_number (charpos), buffer);
475 476 477 478 479 480 481 482
      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));
483
      XOVERLAY (overlay)->next = NULL;
484

485 486 487 488
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
489 490
    }

491
  return result;
492
}
493

494

495 496 497 498 499 500 501 502 503 504 505
/* 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;
{
506
  Lisp_Object to_buffer;
507 508 509
  int offset;

  XSETBUFFER (to_buffer, to);
510

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
  for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
       offset < sizeof *to;
       offset += sizeof (Lisp_Object))
    {
      Lisp_Object obj;

      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);
530

531 532
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
533

534 535 536
  /* 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);
537 538 539 540
}

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

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

559
  tem = base_buffer;
560 561
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
562 563 564
    error ("No such buffer: `%s'", SDATA (tem));
  if (NILP (XBUFFER (base_buffer)->name))
    error ("Base buffer has been killed");
565

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

569
  b = (struct buffer *) allocate_buffer ();
570
  b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
571
  XSETPVECTYPE (b, PVEC_BUFFER);
572 573 574 575 576 577 578 579 580 581 582 583

  if (XBUFFER (base_buffer)->base_buffer)
    b->base_buffer = XBUFFER (base_buffer)->base_buffer;
  else
    b->base_buffer = XBUFFER (base_buffer);

  /* 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);
584 585 586
  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);
587 588 589 590 591 592 593 594 595 596

  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);
597
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
598 599 600
  b->name = name;

  reset_buffer (b);
601
  reset_buffer_local_variables (b, 1);
602 603 604 605 606 607

  /* 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
608
  b->name = name;
609

610 611 612
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

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

637 638 639 640 641 642 643 644 645 646 647 648
  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
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
    {
      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);
    }
664

665
  return buf;
Roland McGrath's avatar
Roland McGrath committed
666 667
}

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
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);
}

692
/* Reinitialize everything about a buffer except its name and contents
693
   and local variables.
694 695 696 697
   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
698 699 700 701 702 703

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

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
732 733
}

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

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

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

  /* 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;
759 760 761 762 763 764 765 766

  /* If the standard case table has been altered and invalidated,
     fix up its insides first.  */
  if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
	 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
	 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
    Fset_standard_case_table (Vascii_downcase_table);

Roland McGrath's avatar
Roland McGrath committed
767
  b->downcase_table = Vascii_downcase_table;
768 769 770
  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];
771
  b->invisibility_spec = Qt;
772 773 774
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
775

776
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
777
  b->local_var_alist = Qnil;
778
  for (i = 0; i < last_per_buffer_idx; ++i)
779
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
780
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
781 782 783 784

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

785
  for (offset = PER_BUFFER_VAR_OFFSET (name);
786 787
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
788
    {
789
      int idx = PER_BUFFER_IDX (offset);
790 791 792 793 794
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
795
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
796
    }
Roland McGrath's avatar
Roland McGrath committed
797 798
}

Roland McGrath's avatar
Roland McGrath committed
799 800 801 802 803
/* 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,
804
       1, 2, 0,
805
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
806 807
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
808
\(starting at 2) until an unused name is found, and then return that name.
Juanma Barranquero's avatar
Juanma Barranquero committed
809 810
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.  */)
811
     (name, ignore)
812
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
813 814 815 816 817
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

818
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
819

820 821 822
  tem = Fstring_equal (name, ignore);
  if (!NILP (tem))
    return name;
Roland McGrath's avatar
Roland McGrath committed
823
  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
824
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
825
    return name;
Roland McGrath's avatar
Roland McGrath committed
826 827 828 829 830 831

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
832
      tem = Fstring_equal (gentemp, ignore);
833 834
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
835
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
836
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
837
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
838 839 840 841 842
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
843 844 845
       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
846 847
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
848
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
849
    return current_buffer->name;
850
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
851 852 853 854
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
855 856 857
       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
858 859
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
860
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
861
    return current_buffer->filename;
862
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
863 864 865
  return XBUFFER (buffer)->filename;
}

866 867
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
868
       doc: /* Return the base buffer of indirect buffer BUFFER.
869 870
If BUFFER is not indirect, return nil.
BUFFER defaults to the current buffer.  */)
871
     (buffer)
872 873 874 875 876 877 878 879 880
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
881
      CHECK_BUFFER (buffer);
882 883 884 885 886 887 888 889 890
      base = XBUFFER (buffer)->base_buffer;
    }

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

891
DEFUN ("buffer-local-value", Fbuffer_local_value,
892
       Sbuffer_local_value, 2, 2, 0,
893 894
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value
895 896 897
is the default binding of the variable. */)
     (variable, buffer)
     register Lisp_Object variable;
898 899 900 901 902
     register Lisp_Object buffer;
{
  register struct buffer *buf;
  register Lisp_Object result;

903
  CHECK_SYMBOL (variable);