buffer.c 174 KB
Newer Older
Roland McGrath's avatar
Roland McGrath committed
1
/* Buffer manipulation primitives for GNU Emacs.
2
   Copyright (C) 1985,86,87,88,89,93,94,95,97,98, 1999, 2000, 2001, 2002
3
	Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
4 5 6 7 8

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Roland McGrath's avatar
Roland McGrath committed
21

22
#include <config.h>
Roland McGrath's avatar
Roland McGrath committed
23

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

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

#ifndef MAXPATHLEN
/* in 4.1, param.h fails to define this. */
#define MAXPATHLEN 1024
#endif /* not MAXPATHLEN */

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

Roland McGrath's avatar
Roland McGrath committed
43
#include "lisp.h"
44
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
45 46 47
#include "window.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
48
#include "charset.h"
49
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
50
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
51
#include "blockinput.h"
52
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
53
#include "keymap.h"
54
#include "frame.h"
Roland McGrath's avatar
Roland McGrath committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

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

struct buffer buffer_defaults;

/* A Lisp_Object pointer to the above, used for staticpro */

static Lisp_Object Vbuffer_defaults;

/* This structure marks which slots in a buffer have corresponding
   default values in buffer_defaults.
   Each such slot has a nonzero value in this structure.
   The value has only one nonzero bit.

   When a buffer has its own local value for a slot,
82 83
   the entry for that slot (found in the same slot in this structure)
   is turned on in the buffer's local_flags array.
Roland McGrath's avatar
Roland McGrath committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

   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 is negative, 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. */

struct buffer buffer_local_symbols;
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

108 109 110 111
/* This structure holds the required types for the values in the
   buffer-local slots.  If a slot contains Qnil, then the
   corresponding buffer slot may contain a value of any type.  If a
   slot contains an integer, then prospective values' tags must be
112 113 114 115 116
   equal to that integer (except nil is always allowed).
   When a tag does not match, the function
   buffer_slot_type_mismatch will signal an error.

   If a slot here contains -1, the corresponding variable is read-only.  */
117 118
struct buffer buffer_local_types;

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

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

125
int last_per_buffer_idx;
126

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

/* 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. */
140 141
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
142

143 144
Lisp_Object Vtransient_mark_mode;

145 146 147 148 149
/* 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;

150 151 152 153
/* 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;

Jim Blandy's avatar
Jim Blandy committed
154 155
/* List of functions to call before changing an unmodified buffer.  */
Lisp_Object Vfirst_change_hook;
156

Jim Blandy's avatar
Jim Blandy committed
157
Lisp_Object Qfirst_change_hook;
158 159
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
160

161 162 163
/* If nonzero, all modification hooks are suppressed.  */
int inhibit_modification_hooks;

Roland McGrath's avatar
Roland McGrath committed
164 165 166 167 168 169 170 171
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
172 173
Lisp_Object Qget_file_buffer;

Jim Blandy's avatar
Jim Blandy committed
174 175
Lisp_Object Qoverlayp;

176
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
177

178 179 180
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;
181
Lisp_Object Qset_buffer_major_mode_hook;
182

183 184
static void alloc_buffer_text P_ ((struct buffer *, size_t));
static void free_buffer_text P_ ((struct buffer *b));
185
static Lisp_Object copy_overlays P_ ((struct buffer *, Lisp_Object));
186
static void modify_overlay P_ ((struct buffer *, int, int));
187 188


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

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

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

  if (FRAMEP (frame))
    {
      Lisp_Object tail;

226
      CHECK_FRAME (frame);
227 228 229 230 231 232 233

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

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

  return general;
Roland McGrath's avatar
Roland McGrath committed
241 242
}

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

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

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

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

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

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

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

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

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

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

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

350
  b = (struct buffer *) allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
351

