buffer.c 154 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
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 28
#include <errno.h>

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

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

Andreas Schwab's avatar
Andreas Schwab committed
38 39 40
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Roland McGrath's avatar
Roland McGrath committed
41
#include "lisp.h"
42
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
43 44 45
#include "window.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
46
#include "charset.h"
47
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
48
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
49
#include "blockinput.h"
50
#include "keyboard.h"
51
#include "frame.h"
Roland McGrath's avatar
Roland McGrath committed
52 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

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,
79 80
   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
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104

   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;

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

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

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

122
int last_per_buffer_idx;
123

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

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

140 141
Lisp_Object Vtransient_mark_mode;

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

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

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

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

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

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

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

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

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))
Roland McGrath's avatar
Roland McGrath committed
187 188 189 190
    error ("No buffer named %s", XSTRING (spec)->data);
  error ("Invalid buffer argument");
}

191 192 193 194 195 196 197 198 199 200
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);
}

201 202 203 204 205
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
206
{
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
  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))
	{
222 223
	  general = Fdelq (XCAR (tail), general);
	  tail = XCDR (tail);
224 225 226 227 228
	}
      return nconc2 (framelist, general);
    }

  return general;
Roland McGrath's avatar
Roland McGrath committed
229 230
}

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
/* 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
252 253 254 255 256 257 258
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;
{
259
  if (BUFFERP (name))
Roland McGrath's avatar
Roland McGrath committed
260 261 262
    return name;
  CHECK_STRING (name, 0);

263
  return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
Roland McGrath's avatar
Roland McGrath committed
264 265 266 267
}

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
268
The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
269 270
If there is no such live buffer, return nil.\n\
See also `find-buffer-visiting'.")
Roland McGrath's avatar
Roland McGrath committed
271 272 273 274
  (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;
Richard M. Stallman's avatar
Richard M. Stallman committed
275 276
  Lisp_Object handler;

Roland McGrath's avatar
Roland McGrath committed
277 278 279
  CHECK_STRING (filename, 0);
  filename = Fexpand_file_name (filename, Qnil);

Richard M. Stallman's avatar
Richard M. Stallman committed
280 281
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
282
  handler = Ffind_file_name_handler (filename, Qget_file_buffer);
Richard M. Stallman's avatar
Richard M. Stallman committed
283 284 285
  if (!NILP (handler))
    return call2 (handler, Qget_file_buffer, filename);

286
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
287
    {
288
      buf = Fcdr (XCAR (tail));
289 290
      if (!BUFFERP (buf)) continue;
      if (!STRINGP (XBUFFER (buf)->filename)) continue;
Roland McGrath's avatar
Roland McGrath committed
291
      tem = Fstring_equal (XBUFFER (buf)->filename, filename);
Jim Blandy's avatar
Jim Blandy committed
292
      if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
293 294 295 296 297
	return buf;
    }
  return Qnil;
}

298 299 300 301 302 303
Lisp_Object
get_truename_buffer (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;

304
  for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
305
    {
306
      buf = Fcdr (XCAR (tail));
307 308 309 310 311 312 313 314 315
      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
316 317 318 319 320 321
/* 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\
322
If NAME starts with a space, the new buffer does not keep undo information.\n\
Roland McGrath's avatar
Roland McGrath committed
323 324 325 326 327
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;
{
328
  register Lisp_Object buf;
Roland McGrath's avatar
Roland McGrath committed
329 330 331
  register struct buffer *b;

  buf = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
332
  if (!NILP (buf))
Roland McGrath's avatar
Roland McGrath committed
333 334
    return buf;

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

338
  b = (struct buffer *) allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
339

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

  BUF_PT (b) = 1;
  BUF_GPT (b) = 1;
  BUF_BEGV (b) = 1;
  BUF_ZV (b) = 1;
  BUF_Z (b) = 1;
360 361 362 363 364
  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
365
  BUF_MODIFF (b) = 1;
366
  BUF_OVERLAY_MODIFF (b) = 1;
367 368
  BUF_SAVE_MODIFF (b) = 1;
  BUF_INTERVALS (b) = 0;
369 370 371 372
  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
373
  *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'.  */
Roland McGrath's avatar
Roland McGrath committed
374

375 376 377
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
378
  b->prevent_redisplay_optimizations_p = 1;
