buffer.c 198 KB
Newer Older
Roland McGrath's avatar
Roland McGrath committed
1
/* Buffer manipulation primitives for GNU Emacs.
Glenn Morris's avatar
Glenn Morris committed
2 3 4 5

Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995, 1997,
  1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
  2009, 2010, 2011  Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
6 7 8

This file is part of GNU Emacs.

9
GNU Emacs is free software: you can redistribute it and/or modify
Roland McGrath's avatar
Roland McGrath committed
10
it under the terms of the GNU General Public License as published by
11 12
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Roland McGrath's avatar
Roland McGrath committed
13 14 15 16 17 18 19

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
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>
29
#include <setjmp.h>
Andreas Schwab's avatar
Andreas Schwab committed
30
#include <unistd.h>
31

Roland McGrath's avatar
Roland McGrath committed
32
#include "lisp.h"
33
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
34 35 36
#include "window.h"
#include "commands.h"
#include "buffer.h"
37
#include "character.h"
38
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
39
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
40
#include "blockinput.h"
41
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
42
#include "keymap.h"
43
#include "frame.h"
Roland McGrath's avatar
Roland McGrath committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

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

Kenichi Handa's avatar
Kenichi Handa committed
59
DECL_ALIGN (struct buffer, buffer_defaults);
Roland McGrath's avatar
Roland McGrath committed
60 61 62 63 64 65 66 67 68 69 70

/* 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,
71 72
   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
73 74 75 76 77 78 79 80 81 82 83 84 85

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

Kenichi Handa's avatar
Kenichi Handa committed
86 87
DECL_ALIGN (struct buffer, buffer_local_symbols);

Roland McGrath's avatar
Roland McGrath committed
88 89 90
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

91 92 93 94 95 96
/* Return the symbol of the per-buffer variable at offset OFFSET in
   the buffer structure.  */

#define PER_BUFFER_SYMBOL(OFFSET) \
      (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))

97 98
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
99
static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
100 101 102

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

103
int last_per_buffer_idx;
104

105 106 107 108 109
static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
                                    int after, Lisp_Object arg1,
                                    Lisp_Object arg2, Lisp_Object arg3);
static void swap_out_buffer_local_variables (struct buffer *b);
static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
Roland McGrath's avatar
Roland McGrath committed
110 111 112 113 114 115

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

116
Lisp_Object Qkill_buffer_query_functions;
117

118
/* Hook run before changing a major mode.  */
119
Lisp_Object Qchange_major_mode_hook;
120

Jim Blandy's avatar
Jim Blandy committed
121
Lisp_Object Qfirst_change_hook;
122 123
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Dave Love's avatar
Dave Love committed
124
Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
125 126

Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
127
Lisp_Object Qpermanent_local_hook;
Roland McGrath's avatar
Roland McGrath committed
128 129 130 131 132 133 134

Lisp_Object Qprotected_field;

Lisp_Object QSFundamental;	/* A string "Fundamental" */

Lisp_Object Qkill_buffer_hook;

Richard M. Stallman's avatar
Richard M. Stallman committed
135 136
Lisp_Object Qget_file_buffer;

Jim Blandy's avatar
Jim Blandy committed
137 138
Lisp_Object Qoverlayp;

139
Lisp_Object Qpriority, Qevaporate, Qbefore_string, Qafter_string;
140

141 142 143 144
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

145 146 147 148 149
static void alloc_buffer_text (struct buffer *, size_t);
static void free_buffer_text (struct buffer *b);
static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
static Lisp_Object buffer_lisp_local_variables (struct buffer *);
150

Roland McGrath's avatar
Roland McGrath committed
151 152 153
/* For debugging; temporary.  See set_buffer_internal.  */
/* Lisp_Object Qlisp_mode, Vcheck_symbol; */

154
void
155
nsberror (Lisp_Object spec)
Roland McGrath's avatar
Roland McGrath committed
156
{
157
  if (STRINGP (spec))
158
    error ("No buffer named %s", SDATA (spec));
Roland McGrath's avatar
Roland McGrath committed
159 160 161
  error ("Invalid buffer argument");
}