352 353 354 355 356 357
  b->size = sizeof (struct buffer) / sizeof (EMACS_INT);

  /* An ordinary buffer uses its own struct buffer_text.  */
  b->text = &b->own_text;
  b->base_buffer = 0;

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

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

387 388 389
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
390
  b->prevent_redisplay_optimizations_p = 1;
391

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

396 397 398 399 400
  /* An ordinary buffer normally doesn't need markers
     to handle BEGV and ZV.  */
  b->pt_marker = Qnil;
  b->begv_marker = Qnil;
  b->zv_marker = Qnil;
401 402

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

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

  reset_buffer (b);
412
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
413 414

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

  b->mark = Fmake_marker ();
419 420 421 422 423
  BUF_MARKERS (b) = Qnil;
  b->name = name;
  return buf;
}

424

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

static Lisp_Object
copy_overlays (b, list)
     struct buffer *b;
     Lisp_Object list;
{
  Lisp_Object result, buffer;

  XSETBUFFER (buffer, b);

  for (result = Qnil; CONSP (list); list = XCDR (list))
    {
      Lisp_Object overlay, start, end, old_overlay;
      int charpos;

      old_overlay = XCAR (list);
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
445
      Fset_marker (start, make_number (charpos), buffer);
446 447 448 449 450
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
451
      Fset_marker (end, make_number (charpos), buffer);
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
      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));
      
      result = Fcons (overlay, result);
    }

  return Fnreverse (result);
}
     

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
/* Clone per-buffer values of buffer FROM.

   Buffer TO gets the same per-buffer values as FROM, with the
   following exceptions: (1) TO's name is left untouched, (2) markers
   are copied and made to refer to TO, and (3) overlay lists are
   copied.  */

static void
clone_per_buffer_values (from, to)
     struct buffer *from, *to;
{
  Lisp_Object to_buffer;
  int offset;

  XSETBUFFER (to_buffer, to);
  
  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);
503 504 505
  
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
506 507 508 509 510
}


DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
511
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
512
       doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
Pavel Janík's avatar
Pavel Janík committed
513 514 515 516
BASE-BUFFER should be an existing buffer (or buffer name).
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.
517 518
CLONE nil means the indirect buffer's state is reset to default values.  */)
     (base_buffer, name, clone)
519
     Lisp_Object base_buffer, name, clone;
520
{
521 522
  Lisp_Object buf;
  struct buffer *b;
523 524 525

  buf = Fget_buffer (name);
  if (!NILP (buf))
526
    error ("Buffer name `%s' is in use", SDATA (name));
527 528 529

  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
530
    error ("No such buffer: `%s'", SDATA (name));
531

532
  if (SCHARS (name) == 0)
533 534
    error ("Empty string for buffer name is not allowed");

535
  b = (struct buffer *) allocate_buffer ();
536 537 538 539 540 541 542 543 544 545 546 547 548
  b->size = sizeof (struct buffer) / sizeof (EMACS_INT);

  if (XBUFFER (base_buffer)->base_buffer)
    b->base_buffer = XBUFFER (base_buffer)->base_buffer;
  else
    b->base_buffer = XBUFFER (base_buffer);

  /* Use the base buffer's text object.  */
  b->text = b->base_buffer->text;

  BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
  BUF_ZV (b) = BUF_ZV (b->base_buffer);
  BUF_PT (b) = BUF_PT (b->base_buffer);
549 550 551
  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);
552 553 554 555 556 557 558 559 560 561

  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);
562
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
563 564 565
  b->name = name;

  reset_buffer (b);
566
  reset_buffer_local_variables (b, 1);
567 568 569 570 571 572

  /* 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
573
  b->name = name;
574

575 576 577
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

578 579 580 581
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
582 583 584
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
585 586 587 588
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
589 590 591
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
592 593 594 595
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
596 597 598
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
599
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
600 601
    }

602 603 604 605 606 607 608 609 610 611 612 613 614
  if (NILP (clone))
    {
      /* Give the indirect buffer markers for its narrowing.  */
      b->pt_marker = Fmake_marker ();
      set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
      b->begv_marker = Fmake_marker ();
      set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
      b->zv_marker = Fmake_marker ();
      set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
      XMARKER (b->zv_marker)->insertion_type = 1;
    }
  else
    clone_per_buffer_values (b->base_buffer, b);
