buffer.c 191 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
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
104
static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
105 106 107

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

108
int last_per_buffer_idx;
109

Roland McGrath's avatar
Roland McGrath committed
110
Lisp_Object Fset_buffer ();
Roland McGrath's avatar
Roland McGrath committed
111
void set_buffer_internal ();
112
void set_buffer_internal_1 ();
113
static void call_overlay_mod_hooks ();
114
static void swap_out_buffer_local_variables ();
115
static void reset_buffer_local_variables ();
Roland McGrath's avatar
Roland McGrath committed
116 117 118 119 120 121 122

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

126 127
Lisp_Object Vtransient_mark_mode;

128 129 130 131 132
/* 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;

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

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

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

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

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

Roland McGrath's avatar
Roland McGrath committed
152 153 154 155 156 157 158 159
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
160 161
Lisp_Object Qget_file_buffer;

Jim Blandy's avatar
Jim Blandy committed
162 163
Lisp_Object Qoverlayp;

164
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
165

166 167 168 169
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

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


Roland McGrath's avatar
Roland McGrath committed
177 178 179
/* For debugging; temporary.  See set_buffer_internal.  */
/* Lisp_Object Qlisp_mode, Vcheck_symbol; */

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

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

  if (FRAMEP (frame))
    {
212 213
      Lisp_Object framelist, prevlist, tail;
      Lisp_Object args[3];
214

215
      CHECK_FRAME (frame);
216 217

      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
218
      prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
219

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

  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 = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
352

353 354 355 356
  /* 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
  b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
Roland McGrath's avatar
Roland McGrath committed
407 408

  reset_buffer (b);
409
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
410

411
  b->mark = Fmake_marker ();
412
  BUF_MARKERS (b) = NULL;
413 414
  b->name = name;

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

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

426 427 428
  return buf;
}

429

430 431 432
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

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

  XSETBUFFER (buffer, b);

443
  for (; list; list = list->next)
444 445
    {
      Lisp_Object overlay, start, end, old_overlay;
446
      EMACS_INT charpos;
447

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

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

468 469 470 471
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
472 473
    }

474
  return result;
475
}
476

477

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

  XSETBUFFER (to_buffer, to);
493

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

514 515
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
516

517 518 519
  /* 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);
520 521 522 523
}

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

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

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

549
  if (SCHARS (name) == 0)
550 551
    error ("Empty string for buffer name is not allowed");

552
  b = allocate_buffer ();
553

554 555 556
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
557 558 559 560 561 562 563

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

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

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

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

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

593 594 595 596
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
597 598 599
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
600 601 602 603
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
604 605 606
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
607 608 609 610
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
611 612 613
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
614
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
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
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
    {
      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);
    }
644

645
  return buf;
Roland McGrath's avatar
Roland McGrath committed
646 647
}

648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
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);
}

672
/* Reinitialize everything about a buffer except its name and contents
673
   and local variables.
674 675 676 677
   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
678 679 680 681 682 683

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

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
712 713
}

714 715 716
/* 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.
717 718 719 720 721
   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.  */
722

723 724
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
725
     register struct buffer *b;
726
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
727 728
{
  register int offset;
729
  int i;
Roland McGrath's avatar
Roland McGrath committed
730 731 732 733 734 735 736 737 738

  /* 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;
739 740 741 742 743 744 745 746

  /* 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
747
  b->downcase_table = Vascii_downcase_table;
748 749 750
  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];
751
  b->invisibility_spec = Qt;
752 753 754
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
755

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

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

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

Roland McGrath's avatar
Roland McGrath committed
779 780 781 782 783
/* 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,
784
       1, 2, 0,
785
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
786 787
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
788
\(starting at 2) until an unused name is found, and then return that name.
Juanma Barranquero's avatar
Juanma Barranquero committed
789 790
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.  */)
791
     (name, ignore)
792
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
793 794 795 796 797
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

798
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
799

800 801 802
  tem = Fstring_equal (name, ignore);
  if (!NILP (tem))
    return name;
Roland McGrath's avatar
Roland McGrath committed
803
  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
804
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
805
    return name;
Roland McGrath's avatar
Roland McGrath committed
806 807 808 809 810 811

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
812
      tem = Fstring_equal (gentemp, ignore);
813 814
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
815
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
816
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
817
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
818 819 820 821 822
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
823 824 825
       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
826 827
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
828
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
829
    return current_buffer->name;
830
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
831 832 833 834
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
835 836 837
       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
838 839
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
840
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
841
    return current_buffer->filename;
842
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
843 844 845
  return XBUFFER (buffer)->filename;
}

846 847
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
848
       doc: /* Return the base buffer of indirect buffer BUFFER.
849 850
If BUFFER is not indirect, return nil.
BUFFER defaults to the current buffer.  */)
851
     (buffer)
852 853 854 855 856 857 858 859 860
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
861
      CHECK_BUFFER (buffer);
862 863 864 865 866 867 868 869 870
      base = XBUFFER (buffer)->base_buffer;
    }

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

871
DEFUN ("buffer-local-value", Fbuffer_local_value,
872
       Sbuffer_local_value, 2, 2, 0,
873 874
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value
875 876 877
is the default binding of the variable. */)
     (variable, buffer)
     register Lisp_Object variable;
878 879 880 881 882
     register Lisp_Object buffer;
{
  register struct buffer *buf;
  register Lisp_Object result;

883
  CHECK_SYMBOL (variable);
884
  CHECK_BUFFER (buffer);
885 886
  buf = XBUFFER (buffer);

887
  variable = indirect_variable (variable);
888

889
  /* Look in local_var_list */
890
  result = Fassoc (variable, buf->local_var_alist);
891
  if (NILP (result))
892 893 894 895 896 897 898 899 900 901 902 903
    {
      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))
904
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset))
905
	      && EQ (PER_BUFFER_SYMBOL (offset), variable))
906 907 908 909 910 911 912 913
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
914
	result = Fdefault_value (variable);
915 916
    }
  else
917 918 919 920 921
    {
      Lisp_Object valcontents;
      Lisp_Object current_alist_element;

      /* What binding is loaded right now?  */
922
      valcontents = SYMBOL_VALUE (variable);
923 924 925 926 927 928 929 930 931 932 933 934 935 936
      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);
    }
937

938 939
  if (!EQ (result, Qunbound))
    return result;
940

941
  xsignal1 (Qvoid_variable, variable);
Richard M. Stallman's avatar