379

Roland McGrath's avatar
Roland McGrath committed
380 381 382 383
  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

384 385 386 387 388
  /* 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;
389 390

  name = Fcopy_sequence (name);
391
  XSTRING (name)->intervals = NULL_INTERVAL;
Roland McGrath's avatar
Roland McGrath committed
392
  b->name = name;
393

Roland McGrath's avatar
Roland McGrath committed
394 395 396 397 398 399
  if (XSTRING (name)->data[0] != ' ')
    b->undo_list = Qnil;
  else
    b->undo_list = Qt;

  reset_buffer (b);
400
  reset_buffer_local_variables (b, 1);
Roland McGrath's avatar
Roland McGrath committed
401 402

  /* Put this in the alist of all live buffers.  */
403
  XSETBUFFER (buf, b);
Roland McGrath's avatar
Roland McGrath committed
404 405 406
  Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));

  b->mark = Fmake_marker ();
407 408 409 410 411
  BUF_MARKERS (b) = Qnil;
  b->name = name;
  return buf;
}

412 413 414 415 416 417 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

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

  to->overlays_after = Fcopy_sequence (from->overlays_after);
  to->overlays_before = Fcopy_sequence (to->overlays_before);
  bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
}


DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
455
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
456 457
  "Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.\n\
BASE-BUFFER should be an existing buffer (or buffer name).\n\
458 459
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\
460
such as major and minor modes, in the indirect buffer.\n\
461 462 463
CLONE nil means the indirect buffer's state is reset to default values.")
  (base_buffer, name, clone)
     Lisp_Object base_buffer, name, clone;
464
{
465 466
  Lisp_Object buf;
  struct buffer *b;
467 468 469 470 471 472 473 474 475 476 477 478 479

  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))
    error ("No such buffer: `%s'",
	   XSTRING (XBUFFER (base_buffer)->name)->data);

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

480
  b = (struct buffer *) allocate_buffer ();
481 482 483 484 485 486 487 488 489 490 491 492 493
  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);
494 495 496
  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);
497 498 499 500 501 502 503 504 505 506

  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);
507
  XSTRING (name)->intervals = NULL_INTERVAL;
508 509 510
  b->name = name;

  reset_buffer (b);
511
  reset_buffer_local_variables (b, 1);
512 513 514 515 516 517

  /* 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
518
  b->name = name;
519

520 521 522
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

523 524 525 526
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
527 528 529
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
530 531 532 533
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
534 535 536
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
537 538 539 540
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
541 542 543
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
544
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
545 546
    }

547 548 549 550 551 552 553 554 555 556 557 558 559
  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);
560

561
  return buf;
Roland McGrath's avatar
Roland McGrath committed
562 563
}

564 565
/* Reinitialize everything about a buffer except its name and contents
   and local variables.  */
Roland McGrath's avatar
Roland McGrath committed
566 567 568 569 570 571

void
reset_buffer (b)
     register struct buffer *b;
{
  b->filename = Qnil;
572
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
573 574
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
575
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
576
  b->last_window_start = 1;
577
  /* It is more conservative to start out "changed" than "unchanged".  */
578 579
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
580 581
  b->backed_up = Qnil;
  b->auto_save_modified = 0;
582
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
583 584
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
585 586
  b->overlays_before = Qnil;
  b->overlays_after = Qnil;
587
  XSETFASTINT (b->overlay_center, 1);
588
  b->mark_active = Qnil;
589
  b->point_before_scroll = Qnil;
590
  b->file_format = Qnil;
591
  b->last_selected_window = Qnil;
592
  XSETINT (b->display_count, 0);
593
  b->display_time = Qnil;
594
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
595
  b->cursor_type = buffer_defaults.cursor_type;
596
  b->extra_line_spacing = buffer_defaults.extra_line_spacing;
Roland McGrath's avatar
Roland McGrath committed
597 598
}

599 600 601
/* 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.
602 603 604 605 606
   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.  */
607

608 609
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
610
     register struct buffer *b;
