buffer.c 190 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 2, 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 219 220 221 222 223 224
  Lisp_Object framelist, general;
  general = Fmapcar (Qcdr, Vbuffer_alist);

  if (FRAMEP (frame))
    {
      Lisp_Object tail;

225
      CHECK_FRAME (frame);
226 227 228 229 230 231 232

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

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

  return general;
Roland McGrath's avatar
Roland McGrath committed
240 241
}

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

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

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

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

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

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

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

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

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

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

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

349
  b = (struct buffer *) allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
350

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

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

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

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

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

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

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

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

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

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

Dave Love's avatar
Dave Love committed
422 423 424
  /* 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
425
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
Dave Love's avatar
Dave Love committed
426
    /* buf is on buffer-alist, so no gcpro.  */
Dave Love's avatar
Dave Love committed
427 428
    call1 (Qucs_set_table_for_input, buf);

429 430 431
  return buf;
}

432

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

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

  XSETBUFFER (buffer, b);

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

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

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

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

477
  return result;
478
}
479

480

481 482 483 484 485 486 487 488 489 490 491
/* 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;
{
492
  Lisp_Object to_buffer;
493 494 495
  int offset;

  XSETBUFFER (to_buffer, to);
496

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

517 518
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
519

520 521 522
  /* 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);
523 524 525 526
}

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

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

545
  tem = base_buffer;
546 547
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
548 549 550
    error ("No such buffer: `%s'", SDATA (tem));
  if (NILP (XBUFFER (base_buffer)->name))
    error ("Base buffer has been killed");
551

552
  if (SCHARS (name) == 0)
553 554
    error ("Empty string for buffer name is not allowed");

555
  b = (struct buffer *) allocate_buffer ();
556 557 558 559 560 561 562 563 564 565 566 567 568
  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);
569 570 571
  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);
572 573 574 575 576 577 578 579 580 581

  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);
582
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
583 584 585
  b->name = name;

  reset_buffer (b);
586
  reset_buffer_local_variables (b, 1);
587 588 589 590 591 592

  /* 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
593
  b->name = name;
594

595 596 597
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

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

622 623 624 625 626 627 628 629 630 631 632 633
  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
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
    {
      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);
    }
649

650
  return buf;
Roland McGrath's avatar
Roland McGrath committed
651 652
}

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
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);
}

677
/* Reinitialize everything about a buffer except its name and contents
678
   and local variables.
679 680 681 682
   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
683 684 685 686 687 688

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

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
717 718
}

719 720 721
/* 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.
722 723 724 725 726
   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.  */
727

728 729
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
730
     register struct buffer *b;
731
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
732 733
{
  register int offset;
734
  int i;
Roland McGrath's avatar
Roland McGrath committed
735 736 737 738 739 740 741 742 743

  /* 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;
744 745 746 747 748 749 750 751

  /* 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
752
  b->downcase_table = Vascii_downcase_table;
753 754 755
  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];
756
  b->invisibility_spec = Qt;
757 758 759
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
760

761
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
762
  b->local_var_alist = Qnil;
763
  for (i = 0; i < last_per_buffer_idx; ++i)
764
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
765
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
766 767 768 769

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

770
  for (offset = PER_BUFFER_VAR_OFFSET (name);
771 772
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
773
    {
774
      int idx = PER_BUFFER_IDX (offset);
775 776 777 778 779
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
780
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
781
    }
Roland McGrath's avatar
Roland McGrath committed
782 783
}

Roland McGrath's avatar
Roland McGrath committed
784 785 786 787 788
/* 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,
789
       1, 2, 0,
790
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
791 792
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
793
\(starting at 2) until an unused name is found, and then return that name.
Pavel Janík's avatar
Pavel Janík committed
794 795
Optional second argument IGNORE specifies a name that is okay to use
\(if it is in the sequence to be tried)
796 797
even if a buffer with that name exists.  */)
     (name, ignore)
798
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
799 800 801 802 803
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

804
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
805

806 807 808
  tem = Fstring_equal (name, ignore);
  if (!NILP (tem))
    return name;
Roland McGrath's avatar
Roland McGrath committed
809
  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
810
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
811
    return name;
Roland McGrath's avatar
Roland McGrath committed
812 813 814 815 816 817

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
818
      tem = Fstring_equal (gentemp, ignore);
819 820
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
821
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
822
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
823
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
824 825 826 827 828
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
829 830 831
       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
832 833
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
834
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
835
    return current_buffer->name;
836
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
837 838 839 840
  return XBUFFER (buffer)->name;
}

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

852 853
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
854
       doc: /* Return the base buffer of indirect buffer BUFFER.
855 856
If BUFFER is not indirect, return nil.
BUFFER defaults to the current buffer.  */)
857
     (buffer)
858 859 860 861 862 863 864 865 866
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
867
      CHECK_BUFFER (buffer);
868 869 870 871 872 873 874 875 876
      base = XBUFFER (buffer)->base_buffer;
    }

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

877
DEFUN ("buffer-local-value", Fbuffer_local_value,
878
       Sbuffer_local_value, 2, 2, 0,
879 880
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value
881 882 883
is the default binding of the variable. */)
     (variable, buffer)
     register Lisp_Object variable;
884 885 886 887 888
     register Lisp_Object buffer;
{
  register struct buffer *buf;
  register Lisp_Object result;

889
  CHECK_SYMBOL (variable);
890
  CHECK_BUFFER (buffer);
891 892
  buf = XBUFFER (buffer);

893 894 895
  if (SYMBOLP (variable))
    variable = indirect_variable (variable);

896
  /* Look in local_var_list */
897
  result = Fassoc (variable, buf->local_var_alist);
898
  if (NILP (result))
899 900 901 902 903 904 905 906 907 908 909 910
    {
      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))
911
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset))
912
	      && EQ (PER_BUFFER_SYMBOL (offset), variable))
913 914 915 916 917 918 919 920
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
921
	result = Fdefault_value (variable