buffer.c 149 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
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


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

extern int errno;
Roland McGrath's avatar
Roland McGrath committed
29 30 31 32 33 34

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

35
#include <config.h>
Andreas Schwab's avatar
Andreas Schwab committed
36 37 38 39 40 41
#ifdef STDC_HEADERS
#include <stdlib.h>
#endif
#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 "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 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104

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,
   the bit for that slot (found in the same slot in this structure)
   is turned on in the buffer's local_var_flags slot.

   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 118 119
/* Flags indicating which built-in buffer-local variables
   are permanent locals.  */
static int buffer_permanent_local_flags;

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

/* 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. */
Lisp_Object Vbefore_change_function;
Lisp_Object Vafter_change_function;
135 136
Lisp_Object Vbefore_change_functions;
Lisp_Object Vafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
137

138 139
Lisp_Object Vtransient_mark_mode;

140 141 142 143 144
/* 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;

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

Jim Blandy's avatar
Jim Blandy committed
152
Lisp_Object Qfirst_change_hook;
153 154
Lisp_Object Qbefore_change_functions;
Lisp_Object Qafter_change_functions;
Roland McGrath's avatar
Roland McGrath committed
155

156 157 158
/* If nonzero, all modification hooks are suppressed.  */
int inhibit_modification_hooks;

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

Jim Blandy's avatar
Jim Blandy committed
169 170
Lisp_Object Qoverlayp;

171
Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
172

173 174 175 176
Lisp_Object Qmodification_hooks;
Lisp_Object Qinsert_in_front_hooks;
Lisp_Object Qinsert_behind_hooks;

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

180
void
Roland McGrath's avatar
Roland McGrath committed
181 182 183
nsberror (spec)
     Lisp_Object spec;
{
184
  if (STRINGP (spec))
Roland McGrath's avatar
Roland McGrath committed
185 186 187 188
    error ("No buffer named %s", XSTRING (spec)->data);
  error ("Invalid buffer argument");
}

189 190 191 192 193 194 195 196 197 198
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);
}

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

  return general;