611
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
612 613
{
  register int offset;
614
  int i;
Roland McGrath's avatar
Roland McGrath committed
615 616 617 618 619 620 621 622 623 624

  /* 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;
625 626 627 628 629 630 631 632

  /* 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
633
  b->downcase_table = Vascii_downcase_table;
634 635 636
  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];
637
  b->invisibility_spec = Qt;
638 639 640
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
641

Roland McGrath's avatar
Roland McGrath committed
642 643 644 645 646
#if 0
  b->sort_table = XSTRING (Vascii_sort_table);
  b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
#endif /* 0 */

647
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
648
  b->local_var_alist = Qnil;
649
  for (i = 0; i < last_per_buffer_idx; ++i)
650
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
651
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
652 653 654 655

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

656
  for (offset = PER_BUFFER_VAR_OFFSET (name);
657 658
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
659
    {
660
      int idx = PER_BUFFER_IDX (offset);
661 662 663 664 665
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
666
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
667
    }
Roland McGrath's avatar
Roland McGrath committed
668 669
}

Roland McGrath's avatar
Roland McGrath committed
670 671 672 673 674
/* 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,
675
  1, 2, 0,
Roland McGrath's avatar
Roland McGrath committed
676 677
  "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
678
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
679
until an unused name is found, and then return that name.\n\
680
Optional second argument IGNORE specifies a name that is okay to use\n\
681
\(if it is in the sequence to be tried)\n\
682
even if a buffer with that name exists.")
683 684
 (name, ignore)
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
685 686 687 688 689 690 691 692
{
  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
693
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
694
    return name;
Roland McGrath's avatar
Roland McGrath committed
695 696 697 698 699 700

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
701
      tem = Fstring_equal (gentemp, ignore);
702 703
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
704
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
705
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
706
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
707 708 709 710 711 712
    }
}


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
713
With no argument or nil as argument, return the name of the current buffer.")
Roland McGrath's avatar
Roland McGrath committed
714 715 716
  (buffer)
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
717
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
718 719 720 721 722 723 724 725 726 727 728
    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
729
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
730 731 732 733 734
    return current_buffer->filename;
  CHECK_BUFFER (buffer, 0);
  return XBUFFER (buffer)->filename;
}

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
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
759 760 761
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\
762 763
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
764 765 766 767 768 769
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;
770
  register Lisp_Object result;
Roland McGrath's avatar
Roland McGrath committed
771

Jim Blandy's avatar
Jim Blandy committed
772
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
773 774 775 776 777 778 779
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

780 781
  result = Qnil;

Roland McGrath's avatar
Roland McGrath committed
782
  {
783
    register Lisp_Object tail;
784
    for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
Roland McGrath's avatar
Roland McGrath committed
785
      {
786 787
	Lisp_Object val, elt;

788
	elt = XCAR (tail);
789

790 791 792 793 794
	/* 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.  */
795
	val = find_symbol_value (XCAR (elt));
796 797
	/* Use the current buffer value only if buf is the current buffer.  */
	if (buf != current_buffer)
798
	  val = XCDR (elt);
799 800 801

	/* If symbol is unbound, put just the symbol in the list.  */
	if (EQ (val, Qunbound))
802
	  result = Fcons (XCAR (elt), result);
803 804
	/* Otherwise, put (symbol . value) in the list.  */
	else
805
	  result = Fcons (Fcons (XCAR (elt), val), result);
Roland McGrath's avatar
Roland McGrath committed
806 807 808 809 810
      }
  }

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

813
    for (offset = PER_BUFFER_VAR_OFFSET (name);
Roland McGrath's avatar
Roland McGrath committed
814
	 offset < sizeof (struct buffer);
815 816
	 /* sizeof EMACS_INT == sizeof Lisp_Object */
	 offset += (sizeof (EMACS_INT)))
Roland McGrath's avatar
Roland McGrath committed
817
      {
818 819 820 821 822
	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)),
823
			  result);
Roland McGrath's avatar
Roland McGrath committed
824 825
      }
  }
826 827

  return result;
Roland McGrath's avatar
Roland McGrath committed
828 829 830 831 832 833 834 835 836 837 838
}


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
839
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
840 841 842 843 844 845 846
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

847
  return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
Roland McGrath's avatar
Roland McGrath committed
848 849 850 851 852 853 854 855 856 857 858
}

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;
859
  Lisp_Object buffer, window;
Roland McGrath's avatar
Roland McGrath committed
860 861 862 863 864

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

865
  fn = current_buffer->file_truename;