615

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

619 620
/* Reinitialize everything about a buffer except its name and contents
   and local variables.  */
Roland McGrath's avatar
Roland McGrath committed
621 622 623 624 625 626

void
reset_buffer (b)
     register struct buffer *b;
{
  b->filename = Qnil;
627
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
628 629
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
630
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
631
  b->last_window_start = 1;
632
  /* It is more conservative to start out "changed" than "unchanged".  */
633 634
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
635 636
  b->backed_up = Qnil;
  b->auto_save_modified = 0;
637
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
638 639
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
640 641
  b->overlays_before = Qnil;
  b->overlays_after = Qnil;
642
  XSETFASTINT (b->overlay_center, 1);
643
  b->mark_active = Qnil;
644
  b->point_before_scroll = Qnil;
645
  b->file_format = Qnil;
646
  b->last_selected_window = Qnil;
647
  XSETINT (b->display_count, 0);
648
  b->display_time = Qnil;
649
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
650
  b->cursor_type = buffer_defaults.cursor_type;
651
  b->extra_line_spacing = buffer_defaults.extra_line_spacing;
652 653

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
654 655
}

656 657 658
/* 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.
659 660 661 662 663
   Instead, use Fkill_all_local_variables.

   If PERMANENT_TOO is 1, then we reset permanent built-in
   buffer-local variables.  If PERMANENT_TOO is 0,
   we preserve those.  */
664

665 666
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
667
     register struct buffer *b;
668
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
669 670
{
  register int offset;
671
  int i;
Roland McGrath's avatar
Roland McGrath committed
672 673 674 675 676 677 678 679 680 681

  /* 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->abbrev_table = Vfundamental_mode_abbrev_table;
  b->mode_name = QSFundamental;
  b->minor_modes = Qnil;
682 683 684 685 686 687 688 689

  /* 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
690
  b->downcase_table = Vascii_downcase_table;
691 692 693
  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];
694
  b->invisibility_spec = Qt;
695 696 697
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
698

699
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
700
  b->local_var_alist = Qnil;
701
  for (i = 0; i < last_per_buffer_idx; ++i)
702
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
703
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
704 705 706 707

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

708
  for (offset = PER_BUFFER_VAR_OFFSET (name);
709 710
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
711
    {
712
      int idx = PER_BUFFER_IDX (offset);
713 714 715 716 717
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
718
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
719
    }
Roland McGrath's avatar
Roland McGrath committed
720 721
}

Roland McGrath's avatar
Roland McGrath committed
722 723 724 725 726
/* 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,
727
       1, 2, 0,
728
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
729 730 731 732 733
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
until an unused name is found, and then return that name.
Optional second argument IGNORE specifies a name that is okay to use
\(if it is in the sequence to be tried)
734 735
even if a buffer with that name exists.  */)
     (name, ignore)
736
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
737 738 739 740 741
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

742
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
743 744

  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
745
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
746
    return name;
Roland McGrath's avatar
Roland McGrath committed
747 748 749 750 751 752

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
753
      tem = Fstring_equal (gentemp, ignore);
754 755
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
756
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
757
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
758
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
759 760 761 762 763
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
764 765 766
       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
767 768
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
769
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
770
    return current_buffer->name;
771
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
772 773 774 775
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
776 777 778
       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
779 780
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
781
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
782
    return current_buffer->filename;
783
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
784 785 786
  return XBUFFER (buffer)->filename;
}

787 788
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
789 790 791
       doc: /* Return the base buffer of indirect buffer BUFFER.
If BUFFER is not indirect, return nil.  */)
     (buffer)
