buffer.c 200 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,
4
                 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
5
                 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>
Richard M. Stallman's avatar
Richard M. Stallman committed
30

Andreas Schwab's avatar
Andreas Schwab committed
31 32 33
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
34

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

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
62
DECL_ALIGN (struct buffer, buffer_defaults);
Roland McGrath's avatar
Roland McGrath committed
63 64 65 66 67 68 69 70 71 72 73

/* 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,
74 75
   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
76 77 78 79 80 81 82 83 84 85 86 87 88

   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
89 90
DECL_ALIGN (struct buffer, buffer_local_symbols);

Roland McGrath's avatar
Roland McGrath committed
91 92 93
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

94 95 96 97 98 99
/* 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))

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

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

106
int last_per_buffer_idx;
107

108
EXFUN (Fset_buffer, 1);
109 110 111 112 113 114 115
void set_buffer_internal (struct buffer *b);
void set_buffer_internal_1 (struct buffer *b);
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
116 117 118 119 120 121 122

/* Alist of all buffer names vs the buffers. */
/* This used to be a variable, but is no longer,
 to prevent lossage due to user rplac'ing this alist or its elements.  */
Lisp_Object Vbuffer_alist;

/* Functions to call before and after each text change. */
123 124
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
125

126 127
Lisp_Object Vtransient_mark_mode;

128 129 130 131 132
/* t means ignore all read-only text properties.
   A list means ignore such a property if its value is a member of the list.
   Any non-nil value means ignore buffer-read-only.  */
Lisp_Object Vinhibit_read_only;

133 134 135
/* List of functions to call that can query about killing a buffer.
   If any of these functions returns nil, we don't kill it.  */
Lisp_Object Vkill_buffer_query_functions;
136
Lisp_Object Qkill_buffer_query_functions;
137

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

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

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

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

Roland McGrath's avatar
Roland McGrath committed
152
Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
153
Lisp_Object Qpermanent_local_hook;
Roland McGrath's avatar
Roland McGrath committed
154 155 156 157 158 159 160

Lisp_Object Qprotected_field;

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

Lisp_Object Qkill_buffer_hook;

Richard M. Stallman's avatar
Richard M. Stallman committed
161 162
Lisp_Object Qget_file_buffer;

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

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

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

171 172 173 174 175
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 *);
176

177
extern char * emacs_strerror (int);
178

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

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

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

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

217
      CHECK_FRAME (frame);
218 219

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

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

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

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

Roland McGrath's avatar
Roland McGrath committed
267
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
268 269 270 271 272 273
       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.  */)
     (buffer_or_name)
     register Lisp_Object buffer_or_name;
Roland McGrath's avatar
Roland McGrath committed
274
{
275 276 277
  if (BUFFERP (buffer_or_name))
    return buffer_or_name;
  CHECK_STRING (buffer_or_name);
Roland McGrath's avatar
Roland McGrath committed
278

279
  return Fcdr (assoc_ignore_text_properties (buffer_or_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 337 338 339 340 341 342 343 344 345
       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.  */)
     (buffer_or_name)
     register Lisp_Object buffer_or_name;
Roland McGrath's avatar
Roland McGrath committed
346
{
347
  register Lisp_Object buffer, name;
Roland McGrath's avatar
Roland McGrath committed
348 349
  register struct buffer *b;

350 351 352
  buffer = Fget_buffer (buffer_or_name);
  if (!NILP (buffer))
    return buffer;
Roland McGrath's avatar
Roland McGrath committed
353

354
  if (SCHARS (buffer_or_name) == 0)
355 356
    error ("Empty string for buffer name is not allowed");

357
  b = allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
358

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

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

393 394 395
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
396
  b->prevent_redisplay_optimizations_p = 1;
397

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

402 403 404 405 406
  /* 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;
407

408
  name = Fcopy_sequence (buffer_or_name);
409
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Roland McGrath's avatar
Roland McGrath committed
410
  b->name = name;
411

412
  b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
Roland McGrath's avatar
Roland McGrath committed
413 414

  reset_buffer (b);
415
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
416

417
  b->mark = Fmake_marker ();
418
  BUF_MARKERS (b) = NULL;
419 420
  b->name = name;

Roland McGrath's avatar
Roland McGrath committed
421
  /* Put this in the alist of all live buffers.  */
422 423
  XSETBUFFER (buffer, b);
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
Roland McGrath's avatar
Roland McGrath committed
424

Juanma Barranquero's avatar
Juanma Barranquero committed
425
  /* An error in calling the function here (should someone redefine it)
Dave Love's avatar
Dave Love committed
426 427
     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
428
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
429 430
    /* buffer is on buffer-alist, so no gcpro.  */
    call1 (Qucs_set_table_for_input, buffer);
Dave Love's avatar
Dave Love committed
431

432
  return buffer;
433 434
}

435

436 437 438
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

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

  XSETBUFFER (buffer, b);

449
  for (; list; list = list->next)
450 451
    {
      Lisp_Object overlay, start, end, old_overlay;
452
      EMACS_INT charpos;
453

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

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

474 475 476 477
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
478 479
    }

480
  return result;
481
}
482

483

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

  XSETBUFFER (to_buffer, to);
499

500 501
  /* buffer-local Lisp variables start at `undo_list',
     tho only the ones from `name' on are GC'd normally.  */
502
  for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
503 504 505 506 507
       offset < sizeof *to;
       offset += sizeof (Lisp_Object))
    {
      Lisp_Object obj;

508 509 510 511
      /* Don't touch the `name' which should be unique for every buffer.  */
      if (offset == PER_BUFFER_VAR_OFFSET (name))
	continue;

512
      obj = PER_BUFFER_VALUE (from, offset);
513
      if (MARKERP (obj) && XMARKER (obj)->buffer == from)
514 515 516 517 518 519 520 521 522 523 524
	{
	  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);
525

526 527
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
528

529 530 531
  /* 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);
532 533 534 535
}

DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
536
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
537
       doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
Kenichi Handa's avatar
Kenichi Handa committed
538
BASE-BUFFER should be a live buffer, or the name of an existing buffer.
Pavel Janík's avatar
Pavel Janík committed
539 540 541
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.
542 543
CLONE nil means the indirect buffer's state is reset to default values.  */)
     (base_buffer, name, clone)
