buffer.c 185 KB
Newer Older
Roland McGrath's avatar
Roland McGrath committed
1
/* Buffer manipulation primitives for GNU Emacs.
2 3 4
   Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994,
                 1995, 1997, 1998, 1999, 2000, 2001, 2002,
                 2003, 2004, 2005 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 2, or (at your option)
Roland McGrath's avatar
Roland McGrath committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Roland McGrath's avatar
Roland McGrath committed
22

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

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

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


Andreas Schwab's avatar
Andreas Schwab committed
36 37 38
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
39

Roland McGrath's avatar
Roland McGrath committed
40
#include "lisp.h"
41
#include "intervals.h"
Roland McGrath's avatar
Roland McGrath committed
42 43 44
#include "window.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
45
#include "charset.h"
46
#include "region-cache.h"
Roland McGrath's avatar
Roland McGrath committed
47
#include "indent.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
48
#include "blockinput.h"
49
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
50
#include "keymap.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

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

67
DECL_ALIGN (struct buffer, buffer_defaults);
Roland McGrath's avatar
Roland McGrath committed
68 69 70 71 72 73 74 75 76 77 78

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

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

97 98
DECL_ALIGN (struct buffer, buffer_local_symbols);

Roland McGrath's avatar
Roland McGrath committed
99 100 101
/* A Lisp_Object pointer to the above, used for staticpro */
static Lisp_Object Vbuffer_local_symbols;

102 103 104 105
/* 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
106 107 108 109 110
   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.  */
111 112
struct buffer buffer_local_types;

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

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

119
int last_per_buffer_idx;
120

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

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

137 138
Lisp_Object Vtransient_mark_mode;

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

144 145 146
/* 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;
147
Lisp_Object Qkill_buffer_query_functions;
148

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;
Dave Love's avatar
Dave Love committed
155
Lisp_Object Qucs_set_table_for_input;
Roland McGrath's avatar
Roland McGrath committed
156

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

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

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

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

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

178 179
static void alloc_buffer_text P_ ((struct buffer *, size_t));
static void free_buffer_text P_ ((struct buffer *b));
180
static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
181
static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
182
static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
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))
193
    error ("No buffer named %s", SDATA (spec));
Roland McGrath's avatar
Roland McGrath committed
194 195 196
  error ("Invalid buffer argument");
}

197
DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
198 199 200
       doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
Value is nil if OBJECT is not a buffer or if it has been killed.  */)
     (object)
201 202 203 204 205 206
     Lisp_Object object;
{
  return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
	  ? Qt : Qnil);
}

207
DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
208
       doc: /* Return a list of all existing live buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
209 210 211
If the optional arg FRAME is a frame, we return the buffer list
in the proper order for that frame: the buffers in FRAME's `buffer-list'
frame parameter come first, followed by the rest of the buffers.  */)
212
     (frame)
213
     Lisp_Object frame;
Roland McGrath's avatar
Roland McGrath committed
214
{
215 216 217 218 219 220 221
  Lisp_Object framelist, general;
  general = Fmapcar (Qcdr, Vbuffer_alist);

  if (FRAMEP (frame))
    {
      Lisp_Object tail;

222
      CHECK_FRAME (frame);
223 224 225 226 227 228 229

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

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

  return general;
Roland McGrath's avatar
Roland McGrath committed
237 238
}

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

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

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

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

285
  CHECK_STRING (filename);
Roland McGrath's avatar
Roland McGrath committed
286 287
  filename = Fexpand_file_name (filename, Qnil);

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

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

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

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

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

343
  if (SCHARS (name) == 0)
344 345
    error ("Empty string for buffer name is not allowed");

346
  b = (struct buffer *) allocate_buffer ();
Roland McGrath's avatar
Roland McGrath committed
347

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

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

383 384 385
  b->newline_cache = 0;
  b->width_run_cache = 0;
  b->width_table = Qnil;
386
  b->prevent_redisplay_optimizations_p = 1;
387

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

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

  name = Fcopy_sequence (name);
399
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
Roland McGrath's avatar
Roland McGrath committed
400
  b->name = name;
401

402
  if (SREF (name, 0) != ' ')
Roland McGrath's avatar
Roland McGrath committed
403 404 405 406 407
    b->undo_list = Qnil;
  else
    b->undo_list = Qt;

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

410
  b->mark = Fmake_marker ();
411
  BUF_MARKERS (b) = NULL;
412 413
  b->name = name;

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

Dave Love's avatar
Dave Love committed
418 419 420
  /* An error in calling the function here (should someone redfine it)
     can lead to infinite regress until you run out of stack.  rms
     says that's not worth protecting against.  */
Dave Love's avatar
Dave Love committed
421
  if (!NILP (Ffboundp (Qucs_set_table_for_input)))
Dave Love's avatar
Dave Love committed
422
    /* buf is on buffer-alist, so no gcpro.  */
Dave Love's avatar
Dave Love committed
423 424
    call1 (Qucs_set_table_for_input, buf);

425 426 427
  return buf;
}