792 793 794 795 796 797 798 799 800
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
801
      CHECK_BUFFER (buffer);
802 803 804 805 806 807 808 809 810
      base = XBUFFER (buffer)->base_buffer;
    }

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

811 812 813 814 815 816 817 818 819 820 821 822
DEFUN ("buffer-local-value", Fbuffer_local_value,
       Sbuffer_local_value, 2, 2, 0, 
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value
is the default binding of variable. */)
     (symbol, buffer)
     register Lisp_Object symbol;
     register Lisp_Object buffer;
{
  register struct buffer *buf;
  register Lisp_Object result;

823 824
  CHECK_SYMBOL (symbol);
  CHECK_BUFFER (buffer);
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
  buf = XBUFFER (buffer);

  /* Look in local_var_list */
  result = Fassoc (symbol, buf->local_var_alist);
  if (NILP (result)) 
    {
      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))
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset)) 
	      && EQ (PER_BUFFER_SYMBOL (offset), symbol)) 
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
	result = Fdefault_value (symbol);
    }
  else
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
    {
      Lisp_Object valcontents;
      Lisp_Object current_alist_element;

      /* What binding is loaded right now?  */
      valcontents = SYMBOL_VALUE (symbol);
      current_alist_element
	= XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);

      /* The value of the currently loaded binding is not
	 stored in it, but rather in the realvalue slot.
	 Store that value into the binding it belongs to
	 in case that is the one we are about to use.  */

      Fsetcdr (current_alist_element,
	       do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));

      /* Now get the (perhaps updated) value out of the binding.  */
      result = XCDR (result);
    }
875 876 877 878 879 880 881

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

  return result;
}

Roland McGrath's avatar
Roland McGrath committed
882
DEFUN ("buffer-local-variables", Fbuffer_local_variables,
883
       Sbuffer_local_variables, 0, 1, 0,
884
       doc: /* Return an alist of variables that are buffer-local in BUFFER.
Pavel Janík's avatar
Pavel Janík committed
885 886 887
Most elements look like (SYMBOL . VALUE), describing one variable.
For a symbol that is locally unbound, just the symbol appears in the value.
Note that storing new VALUEs in these elements doesn't change the variables.
888 889
No argument or nil as argument means use current buffer as BUFFER.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
890 891 892
     register Lisp_Object buffer;
{
  register struct buffer *buf;
893
  register Lisp_Object result;
Roland McGrath's avatar
Roland McGrath committed
894

Jim Blandy's avatar
Jim Blandy committed
895
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
896 897 898
    buf = current_buffer;
  else
    {
899
      CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
900 901 902
      buf = XBUFFER (buffer);
    }

903 904
  result = Qnil;

Roland McGrath's avatar
Roland McGrath committed
905
  {
906
    register Lisp_Object tail;
907
    for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
908
      {
909 910
	Lisp_Object val, elt;

911
	elt = XCAR (tail);
912

913 914 915 916 917
	/* Reference each variable in the alist in buf.
	   If inquiring about the current buffer, this gets the current values,
	   so store them into the alist so the alist is up to date.
	   If inquiring about some other buffer, this swaps out any values
	   for that buffer, making the alist up to date automatically.  */
918
	val = find_symbol_value (XCAR (elt));
919 920
	/* Use the current buffer value only if buf is the current buffer.  */
	if (buf != current_buffer)
921
	  val = XCDR (elt);
922 923 924

	/* If symbol is unbound, put just the symbol in the list.  */
	if (EQ (val, Qunbound))
925
	  result = Fcons (XCAR (elt), result);
926 927
	/* Otherwise, put (symbol . value) in the list.  */
	else
928
	  result = Fcons (Fcons (XCAR (elt), val), result);
Roland McGrath's avatar
Roland McGrath committed
929 930 931 932 933
      }
  }

  /* Add on all the variables stored in special slots.  */
  {
934
    int offset, idx;
Roland McGrath's avatar
Roland McGrath committed
935

936
    for (offset = PER_BUFFER_VAR_OFFSET (name);
Roland McGrath's avatar
Roland McGrath committed
937
	 offset < sizeof (struct buffer);
938 939
	 /* sizeof EMACS_INT == sizeof Lisp_Object */
	 offset += (sizeof (EMACS_INT)))
Roland McGrath's avatar
Roland McGrath committed
940
      {
941 942 943 944 945
	idx = PER_BUFFER_IDX (offset);
	if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
	    && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
	  result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
				 PER_BUFFER_VALUE (buf, offset)),
946
			  result);
