buffer.c 178 KB
Newer Older
Roland McGrath's avatar
Roland McGrath committed
1
/* Buffer manipulation primitives for GNU Emacs.
2
   Copyright (C) 1985,86,87,88,89,93,94,95,97,98, 1999, 2000, 2001, 02, 2003
3
	Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Roland McGrath's avatar
Roland McGrath committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
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

#ifndef MAXPATHLEN
35
/* in 4.1 [probably SunOS? -stef] , param.h fails to define this. */
Roland McGrath's avatar
Roland McGrath committed
36 37 38
#define MAXPATHLEN 1024
#endif /* not MAXPATHLEN */

Andreas Schwab's avatar
Andreas Schwab committed
39 40 41
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
42

Roland McGrath's avatar
Roland McGrath committed
43
#include "lisp.h"
44
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
45 46 47
#include "window.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
48
#include "charset.h"
49
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
50
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
51
#include "blockinput.h"
52
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
53
#include "keymap.h"
54
#include "frame.h"
Roland McGrath's avatar
Roland McGrath committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

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

struct buffer buffer_defaults;

/* 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,
82 83
   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
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

   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 is negative, then even though there may
   be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
   and the corresponding slot in buffer_defaults is not used.

   If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
   zero, that is a bug */

struct buffer buffer_local_flags;

/* This structure holds the names of symbols whose values may be
   buffer-local.  It is indexed and accessed in the same way as the above. */

struct buffer buffer_local_symbols;
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

108 109 110 111
/* 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
112 113 114 115 116
   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.  */
117 118
struct buffer buffer_local_types;

119 120
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
121
static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
122 123 124

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

125
int last_per_buffer_idx;
126

Roland McGrath's avatar
Roland McGrath committed
127
Lisp_Object Fset_buffer ();
Roland McGrath's avatar
Roland McGrath committed
128
void set_buffer_internal ();
129
void set_buffer_internal_1 ();
130
static void call_overlay_mod_hooks ();
131
static void swap_out_buffer_local_variables ();
132
static void reset_buffer_local_variables ();
Roland McGrath's avatar
Roland McGrath committed
133 134 135 136 137 138 139

/* 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. */
140 141
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
142

143 144
Lisp_Object Vtransient_mark_mode;

145 146 147 148 149
/* 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;

150 151 152
/* 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;
153
Lisp_Object Qkill_buffer_query_functions;
154

Jim Blandy's avatar
Jim Blandy committed
155 156
/* List of functions to call before changing an unmodified buffer.  */
Lisp_Object Vfirst_change_hook;
157

Jim Blandy's avatar
Jim Blandy committed
158
Lisp_Object Qfirst_change_hook;
159 160
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Dave Love's avatar
Dave Love committed
161
Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
162

163 164 165
/* If nonzero, all modification hooks are suppressed.  */
int inhibit_modification_hooks;

Roland McGrath's avatar
Roland McGrath committed
166 167 168 169 170 171 172 173
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
174 175
Lisp_Object Qget_file_buffer;

Jim Blandy's avatar
Jim Blandy committed
176 177
Lisp_Object Qoverlayp;

178
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
179

180 181 182 183
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

184 185
static void alloc_buffer_text P_ ((struct buffer *, size_t));
static void free_buffer_text P_ ((struct buffer *b));
186
static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
187
static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
188 189


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

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

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

  if (FRAMEP (frame))
    {
      Lisp_Object tail;

227
      CHECK_FRAME (frame);
228 229 230 231 232 233 234

      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);

      /* Remove from GENERAL any buffer that duplicates one in FRAMELIST.  */
      tail = framelist;
      while (! NILP (tail))
	{
235 236
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
237 238 239 240 241
	}
      return nconc2 (framelist, general);
    }

  return general;
Roland McGrath's avatar
Roland McGrath committed
242 243
}

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

Roland McGrath's avatar
Roland McGrath committed
265
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
266
       doc: /* Return the buffer named NAME (a string).
Pavel Janík's avatar
Pavel Janík committed
267
If there is no live buffer named NAME, return nil.
268 269
NAME may also be a buffer; if so, the value is that buffer.  */)
     (name)
