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

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,
80 81
   the entry for that slot (found in the same slot in this structure)
   is turned on in the buffer's local_flags array.
Roland McGrath's avatar
Roland McGrath committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

   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;

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

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

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

123
int last_per_buffer_idx;
124

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

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

141 142
Lisp_Object Vtransient_mark_mode;

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

148 149 150 151
/* 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
152 153
/* List of functions to call before changing an unmodified buffer.  */
Lisp_Object Vfirst_change_hook;
154

Jim Blandy's avatar
Jim Blandy committed
155
Lisp_Object Qfirst_change_hook;
156 157
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
158

159 160 161
/* If nonzero, all modification hooks are suppressed.  */
int inhibit_modification_hooks;

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

Jim Blandy's avatar
Jim Blandy committed
172 173
Lisp_Object Qoverlayp;

174
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
175

176 177 178 179
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

180 181
static void alloc_buffer_text P_ ((struct buffer *, size_t));
static void free_buffer_text P_ ((struct buffer *b));
182
static Lisp_Object copy_overlays P_ ((struct buffer *, Lisp_Object));
183 184


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

188
void
Roland McGrath's avatar
Roland McGrath committed
189 190 191
nsberror (spec)
     Lisp_Object spec;
{
192
  if (STRINGP (spec))
Roland McGrath's avatar
Roland McGrath committed
193 194 195 196
    error ("No buffer named %s", XSTRING (spec)->data);
  error ("Invalid buffer argument");
}

197 198 199 200 201 202 203 204 205 206
DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
  "Return non-nil if OBJECT is a buffer which has not been killed.\n\
Value is nil if OBJECT is not a buffer or if it has been killed.")
  (object)
     Lisp_Object object;
{
  return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
	  ? Qt : Qnil);
}

207 208 209 210 211
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
  "Return a list of all existing live buffers.\n\
If the optional arg FRAME is a frame, we return that frame's buffer list.")
  (frame)
     Lisp_Object frame;
Roland McGrath's avatar
Roland McGrath committed
212
{
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  Lisp_Object framelist, general;
  general = Fmapcar (Qcdr, Vbuffer_alist);

  if (FRAMEP (frame))
    {
      Lisp_Object tail;

      CHECK_FRAME (frame, 1);

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

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

  return general;
Roland McGrath's avatar
Roland McGrath committed
235 236
}

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

Roland McGrath's avatar
Roland McGrath committed
258 259 260 261 262 263 264
DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
  "Return the buffer named NAME (a string).\n\
If there is no live buffer named NAME, return nil.\n\
NAME may also be a buffer; if so, the value is that buffer.")
  (name)
     register Lisp_Object name;
{
265
  if (BUFFERP (name))
Roland McGrath's avatar
Roland McGrath committed
266 267 268
    return name;
  CHECK_STRING (name, 0);

269
  return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
270 271 272 273
}

DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
  "Return the buffer visiting file FILENAME (a string).\n\
Karl Heuer's avatar
Karl Heuer committed
274
The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
275 276
If there is no such live buffer, return nil.\n\
See also `find-buffer-visiting'.")
Roland McGrath's avatar
Roland McGrath committed
277 278 279 280
  (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;
Richard M. Stallman's avatar
Richard M. Stallman committed
281 282
  Lisp_Object handler;

Roland McGrath's avatar
Roland McGrath committed
283 284 285
  CHECK_STRING (filename, 0);
  filename = Fexpand_file_name (filename, Qnil);

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

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

304 305 306 307 308 309
Lisp_Object
get_truename_buffer (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;

310
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
311
    {
312
      buf = Fcdr (XCAR (tail));
313 314 315 316 317 318 319 320 321
      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
322 323 324 325 326 327
/* 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,
  "Return the buffer named NAME, or create such a buffer and return it.\n\
A new buffer is created if there is no live buffer named NAME.\n\
328
If NAME starts with a space, the new buffer does not keep undo information.\n\
Roland McGrath's avatar
Roland McGrath committed
329 330 331 332 333
If NAME is a buffer instead of a string, then it is the value returned.\n\
The value is never nil.")  
  (name)
     register Lisp_Object name;
{
334
  register Lisp_Object buf;
Roland McGrath's avatar
Roland McGrath committed
335 336 337
  register struct buffer *b;

  buf = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
338
  if (!NILP (buf))
Roland McGrath's avatar
Roland McGrath committed
339 340
    return buf;

341 342 343
  if (XSTRING (name)->size == 0)
    error ("Empty string for buffer name is not allowed");

344
  b = (struct buffer *) allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
345

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

  BUF_PT (b) = 1;
  BUF_GPT (b) = 1;
  BUF_BEGV (b) = 1;
  BUF_ZV (b) = 1;
  BUF_Z (b) = 1;
366 367 368 369 370
  BUF_PT_BYTE (b) = 1;
  BUF_GPT_BYTE (b) = 1;
  BUF_BEGV_BYTE (b) = 1;
  BUF_ZV_BYTE (b) = 1;
  BUF_Z_BYTE (b) = 1;
Roland McGrath's avatar
Roland McGrath committed
371
  BUF_MODIFF (b) = 1;
372
  BUF_OVERLAY_MODIFF (b) = 1;
373 374
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
375 376 377 378
  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
379
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
Roland McGrath's avatar
Roland McGrath committed
380

381 382 383
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
384
  b->prevent_redisplay_optimizations_p = 1;
385

Roland McGrath's avatar
Roland McGrath committed
386 387 388 389
  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

390 391 392 393 394
  /* 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;
395 396

  name = Fcopy_sequence (name);
397
  XSTRING (name)->intervals = NULL_INTERVAL;
Roland McGrath's avatar
Roland McGrath committed
398
  b->name = name;
399

Roland McGrath's avatar
Roland McGrath committed
400 401 402 403 404 405
  if (XSTRING (name)->data[0] != ' ')
    b->undo_list = Qnil;
  else
    b->undo_list = Qt;

  reset_buffer (b);
406
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
407 408

  /* Put this in the alist of all live buffers.  */
409
  XSETBUFFER (buf, b);
Roland McGrath's avatar
Roland McGrath committed
410 411 412
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));

  b->mark = Fmake_marker ();
413 414 415 416 417
  BUF_MARKERS (b) = Qnil;
  b->name = name;
  return buf;
}

418

419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
/* 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 ();
      Fset_marker (start, charpos, buffer);
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
      Fset_marker (end, charpos, buffer);
      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);
}
     

462 463 464 465 466 467 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
/* 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);
497 498 499
  
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
500 501 502 503 504
}


DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
505
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
506 507
  "Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.\n\
BASE-BUFFER should be an existing buffer (or buffer name).\n\
508 509
NAME should be a string which is not the name of an existing buffer.\n\
Optional argument CLONE non-nil means preserve BASE-BUFFER's state,\n\
510
such as major and minor modes, in the indirect buffer.\n\
511 512 513
CLONE nil means the indirect buffer's state is reset to default values.")
  (base_buffer, name, clone)
     Lisp_Object base_buffer, name, clone;
514
{
515 516
  Lisp_Object buf;
  struct buffer *b;
517 518 519 520 521 522 523

  buf = Fget_buffer (name);
  if (!NILP (buf))
    error ("Buffer name `%s' is in use", XSTRING (name)->data);

  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
524
    error ("No such buffer: `%s'", XSTRING (name)->data);
525 526 527 528

  if (XSTRING (name)->size == 0)
    error ("Empty string for buffer name is not allowed");

529
  b = (struct buffer *) allocate_buffer ();
530 531 532 533 534 535 536 537 538 539 540 541 542
  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);
543 544 545
  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);
546 547 548 549 550 551 552 553 554 555

  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);
556
  XSTRING (name)->intervals = NULL_INTERVAL;
557 558 559
  b->name = name;

  reset_buffer (b);
560
  reset_buffer_local_variables (b, 1);
561 562 563 564 565 566

  /* 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
567
  b->name = name;
568

569 570 571
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

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

596 597 598 599 600 601 602 603 604 605 606 607 608
  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);
609

610
  return buf;
Roland McGrath's avatar
Roland McGrath committed
611 612
}

613 614
/* Reinitialize everything about a buffer except its name and contents
   and local variables.  */
Roland McGrath's avatar
Roland McGrath committed
615 616 617 618 619 620

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

648 649 650
/* 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.
651 652 653 654 655
   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.  */
656

657 658
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
659
     register struct buffer *b;