428

429 430 431
/* Return a list of overlays which is a copy of the overlay list
   LIST, but for buffer B.  */

432
static struct Lisp_Overlay *
433 434
copy_overlays (b, list)
     struct buffer *b;
435
     struct Lisp_Overlay *list;
436
{
437 438
  Lisp_Object buffer;
  struct Lisp_Overlay *result = NULL, *tail = NULL;
439 440 441

  XSETBUFFER (buffer, b);

442
  for (; list; list = list->next)
443 444
    {
      Lisp_Object overlay, start, end, old_overlay;
445
      EMACS_INT charpos;
446

447
      XSETMISC (old_overlay, list);
448 449
      charpos = marker_position (OVERLAY_START (old_overlay));
      start = Fmake_marker ();
450
      Fset_marker (start, make_number (charpos), buffer);
451 452 453 454 455
      XMARKER (start)->insertion_type
	= XMARKER (OVERLAY_START (old_overlay))->insertion_type;

      charpos = marker_position (OVERLAY_END (old_overlay));
      end = Fmake_marker ();
456
      Fset_marker (end, make_number (charpos), buffer);
457 458 459 460 461 462 463 464
      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));
465
      XOVERLAY (overlay)->next = NULL;
466

467 468 469 470
      if (tail)
	tail = tail->next = XOVERLAY (overlay);
      else
	result = tail = XOVERLAY (overlay);
471 472
    }

473
  return result;
474
}
475

476

477 478 479 480 481 482 483 484 485 486 487
/* 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;
{
488
  Lisp_Object to_buffer, tem;
489 490 491
  int offset;

  XSETBUFFER (to_buffer, to);
492

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
  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);
512

513 514
  to->overlays_before = copy_overlays (to, from->overlays_before);
  to->overlays_after = copy_overlays (to, from->overlays_after);
515

516 517 518
  /* Get (a copy of) the alist of Lisp-level local variables of FROM
     and install that in TO.  */
  to->local_var_alist = buffer_lisp_local_variables (from);
519 520 521 522
}

DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
       2, 3,
523
       "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
524
       doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
525
BASE-BUFFER should be a live buffer, or the name of an existing buffer.
Pavel Janík's avatar
Pavel Janík committed
526 527 528
NAME should be a string which is not the name of an existing buffer.
Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
such as major and minor modes, in the indirect buffer.
529 530
CLONE nil means the indirect buffer's state is reset to default values.  */)
     (base_buffer, name, clone)
531
     Lisp_Object base_buffer, name, clone;
532
{
533
  Lisp_Object buf, tem;
534
  struct buffer *b;
535

536
  CHECK_STRING (name);
537 538
  buf = Fget_buffer (name);
  if (!NILP (buf))
539
    error ("Buffer name `%s' is in use", SDATA (name));
540

541
  tem = base_buffer;
542 543
  base_buffer = Fget_buffer (base_buffer);
  if (NILP (base_buffer))
544 545 546
    error ("No such buffer: `%s'", SDATA (tem));
  if (NILP (XBUFFER (base_buffer)->name))
    error ("Base buffer has been killed");
547

548
  if (SCHARS (name) == 0)
549 550
    error ("Empty string for buffer name is not allowed");

551
  b = (struct buffer *) allocate_buffer ();
552 553 554 555 556 557 558 559 560 561 562 563 564
  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);
