buffer.c 182 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, 03, 2004
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

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

70
DECL_ALIGN (struct buffer, buffer_defaults);
Roland McGrath's avatar
Roland McGrath committed
71 72 73 74 75 76 77 78 79 80 81

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

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

100 101
DECL_ALIGN (struct buffer, buffer_local_symbols);

Roland McGrath's avatar
Roland McGrath committed
102 103 104
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

105 106 107 108
/* 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
109 110 111 112 113
   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.  */
114 115
struct buffer buffer_local_types;

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

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

122
int last_per_buffer_idx;
123

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

/* 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. */
137 138
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
139

140 141
Lisp_Object Vtransient_mark_mode;

142 143 144 145 146
/* 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;

147 148 149
/* 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;
150
Lisp_Object Qkill_buffer_query_functions;
151

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 186


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

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

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

  if (FRAMEP (frame))
    {
      Lisp_Object tail;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

385 386 387
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
388
  b->prevent_redisplay_optimizations_p = 1;
389

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

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

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

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

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

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

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

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

427 428 429
  return buf;
}

430

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

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

  XSETBUFFER (buffer, b);

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

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

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

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

475
  return result;
476
}
477

478

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
/* 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);
494

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

515 516
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
517 518 519 520 521
}


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

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

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

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

550
  b = (struct buffer *) allocate_buffer ();
551 552 553 554 555 556 557 558 559 560 561 562 563
  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);
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 629
  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);
630

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

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

658
/* Reinitialize everything about a buffer except its name and contents
659
   and local variables.
660 661 662 663
   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
664 665 666 667 668 669

void
reset_buffer (b)
     register struct buffer *b;
{
  b->filename = Qnil;
670
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
671 672
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
673
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
674
  b->last_window_start = 1;
675
  /* It is more conservative to start out "changed" than "unchanged".  */
676 677
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
678 679
  b->backed_up = Qnil;
  b->auto_save_modified = 0;
680
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
681 682
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
683 684
  b->overlays_before = NULL;
  b->overlays_after = NULL;
685
  b->overlay_center = BEG;
686
  b->mark_active = Qnil;
687
  b->point_before_scroll = Qnil;
688
  b->file_format = Qnil;
689
  b->last_selected_window = Qnil;
690
  XSETINT (b->display_count, 0);
691
  b->display_time = Qnil;
692
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
693
  b->cursor_type = buffer_defaults.cursor_type;
694
  b->extra_line_spacing = buffer_defaults.extra_line_spacing;
695 696

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
697 698
}

699 700 701
/* 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.
702 703 704 705 706
   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.  */
707

708 709
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
710
     register struct buffer *b;
711
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
712 713
{
  register int offset;
714
  int i;
Roland McGrath's avatar
Roland McGrath committed
715 716 717 718 719 720 721 722 723

  /* 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;
724 725 726 727 728 729 730 731

  /* 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
732
  b->downcase_table = Vascii_downcase_table;
733 734 735
  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];
736
  b->invisibility_spec = Qt;
737 738 739
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
740

741
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
742
  b->local_var_alist = Qnil;
743
  for (i = 0; i < last_per_buffer_idx; ++i)
744
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
745
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
746 747 748 749

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

750
  for (offset = PER_BUFFER_VAR_OFFSET (name);
751 752
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
753
    {
754
      int idx = PER_BUFFER_IDX (offset);
755 756 757 758 759
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
760
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
761
    }
Roland McGrath's avatar
Roland McGrath committed
762 763
}

Roland McGrath's avatar
Roland McGrath committed
764 765 766 767 768
/* 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,
769
       1, 2, 0,
770
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
771 772
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
773
\(starting at 2) until an unused name is found, and then return that name.
Pavel Janík's avatar
Pavel Janík committed
774 775
Optional second argument IGNORE specifies a name that is okay to use
\(if it is in the sequence to be tried)
776 777
even if a buffer with that name exists.  */)
     (name, ignore)
778
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
779 780 781 782 783
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

784
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
785

786 787 788
  tem = Fstring_equal (name, ignore);
  if (!NILP (tem))
    return name;
Roland McGrath's avatar
Roland McGrath committed
789
  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
790
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
791
    return name;
Roland McGrath's avatar
Roland McGrath committed
792 793 794 795 796 797

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
798
      tem = Fstring_equal (gentemp, ignore);
799 800
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
801
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
802
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
803
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
804 805 806 807 808
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
809 810 811
       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
812 813
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
814
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
815
    return current_buffer->name;
816
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
817 818 819 820
  return XBUFFER (buffer)->name;
}

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

832 833
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
834
       doc: /* Return the base buffer of indirect buffer BUFFER.
835 836
If BUFFER is not indirect, return nil.
BUFFER defaults to the current buffer.  */)
837
     (buffer)
838 839 840 841 842 843 844 845 846
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
847
      CHECK_BUFFER (buffer);
848 849 850 851 852 853 854 855 856
      base = XBUFFER (buffer)->base_buffer;
    }

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

857
DEFUN ("buffer-local-value", Fbuffer_local_value,
858
       Sbuffer_local_value, 2, 2, 0,
859 860 861 862 863 864 865 866 867 868
       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;

869 870
  CHECK_SYMBOL (symbol);
  CHECK_BUFFER (buffer);
871 872 873 874
  buf = XBUFFER (buffer);

  /* Look in local_var_list */
  result = Fassoc (symbol, buf->local_var_alist);
875
  if (NILP (result))
876 877 878 879 880 881 882 883 884 885 886 887
    {
      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))
888 889
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset))
	      && EQ (PER_BUFFER_SYMBOL (offset), symbol))
890 891 892 893 894 895 896 897 898 899 900
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
	result = Fdefault_value (symbol);
    }
  else
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
    {
      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);
    }
921 922 923 924 925 926 927

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

  return result;
}

Roland McGrath's avatar
Roland McGrath committed
928
DEFUN ("buffer-local-variables", Fbuffer_local_variables,
929
       Sbuffer_local_variables, 0, 1, 0,
930
       doc: /* Return an alist of variables that are buffer-local in BUFFER.
Pavel Janík's avatar
Pavel Janík committed
931 932 933
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.
934 935
No argument or nil as argument means use current buffer as BUFFER.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
936 937 938
     register Lisp_Object buffer;
{
  register struct buffer *buf;
939
  register Lisp_Object result;
Roland McGrath's avatar
Roland McGrath committed
940