162
DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
163 164
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
165
  (Lisp_Object object)
166 167 168 169 170
{
  return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
	  ? Qt : Qnil);
}

171
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
172
       doc: /* Return a list of all existing live buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
173 174 175
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
176
  (Lisp_Object frame)
Roland McGrath's avatar
Roland McGrath committed
177
{
178
  Lisp_Object general;
179 180 181 182
  general = Fmapcar (Qcdr, Vbuffer_alist);

  if (FRAMEP (frame))
    {
183 184
      Lisp_Object framelist, prevlist, tail;
      Lisp_Object args[3];
185

186
      CHECK_FRAME (frame);
187 188

      framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
189
      prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
190

191 192
      /* Remove from GENERAL any buffer that duplicates one in
         FRAMELIST or PREVLIST.  */
193
      tail = framelist;
194
      while (CONSP (tail))
195
	{
196 197
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
198
	}
199 200 201 202 203 204 205 206 207 208 209
      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);
210 211 212
    }

  return general;
Roland McGrath's avatar
Roland McGrath committed
213 214
}

215 216 217 218 219
/* Like Fassoc, but use Fstring_equal to compare
   (which ignores text properties),
   and don't ever QUIT.  */

static Lisp_Object
220
assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
221 222
{
  register Lisp_Object tail;
223
  for (tail = list; CONSP (tail); tail = XCDR (tail))
224 225
    {
      register Lisp_Object elt, tem;
226
      elt = XCAR (tail);
227 228 229 230 231 232 233
      tem = Fstring_equal (Fcar (elt), key);
      if (!NILP (tem))
	return elt;
    }
  return Qnil;
}

Roland McGrath's avatar
Roland McGrath committed
234
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
235 236 237 238
       doc: /* Return the buffer named BUFFER-OR-NAME.
BUFFER-OR-NAME must be either a string or a buffer.  If BUFFER-OR-NAME
is a string and there is no buffer with that name, return nil.  If
BUFFER-OR-NAME is a buffer, return it as given.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
239
  (register Lisp_Object buffer_or_name)
Roland McGrath's avatar
Roland McGrath committed
240
{
241 242 243
  if (BUFFERP (buffer_or_name))
    return buffer_or_name;
  CHECK_STRING (buffer_or_name);
Roland McGrath's avatar
Roland McGrath committed
244

245
  return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
246 247 248
}

DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
249
       doc: /* Return the buffer visiting file FILENAME (a string).
Pavel Janík's avatar
Pavel Janík committed
250 251
The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
If there is no such live buffer, return nil.
252
See also `find-buffer-visiting'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
253
  (register Lisp_Object filename)
Roland McGrath's avatar
Roland McGrath committed
254 255
{
  register Lisp_Object tail, buf, tem;
Richard M. Stallman's avatar
Richard M. Stallman committed
256 257
  Lisp_Object handler;

258
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
259 260
  filename = Fexpand_file_name (filename, Qnil);

Richard M. Stallman's avatar
Richard M. Stallman committed
261 262
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
263
  handler = Ffind_file_name_handler (filename, Qget_file_buffer);
Richard M. Stallman's avatar
Richard M. Stallman committed
264 265 266
  if (!NILP (handler))
    return call2 (handler, Qget_file_buffer, filename);

267
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
268
    {
269
      buf = Fcdr (XCAR (tail));
270 271
      if (!BUFFERP (buf)) continue;
      if (!STRINGP (XBUFFER (buf)->filename)) continue;
Roland McGrath's avatar
Roland McGrath committed
272
      tem = Fstring_equal (XBUFFER (buf)->filename, filename);
Jim Blandy's avatar
Jim Blandy committed
273
      if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
274 275 276 277 278
	return buf;
    }
  return Qnil;
}

279
Lisp_Object
280
get_truename_buffer (register Lisp_Object filename)
281 282 283
{
  register Lisp_Object tail, buf, tem;

284
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
285
    {
286
      buf = Fcdr (XCAR (tail));
287 288 289 290 291 292 293 294 295
      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
296 297 298 299
/* 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,
300 301 302 303 304 305 306 307
       doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
If BUFFER-OR-NAME is a string and a live buffer with that name exists,
return that buffer.  If no such buffer exists, create a new buffer with
that name and return it.  If BUFFER-OR-NAME starts with a space, the new
buffer does not keep undo information.

If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
even if it is dead.  The return value is never nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
308
  (register Lisp_Object buffer_or_name)
Roland McGrath's avatar
Roland McGrath committed
309
{
310
  register Lisp_Object buffer, name;
Roland McGrath's avatar
Roland McGrath committed
311 312
  register struct buffer *b;

313 314 315
  buffer = Fget_buffer (buffer_or_name);
  if (!NILP (buffer))
    return buffer;
Roland McGrath's avatar
Roland McGrath committed
316

317
  if (SCHARS (buffer_or_name) == 0)
318 319
    error ("Empty string for buffer name is not allowed");

320
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
321

322 323 324 325
  /* 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
326
  BUF_GAP_SIZE (b) = 20;
327
  BLOCK_INPUT;
Karl Heuer's avatar
Karl Heuer committed
328 329
  /* We allocate extra 1-byte at the tail and keep it always '\0' for
     anchoring a search.  */