565 566 567
  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);
568 569 570 571 572 573 574 575 576 577

  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);
578
  STRING_SET_INTERVALS (name, NULL_INTERVAL);
579 580 581
  b->name = name;

  reset_buffer (b);
582
  reset_buffer_local_variables (b, 1);
583 584 585 586 587 588

  /* 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
589
  b->name = name;
590

591 592 593
  /* The multibyte status belongs to the base buffer.  */
  b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;

594 595 596 597
  /* Make sure the base buffer has markers for its narrowing.  */
  if (NILP (b->base_buffer->pt_marker))
    {
      b->base_buffer->pt_marker = Fmake_marker ();
598 599 600
      set_marker_both (b->base_buffer->pt_marker, base_buffer,
		       BUF_PT (b->base_buffer),
		       BUF_PT_BYTE (b->base_buffer));
601 602 603 604
    }
  if (NILP (b->base_buffer->begv_marker))
    {
      b->base_buffer->begv_marker = Fmake_marker ();
605 606 607
      set_marker_both (b->base_buffer->begv_marker, base_buffer,
		       BUF_BEGV (b->base_buffer),
		       BUF_BEGV_BYTE (b->base_buffer));
608 609 610 611
    }
  if (NILP (b->base_buffer->zv_marker))
    {
      b->base_buffer->zv_marker = Fmake_marker ();
612 613 614
      set_marker_both (b->base_buffer->zv_marker, base_buffer,
		       BUF_ZV (b->base_buffer),
		       BUF_ZV_BYTE (b->base_buffer));
615
      XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
616 617
    }

618 619 620 621 622 623 624 625 626 627 628 629
  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
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
    {
      struct buffer *old_b = current_buffer;

      clone_per_buffer_values (b->base_buffer, b);
      b->filename = Qnil;
      b->file_truename = Qnil;
      b->display_count = make_number (0);
      b->backed_up = Qnil;
      b->auto_save_file_name = Qnil;
      set_buffer_internal_1 (b);
      Fset (intern ("buffer-save-without-query"), Qnil);
      Fset (intern ("buffer-file-number"), Qnil);
      Fset (intern ("buffer-stale-function"), Qnil);
      set_buffer_internal_1 (old_b);
    }
645

646
  return buf;
Roland McGrath's avatar
Roland McGrath committed
647 648
}

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
void
delete_all_overlays (b)
     struct buffer *b;
{
  Lisp_Object overlay;

  /* `reset_buffer' blindly sets the list of overlays to NULL, so we
     have to empty the list, otherwise we end up with overlays that
     think they belong to this buffer while the buffer doesn't know about
     them any more.  */
  while (b->overlays_before)
    {
      XSETMISC (overlay, b->overlays_before);
      Fdelete_overlay (overlay);
    }
  while (b->overlays_after)
    {
      XSETMISC (overlay, b->overlays_after);
      Fdelete_overlay (overlay);
    }
  eassert (b->overlays_before == NULL);
  eassert (b->overlays_after == NULL);
}

673
/* Reinitialize everything about a buffer except its name and contents
674
   and local variables.
675 676 677 678
   If called on an already-initialized buffer, the list of overlays
   should be deleted before calling this function, otherwise we end up
   with overlays that claim to belong to the buffer but the buffer
   claims it doesn't belong to it.  */
Roland McGrath's avatar
Roland McGrath committed
679 680 681 682 683 684