Roland McGrath's avatar
Roland McGrath committed
270 271
     register Lisp_Object name;
{
272
  if (BUFFERP (name))
Roland McGrath's avatar
Roland McGrath committed
273
    return name;
274
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
275

276
  return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
277 278 279
}

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

290
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
291 292
  filename = Fexpand_file_name (filename, Qnil);

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

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

311 312 313 314 315 316
Lisp_Object
get_truename_buffer (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;

317
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
318
    {
319
      buf = Fcdr (XCAR (tail));
320 321 322 323 324 325 326 327 328
      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
329 330 331 332
/* 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,
333
       doc: /* Return the buffer named NAME, or create such a buffer and return it.
Pavel Janík's avatar
Pavel Janík committed
334 335 336
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.
337 338
The value is never nil.  */)
     (name)
Roland McGrath's avatar
Roland McGrath committed
339 340
     register Lisp_Object name;
{
341
  register Lisp_Object buf;
Roland McGrath's avatar
Roland McGrath committed
342 343 344
  register struct buffer *b;

  buf = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
345
  if (!NILP (buf))
Roland McGrath's avatar
Roland McGrath committed
346 347
    return buf;

348
  if (SCHARS (name) == 0)
349 350
    error ("Empty string for buffer name is not allowed");

351
  b = (struct buffer *) allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
352

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

368 369 370 371 372 373 374 375 376 377
  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
378
  BUF_MODIFF (b) = 1;
379
  BUF_OVERLAY_MODIFF (b) = 1;
380 381
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
382 383 384 385
  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
386
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
Roland McGrath's avatar
Roland McGrath committed
387

388 389 390
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
391
  b->prevent_redisplay_optimizations_p = 1;
392

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

397 398 399 400 401
  /* 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;
402 403

  name = Fcopy_sequence (name);
404
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Roland McGrath's avatar
Roland McGrath committed
405
  b->name = name;
406

407
  if (SREF (name, 0) != ' ')
Roland McGrath's avatar
Roland McGrath committed
408 409 410 411 412
    b->undo_list = Qnil;
  else
    b->undo_list = Qt;

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

Dave Love's avatar
Dave Love committed
423 424 425
  /* An error in calling the function here (should someone redfine it)
     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 450 451
    {
      Lisp_Object overlay, start, end, old_overlay;
      int charpos;

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 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;
{
  Lisp_Object to_buffer;
  int offset;

  XSETBUFFER (to_buffer, to);
497

498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  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);
517

518 519
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
520 521 522 523 524
}


DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
525
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
526
       doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
Pavel Janík's avatar
Pavel Janík committed
527 528 529 530
BASE-BUFFER should be an existing buffer (or buffer name).
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.
531 532
CLONE nil means the indirect buffer's state is reset to default values.  */)
     (base_buffer, name, clone)
533
     Lisp_Object base_buffer, name, clone;
534
{
535 536
  Lisp_Object buf;
  struct buffer *b;
537 538 539

  buf = Fget_buffer (name);
  if (!NILP (buf))
540
    error ("Buffer name `%s' is in use", SDATA (name));
541 542 543

  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
544
    error ("No such buffer: `%s'", SDATA (name));
545

546
  if (SCHARS (name) == 0)
547 548
    error ("Empty string for buffer name is not allowed");

549
  b = (struct buffer *) allocate_buffer ();
550 551 552 553 554 555 556 557 558 559 560 561 562
  b->size = sizeof (struct buffer) / sizeof (EMACS_INT);

  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);
563 564 565
  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);
566 567 568 569 570 571 572 573 574 575

  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);
576
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
577 578 579
  b->name = name;

  reset_buffer (b);
580
  reset_buffer_local_variables (b, 1);
581 582 583 584 585 586

  /* 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
587
  b->name = name;
588

589 590 591
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

592 593 594 595
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
596 597 598
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
599 600 601 602
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
603 604 605
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
606 607 608 609
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
610 611 612
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
613
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
614 615
    }

616 617 618 619 620 621 622 623 624 625 626 627 628
  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
    clone_per_buffer_values (b->base_buffer, b);
629

630
  return buf;
Roland McGrath's avatar
Roland McGrath committed
631 632
}

633 634
/* Reinitialize everything about a buffer except its name and contents
   and local variables.  */