Roland McGrath's avatar
Roland McGrath committed
227 228
}

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

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

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

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

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

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

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
Lisp_Object
get_truename_buffer (filename)
     register Lisp_Object filename;
{
  register Lisp_Object tail, buf, tem;

  for (tail = Vbuffer_alist; CONSP (tail); tail = XCONS (tail)->cdr)
    {
      buf = Fcdr (XCONS (tail)->car);
      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
314 315 316 317 318 319
/* 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\
320
If NAME starts with a space, the new buffer does not keep undo information.\n\
Roland McGrath's avatar
Roland McGrath committed
321 322 323 324 325
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;
{
326
  register Lisp_Object buf;
Roland McGrath's avatar
Roland McGrath committed
327 328 329
  register struct buffer *b;

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

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

336
  b = (struct buffer *) xmalloc (sizeof (struct buffer));
Roland McGrath's avatar
Roland McGrath committed
337

338 339 340 341 342 343
  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
344
  BUF_GAP_SIZE (b) = 20;
345
  BLOCK_INPUT;
Karl Heuer's avatar
Karl Heuer committed
346 347 348
  /* 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));
349
  UNBLOCK_INPUT;
Roland McGrath's avatar
Roland McGrath committed
350
  if (! BUF_BEG_ADDR (b))
351
    buffer_memory_full ();
Roland McGrath's avatar
Roland McGrath committed
352 353 354 355 356 357

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

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

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

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

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

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

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

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

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

411
DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer, 2, 2,
412
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
413 414
  "Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.\n\
BASE-BUFFER should be an existing buffer (or buffer name).\n\
415 416 417
NAME should be a string which is not the name of an existing buffer.")
  (base_buffer, name)
     register Lisp_Object base_buffer, name;
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
{
  register Lisp_Object buf;
  register struct buffer *b;

  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");

  b = (struct buffer *) xmalloc (sizeof (struct buffer));

  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);
449 450 451
  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);
452 453 454 455

  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
456
  b->prompt_end_charpos = Qnil;
457 458 459 460 461 462 463 464 465 466

  /* Put this on the chain of all buffers including killed ones.  */
  b->next = all_buffers;
  all_buffers = b;

  name = Fcopy_sequence (name);
  INITIALIZE_INTERVAL (XSTRING (name), NULL_INTERVAL);
  b->name = name;

  reset_buffer (b);
467
  reset_buffer_local_variables (b, 1);
468 469 470 471 472 473

  /* 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
474
  b->name = name;
475

476 477 478
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

479 480 481 482
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
483 484 485
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
486 487 488 489
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
490 491 492
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
493 494 495 496
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
497 498 499
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
500
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
501 502 503
    }

  /* Give the indirect buffer markers for its narrowing.  */
504
  b->pt_marker = Fmake_marker ();
505
  set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
506
  b->begv_marker = Fmake_marker ();
507
  set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
508
  b->zv_marker = Fmake_marker ();
509
  set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
510
  XMARKER (b->zv_marker)->insertion_type = 1;
511

512
  return buf;
Roland McGrath's avatar
Roland McGrath committed
513 514
}

515 516
/* Reinitialize everything about a buffer except its name and contents
   and local variables.  */
Roland McGrath's avatar
Roland McGrath committed
517 518 519 520 521 522

void
reset_buffer (b)
     register struct buffer *b;
{
  b->filename = Qnil;
523
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
524 525
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
526
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
527
  b->last_window_start = 1;
528
  /* It is more conservative to start out "changed" than "unchanged".  */
529 530
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
531 532
  b->backed_up = Qnil;
  b->auto_save_modified = 0;
533
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
534 535
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
536 537
  b->overlays_before = Qnil;
  b->overlays_after = Qnil;
538
  XSETFASTINT (b->overlay_center, 1);
539
  b->mark_active = Qnil;
540
  b->point_before_scroll = Qnil;
541
  b->file_format = Qnil;
542
  b->last_selected_window = Qnil;
543
  XSETINT (b->display_count, 0);
544
  b->display_time = Qnil;
545 546
  b->extra2 = Qnil;
  b->extra3 = Qnil;
547
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
Roland McGrath's avatar
Roland McGrath committed
548 549
}

550 551 552
/* 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.
553 554 555 556 557
   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.  */
558

559 560
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
561
     register struct buffer *b;
562
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
563 564
{
  register int offset;
565 566 567 568 569 570 571
  int dont_reset;

  /* Decide which built-in local variables to reset.  */
  if (permanent_too)
    dont_reset = 0;
  else
    dont_reset = buffer_permanent_local_flags;
Roland McGrath's avatar
Roland McGrath committed
572 573 574 575 576 577 578 579 580 581

  /* 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;
582 583 584 585 586 587 588 589

  /* 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
590
  b->downcase_table = Vascii_downcase_table;
591 592 593
  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];
594
  b->invisibility_spec = Qt;
595 596 597
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
598

Roland McGrath's avatar
Roland McGrath committed
599 600 601 602 603
#if 0
  b->sort_table = XSTRING (Vascii_sort_table);
  b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
#endif /* 0 */

604
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
605
  b->local_var_alist = Qnil;
606
  b->local_var_flags &= dont_reset;
Roland McGrath's avatar
Roland McGrath committed
607 608 609 610 611 612

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

  for (offset = (char *)&buffer_local_flags.name - (char *)&buffer_local_flags;
       offset < sizeof (struct buffer);
613
       offset += sizeof (Lisp_Object)) /* sizeof EMACS_INT == sizeof Lisp_Object */
614 615
    {
      int flag = XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_flags));
616 617 618 619 620 621
      if ((flag > 0
	   /* Don't reset a permanent local.  */
	   && ! (dont_reset & flag))
	  || flag == -2)
	*(Lisp_Object *)(offset + (char *)b)
	  = *(Lisp_Object *)(offset + (char *)&buffer_defaults);
622
    }
Roland McGrath's avatar
Roland McGrath committed
623 624
}