660
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
661 662
{
  register int offset;
663
  int i;
Roland McGrath's avatar
Roland McGrath committed
664 665 666 667 668 669 670 671 672 673

  /* 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;
674 675 676 677 678 679 680 681

  /* 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
682
  b->downcase_table = Vascii_downcase_table;
683 684 685
  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];
686
  b->invisibility_spec = Qt;
687 688 689
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
690

Roland McGrath's avatar
Roland McGrath committed
691 692 693 694 695
#if 0
  b->sort_table = XSTRING (Vascii_sort_table);
  b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
#endif /* 0 */

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

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

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

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

  CHECK_STRING (name, 0);

  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
742
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
743
    return name;
Roland McGrath's avatar
Roland McGrath committed
744 745 746 747 748 749

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


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
  "Return the name of BUFFER, as a string.\n\
Roland McGrath's avatar
Roland McGrath committed
762
With no argument or nil as argument, return the name of the current buffer.")
Roland McGrath's avatar
Roland McGrath committed
763 764 765
  (buffer)
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
766
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
767 768 769 770 771 772 773 774 775 776 777
    return current_buffer->name;
  CHECK_BUFFER (buffer, 0);
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
  "Return name of file BUFFER is visiting, or nil if none.\n\
No argument or nil as argument means use the current buffer.")
  (buffer)
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
778
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
779 780 781 782 783
    return current_buffer->filename;
  CHECK_BUFFER (buffer, 0);
  return XBUFFER (buffer)->filename;
}

784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
  "Return the base buffer of indirect buffer BUFFER.\n\
If BUFFER is not indirect, return nil.")
  (buffer)
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      base = XBUFFER (buffer)->base_buffer;
    }

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

Roland McGrath's avatar
Roland McGrath committed
808 809 810
DEFUN ("buffer-local-variables", Fbuffer_local_variables,
  Sbuffer_local_variables, 0, 1, 0,
  "Return an alist of variables that are buffer-local in BUFFER.\n\
811 812
Most elements look like (SYMBOL . VALUE), describing one variable.\n\
For a symbol that is locally unbound, just the symbol appears in the value.\n\
Roland McGrath's avatar
Roland McGrath committed
813 814 815 816 817 818
Note that storing new VALUEs in these elements doesn't change the variables.\n\
No argument or nil as argument means use current buffer as BUFFER.")
  (buffer)
     register Lisp_Object buffer;
{
  register struct buffer *buf;
819
  register Lisp_Object result;
Roland McGrath's avatar
Roland McGrath committed
820

Jim Blandy's avatar
Jim Blandy committed
821
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
822 823 824 825 826 827 828
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

829 830
  result = Qnil;

Roland McGrath's avatar
Roland McGrath committed
831
  {
832
    register Lisp_Object tail;
833
    for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
834
      {
835 836
	Lisp_Object val, elt;

837
	elt = XCAR (tail);
838

839 840 841 842 843
	/* 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.  */
844
	val = find_symbol_value (XCAR (elt));
845 846
	/* Use the current buffer value only if buf is the current buffer.  */
	if (buf != current_buffer)
847
	  val = XCDR (elt);
848 849 850

	/* If symbol is unbound, put just the symbol in the list.  */
	if (EQ (val, Qunbound))
851
	  result = Fcons (XCAR (elt), result);
852 853
	/* Otherwise, put (symbol . value) in the list.  */
	else
854
	  result = Fcons (Fcons (XCAR (elt), val), result);
Roland McGrath's avatar
Roland McGrath committed
855 856 857 858 859
      }
  }

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

862
    for (offset = PER_BUFFER_VAR_OFFSET (name);
Roland McGrath's avatar
Roland McGrath committed
863
	 offset < sizeof (struct buffer);
864 865
	 /* sizeof EMACS_INT == sizeof Lisp_Object */
	 offset += (sizeof (EMACS_INT)))
Roland McGrath's avatar
Roland McGrath committed
866
      {
867 868 869 870 871
	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)),
872
			  result);
Roland McGrath's avatar
Roland McGrath committed
873 874
      }
  }
875 876

  return result;
Roland McGrath's avatar
Roland McGrath committed
877 878 879 880 881 882 883 884 885 886 887
}


DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
  0, 1, 0,
  "Return t if BUFFER was modified since its file was last read or saved.\n\
No argument or nil as argument means use current buffer as BUFFER.")
  (buffer)
     register Lisp_Object buffer;
{
  register struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
888
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
889 890 891 892 893 894 895
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

896
  return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
Roland McGrath's avatar
Roland McGrath committed
897 898 899 900 901 902 903 904 905 906 907
}

DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
  1, 1, 0,
  "Mark current buffer as modified or unmodified according to FLAG.\n\
A non-nil FLAG means mark the buffer modified.")
  (flag)
     register Lisp_Object flag;
{
  register int already;
  register Lisp_Object fn;
908
  Lisp_Object buffer, window;
Roland McGrath's avatar
Roland McGrath committed
909 910 911 912 913

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

914
  fn = current_buffer->file_truename;
915 916
  /* 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
917
    {
918
      already = SAVE_MODIFF < MODIFF;
Jim Blandy's avatar
Jim Blandy committed
919
      if (!already && !NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
920
	lock_file (fn);
Jim Blandy's avatar
Jim Blandy committed
921
      else if (already && NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
922 923 924 925
	unlock_file (fn);
    }
#endif /* CLASH_DETECTION */

926
  SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
  
  /* 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))
942 943 944 945
    {
      ++update_mode_lines;
      current_buffer->prevent_redisplay_optimizations_p = 1;
    }
946
  
Roland McGrath's avatar
Roland McGrath committed
947 948 949
  return flag;
}

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
       Srestore_buffer_modified_p, 1, 1, 0,
   "Like `set-buffer-modified-p', with a differences concerning redisplay.\n\
It is not ensured that mode lines will be updated to show the modified\n\
state of the current buffer.  Use with care.")
  (flag)
     Lisp_Object flag;
{
#ifdef CLASH_DETECTION
  Lisp_Object fn;
  
  /* If buffer becoming modified, lock the file.
     If buffer becoming unmodified, unlock the file.  */

  fn = current_buffer->file_truename;
  /* Test buffer-file-name so that binding it to nil is effective.  */
  if (!NILP (fn) && ! NILP (current_buffer->filename))
    {
      int already = SAVE_MODIFF < MODIFF;
      if (!already && !NILP (flag))
	lock_file (fn);
      else if (already && NILP (flag))
	unlock_file (fn);
    }
#endif /* CLASH_DETECTION */
  
  SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
  return flag;
}

Roland McGrath's avatar
Roland McGrath committed
980 981 982 983 984 985 986 987 988 989
DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
  0, 1, 0,
  "Return BUFFER's tick counter, incremented for each change in text.\n\
Each buffer has a tick counter which is incremented each time the text in\n\
that buffer is changed.  It wraps around occasionally.\n\
No argument or nil as argument means use current buffer as BUFFER.")
  (buffer)
     register Lisp_Object buffer;
{
  register struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
990
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
991 992 993 994 995 996 997 998 999 1000
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

  return make_number (BUF_MODIFF (buf));
}

Roland McGrath's avatar
Roland McGrath committed
1001
DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1002
       "sRename buffer (to new name): \nP",
Roland McGrath's avatar
Roland McGrath committed
1003
  "Change current buffer's name to NEWNAME (a string).\n\
1004
If second arg UNIQUE is nil or omitted, it is an error if a\n\
Roland McGrath's avatar
Roland McGrath committed
1005
buffer named NEWNAME already exists.\n\
1006
If UNIQUE is non-nil, come up with a new name using\n\
Roland McGrath's avatar
Roland McGrath committed
1007
`generate-new-buffer-name'.\n\
1008 1009
Interactively, you can set UNIQUE with a prefix argument.\n\
We return the name we actually gave the buffer.\n\
Roland McGrath's avatar
Roland McGrath committed
1010
This does not change the name of the visited file (if any).")
1011 1012
  (newname, unique)
     register Lisp_Object newname, unique;
Roland McGrath's avatar
Roland McGrath committed
1013 1014 1015
{
  register Lisp_Object tem, buf;

1016
  CHECK_STRING (newname, 0);
1017

1018
  if (XSTRING (newname)->size == 0)
1019 1020
    error ("Empty string is invalid as a buffer name");

1021
  tem = Fget_buffer (newname);
Jim Blandy's avatar
Jim Blandy committed
1022
  if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
1023
    {
1024 1025 1026 1027 1028 1029
      /* Don't short-circuit if UNIQUE is t.  That is a useful way to
	 rename the buffer automatically so you can create another
	 with the original name.  It makes UNIQUE equivalent to
	 (rename-buffer (generate-new-buffer-name NEWNAME)).  */
      if (NILP (unique) && XBUFFER (tem) == current_buffer)
	return current_buffer->name;
1030
      if (!NILP (unique))
1031
	newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
Roland McGrath's avatar
Roland McGrath committed
1032
      else
1033
	error ("Buffer name `%s' is in use", XSTRING (newname)->data);
Roland McGrath's avatar
Roland McGrath committed
1034
    }
Roland McGrath's avatar
Roland McGrath committed
1035

1036
  current_buffer->name = newname;
1037 1038 1039 1040 1041

  /* Catch redisplay's attention.  Unless we do this, the mode lines for
     any windows displaying current_buffer will stay unchanged.  */
  update_mode_lines++;

1042
  XSETBUFFER (buf, current_buffer);
1043
  Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1044 1045
  if (NILP (current_buffer->filename)
      && !NILP (current_buffer->auto_save_file_name))
Roland McGrath's avatar
Roland McGrath committed