Roland McGrath's avatar
Roland McGrath committed
635 636 637 638 639 640

void
reset_buffer (b)
     register struct buffer *b;
{
  b->filename = Qnil;
641
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
642 643
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
644
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
645
  b->last_window_start = 1;
646
  /* It is more conservative to start out "changed" than "unchanged".  */
647 648
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
649 650
  b->backed_up = Qnil;
  b->auto_save_modified = 0;
651
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
652 653
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
654 655
  b->overlays_before = NULL;
  b->overlays_after = NULL;
656
  b->overlay_center = BEG;
657
  b->mark_active = Qnil;
658
  b->point_before_scroll = Qnil;
659
  b->file_format = Qnil;
660
  b->last_selected_window = Qnil;
661
  XSETINT (b->display_count, 0);
662
  b->display_time = Qnil;
663
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
664
  b->cursor_type = buffer_defaults.cursor_type;
665
  b->extra_line_spacing = buffer_defaults.extra_line_spacing;
666 667

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
668 669
}

670 671 672
/* 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.
673 674 675 676 677
   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.  */
678

679 680
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
681
     register struct buffer *b;
682
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
683 684
{
  register int offset;
685
  int i;
Roland McGrath's avatar
Roland McGrath committed
686 687 688 689 690 691 692 693 694

  /* 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;
695 696 697 698 699 700 701 702

  /* 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
703
  b->downcase_table = Vascii_downcase_table;
704 705 706
  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];
707
  b->invisibility_spec = Qt;
708 709 710
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
711

712
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
713
  b->local_var_alist = Qnil;
714
  for (i = 0; i < last_per_buffer_idx; ++i)
715
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
716
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
717 718 719 720

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

721
  for (offset = PER_BUFFER_VAR_OFFSET (name);
722 723
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
724
    {
725
      int idx = PER_BUFFER_IDX (offset);
726 727 728 729 730
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
731
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
732
    }
Roland McGrath's avatar
Roland McGrath committed
733 734
}

Roland McGrath's avatar
Roland McGrath committed
735 736 737 738 739
/* 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,
740
       1, 2, 0,
741
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
742 743 744 745 746
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
until an unused name is found, and then return that name.
Optional second argument IGNORE specifies a name that is okay to use
\(if it is in the sequence to be tried)
747 748
even if a buffer with that name exists.  */)
     (name, ignore)
749
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
750 751 752 753 754
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

755
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
756 757

  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
758
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
759
    return name;
Roland McGrath's avatar
Roland McGrath committed
760 761 762 763 764 765

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
766
      tem = Fstring_equal (gentemp, ignore);
767 768
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
769
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
770
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
771
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
772 773 774 775 776
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
777 778 779
       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
780 781
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
782
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
783
    return current_buffer->name;
784
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
785 786 787 788
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
789 790 791
       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
792 793
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
794
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
795
    return current_buffer->filename;
796
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
797 798 799
  return XBUFFER (buffer)->filename;
}

800 801
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
802 803 804
       doc: /* Return the base buffer of indirect buffer BUFFER.
If BUFFER is not indirect, return nil.  */)
     (buffer)
805 806 807 808 809 810 811 812 813
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
814
      CHECK_BUFFER (buffer);
815 816 817 818 819 820 821 822 823
      base = XBUFFER (buffer)->base_buffer;
    }

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

824
DEFUN ("buffer-local-value", Fbuffer_local_value,
825
       Sbuffer_local_value, 2, 2, 0,
826 827 828 829 830 831 832 833 834 835
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value
is the default binding of variable. */)
     (symbol, buffer)
     register Lisp_Object symbol;
     register Lisp_Object buffer;
{
  register struct buffer *buf;
  register Lisp_Object result;

836 837
  CHECK_SYMBOL (symbol);
  CHECK_BUFFER (buffer);
838 839 840 841
  buf = XBUFFER (buffer);

  /* Look in local_var_list */
  result = Fassoc (symbol, buf->local_var_alist);
842
  if (NILP (result))
843 844 845 846 847 848 849 850 851 852 853 854
    {
      int offset, idx;
      int found = 0;

      /* Look in special slots */
      for (offset = PER_BUFFER_VAR_OFFSET (name);
	   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))
855 856
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset))
	      && EQ (PER_BUFFER_SYMBOL (offset), symbol))