Roland McGrath's avatar
Roland McGrath committed
625 626 627 628 629
/* 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,
630
  1, 2, 0,
Roland McGrath's avatar
Roland McGrath committed
631 632
  "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
633
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
634
until an unused name is found, and then return that name.\n\
635
Optional second argument IGNORE specifies a name that is okay to use\n\
636
\(if it is in the sequence to be tried)\n\
637
even if a buffer with that name exists.")
638 639
 (name, ignore)
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
640 641 642 643 644 645 646 647
{
  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
648
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
649
    return name;
Roland McGrath's avatar
Roland McGrath committed
650 651 652 653 654 655

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
656
      tem = Fstring_equal (gentemp, ignore);
657 658
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
659
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
660
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
661
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
662 663 664 665 666 667
    }
}


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
668
With no argument or nil as argument, return the name of the current buffer.")
Roland McGrath's avatar
Roland McGrath committed
669 670 671
  (buffer)
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
672
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
673 674 675 676 677 678 679 680 681 682 683
    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
684
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
685 686 687 688 689
    return current_buffer->filename;
  CHECK_BUFFER (buffer, 0);
  return XBUFFER (buffer)->filename;
}

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
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
714 715 716
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\
717 718
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
719 720 721 722 723 724
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;
725
  register Lisp_Object result;
Roland McGrath's avatar
Roland McGrath committed
726

Jim Blandy's avatar
Jim Blandy committed
727
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
728 729 730 731 732 733 734
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

735 736
  result = Qnil;

Roland McGrath's avatar
Roland McGrath committed
737
  {
738 739
    register Lisp_Object tail;
    for (tail = buf->local_var_alist; CONSP (tail); tail = XCONS (tail)->cdr)
Roland McGrath's avatar
Roland McGrath committed
740
      {
741 742 743 744
	Lisp_Object val, elt;

	elt = XCONS (tail)->car;

745 746 747 748 749 750 751 752
	/* 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.  */
	val = find_symbol_value (XCONS (elt)->car);
	/* Use the current buffer value only if buf is the current buffer.  */
	if (buf != current_buffer)
753 754 755 756 757 758 759 760
	  val = XCONS (elt)->cdr;

	/* If symbol is unbound, put just the symbol in the list.  */
	if (EQ (val, Qunbound))
	  result = Fcons (XCONS (elt)->car, result);
	/* Otherwise, put (symbol . value) in the list.  */
	else
	  result = Fcons (Fcons (XCONS (elt)->car, val), result);
Roland McGrath's avatar
Roland McGrath committed
761 762 763 764 765 766 767 768 769
      }
  }

  /* Add on all the variables stored in special slots.  */
  {
    register int offset, mask;

    for (offset = (char *)&buffer_local_symbols.name - (char *)&buffer_local_symbols;
	 offset < sizeof (struct buffer);
770
	 offset += (sizeof (EMACS_INT))) /* sizeof EMACS_INT == sizeof Lisp_Object */
Roland McGrath's avatar
Roland McGrath committed
771
      {
772
	mask = XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_flags));
Roland McGrath's avatar
Roland McGrath committed
773
	if (mask == -1 || (buf->local_var_flags & mask))
774 775 776 777
	  if (SYMBOLP (*(Lisp_Object *)(offset
					+ (char *)&buffer_local_symbols)))
	    result = Fcons (Fcons (*((Lisp_Object *)
				     (offset + (char *)&buffer_local_symbols)),
778 779
				   *(Lisp_Object *)(offset + (char *)buf)),
			    result);
Roland McGrath's avatar
Roland McGrath committed
780 781
      }
  }
782 783

  return result;
Roland McGrath's avatar
Roland McGrath committed
784 785 786 787 788 789 790 791 792 793 794
}


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
795
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
796 797 798 799 800 801 802
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

803
  return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
Roland McGrath's avatar
Roland McGrath committed
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
}

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;

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

820
  fn = current_buffer->file_truename;
821 822
  /* 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
823
    {
824
      already = SAVE_MODIFF < MODIFF;
Jim Blandy's avatar
Jim Blandy committed
825
      if (!already && !NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
826
	lock_file (fn);
Jim Blandy's avatar
Jim Blandy committed
827
      else if (already && NILP (flag))
Roland McGrath's avatar
Roland McGrath committed
828 829 830 831
	unlock_file (fn);
    }
#endif /* CLASH_DETECTION */

832
  SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