866 867
  /* 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
868
    {
869
      already = SAVE_MODIFF < MODIFF;
Jim Blandy's avatar
Jim Blandy committed
870
      if (!already && !NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
871
	lock_file (fn);
Jim Blandy's avatar
Jim Blandy committed
872
      else if (already && NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
873 874 875 876
	unlock_file (fn);
    }
#endif /* CLASH_DETECTION */

877
  SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
  
  /* 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))
    update_mode_lines++;
  
Roland McGrath's avatar
Roland McGrath committed
895 896 897
  return flag;
}

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
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
928 929 930 931 932 933 934 935 936 937
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
938
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
939 940 941 942 943 944 945 946 947 948
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

  return make_number (BUF_MODIFF (buf));
}

Roland McGrath's avatar
Roland McGrath committed
949
DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
950
       "sRename buffer (to new name): \nP",
Roland McGrath's avatar
Roland McGrath committed
951
  "Change current buffer's name to NEWNAME (a string).\n\
952
If second arg UNIQUE is nil or omitted, it is an error if a\n\
Roland McGrath's avatar
Roland McGrath committed
953
buffer named NEWNAME already exists.\n\
954
If UNIQUE is non-nil, come up with a new name using\n\
Roland McGrath's avatar
Roland McGrath committed
955
`generate-new-buffer-name'.\n\
956 957
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
958
This does not change the name of the visited file (if any).")
959 960
  (newname, unique)
     register Lisp_Object newname, unique;
Roland McGrath's avatar
Roland McGrath committed
961 962 963
{
  register Lisp_Object tem, buf;

964
  CHECK_STRING (newname, 0);
965

966
  if (XSTRING (newname)->size == 0)
967 968
    error ("Empty string is invalid as a buffer name");

969
  tem = Fget_buffer (newname);
Jim Blandy's avatar
Jim Blandy committed
970
  if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
971
    {
972 973 974 975 976 977
      /* 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;
978
      if (!NILP (unique))
979
	newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
Roland McGrath's avatar
Roland McGrath committed
980
      else
981
	error ("Buffer name `%s' is in use", XSTRING (newname)->data);
Roland McGrath's avatar
Roland McGrath committed
982
    }
Roland McGrath's avatar
Roland McGrath committed
983

984
  current_buffer->name = newname;
985 986 987 988 989

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

990
  XSETBUFFER (buf, current_buffer);
991
  Fsetcar (Frassq (buf, Vbuffer_alist), newname);
992 993
  if (NILP (current_buffer->filename)
      && !NILP (current_buffer->auto_save_file_name))
Roland McGrath's avatar
Roland McGrath committed
994
    call0 (intern ("rename-auto-save-file"));
995 996
  /* Refetch since that last call may have done GC.  */
  return current_buffer->name;
Roland McGrath's avatar
Roland McGrath committed
997 998
}

999
DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
Roland McGrath's avatar
Roland McGrath committed
1000
  "Return most recently selected buffer other than BUFFER.\n\
1001 1002
Buffers not visible in windows are preferred to visible buffers,\n\
unless optional second argument VISIBLE-OK is non-nil.\n\
1003 1004
If the optional third argument FRAME is non-nil, use that frame's\n\
buffer list instead of the selected frame's buffer list.\n\
Roland McGrath's avatar
Roland McGrath committed
1005 1006
If no other buffer exists, the buffer `*scratch*' is returned.\n\
If BUFFER is omitted or nil, some interesting buffer is returned.")
1007 1008
  (buffer, visible_ok, frame)
     register Lisp_Object buffer, visible_ok, frame;
Roland McGrath's avatar
Roland McGrath committed
1009
{
1010
  Lisp_Object Fset_buffer_major_mode ();
1011
  register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
Roland McGrath's avatar
Roland McGrath committed
1012 1013
  notsogood = Qnil;

1014
  if (NILP (frame))
1015
    frame = selected_frame;
1016

1017
  tail = Vbuffer_alist;
1018
  pred = frame_buffer_predicate (frame);
1019 1020 1021 1022

  /* Consider buffers that have been seen in the selected frame
     before other buffers.  */
    
1023
  tem = frame_buffer_list (frame);
1024 1025 1026
  add_ons = Qnil;
  while (CONSP (tem))
    {