544
     Lisp_Object base_buffer, name, clone;
545
{
Kenichi Handa's avatar
Kenichi Handa committed
546
  Lisp_Object buf, tem;
547
  struct buffer *b;
548

Kenichi Handa's avatar
Kenichi Handa committed
549
  CHECK_STRING (name);
550 551
  buf = Fget_buffer (name);
  if (!NILP (buf))
552
    error ("Buffer name `%s' is in use", SDATA (name));
553

Kenichi Handa's avatar
Kenichi Handa committed
554
  tem = base_buffer;
555 556
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
Kenichi Handa's avatar
Kenichi Handa committed
557 558 559
    error ("No such buffer: `%s'", SDATA (tem));
  if (NILP (XBUFFER (base_buffer)->name))
    error ("Base buffer has been killed");
560

561
  if (SCHARS (name) == 0)
562 563
    error ("Empty string for buffer name is not allowed");

564
  b = allocate_buffer ();
565

566 567 568
  b->base_buffer = (XBUFFER (base_buffer)->base_buffer
		    ? XBUFFER (base_buffer)->base_buffer
		    : XBUFFER (base_buffer));
569 570 571 572 573 574 575

  /* 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);
576 577 578
  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);
579 580 581 582 583 584 585 586 587 588

  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);
589
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
590 591 592
  b->name = name;

  reset_buffer (b);
593
  reset_buffer_local_variables (b, 1);
594 595 596 597 598 599

  /* 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
600
  b->name = name;
601

602 603 604
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

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

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

657
  return buf;
Roland McGrath's avatar
Roland McGrath committed
658 659
}

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
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);
}

684
/* Reinitialize everything about a buffer except its name and contents
Kenichi Handa's avatar
Kenichi Handa committed
685
   and local variables.
686 687 688 689
   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
690 691 692 693 694 695

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

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
725 726
}

727 728 729
/* 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.
730 731
   Instead, use Fkill_all_local_variables.

732
   If PERMANENT_TOO is 1, then we reset permanent
733 734
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
735

736 737
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
738
     register struct buffer *b;
739
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
740 741
{
  register int offset;
742
  int i;
Roland McGrath's avatar
Roland McGrath committed
743 744 745 746 747 748 749 750 751

  /* 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;
752 753 754 755 756 757 758 759

  /* 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
760
  b->downcase_table = Vascii_downcase_table;
761 762 763
  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];
764
  b->invisibility_spec = Qt;
765 766 767
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
768

769
  /* Reset all (or most) per-buffer variables to their defaults.  */
770 771 772 773
  if (permanent_too)
    b->local_var_alist = Qnil;
  else
    {
774
      Lisp_Object tmp, prop, last = Qnil;
775
      for (tmp = b->local_var_alist; CONSP (tmp); tmp = XCDR (tmp))
776
	if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
	  {
	    /* 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.  */
804 805 806 807 808 809
	else if (NILP (last))
	  b->local_var_alist = XCDR (tmp);
	else
	  XSETCDR (last, XCDR (tmp));
    }

810
  for (i = 0; i < last_per_buffer_idx; ++i)
811
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
812
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
813 814 815 816

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

817 818 819
  /* 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);
820 821
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
822
    {
823
      int idx = PER_BUFFER_IDX (offset);
824 825
      if ((idx > 0
	   && (permanent_too
826
	       || buffer_permanent_local_flags[idx] == 0)))
827
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
828
    }
Roland McGrath's avatar
Roland McGrath committed
829 830
}

Roland McGrath's avatar
Roland McGrath committed
831 832 833 834 835
/* 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,
836
       1, 2, 0,
837
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
838 839
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
840
\(starting at 2) until an unused name is found, and then return that name.
Juanma Barranquero's avatar
Juanma Barranquero committed
841 842
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.  */)
843
     (name, ignore)
844
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
845 846 847 848 849
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

850
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
851

Kenichi Handa's avatar
Kenichi Handa committed
852 853 854
  tem = Fstring_equal (name, ignore);
  if (!NILP (tem))
    return name;
Roland McGrath's avatar
Roland McGrath committed
855
  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
856
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
857
    return name;
Roland McGrath's avatar
Roland McGrath committed
858 859 860 861 862 863

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
864
      tem = Fstring_equal (gentemp, ignore);
865 866
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
867
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
868
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
869
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
870 871 872 873 874
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
875
       doc: /* Return the name of BUFFER, as a string.
876 877
BUFFER defaults to the current buffer.
Return nil if BUFFER has been killed.  */)
878
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
879 880
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
881
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
882
    return current_buffer->name;
883
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
884 885 886 887
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
888 889 890
       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
891 892
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
893
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
894
    return current_buffer->filename;
895
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
896 897 898
  return XBUFFER (buffer)->filename;
}

899 900
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
901
       doc: /* Return the base buffer of indirect buffer BUFFER.
902 903
If BUFFER is not indirect, return nil.
BUFFER defaults to the current buffer.  */)