Roland McGrath's avatar
Roland McGrath committed
833 834 835 836 837 838 839 840 841 842 843 844 845 846
  update_mode_lines++;
  return flag;
}

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
847
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
848 849 850 851 852 853 854 855 856 857
    buf = current_buffer;
  else
    {
      CHECK_BUFFER (buffer, 0);
      buf = XBUFFER (buffer);
    }

  return make_number (BUF_MODIFF (buf));
}

Roland McGrath's avatar
Roland McGrath committed
858
DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
859
       "sRename buffer (to new name): \nP",
Roland McGrath's avatar
Roland McGrath committed
860
  "Change current buffer's name to NEWNAME (a string).\n\
861
If second arg UNIQUE is nil or omitted, it is an error if a\n\
Roland McGrath's avatar
Roland McGrath committed
862
buffer named NEWNAME already exists.\n\
863
If UNIQUE is non-nil, come up with a new name using\n\
Roland McGrath's avatar
Roland McGrath committed
864
`generate-new-buffer-name'.\n\
865 866
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
867
This does not change the name of the visited file (if any).")
868 869
  (newname, unique)
     register Lisp_Object newname, unique;
Roland McGrath's avatar
Roland McGrath committed
870 871 872
{
  register Lisp_Object tem, buf;

873
  CHECK_STRING (newname, 0);
874

875
  if (XSTRING (newname)->size == 0)
876 877
    error ("Empty string is invalid as a buffer name");

878
  tem = Fget_buffer (newname);
879 880 881
  /* 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
882
     (rename-buffer (generate-new-buffer-name NEWNAME)).  */
883
  if (NILP (unique) && XBUFFER (tem) == current_buffer)
884
    return current_buffer->name;
Jim Blandy's avatar
Jim Blandy committed
885
  if (!NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
886
    {
887
      if (!NILP (unique))
888
	newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
Roland McGrath's avatar
Roland McGrath committed
889
      else
890
	error ("Buffer name `%s' is in use", XSTRING (newname)->data);
Roland McGrath's avatar
Roland McGrath committed
891
    }
Roland McGrath's avatar
Roland McGrath committed
892

893
  current_buffer->name = newname;
894 895 896 897 898

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

899
  XSETBUFFER (buf, current_buffer);
900
  Fsetcar (Frassq (buf, Vbuffer_alist), newname);
901 902
  if (NILP (current_buffer->filename)
      && !NILP (current_buffer->auto_save_file_name))
Roland McGrath's avatar
Roland McGrath committed
903
    call0 (intern ("rename-auto-save-file"));
904 905
  /* Refetch since that last call may have done GC.  */
  return current_buffer->name;
Roland McGrath's avatar
Roland McGrath committed
906 907
}