Roland McGrath's avatar
Roland McGrath committed
947 948
      }
  }
949 950

  return result;
Roland McGrath's avatar
Roland McGrath committed
951 952 953 954
}


DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
955
       0, 1, 0,
956 957 958
       doc: /* Return t if BUFFER was modified since its file was last read or saved.
No argument or nil as argument means use current buffer as BUFFER.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
959 960 961
     register Lisp_Object buffer;
{
  register struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
962
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
963 964 965
    buf = current_buffer;
  else
    {
966
      CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
967 968 969
      buf = XBUFFER (buffer);
    }

970
  return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
Roland McGrath's avatar
Roland McGrath committed
971 972 973
}

DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
974
       1, 1, 0,
975 976 977
       doc: /* Mark current buffer as modified or unmodified according to FLAG.
A non-nil FLAG means mark the buffer modified.  */)
     (flag)
Roland McGrath's avatar
Roland McGrath committed
978 979 980 981
     register Lisp_Object flag;
{
  register int already;
  register Lisp_Object fn;
982
  Lisp_Object buffer, window;
Roland McGrath's avatar
Roland McGrath committed
983 984 985 986 987

#ifdef CLASH_DETECTION
  /* If buffer becoming modified, lock the file.
     If buffer becoming unmodified, unlock the file.  */

988
  fn = current_buffer->file_truename;
989 990
  /* Test buffer-file-name so that binding it to nil is effective.  */
  if (!NILP (fn) && ! NILP (current_buffer->filename))
Roland McGrath's avatar
Roland McGrath committed
991
    {
992
      already = SAVE_MODIFF < MODIFF;
Jim Blandy's avatar
Jim Blandy committed
993
      if (!already && !NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
994
	lock_file (fn);
Jim Blandy's avatar
Jim Blandy committed
995
      else if (already && NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
996 997 998 999
	unlock_file (fn);
    }
#endif /* CLASH_DETECTION */

1000
  SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
  
  /* Set update_mode_lines only if buffer is displayed in some window.
     Packages like jit-lock or lazy-lock preserve a buffer's modified
     state by recording/restoring the state around blocks of code.
     Setting update_mode_lines makes redisplay consider all windows
     (on all frames).  Stealth fontification of buffers not displayed
     would incur additional redisplay costs if we'd set
     update_modes_lines unconditionally.

     Ideally, I think there should be another mechanism for fontifying
     buffers without "modifying" buffers, or redisplay should be
     smarter about updating the `*' in mode lines.  --gerd  */
  XSETBUFFER (buffer, current_buffer);
  window = Fget_buffer_window (buffer, Qt);
  if (WINDOWP (window))
1016 1017 1018 1019
    {
      ++update_mode_lines;
      current_buffer->prevent_redisplay_optimizations_p = 1;
    }
1020
  
Roland McGrath's avatar
Roland McGrath committed
1021 1022 1023
  return flag;
}

1024 1025
DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
       Srestore_buffer_modified_p, 1, 1, 0,
1026
       doc: /* Like `set-buffer-modified-p', with a differences concerning redisplay.
Pavel Janík's avatar
Pavel Janík committed
1027
It is not ensured that mode lines will be updated to show the modified
1028 1029
state of the current buffer.  Use with care.  */)
     (flag)