330
  alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
331
  UNBLOCK_INPUT;
Roland McGrath's avatar
Roland McGrath committed
332
  if (! BUF_BEG_ADDR (b))
333
    buffer_memory_full ();
Roland McGrath's avatar
Roland McGrath committed
334

335 336 337 338 339 340 341 342 343 344
  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
345
  BUF_MODIFF (b) = 1;
346
  BUF_CHARS_MODIFF (b) = 1;
347
  BUF_OVERLAY_MODIFF (b) = 1;
348 349
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
350 351 352 353
  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
354
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
Roland McGrath's avatar
Roland McGrath committed
355

356 357 358
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
359
  b->prevent_redisplay_optimizations_p = 1;
360

Roland McGrath's avatar
Roland McGrath committed
361 362 363 364
  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

365 366 367 368 369
  /* 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;
370

371
  name = Fcopy_sequence (buffer_or_name);
372
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Roland McGrath's avatar
Roland McGrath committed
373
  b->name = name;
374

375
  b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
Roland McGrath's avatar
Roland McGrath committed
376 377

  reset_buffer (b);
378
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
379

380
  b->mark = Fmake_marker ();
381
  BUF_MARKERS (b) = NULL;
382 383
  b->name = name;

Roland McGrath's avatar
Roland McGrath committed
384
  /* Put this in the alist of all live buffers.  */
385 386
  XSETBUFFER (buffer, b);
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
Roland McGrath's avatar
Roland McGrath committed
387

Juanma Barranquero's avatar
Juanma Barranquero committed
388
  /* An error in calling the function here (should someone redefine it)
Dave Love's avatar
Dave Love committed
389 390
     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
391
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
392 393
    /* buffer is on buffer-alist, so no gcpro.  */
    call1 (Qucs_set_table_for_input, buffer);
Dave Love's avatar
Dave Love committed
394

395
  return buffer;
396 397
}

398

399 400 401
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

402
static struct Lisp_Overlay *
403
copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
404
{
405 406
  Lisp_Object buffer;
  struct Lisp_Overlay *result = NULL, *tail = NULL;
407 408 409

  XSETBUFFER (buffer, b);

410
  for (; list; list = list->next)
411 412
    {
      Lisp_Object overlay, start, end, old_overlay;
413
      EMACS_INT charpos;
414

415
      XSETMISC (old_overlay, list);
416 417
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
418
      Fset_marker (start, make_number (charpos), buffer);
419 420 421 422 423
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
424
      Fset_marker (end, make_number (charpos), buffer);
425 426 427 428 429 430 431 432
      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));