908
DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
Roland McGrath's avatar
Roland McGrath committed
909
  "Return most recently selected buffer other than BUFFER.\n\
910 911
Buffers not visible in windows are preferred to visible buffers,\n\
unless optional second argument VISIBLE-OK is non-nil.\n\
912 913
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
914 915
If no other buffer exists, the buffer `*scratch*' is returned.\n\
If BUFFER is omitted or nil, some interesting buffer is returned.")
916 917
  (buffer, visible_ok, frame)
     register Lisp_Object buffer, visible_ok, frame;
Roland McGrath's avatar
Roland McGrath committed
918
{
919
  Lisp_Object Fset_buffer_major_mode ();
920
  register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
Roland McGrath's avatar
Roland McGrath committed
921 922
  notsogood = Qnil;

923 924 925
  if (NILP (frame))
    frame = Fselected_frame ();

926
  tail = Vbuffer_alist;
927
  pred = frame_buffer_predicate (frame);
928 929 930 931

  /* Consider buffers that have been seen in the selected frame
     before other buffers.  */
    
932
  tem = frame_buffer_list (frame);
933 934 935 936 937 938 939 940 941 942
  add_ons = Qnil;
  while (CONSP (tem))
    {
      if (BUFFERP (XCONS (tem)->car))
	add_ons = Fcons (Fcons (Qnil, XCONS (tem)->car), add_ons);
      tem = XCONS (tem)->cdr;
    }
  tail = nconc2 (Fnreverse (add_ons), tail);

  for (; !NILP (tail); tail = Fcdr (tail))
Roland McGrath's avatar
Roland McGrath committed
943 944 945 946 947 948
    {
      buf = Fcdr (Fcar (tail));
      if (EQ (buf, buffer))
	continue;
      if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
	continue;
949 950
      /* If the selected frame has a buffer_predicate,
	 disregard buffers that don't fit the predicate.  */
951
      if (!NILP (pred))
952
	{
953
	  tem = call1 (pred, buf);
954 955 956 957
	  if (NILP (tem))
	    continue;
	}

958
      if (NILP (visible_ok))
959
	tem = Fget_buffer_window (buf, Qt);
960 961
      else
	tem = Qnil;
Jim Blandy's avatar
Jim Blandy committed
962
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
963
	return buf;
Jim Blandy's avatar
Jim Blandy committed
964
      if (NILP (notsogood))
Roland McGrath's avatar
Roland McGrath committed
965 966
	notsogood = buf;
    }
Jim Blandy's avatar
Jim Blandy committed
967
  if (!NILP (notsogood))
Roland McGrath's avatar
Roland McGrath committed
968
    return notsogood;
969 970 971
  buf = Fget_buffer_create (build_string ("*scratch*"));
  Fset_buffer_major_mode (buf);
  return buf;
Roland McGrath's avatar
Roland McGrath committed
972 973
}

974 975
DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
       0, 1, "",
976 977
  "Make BUFFER stop keeping undo information.\n\
No argument or nil as argument means do this for the current buffer.")
Jim Blandy's avatar
Jim Blandy committed
978 979
  (buffer)
     register Lisp_Object buffer;
Roland McGrath's avatar
Roland McGrath committed
980
{
Jim Blandy's avatar
Jim Blandy committed
981 982 983
  Lisp_Object real_buffer;

  if (NILP (buffer))
984
    XSETBUFFER (real_buffer, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
985 986 987 988 989 990 991 992 993
  else
    {
      real_buffer = Fget_buffer (buffer);
      if (NILP (real_buffer))
	nsberror (buffer);
    }

  XBUFFER (real_buffer)->undo_list = Qt;

Roland McGrath's avatar
Roland McGrath committed
994 995 996 997 998 999 1000
  return Qnil;
}

DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
       0, 1, "",
  "Start keeping undo information for buffer BUFFER.\n\
No argument or nil as argument means do this for the current buffer.")
Jim Blandy's avatar
Jim Blandy committed
1001 1002
  (buffer)
     register Lisp_Object buffer;
Roland McGrath's avatar
Roland McGrath committed
1003
{
Jim Blandy's avatar
Jim Blandy committed
1004
  Lisp_Object real_buffer;
Roland McGrath's avatar
Roland McGrath committed
1005

Jim Blandy's avatar
Jim Blandy committed
1006
  if (NILP (buffer))
1007
    XSETBUFFER (real_buffer, current_buffer);
Roland McGrath's avatar
Roland McGrath committed
1008 1009
  else
    {
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012
      real_buffer = Fget_buffer (buffer);
      if (NILP (real_buffer))
	nsberror (buffer);
Roland McGrath's avatar
Roland McGrath committed
1013 1014
    }

Jim Blandy's avatar
Jim Blandy committed
1015 1016
  if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
    XBUFFER (real_buffer)->undo_list = Qnil;
Roland McGrath's avatar
Roland McGrath committed
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036

  return Qnil;
}

/*
  DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
The buffer being killed will be current while the hook is running.\n\
See `kill-buffer'."
 */
DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
  "Kill the buffer BUFFER.\n\
The argument may be a buffer or may be the name of a buffer.\n\
An argument of nil means kill the current buffer.\n\n\
Value is t if the buffer is actually killed, nil if user says no.\n\n\
The value of `kill-buffer-hook' (which may be local to that buffer),\n\
if not void, is a list of functions to be called, with no arguments,\n\
before the buffer is actually killed.  The buffer to be killed is current\n\
when the hook functions are called.\n\n\
Any processes that have this buffer as the `process-buffer' are killed\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1037
with SIGHUP.")
1038 1039
  (buffer)
     Lisp_Object buffer;