void
reset_buffer (b)
     register struct buffer *b;
{
  b->filename = Qnil;
685
  b->file_truename = Qnil;
Roland McGrath's avatar
Roland McGrath committed
686 687
  b->directory = (current_buffer) ? current_buffer->directory : Qnil;
  b->modtime = 0;
688
  XSETFASTINT (b->save_length, 0);
Roland McGrath's avatar
Roland McGrath committed
689
  b->last_window_start = 1;
690
  /* It is more conservative to start out "changed" than "unchanged".  */
691 692
  b->clip_changed = 0;
  b->prevent_redisplay_optimizations_p = 1;
Roland McGrath's avatar
Roland McGrath committed
693 694
  b->backed_up = Qnil;
  b->auto_save_modified = 0;
695
  b->auto_save_failure_time = -1;
Roland McGrath's avatar
Roland McGrath committed
696 697
  b->auto_save_file_name = Qnil;
  b->read_only = Qnil;
698 699
  b->overlays_before = NULL;
  b->overlays_after = NULL;
700
  b->overlay_center = BEG;
701
  b->mark_active = Qnil;
702
  b->point_before_scroll = Qnil;
703
  b->file_format = Qnil;
704
  b->auto_save_file_format = Qt;
705
  b->last_selected_window = Qnil;
706
  XSETINT (b->display_count, 0);
707
  b->display_time = Qnil;
708
  b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
709
  b->cursor_type = buffer_defaults.cursor_type;
710
  b->extra_line_spacing = buffer_defaults.extra_line_spacing;
711 712

  b->display_error_modiff = 0;
Roland McGrath's avatar
Roland McGrath committed
713 714
}

715 716 717
/* 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.
718 719 720 721 722
   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.  */
723

724 725
static void
reset_buffer_local_variables (b, permanent_too)
Roland McGrath's avatar
Roland McGrath committed
726
     register struct buffer *b;
727
     int permanent_too;
Roland McGrath's avatar
Roland McGrath committed
728 729
{
  register int offset;
730
  int i;
Roland McGrath's avatar
Roland McGrath committed
731 732 733 734 735 736 737 738 739

  /* Reset the major mode to Fundamental, together with all the
     things that depend on the major mode.
     default-major-mode is handled at a higher level.
     We ignore it here.  */
  b->major_mode = Qfundamental_mode;
  b->keymap = Qnil;
  b->mode_name = QSFundamental;
  b->minor_modes = Qnil;
740 741 742 743 744 745 746 747

  /* 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
748
  b->downcase_table = Vascii_downcase_table;
749 750 751
  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];
752
  b->invisibility_spec = Qt;
753 754 755
#ifndef DOS_NT
  b->buffer_file_type = Qnil;
#endif
756

757
  /* Reset all (or most) per-buffer variables to their defaults.  */
Roland McGrath's avatar
Roland McGrath committed
758
  b->local_var_alist = Qnil;
759
  for (i = 0; i < last_per_buffer_idx; ++i)
760
    if (permanent_too || buffer_permanent_local_flags[i] == 0)
761
      SET_PER_BUFFER_VALUE_P (b, i, 0);
Roland McGrath's avatar
Roland McGrath committed
762 763 764 765

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

766
  for (offset = PER_BUFFER_VAR_OFFSET (name);
767 768
       offset < sizeof *b;
       offset += sizeof (Lisp_Object))
769
    {
770
      int idx = PER_BUFFER_IDX (offset);
771 772 773 774 775
      if ((idx > 0
	   && (permanent_too
	       || buffer_permanent_local_flags[idx] == 0))
	  /* Is -2 used anywhere?  */
	  || idx == -2)
776
	PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
777
    }
Roland McGrath's avatar
Roland McGrath committed
778 779
}

Roland McGrath's avatar
Roland McGrath committed
780 781 782 783 784
/* 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,
785
       1, 2, 0,
786
       doc: /* Return a string that is the name of no existing buffer based on NAME.
Pavel Janík's avatar
Pavel Janík committed
787 788
If there is no live buffer named NAME, then return NAME.
Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
789
\(starting at 2) until an unused name is found, and then return that name.
Pavel Janík's avatar
Pavel Janík committed
790 791
Optional second argument IGNORE specifies a name that is okay to use
\(if it is in the sequence to be tried)
792 793
even if a buffer with that name exists.  */)
     (name, ignore)
794
     register Lisp_Object name, ignore;