433
      XOVERLAY (overlay)->next = NULL;
434

435 436 437 438
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
439 440
    }

441
  return result;
442
}
443

444

445 446 447 448 449 450 451 452
/* 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
453
clone_per_buffer_values (struct buffer *from, struct buffer *to)
454
{
455
  Lisp_Object to_buffer;
456 457 458
  int offset;

  XSETBUFFER (to_buffer, to);
459

460 461
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
462
  for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
463 464 465 466 467
       offset < sizeof *to;
       offset += sizeof (Lisp_Object))
    {
      Lisp_Object obj;

468 469 470 471
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

472
      obj = PER_BUFFER_VALUE (from, offset);
473
      if (MARKERP (obj) && XMARKER (obj)->buffer == from)
474 475 476 477 478 479 480 481 482 483
	{
	  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;
    }

484
  memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
485

486 487
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
488

489 490 491
  /* 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);
492 493 494 495
}

DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
496
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
497
       doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
Kenichi Handa's avatar
Kenichi Handa committed
498
BASE-BUFFER should be a live buffer, or the name of an existing buffer.
Pavel Janík's avatar
Pavel Janík committed
499 500 501
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.
502
CLONE nil means the indirect buffer's state is reset to default values.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
503
  (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
504
{
Kenichi Handa's avatar
Kenichi Handa committed
505
  Lisp_Object buf, tem;
506
  struct buffer *b;
507

Kenichi Handa's avatar
Kenichi Handa committed
508
  CHECK_STRING (name);
509 510
  buf = Fget_buffer (name);
  if (!NILP (buf))
511
    error ("Buffer name `%s' is in use", SDATA (name));
512

Kenichi Handa's avatar
Kenichi Handa committed
513
  tem = base_buffer;
514 515
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
Kenichi Handa's avatar
Kenichi Handa committed
516 517 518
    error ("No such buffer: `%s'", SDATA (tem));
  if (NILP (XBUFFER (base_buffer)->name))
    error ("Base buffer has been killed");
519

520
  if (SCHARS (name) == 0)
521 522
    error ("Empty string for buffer name is not allowed");

523
  b = allocate_buffer ();
524

525 526 527
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
528 529 530 531 532 533 534

  /* 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);
535 536 537
  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);
538 539 540 541 542 543 544 545 546 547

  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);
548
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
549 550 551
  b->name = name;

  reset_buffer (b);
552
  reset_buffer_local_variables (b, 1);
553 554 555 556 557 558

  /* 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
559
  b->name = name;
560

561 562 563
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

564 565 566 567
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
568 569 570
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
571 572 573 574
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
575 576 577
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
578 579 580 581
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
582 583 584
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
585
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
586 587
    }

588 589 590 591 592 593 594 595 596 597 598 599
  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
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
    {
      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);
    }
615

616
  return buf;
Roland McGrath's avatar
Roland McGrath committed
617 618
}

619
void
620
delete_all_overlays (struct buffer *b)
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
{
  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);
}

642
/* Reinitialize everything about a buffer except its name and contents
Kenichi Handa's avatar
Kenichi Handa committed
643
   and local variables.
644 645 646 647
   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
648 649

void
650
reset_buffer (register struct buffer *b)
Roland McGrath's avatar
Roland McGrath committed
651 652
{
  b->filename = Qnil;
653
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
654 655
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
656
  b->modtime_size = -1;
657
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
658
  b->last_window_start = 1;
659
  /* It is more conservative to start out "changed" than "unchanged".  */
660 661
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
662
  b->backed_up = Qnil;
663
  BUF_AUTOSAVE_MODIFF (b) = 0;
664
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
665 666
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
667 668
  b->overlays_before = NULL;
  b->overlays_after = NULL;
669
  b->overlay_center = BEG;
670
  b->mark_active = Qnil;
671
  b->point_before_scroll = Qnil;
672
  b->file_format = Qnil;
673
  b->auto_save_file_format = Qt;