Roland McGrath's avatar
Roland McGrath committed
1040 1041 1042 1043 1044 1045 1046
{
  Lisp_Object buf;
  register struct buffer *b;
  register Lisp_Object tem;
  register struct Lisp_Marker *m;
  struct gcpro gcpro1, gcpro2;

1047
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
1048 1049
    buf = Fcurrent_buffer ();
  else
1050
    buf = Fget_buffer (buffer);
Jim Blandy's avatar
Jim Blandy committed
1051
  if (NILP (buf))
1052
    nsberror (buffer);
Roland McGrath's avatar
Roland McGrath committed
1053 1054 1055

  b = XBUFFER (buf);

1056 1057 1058 1059
  /* Avoid trouble for buffer already dead.  */
  if (NILP (b->name))
    return Qnil;

Roland McGrath's avatar
Roland McGrath committed
1060
  /* Query if the buffer is still modified.  */
Jim Blandy's avatar
Jim Blandy committed
1061
  if (INTERACTIVE && !NILP (b->filename)
1062
      && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
Roland McGrath's avatar
Roland McGrath committed
1063
    {
1064
      GCPRO1 (buf);
Roland McGrath's avatar
Roland McGrath committed
1065 1066 1067
      tem = do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
				     XSTRING (b->name)->data));
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1068
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
1069 1070 1071
	return Qnil;
    }

1072
  /* Run hooks with the buffer to be killed the current buffer.  */
Roland McGrath's avatar
Roland McGrath committed
1073 1074 1075
  {
    register Lisp_Object val;
    int count = specpdl_ptr - specpdl;
1076
    Lisp_Object list;
Roland McGrath's avatar
Roland McGrath committed
1077 1078 1079

    record_unwind_protect (save_excursion_restore, save_excursion_save ());
    set_buffer_internal (b);
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090

    /* First run the query functions; if any query is answered no,
       don't kill the buffer.  */
    for (list = Vkill_buffer_query_functions; !NILP (list); list = Fcdr (list))
      {
	tem = call0 (Fcar (list));
	if (NILP (tem))
	  return unbind_to (count, Qnil);
      }

    /* Then run the hooks.  */
1091 1092
    if (!NILP (Vrun_hooks))
      call1 (Vrun_hooks, Qkill_buffer_hook);
Roland McGrath's avatar
Roland McGrath committed
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
    unbind_to (count, Qnil);
  }

  /* We have no more questions to ask.  Verify that it is valid
     to kill the buffer.  This must be done after the questions
     since anything can happen within do_yes_or_no_p.  */

  /* Don't kill the minibuffer now current.  */
  if (EQ (buf, XWINDOW (minibuf_window)->buffer))
    return Qnil;

Jim Blandy's avatar
Jim Blandy committed
1104
  if (NILP (b->name))
Roland McGrath's avatar
Roland McGrath committed
1105 1106
    return Qnil;

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
  /* When we kill a base buffer, kill all its indirect buffers.
     We do it at this stage so nothing terrible happens if they
     ask questions or their hooks get errors.  */
  if (! b->base_buffer)
    {
      struct buffer *other;

      GCPRO1 (buf);

      for (other = all_buffers; other; other = other->next)
1117 1118 1119
	/* all_buffers contains dead buffers too;
	   don't re-kill them.  */
	if (other->base_buffer == b && !NILP (other->name))
1120 1121 1122 1123 1124 1125 1126 1127 1128
	  {
	    Lisp_Object buf;
	    XSETBUFFER (buf, other);
	    Fkill_buffer (buf);
	  }

      UNGCPRO;
    }
  
Roland McGrath's avatar
Roland McGrath committed
1129 1130 1131 1132 1133
  /* Make this buffer not be current.
     In the process, notice if this is the sole visible buffer
     and give up if so.  */
  if (b == current_buffer)
    {
1134
      tem = Fother_buffer (buf, Qnil, Qnil);
Roland McGrath's avatar
Roland McGrath committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
      Fset_buffer (tem);
      if (b == current_buffer)
	return Qnil;
    }

  /* Now there is no question: we can kill the buffer.  */

#ifdef CLASH_DETECTION
  /* Unlock this buffer's file, if it is locked.  */
  unlock_buffer (b);
#endif /* CLASH_DETECTION */

  kill_buffer_processes (buf);

  tem = Vinhibit_quit;
  Vinhibit_quit = Qt;
1151
  replace_buffer_in_all_windows (buf);
1152
  Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1153
  fram