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

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
11
the Free Software Foundation; either version 3, or (at your option)
Roland McGrath's avatar
Roland McGrath committed
12 13 14 15 16 17 18 19 20
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
21 22
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Roland McGrath's avatar
Roland McGrath committed
23

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

26 27
#include <sys/types.h>
#include <sys/stat.h>
Roland McGrath's avatar
Roland McGrath committed
28
#include <sys/param.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
29
#include <errno.h>
Dave Love's avatar
Dave Love committed
30
#include <stdio.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
31

32
#ifndef USE_CRT_DLL
Richard M. Stallman's avatar
Richard M. Stallman committed
33
extern int errno;
34
#endif
Roland McGrath's avatar
Roland McGrath committed
35 36


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

Roland McGrath's avatar
Roland McGrath committed
41
#include "lisp.h"
42
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
43 44 45
#include "window.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
46
#include "charset.h"
47
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
48
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
49
#include "blockinput.h"
50
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
51
#include "keymap.h"
52
#include "frame.h"
Roland McGrath's avatar
Roland McGrath committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67

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

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

/* 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,
80 81
   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
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

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

98 99
DECL_ALIGN (struct buffer, buffer_local_symbols);

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

103 104
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
105
static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
106 107 108

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

109
int last_per_buffer_idx;
110

111 112 113 114 115 116 117 118
EXFUN (Fset_buffer, 1);
void set_buffer_internal P_ ((struct buffer *b));
void set_buffer_internal_1 P_ ((struct buffer *b));
static void call_overlay_mod_hooks P_ ((Lisp_Object list, Lisp_Object overlay,
					int after, Lisp_Object arg1,
					Lisp_Object arg2, Lisp_Object arg3));
static void swap_out_buffer_local_variables P_ ((struct buffer *b));
static void reset_buffer_local_variables P_ ((struct buffer *b, int permanent_too));
Roland McGrath's avatar
Roland McGrath committed
119 120 121 122 123 124 125

/* 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. */
126 127
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
128

129 130
Lisp_Object Vtransient_mark_mode;

131 132 133 134 135
/* 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;

136 137 138
/* 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;
139
Lisp_Object Qkill_buffer_query_functions;
140

141 142 143
/* Hook run before changing a major mode.  */
Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;

Jim Blandy's avatar
Jim Blandy committed
144 145
/* List of functions to call before changing an unmodified buffer.  */
Lisp_Object Vfirst_change_hook;
146

Jim Blandy's avatar
Jim Blandy committed
147
Lisp_Object Qfirst_change_hook;
148 149
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Dave Love's avatar
Dave Love committed
150
Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
151

152 153 154
/* If nonzero, all modification hooks are suppressed.  */
int inhibit_modification_hooks;

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

Jim Blandy's avatar
Jim Blandy committed
165 166
Lisp_Object Qoverlayp;

167
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
168

169 170 171 172
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

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


Roland McGrath's avatar
Roland McGrath committed
180 181 182
/* For debugging; temporary.  See set_buffer_internal.  */
/* Lisp_Object Qlisp_mode, Vcheck_symbol; */

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

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

  if (FRAMEP (frame))
    {
215 216
      Lisp_Object framelist, prevlist, tail;
      Lisp_Object args[3];
217

218
      CHECK_FRAME (frame);
219 220

      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
221
      prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
222

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

  return general;
Roland McGrath's avatar
Roland McGrath committed
245 246
}

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

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

279
  return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
280 281 282
}

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

293
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
294 295
  filename = Fexpand_file_name (filename, Qnil);

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

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

314 315 316 317 318 319
Lisp_Object
get_truename_buffer (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;

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

  buf = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
348
  if (!NILP (buf))
Roland McGrath's avatar
Roland McGrath committed
349 350
    return buf;

351
  if (SCHARS (name) == 0)
352 353
    error ("Empty string for buffer name is not allowed");

354
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
355

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

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

390 391 392
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
393
  b->prevent_redisplay_optimizations_p = 1;
394

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

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

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

409
  b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
Roland McGrath's avatar
Roland McGrath committed
410 411

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

Juanma Barranquero's avatar
Juanma Barranquero committed
422
  /* An error in calling the function here (should someone redefine it)
Dave Love's avatar
Dave Love committed
423 424
     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 = allocate_buffer ();
556

557 558 559
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
560 561 562 563 564 565 566

  /* 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);
567 568 569
  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);
570 571 572 573 574 575 576 577 578 579

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

  reset_buffer (b);
584
  reset_buffer_local_variables (b, 1);
585 586 587 588 589 590

  /* 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
591
  b->name = name;
592

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

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

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

648
  return buf;
Roland McGrath's avatar
Roland McGrath committed
649 650
}

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

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

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

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
715 716
}

717 718 719
/* 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.
720 721
   Instead, use Fkill_all_local_variables.

722
   If PERMANENT_TOO is 1, then we reset permanent
723 724
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
725

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

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

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

759
  /* Reset all (or most) per-buffer variables to their defaults.  */
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
  if (permanent_too)
    b->local_var_alist = Qnil;
  else
    {
      Lisp_Object tmp, last = Qnil;
      for (tmp = b->local_var_alist; CONSP (tmp); tmp = XCDR (tmp))
	if (CONSP (XCAR (tmp))
	    && SYMBOLP (XCAR (XCAR (tmp)))
	    && !NILP (Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
	  /* If permanent-local, keep it.  */
	  last = tmp;
	else if (NILP (last))
	  b->local_var_alist = XCDR (tmp);
	else
	  XSETCDR (last, XCDR (tmp));
    }

777
  for (i = 0; i < last_per_buffer_idx; ++i)
778
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
779
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
780 781 782 783

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

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

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

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

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

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

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

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

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

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

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

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

902
  CHECK_SYMBOL (variable);
903
  CHECK_BUFFER (buffer);
904 905
  buf = XBUFFER (buffer);

906
  variable = indirect_variable (variable);
907

908
  /* Look in local_var_list */
909
  result = Fassoc (variable, buf->local_var_alist);
910
  if (NILP (result))
911 912 913 914 915 916 917 918 919 920 921 922
    {
      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))
923
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset))
924
	      && EQ (PER_BUFFER_SYMBOL (offset), variable))
925 926 927 928 929 930 931 932
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
933
	result = Fdefault_value (variable);
934 935
    }
  else
936 937 938 939 940
    {
      Lisp_Object valcontents;
      Lisp_Object current_alist_element;

      /* What binding is loaded right now?  */
941
      valcontents = SYMBOL_VALUE (variable);
942 943 944 945 946 947 948 949 950 951 952 953 954 955
      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);
    }
956