674
  b->last_selected_window = Qnil;
675
  XSETINT (b->display_count, 0);
676
  b->display_time = Qnil;
677
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
678
  b->cursor_type = buffer_defaults.cursor_type;
679
  b->extra_line_spacing = buffer_defaults.extra_line_spacing;
680 681

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
682 683
}

684 685 686
/* 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.
687 688
   Instead, use Fkill_all_local_variables.

689
   If PERMANENT_TOO is 1, then we reset permanent
690 691
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
692

693
static void
694
reset_buffer_local_variables (register struct buffer *b, int permanent_too)
Roland McGrath's avatar
Roland McGrath committed
695 696
{
  register int offset;
697
  int i;
Roland McGrath's avatar
Roland McGrath committed
698 699 700 701 702 703 704 705 706

  /* 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;
707 708 709 710 711 712 713 714

  /* 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
715
  b->downcase_table = Vascii_downcase_table;
716 717 718
  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];
719
  b->invisibility_spec = Qt;
720 721 722
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
723

724
  /* Reset all (or most) per-buffer variables to their defaults.  */
725 726 727 728
  if (permanent_too)
    b->local_var_alist = Qnil;
  else
    {
729
      Lisp_Object tmp, prop, last = Qnil;
730
      for (tmp = b->local_var_alist; CONSP (tmp); tmp = XCDR (tmp))
731
	if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
	  {
	    /* If permanent-local, keep it.  */
	    last = tmp;
	    if (EQ (prop, Qpermanent_local_hook))
	      {
		/* This is a partially permanent hook variable.
		   Preserve only the elements that want to be preserved.  */
		Lisp_Object list, newlist;
		list = XCDR (XCAR (tmp));
		if (!CONSP (list))
		  newlist = list;
		else
		  for (newlist = Qnil; CONSP (list); list = XCDR (list))
		    {
		      Lisp_Object elt = XCAR (list);
		      /* Preserve element ELT if it's t,
			 if it is a function with a `permanent-local-hook' property,
			 or if it's not a symbol.  */
		      if (! SYMBOLP (elt)
			  || EQ (elt, Qt)
			  || !NILP (Fget (elt, Qpermanent_local_hook)))
			newlist = Fcons (elt, newlist);
		    }
		XSETCDR (XCAR (tmp), Fnreverse (newlist));
	      }
	  }
	/* Delete this local variable.  */
759 760 761 762 763 764
	else if (NILP (last))
	  b->local_var_alist = XCDR (tmp);
	else
	  XSETCDR (last, XCDR (tmp));
    }

765
  for (i = 0; i < last_per_buffer_idx; ++i)
766
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
767
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
768 769 770 771

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

772 773 774
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
  for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
775 776
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
777
    {
778
      int idx = PER_BUFFER_IDX (offset);
779 780
      if ((idx > 0
	   && (permanent_too
781
	       || buffer_permanent_local_flags[idx] == 0)))
782
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
783
    }
Roland McGrath's avatar
Roland McGrath committed
784 785
}

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

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

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

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


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
829
       doc: /* Return the name of BUFFER, as a string.
830 831
BUFFER defaults to the current buffer.
Return nil if BUFFER has been killed.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
832
  (register Lisp_Object buffer)
Roland McGrath's avatar
Roland McGrath committed
833
{
Jim Blandy's avatar
Jim Blandy committed
834
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
835
    return current_buffer->name;
836
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
837 838 839 840
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
841 842
       doc: /* Return name of file BUFFER is visiting, or nil if none.
No argument or nil as argument means use the current buffer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
843
  (register Lisp_Object buffer)
Roland McGrath's avatar
Roland McGrath committed
844
{
Jim Blandy's avatar
Jim Blandy committed
845
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
846
    return current_buffer->filename;
847
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
848 849 850
  return XBUFFER (buffer)->filename;
}

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

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

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

875
DEFUN ("buffer-local-value", Fbuffer_local_value,
876
       Sbuffer_local_value, 2, 2, 0,
877 878
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value