857 858 859 860 861 862 863 864 865 866 867
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
	result = Fdefault_value (symbol);
    }
  else
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    {
      Lisp_Object valcontents;
      Lisp_Object current_alist_element;

      /* What binding is loaded right now?  */
      valcontents = SYMBOL_VALUE (symbol);
      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);
    }
888 889 890 891 892 893 894

  if (EQ (result, Qunbound))
    return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));

  return result;
}

Roland McGrath's avatar
Roland McGrath committed
895
DEFUN ("buffer-local-variables", Fbuffer_local_variables,
896
       Sbuffer_local_variables, 0, 1, 0,
897
       doc: /* Return an alist of variables that are buffer-local in BUFFER.
Pavel Janík's avatar
Pavel Janík committed
898 899 900
Most elements look like (SYMBOL . VALUE), describing one variable.
For a symbol that is locally unbound, just the symbol appears in the value.
Note that storing new VALUEs in these elements doesn't change the variables.
901 902
No argument or nil as argument means use current buffer as BUFFER.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
903 904 905
     register Lisp_Object buffer;
{
  register struct buffer *buf;
906
  register Lisp_Object result;
Roland McGrath's avatar
Roland McGrath committed
907

Jim Blandy's avatar
Jim Blandy committed
908
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
909 910 911
    buf = current_buffer;
  else
    {
912
      CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
913 914 915
      buf = XBUFFER (buffer);
    }

916 917
  result = Qnil;

Roland McGrath's avatar
Roland McGrath committed
918
  {
919
    register Lisp_Object tail;
920
    for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
921
      {
922 923
	Lisp_Object val, elt;

924
	elt = XCAR (tail);
925

926 927 928 929 930
	/* Reference each variable in the alist in buf.
	   If inquiring about the current buffer, this gets the current values,
	   so store them into the alist so the alist is up to date.
	   If inquiring about some other buffer, this swaps out any values
	   for that buffer, making the alist up to date automatically.  */
931
	val = find_symbol_value (XCAR (elt));
932 933
	/* Use the current buffer value only if buf is the current buffer.  */
	if (buf != current_buffer)
934
	  val = XCDR (elt);
935 936 937

	/* If symbol is unbound, put just the symbol in the list.  */
	if (EQ (val, Qunbound))
938
	  result = Fcons (XCAR (elt), result);
939 940
	/* Otherwise, put (symbol . value) in the list.  */
	else
941
	  result = Fcons (Fcons (XCAR (elt), val), result);
Roland McGrath's avatar
Roland McGrath committed
942 943 944 945 946
      }
  }

  /* Add on all the variables stored in special slots.  */
  {
947
    int offset, idx;
Roland McGrath's avatar
Roland McGrath committed
948

949
    for (offset = PER_BUFFER_VAR_OFFSET (name);
Roland McGrath's avatar
Roland McGrath committed
950
	 offset < sizeof (struct buffer);
951 952
	 /* sizeof EMACS_INT == sizeof Lisp_Object */
	 offset += (sizeof (EMACS_INT)))
Roland McGrath's avatar
Roland McGrath committed
953
      {
954 955 956 957 958
	idx = PER_BUFFER_IDX (offset);
	if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
	    && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
	  result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
				 PER_BUFFER_VALUE (buf, offset)),
959
			  result);
Roland McGrath's avatar
Roland McGrath committed
960 961
      }
  }
962 963

  return result;
Roland McGrath's avatar
Roland McGrath committed
964 965 966 967
}


DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
968
       0, 1, 0,
969 970 971
       doc: /* Return t if BUFFER was modified since its file was last read or saved.
No argument or nil as argument means use current buffer as BUFFER.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
972 973 974
     register Lisp_Object buffer;
{
  register struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
975
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
976 977 978
    buf = current_buffer;
  else
    {
979
      CHECK_BUFFER (buffer);