Roland McGrath's avatar
Roland McGrath committed
795 796 797 798 799
{
  register Lisp_Object gentemp, tem;
  int count;
  char number[10];

800
  CHECK_STRING (name);
Roland McGrath's avatar
Roland McGrath committed
801

802 803 804
  tem = Fstring_equal (name, ignore);
  if (!NILP (tem))
    return name;
Roland McGrath's avatar
Roland McGrath committed
805
  tem = Fget_buffer (name);
Jim Blandy's avatar
Jim Blandy committed
806
  if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
807
    return name;
Roland McGrath's avatar
Roland McGrath committed
808 809 810 811 812 813

  count = 1;
  while (1)
    {
      sprintf (number, "<%d>", ++count);
      gentemp = concat2 (name, build_string (number));
814
      tem = Fstring_equal (gentemp, ignore);
815 816
      if (!NILP (tem))
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
817
      tem = Fget_buffer (gentemp);
Jim Blandy's avatar
Jim Blandy committed
818
      if (NILP (tem))
Roland McGrath's avatar
Roland McGrath committed
819
	return gentemp;
Roland McGrath's avatar
Roland McGrath committed
820 821 822 823 824
    }
}


DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
825 826 827
       doc: /* Return the name of BUFFER, as a string.
With no argument or nil as argument, return the name of the current buffer.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
828 829
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
830
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
831
    return current_buffer->name;
832
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
833 834 835 836
  return XBUFFER (buffer)->name;
}

DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
837 838 839
       doc: /* Return name of file BUFFER is visiting, or nil if none.
No argument or nil as argument means use the current buffer.  */)
     (buffer)
Roland McGrath's avatar
Roland McGrath committed
840 841
     register Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
842
  if (NILP (buffer))
Roland McGrath's avatar
Roland McGrath committed
843
    return current_buffer->filename;
844
  CHECK_BUFFER (buffer);
Roland McGrath's avatar
Roland McGrath committed
845 846 847
  return XBUFFER (buffer)->filename;
}

848 849
DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
       0, 1, 0,
850
       doc: /* Return the base buffer of indirect buffer BUFFER.
851 852
If BUFFER is not indirect, return nil.
BUFFER defaults to the current buffer.  */)
853
     (buffer)
854 855 856 857 858 859 860 861 862
     register Lisp_Object buffer;
{
  struct buffer *base;
  Lisp_Object base_buffer;

  if (NILP (buffer))
    base = current_buffer->base_buffer;
  else
    {
863
      CHECK_BUFFER (buffer);
864 865 866 867 868 869 870 871 872
      base = XBUFFER (buffer)->base_buffer;
    }

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

873
DEFUN ("buffer-local-value", Fbuffer_local_value,
874
       Sbuffer_local_value, 2, 2, 0,
875 876
       doc: /* Return the value of VARIABLE in BUFFER.
If VARIABLE does not have a buffer-local binding in BUFFER, the value
877 878 879
is the default binding of the variable. */)
     (variable, buffer)
     register Lisp_Object variable;
880 881 882 883 884
     register Lisp_Object buffer;
{
  register struct buffer *buf;
  register Lisp_Object result;

885
  CHECK_SYMBOL (variable);
886
  CHECK_BUFFER (buffer);
887 888
  buf = XBUFFER (buffer);

889 890 891
  if (SYMBOLP (variable))
    variable = indirect_variable (variable);

892
  /* Look in local_var_list */
893
  result = Fassoc (variable, buf->local_var_alist);
894
  if (NILP (result))
895 896 897 898 899 900 901 902 903 904 905 906
    {
      int offset, idx;
      int found = 0;

      /* Look in special slots */
      for (offset = PER_BUFFER_VAR_OFFSET (name);
	   offset < sizeof (struct buffer);
	   /* sizeof EMACS_INT == sizeof Lisp_Object */
	   offset += (sizeof (EMACS_INT)))
	{
	  idx = PER_BUFFER_IDX (offset);
	  if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
907
	      && SYMBOLP (PER_BUFFER_SYMBOL (offset))
908
	      && EQ (PER_BUFFER_SYMBOL (offset), variable))
909 910 911 912 913 914 915 916
	    {
	      result = PER_BUFFER_VALUE (buf, offset);
	      found = 1;
	      break;
	    }
	}

      if (!found)
917
	result = Fdefault_value (variable);
918 919
    }
  else
920 921 922 923 924
    {
      Lisp_Object valcontents;
      Lisp_Object current_alist_element;

      /* What binding is loaded right now?  */
Juanma Barranquero's avatar