Auto-commit of loaddefs files.
[bpt/emacs.git] / src / buffer.c
CommitLineData
1ab256cb 1/* Buffer manipulation primitives for GNU Emacs.
66c6abf0 2
73b0cd50 3Copyright (C) 1985-1989, 1993-1995, 1997-2011 Free Software Foundation, Inc.
1ab256cb
RM
4
5This file is part of GNU Emacs.
6
9ec0b715 7GNU Emacs is free software: you can redistribute it and/or modify
1ab256cb 8it under the terms of the GNU General Public License as published by
9ec0b715
GM
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
1ab256cb
RM
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
9ec0b715 18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
1ab256cb 19
68c45bf0 20#include <config.h>
1ab256cb 21
2381d133
JB
22#include <sys/types.h>
23#include <sys/stat.h>
1ab256cb 24#include <sys/param.h>
9dde47f5 25#include <errno.h>
15e7873a 26#include <stdio.h>
d7306fe6 27#include <setjmp.h>
dfcf069d 28#include <unistd.h>
7ee72033 29
d6202519
PE
30#include <verify.h>
31
1ab256cb 32#include "lisp.h"
21cf4cf8 33#include "intervals.h"
1ab256cb
RM
34#include "window.h"
35#include "commands.h"
36#include "buffer.h"
8f348ed5 37#include "character.h"
28e969dd 38#include "region-cache.h"
1ab256cb 39#include "indent.h"
d014bf88 40#include "blockinput.h"
2538fae4 41#include "keyboard.h"
e35f6ff7 42#include "keymap.h"
08460cd4 43#include "frame.h"
1ab256cb
RM
44
45struct buffer *current_buffer; /* the current buffer */
46
47/* First buffer in chain of all buffers (in reverse order of creation).
179dade4 48 Threaded through ->header.next.buffer. */
1ab256cb
RM
49
50struct buffer *all_buffers;
51
52/* This structure holds the default values of the buffer-local variables
53 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
54 The default value occupies the same slot in this structure
55 as an individual buffer's value occupies in that buffer.
56 Setting the default value also goes through the alist of buffers
57 and stores into each buffer that does not say it has a local value. */
58
6b61353c 59DECL_ALIGN (struct buffer, buffer_defaults);
1ab256cb
RM
60
61/* A Lisp_Object pointer to the above, used for staticpro */
62
63static Lisp_Object Vbuffer_defaults;
64
65/* This structure marks which slots in a buffer have corresponding
66 default values in buffer_defaults.
67 Each such slot has a nonzero value in this structure.
68 The value has only one nonzero bit.
69
70 When a buffer has its own local value for a slot,
7c02e886
GM
71 the entry for that slot (found in the same slot in this structure)
72 is turned on in the buffer's local_flags array.
1ab256cb
RM
73
74 If a slot in this structure is -1, then even though there may
75 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
76 and the corresponding slot in buffer_defaults is not used.
77
1ab256cb
RM
78 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
79 zero, that is a bug */
80
81struct buffer buffer_local_flags;
82
83/* This structure holds the names of symbols whose values may be
84 buffer-local. It is indexed and accessed in the same way as the above. */
85
6b61353c
KH
86DECL_ALIGN (struct buffer, buffer_local_symbols);
87
1ab256cb
RM
88/* A Lisp_Object pointer to the above, used for staticpro */
89static Lisp_Object Vbuffer_local_symbols;
90
ce5b453a
SM
91/* Return the symbol of the per-buffer variable at offset OFFSET in
92 the buffer structure. */
93
94#define PER_BUFFER_SYMBOL(OFFSET) \
95 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
96
21514da7
PE
97/* Maximum length of an overlay vector. */
98#define OVERLAY_COUNT_MAX \
99 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
100 min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)))
101
13de9290
RS
102/* Flags indicating which built-in buffer-local variables
103 are permanent locals. */
7313acd0 104static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
7c02e886
GM
105
106/* Number of per-buffer variables used. */
107
7313acd0 108int last_per_buffer_idx;
13de9290 109
cd64ea1d
PE
110static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
111static Lisp_Object Fdelete_overlay (Lisp_Object);
f57e2426
J
112static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
113 int after, Lisp_Object arg1,
114 Lisp_Object arg2, Lisp_Object arg3);
115static void swap_out_buffer_local_variables (struct buffer *b);
116static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
1ab256cb
RM
117
118/* Alist of all buffer names vs the buffers. */
119/* This used to be a variable, but is no longer,
120 to prevent lossage due to user rplac'ing this alist or its elements. */
121Lisp_Object Vbuffer_alist;
122
955cbe7b 123static Lisp_Object Qkill_buffer_query_functions;
dcdffbf6 124
43ed3b8d 125/* Hook run before changing a major mode. */
955cbe7b 126static Lisp_Object Qchange_major_mode_hook;
22378665 127
dbc4e1c1 128Lisp_Object Qfirst_change_hook;
22378665
RS
129Lisp_Object Qbefore_change_functions;
130Lisp_Object Qafter_change_functions;
955cbe7b 131static Lisp_Object Qucs_set_table_for_input;
1ab256cb 132
955cbe7b
PE
133static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
134static Lisp_Object Qpermanent_local_hook;
1ab256cb 135
955cbe7b 136static Lisp_Object Qprotected_field;
1ab256cb 137
955cbe7b 138static Lisp_Object QSFundamental; /* A string "Fundamental" */
1ab256cb 139
955cbe7b 140static Lisp_Object Qkill_buffer_hook;
9397e56f 141static Lisp_Object Qbuffer_list_update_hook;
1ab256cb 142
955cbe7b 143static Lisp_Object Qget_file_buffer;
5fe0b67e 144
955cbe7b 145static Lisp_Object Qoverlayp;
52f8ec73 146
955cbe7b 147Lisp_Object Qpriority, Qbefore_string, Qafter_string;
9397e56f 148
e43b6e43 149static Lisp_Object Qclone_number, Qevaporate;
5985d248 150
294d215f
RS
151Lisp_Object Qmodification_hooks;
152Lisp_Object Qinsert_in_front_hooks;
153Lisp_Object Qinsert_behind_hooks;
154
f57e2426
J
155static void alloc_buffer_text (struct buffer *, size_t);
156static void free_buffer_text (struct buffer *b);
157static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
158static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
159static Lisp_Object buffer_lisp_local_variables (struct buffer *);
b86af064 160
1ab256cb
RM
161/* For debugging; temporary. See set_buffer_internal. */
162/* Lisp_Object Qlisp_mode, Vcheck_symbol; */
163
01136e9b 164void
d3da34e0 165nsberror (Lisp_Object spec)
1ab256cb 166{
a7a60ce9 167 if (STRINGP (spec))
d5db4077 168 error ("No buffer named %s", SDATA (spec));
1ab256cb
RM
169 error ("Invalid buffer argument");
170}
171\f
a7ca3326 172DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
7ee72033
MB
173 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
174Value is nil if OBJECT is not a buffer or if it has been killed. */)
5842a27b 175 (Lisp_Object object)
0dc88e60 176{
4b4deea2 177 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
0dc88e60
RS
178 ? Qt : Qnil);
179}
180
08460cd4 181DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
7ee72033 182 doc: /* Return a list of all existing live buffers.
9397e56f
MR
183If the optional arg FRAME is a frame, we return the buffer list in the
184proper order for that frame: the buffers show in FRAME come first,
185followed by the rest of the buffers. */)
5842a27b 186 (Lisp_Object frame)
1ab256cb 187{
a18b8cb5 188 Lisp_Object general;
08460cd4
RS
189 general = Fmapcar (Qcdr, Vbuffer_alist);
190
191 if (FRAMEP (frame))
192 {
a18b8cb5
KL
193 Lisp_Object framelist, prevlist, tail;
194 Lisp_Object args[3];
08460cd4 195
b7826503 196 CHECK_FRAME (frame);
08460cd4 197 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
9397e56f
MR
198 prevlist = Fnreverse (Fcopy_sequence
199 (XFRAME (frame)->buried_buffer_list));
08460cd4 200
a18b8cb5
KL
201 /* Remove from GENERAL any buffer that duplicates one in
202 FRAMELIST or PREVLIST. */
08460cd4 203 tail = framelist;
a18b8cb5 204 while (CONSP (tail))
08460cd4 205 {
7539e11f
KR
206 general = Fdelq (XCAR (tail), general);
207 tail = XCDR (tail);
08460cd4 208 }
a18b8cb5
KL
209 tail = prevlist;
210 while (CONSP (tail))
211 {
212 general = Fdelq (XCAR (tail), general);
213 tail = XCDR (tail);
214 }
215
216 args[0] = framelist;
217 args[1] = general;
218 args[2] = prevlist;
219 return Fnconc (3, args);
08460cd4 220 }
9397e56f
MR
221 else
222 return general;
1ab256cb
RM
223}
224
04ae1b48
RS
225/* Like Fassoc, but use Fstring_equal to compare
226 (which ignores text properties),
227 and don't ever QUIT. */
228
229static Lisp_Object
d3da34e0 230assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
04ae1b48
RS
231{
232 register Lisp_Object tail;
6d70a280 233 for (tail = list; CONSP (tail); tail = XCDR (tail))
04ae1b48
RS
234 {
235 register Lisp_Object elt, tem;
6d70a280 236 elt = XCAR (tail);
04ae1b48
RS
237 tem = Fstring_equal (Fcar (elt), key);
238 if (!NILP (tem))
239 return elt;
240 }
241 return Qnil;
242}
243
a7ca3326 244DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
c8804c4f
MR
245 doc: /* Return the buffer named BUFFER-OR-NAME.
246BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
247is a string and there is no buffer with that name, return nil. If
248BUFFER-OR-NAME is a buffer, return it as given. */)
5842a27b 249 (register Lisp_Object buffer_or_name)
1ab256cb 250{
c8804c4f
MR
251 if (BUFFERP (buffer_or_name))
252 return buffer_or_name;
253 CHECK_STRING (buffer_or_name);
1ab256cb 254
c8804c4f 255 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
1ab256cb
RM
256}
257
258DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
7ee72033 259 doc: /* Return the buffer visiting file FILENAME (a string).
018ba359
PJ
260The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
261If there is no such live buffer, return nil.
7ee72033 262See also `find-buffer-visiting'. */)
5842a27b 263 (register Lisp_Object filename)
1ab256cb
RM
264{
265 register Lisp_Object tail, buf, tem;
5fe0b67e
RS
266 Lisp_Object handler;
267
b7826503 268 CHECK_STRING (filename);
1ab256cb
RM
269 filename = Fexpand_file_name (filename, Qnil);
270
5fe0b67e
RS
271 /* If the file name has special constructs in it,
272 call the corresponding file handler. */
a617e913 273 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
5fe0b67e
RS
274 if (!NILP (handler))
275 return call2 (handler, Qget_file_buffer, filename);
276
7539e11f 277 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
1ab256cb 278 {
7539e11f 279 buf = Fcdr (XCAR (tail));
a7a60ce9 280 if (!BUFFERP (buf)) continue;
4b4deea2
TT
281 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
282 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
265a9e55 283 if (!NILP (tem))
1ab256cb
RM
284 return buf;
285 }
286 return Qnil;
287}
288
52e01189 289Lisp_Object
d3da34e0 290get_truename_buffer (register Lisp_Object filename)
52e01189
RS
291{
292 register Lisp_Object tail, buf, tem;
293
7539e11f 294 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
52e01189 295 {
7539e11f 296 buf = Fcdr (XCAR (tail));
52e01189 297 if (!BUFFERP (buf)) continue;
4b4deea2
TT
298 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
299 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
52e01189
RS
300 if (!NILP (tem))
301 return buf;
302 }
303 return Qnil;
304}
305
a7ca3326 306DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
cd265ca6
MR
307 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
308If BUFFER-OR-NAME is a string and a live buffer with that name exists,
309return that buffer. If no such buffer exists, create a new buffer with
310that name and return it. If BUFFER-OR-NAME starts with a space, the new
311buffer does not keep undo information.
312
313If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
314even if it is dead. The return value is never nil. */)
5842a27b 315 (register Lisp_Object buffer_or_name)
1ab256cb 316{
cd265ca6 317 register Lisp_Object buffer, name;
1ab256cb
RM
318 register struct buffer *b;
319
cd265ca6
MR
320 buffer = Fget_buffer (buffer_or_name);
321 if (!NILP (buffer))
322 return buffer;
1ab256cb 323
cd265ca6 324 if (SCHARS (buffer_or_name) == 0)
31cd83e9
KH
325 error ("Empty string for buffer name is not allowed");
326
cc648cef 327 b = allocate_buffer ();
1ab256cb 328
336cd056
RS
329 /* An ordinary buffer uses its own struct buffer_text. */
330 b->text = &b->own_text;
331 b->base_buffer = 0;
332
1ab256cb 333 BUF_GAP_SIZE (b) = 20;
9ac0d9e0 334 BLOCK_INPUT;
3b06f880
KH
335 /* We allocate extra 1-byte at the tail and keep it always '\0' for
336 anchoring a search. */
b86af064 337 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
9ac0d9e0 338 UNBLOCK_INPUT;
1ab256cb 339 if (! BUF_BEG_ADDR (b))
531b0165 340 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
1ab256cb 341
cffc6f3b
CY
342 b->pt = BEG;
343 b->begv = BEG;
344 b->zv = BEG;
345 b->pt_byte = BEG_BYTE;
346 b->begv_byte = BEG_BYTE;
347 b->zv_byte = BEG_BYTE;
348
6d70a280 349 BUF_GPT (b) = BEG;
6d70a280 350 BUF_GPT_BYTE (b) = BEG_BYTE;
cffc6f3b
CY
351
352 BUF_Z (b) = BEG;
6d70a280 353 BUF_Z_BYTE (b) = BEG_BYTE;
1ab256cb 354 BUF_MODIFF (b) = 1;
3e145152 355 BUF_CHARS_MODIFF (b) = 1;
2509d356 356 BUF_OVERLAY_MODIFF (b) = 1;
336cd056
RS
357 BUF_SAVE_MODIFF (b) = 1;
358 BUF_INTERVALS (b) = 0;
b5a225b4
GM
359 BUF_UNCHANGED_MODIFIED (b) = 1;
360 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
361 BUF_END_UNCHANGED (b) = 0;
362 BUF_BEG_UNCHANGED (b) = 0;
3b06f880 363 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
1ab256cb 364
28e969dd
JB
365 b->newline_cache = 0;
366 b->width_run_cache = 0;
4b4deea2 367 BVAR (b, width_table) = Qnil;
b5a225b4 368 b->prevent_redisplay_optimizations_p = 1;
28e969dd 369
1ab256cb 370 /* Put this on the chain of all buffers including killed ones. */
eab3844f 371 b->header.next.buffer = all_buffers;
1ab256cb
RM
372 all_buffers = b;
373
336cd056
RS
374 /* An ordinary buffer normally doesn't need markers
375 to handle BEGV and ZV. */
4b4deea2
TT
376 BVAR (b, pt_marker) = Qnil;
377 BVAR (b, begv_marker) = Qnil;
378 BVAR (b, zv_marker) = Qnil;
04ae1b48 379
cd265ca6 380 name = Fcopy_sequence (buffer_or_name);
ab77f05c 381 STRING_SET_INTERVALS (name, NULL_INTERVAL);
4b4deea2 382 BVAR (b, name) = name;
04ae1b48 383
4b4deea2 384 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
1ab256cb
RM
385
386 reset_buffer (b);
13de9290 387 reset_buffer_local_variables (b, 1);
1ab256cb 388
4b4deea2 389 BVAR (b, mark) = Fmake_marker ();
65745fad 390 BUF_MARKERS (b) = NULL;
4b4deea2 391 BVAR (b, name) = name;
1f57cb74 392
1ab256cb 393 /* Put this in the alist of all live buffers. */
cd265ca6
MR
394 XSETBUFFER (buffer, b);
395 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
9397e56f
MR
396 /* And run buffer-list-update-hook. */
397 if (!NILP (Vrun_hooks))
398 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1ab256cb 399
2f064abf 400 /* An error in calling the function here (should someone redefine it)
d36b182f
DL
401 can lead to infinite regress until you run out of stack. rms
402 says that's not worth protecting against. */
48265e61 403 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
cd265ca6
MR
404 /* buffer is on buffer-alist, so no gcpro. */
405 call1 (Qucs_set_table_for_input, buffer);
48265e61 406
cd265ca6 407 return buffer;
336cd056
RS
408}
409
7e9d5818 410
04e4cb3a
GM
411/* Return a list of overlays which is a copy of the overlay list
412 LIST, but for buffer B. */
413
2410d73a 414static struct Lisp_Overlay *
d3da34e0 415copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
04e4cb3a 416{
2410d73a
SM
417 Lisp_Object buffer;
418 struct Lisp_Overlay *result = NULL, *tail = NULL;
04e4cb3a
GM
419
420 XSETBUFFER (buffer, b);
421
2410d73a 422 for (; list; list = list->next)
04e4cb3a
GM
423 {
424 Lisp_Object overlay, start, end, old_overlay;
27c6b98e 425 EMACS_INT charpos;
04e4cb3a 426
2410d73a 427 XSETMISC (old_overlay, list);
04e4cb3a
GM
428 charpos = marker_position (OVERLAY_START (old_overlay));
429 start = Fmake_marker ();
db3a49a6 430 Fset_marker (start, make_number (charpos), buffer);
04e4cb3a
GM
431 XMARKER (start)->insertion_type
432 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
433
434 charpos = marker_position (OVERLAY_END (old_overlay));
435 end = Fmake_marker ();
db3a49a6 436 Fset_marker (end, make_number (charpos), buffer);
04e4cb3a
GM
437 XMARKER (end)->insertion_type
438 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
439
440 overlay = allocate_misc ();
441 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
442 OVERLAY_START (overlay) = start;
443 OVERLAY_END (overlay) = end;
444 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
2410d73a 445 XOVERLAY (overlay)->next = NULL;
177c0ea7 446
2410d73a
SM
447 if (tail)
448 tail = tail->next = XOVERLAY (overlay);
449 else
450 result = tail = XOVERLAY (overlay);
04e4cb3a
GM
451 }
452
2410d73a 453 return result;
04e4cb3a 454}
177c0ea7 455
04e4cb3a 456
7e9d5818
GM
457/* Clone per-buffer values of buffer FROM.
458
459 Buffer TO gets the same per-buffer values as FROM, with the
460 following exceptions: (1) TO's name is left untouched, (2) markers
461 are copied and made to refer to TO, and (3) overlay lists are
462 copied. */
463
464static void
d3da34e0 465clone_per_buffer_values (struct buffer *from, struct buffer *to)
7e9d5818 466{
54622f33 467 Lisp_Object to_buffer;
7e9d5818
GM
468 int offset;
469
470 XSETBUFFER (to_buffer, to);
177c0ea7 471
3ee24aec
SM
472 /* buffer-local Lisp variables start at `undo_list',
473 tho only the ones from `name' on are GC'd normally. */
4b7cdc0e 474 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
7e9d5818
GM
475 offset < sizeof *to;
476 offset += sizeof (Lisp_Object))
477 {
478 Lisp_Object obj;
479
4b7cdc0e
SM
480 /* Don't touch the `name' which should be unique for every buffer. */
481 if (offset == PER_BUFFER_VAR_OFFSET (name))
482 continue;
483
7e9d5818 484 obj = PER_BUFFER_VALUE (from, offset);
ce5b453a 485 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
7e9d5818
GM
486 {
487 struct Lisp_Marker *m = XMARKER (obj);
488 obj = Fmake_marker ();
489 XMARKER (obj)->insertion_type = m->insertion_type;
490 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
491 }
492
493 PER_BUFFER_VALUE (to, offset) = obj;
494 }
495
72af86bd 496 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
177c0ea7 497
04e4cb3a
GM
498 to->overlays_before = copy_overlays (to, from->overlays_before);
499 to->overlays_after = copy_overlays (to, from->overlays_after);
02f28bbd 500
e1688f54
RS
501 /* Get (a copy of) the alist of Lisp-level local variables of FROM
502 and install that in TO. */
4b4deea2 503 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
7e9d5818
GM
504}
505
cffc6f3b
CY
506
507/* If buffer B has markers to record PT, BEGV and ZV when it is not
508 current, update these markers. */
509
510static void
511record_buffer_markers (struct buffer *b)
512{
513 if (! NILP (BVAR (b, pt_marker)))
514 {
515 Lisp_Object buffer;
516
517 eassert (!NILP (BVAR (b, begv_marker)));
518 eassert (!NILP (BVAR (b, zv_marker)));
519
520 XSETBUFFER (buffer, b);
521 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
522 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
523 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
524 }
525}
526
527
528/* If buffer B has markers to record PT, BEGV and ZV when it is not
529 current, fetch these values into B->begv etc. */
530
531static void
532fetch_buffer_markers (struct buffer *b)
533{
534 if (! NILP (BVAR (b, pt_marker)))
535 {
536 Lisp_Object m;
537
538 eassert (!NILP (BVAR (b, begv_marker)));
539 eassert (!NILP (BVAR (b, zv_marker)));
540
541 m = BVAR (b, pt_marker);
542 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
543
544 m = BVAR (b, begv_marker);
545 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
546
547 m = BVAR (b, zv_marker);
548 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
549 }
550}
551
552
7e9d5818
GM
553DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
554 2, 3,
193c3837 555 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
7ee72033 556 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
6b61353c 557BASE-BUFFER should be a live buffer, or the name of an existing buffer.
018ba359
PJ
558NAME should be a string which is not the name of an existing buffer.
559Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
560such as major and minor modes, in the indirect buffer.
7ee72033 561CLONE nil means the indirect buffer's state is reset to default values. */)
5842a27b 562 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
336cd056 563{
6b61353c 564 Lisp_Object buf, tem;
7e9d5818 565 struct buffer *b;
336cd056 566
6b61353c 567 CHECK_STRING (name);
336cd056
RS
568 buf = Fget_buffer (name);
569 if (!NILP (buf))
d5db4077 570 error ("Buffer name `%s' is in use", SDATA (name));
336cd056 571
6b61353c 572 tem = base_buffer;
336cd056
RS
573 base_buffer = Fget_buffer (base_buffer);
574 if (NILP (base_buffer))
6b61353c 575 error ("No such buffer: `%s'", SDATA (tem));
4b4deea2 576 if (NILP (BVAR (XBUFFER (base_buffer), name)))
6b61353c 577 error ("Base buffer has been killed");
336cd056 578
d5db4077 579 if (SCHARS (name) == 0)
336cd056
RS
580 error ("Empty string for buffer name is not allowed");
581
cc648cef 582 b = allocate_buffer ();
336cd056 583
67ee9f6e
SM
584 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
585 ? XBUFFER (base_buffer)->base_buffer
586 : XBUFFER (base_buffer));
336cd056
RS
587
588 /* Use the base buffer's text object. */
589 b->text = b->base_buffer->text;
590
cffc6f3b
CY
591 b->pt = b->base_buffer->pt;
592 b->begv = b->base_buffer->begv;
593 b->zv = b->base_buffer->zv;
594 b->pt_byte = b->base_buffer->pt_byte;
595 b->begv_byte = b->base_buffer->begv_byte;
596 b->zv_byte = b->base_buffer->zv_byte;
336cd056
RS
597
598 b->newline_cache = 0;
599 b->width_run_cache = 0;
4b4deea2 600 BVAR (b, width_table) = Qnil;
336cd056
RS
601
602 /* Put this on the chain of all buffers including killed ones. */
eab3844f 603 b->header.next.buffer = all_buffers;
336cd056
RS
604 all_buffers = b;
605
606 name = Fcopy_sequence (name);
ab77f05c 607 STRING_SET_INTERVALS (name, NULL_INTERVAL);
4b4deea2 608 BVAR (b, name) = name;
336cd056
RS
609
610 reset_buffer (b);
13de9290 611 reset_buffer_local_variables (b, 1);
336cd056
RS
612
613 /* Put this in the alist of all live buffers. */
614 XSETBUFFER (buf, b);
615 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
616
4b4deea2
TT
617 BVAR (b, mark) = Fmake_marker ();
618 BVAR (b, name) = name;
336cd056 619
abc9d959 620 /* The multibyte status belongs to the base buffer. */
4b4deea2 621 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
abc9d959 622
336cd056 623 /* Make sure the base buffer has markers for its narrowing. */
4b4deea2 624 if (NILP (BVAR (b->base_buffer, pt_marker)))
336cd056 625 {
2aa46d6c
CY
626 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
627 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
cffc6f3b 628
4b4deea2
TT
629 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
630 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
cffc6f3b
CY
631 b->base_buffer->pt,
632 b->base_buffer->pt_byte);
633
4b4deea2
TT
634 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
635 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
cffc6f3b
CY
636 b->base_buffer->begv,
637 b->base_buffer->begv_byte);
638
4b4deea2
TT
639 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
640 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
cffc6f3b
CY
641 b->base_buffer->zv,
642 b->base_buffer->zv_byte);
4b4deea2 643 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
336cd056
RS
644 }
645
7e9d5818
GM
646 if (NILP (clone))
647 {
648 /* Give the indirect buffer markers for its narrowing. */
4b4deea2 649 BVAR (b, pt_marker) = Fmake_marker ();
cffc6f3b 650 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
4b4deea2 651 BVAR (b, begv_marker) = Fmake_marker ();
cffc6f3b 652 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
4b4deea2 653 BVAR (b, zv_marker) = Fmake_marker ();
cffc6f3b 654 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
4b4deea2 655 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
7e9d5818
GM
656 }
657 else
7fa57e45
RS
658 {
659 struct buffer *old_b = current_buffer;
660
661 clone_per_buffer_values (b->base_buffer, b);
4b4deea2
TT
662 BVAR (b, filename) = Qnil;
663 BVAR (b, file_truename) = Qnil;
664 BVAR (b, display_count) = make_number (0);
665 BVAR (b, backed_up) = Qnil;
666 BVAR (b, auto_save_file_name) = Qnil;
7fa57e45
RS
667 set_buffer_internal_1 (b);
668 Fset (intern ("buffer-save-without-query"), Qnil);
669 Fset (intern ("buffer-file-number"), Qnil);
670 Fset (intern ("buffer-stale-function"), Qnil);
671 set_buffer_internal_1 (old_b);
672 }
336cd056 673
9397e56f
MR
674 /* Run buffer-list-update-hook. */
675 if (!NILP (Vrun_hooks))
676 call1 (Vrun_hooks, Qbuffer_list_update_hook);
677
a9ee7a59 678 return buf;
1ab256cb
RM
679}
680
d4f5719a 681void
d3da34e0 682delete_all_overlays (struct buffer *b)
d4f5719a
SM
683{
684 Lisp_Object overlay;
685
686 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
687 have to empty the list, otherwise we end up with overlays that
688 think they belong to this buffer while the buffer doesn't know about
689 them any more. */
690 while (b->overlays_before)
691 {
692 XSETMISC (overlay, b->overlays_before);
693 Fdelete_overlay (overlay);
694 }
695 while (b->overlays_after)
696 {
697 XSETMISC (overlay, b->overlays_after);
698 Fdelete_overlay (overlay);
699 }
700 eassert (b->overlays_before == NULL);
701 eassert (b->overlays_after == NULL);
702}
703
bcd40520 704/* Reinitialize everything about a buffer except its name and contents
6b61353c 705 and local variables.
d4f5719a
SM
706 If called on an already-initialized buffer, the list of overlays
707 should be deleted before calling this function, otherwise we end up
708 with overlays that claim to belong to the buffer but the buffer
709 claims it doesn't belong to it. */
1ab256cb
RM
710
711void
d3da34e0 712reset_buffer (register struct buffer *b)
1ab256cb 713{
4b4deea2
TT
714 BVAR (b, filename) = Qnil;
715 BVAR (b, file_truename) = Qnil;
716 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
1ab256cb 717 b->modtime = 0;
58b963f7 718 b->modtime_size = -1;
4b4deea2 719 XSETFASTINT (BVAR (b, save_length), 0);
1ab256cb 720 b->last_window_start = 1;
8b264726 721 /* It is more conservative to start out "changed" than "unchanged". */
b5a225b4
GM
722 b->clip_changed = 0;
723 b->prevent_redisplay_optimizations_p = 1;
4b4deea2 724 BVAR (b, backed_up) = Qnil;
0b5397c2 725 BUF_AUTOSAVE_MODIFF (b) = 0;
84f6bcba 726 b->auto_save_failure_time = -1;
4b4deea2
TT
727 BVAR (b, auto_save_file_name) = Qnil;
728 BVAR (b, read_only) = Qnil;
2410d73a
SM
729 b->overlays_before = NULL;
730 b->overlays_after = NULL;
c2d5b10f 731 b->overlay_center = BEG;
4b4deea2
TT
732 BVAR (b, mark_active) = Qnil;
733 BVAR (b, point_before_scroll) = Qnil;
734 BVAR (b, file_format) = Qnil;
735 BVAR (b, auto_save_file_format) = Qt;
736 BVAR (b, last_selected_window) = Qnil;
737 XSETINT (BVAR (b, display_count), 0);
738 BVAR (b, display_time) = Qnil;
739 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
740 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
741 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
0522997d
RS
742
743 b->display_error_modiff = 0;
1ab256cb
RM
744}
745
bcd40520
RS
746/* Reset buffer B's local variables info.
747 Don't use this on a buffer that has already been in use;
748 it does not treat permanent locals consistently.
13de9290
RS
749 Instead, use Fkill_all_local_variables.
750
3709505e 751 If PERMANENT_TOO is 1, then we reset permanent
13de9290
RS
752 buffer-local variables. If PERMANENT_TOO is 0,
753 we preserve those. */
bcd40520 754
13de9290 755static void
d3da34e0 756reset_buffer_local_variables (register struct buffer *b, int permanent_too)
1ab256cb
RM
757{
758 register int offset;
7c02e886 759 int i;
1ab256cb
RM
760
761 /* Reset the major mode to Fundamental, together with all the
762 things that depend on the major mode.
763 default-major-mode is handled at a higher level.
764 We ignore it here. */
4b4deea2
TT
765 BVAR (b, major_mode) = Qfundamental_mode;
766 BVAR (b, keymap) = Qnil;
767 BVAR (b, mode_name) = QSFundamental;
768 BVAR (b, minor_modes) = Qnil;
3446af9c
RS
769
770 /* If the standard case table has been altered and invalidated,
771 fix up its insides first. */
772 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
773 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
774 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
775 Fset_standard_case_table (Vascii_downcase_table);
776
4b4deea2
TT
777 BVAR (b, downcase_table) = Vascii_downcase_table;
778 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
779 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
780 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
781 BVAR (b, invisibility_spec) = Qt;
3cb719bd 782
13de9290 783 /* Reset all (or most) per-buffer variables to their defaults. */
3709505e 784 if (permanent_too)
4b4deea2 785 BVAR (b, local_var_alist) = Qnil;
3709505e
SM
786 else
787 {
2f7a359d 788 Lisp_Object tmp, prop, last = Qnil;
4b4deea2 789 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
ce5b453a 790 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
2f7a359d
RS
791 {
792 /* If permanent-local, keep it. */
793 last = tmp;
794 if (EQ (prop, Qpermanent_local_hook))
795 {
796 /* This is a partially permanent hook variable.
797 Preserve only the elements that want to be preserved. */
798 Lisp_Object list, newlist;
799 list = XCDR (XCAR (tmp));
800 if (!CONSP (list))
801 newlist = list;
802 else
803 for (newlist = Qnil; CONSP (list); list = XCDR (list))
804 {
805 Lisp_Object elt = XCAR (list);
806 /* Preserve element ELT if it's t,
807 if it is a function with a `permanent-local-hook' property,
808 or if it's not a symbol. */
809 if (! SYMBOLP (elt)
810 || EQ (elt, Qt)
811 || !NILP (Fget (elt, Qpermanent_local_hook)))
812 newlist = Fcons (elt, newlist);
813 }
814 XSETCDR (XCAR (tmp), Fnreverse (newlist));
815 }
816 }
817 /* Delete this local variable. */
3709505e 818 else if (NILP (last))
4b4deea2 819 BVAR (b, local_var_alist) = XCDR (tmp);
3709505e
SM
820 else
821 XSETCDR (last, XCDR (tmp));
822 }
823
7313acd0 824 for (i = 0; i < last_per_buffer_idx; ++i)
7c02e886 825 if (permanent_too || buffer_permanent_local_flags[i] == 0)
7313acd0 826 SET_PER_BUFFER_VALUE_P (b, i, 0);
1ab256cb
RM
827
828 /* For each slot that has a default value,
829 copy that into the slot. */
830
3ee24aec
SM
831 /* buffer-local Lisp variables start at `undo_list',
832 tho only the ones from `name' on are GC'd normally. */
833 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
7c02e886
GM
834 offset < sizeof *b;
835 offset += sizeof (Lisp_Object))
aab80822 836 {
7313acd0 837 int idx = PER_BUFFER_IDX (offset);
7c02e886
GM
838 if ((idx > 0
839 && (permanent_too
ce5b453a 840 || buffer_permanent_local_flags[idx] == 0)))
7313acd0 841 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
aab80822 842 }
1ab256cb
RM
843}
844
01050cb5
RM
845/* We split this away from generate-new-buffer, because rename-buffer
846 and set-visited-file-name ought to be able to use this to really
847 rename the buffer properly. */
848
a7ca3326 849DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
16a97296 850 Sgenerate_new_buffer_name, 1, 2, 0,
7ee72033 851 doc: /* Return a string that is the name of no existing buffer based on NAME.
018ba359
PJ
852If there is no live buffer named NAME, then return NAME.
853Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
6b61353c 854\(starting at 2) until an unused name is found, and then return that name.
2f064abf
JB
855Optional second argument IGNORE specifies a name that is okay to use (if
856it is in the sequence to be tried) even if a buffer with that name exists. */)
5842a27b 857 (register Lisp_Object name, Lisp_Object ignore)
1ab256cb
RM
858{
859 register Lisp_Object gentemp, tem;
666398f3
PE
860 EMACS_INT count;
861 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
1ab256cb 862
b7826503 863 CHECK_STRING (name);
1ab256cb 864
6b61353c
KH
865 tem = Fstring_equal (name, ignore);
866 if (!NILP (tem))
867 return name;
1ab256cb 868 tem = Fget_buffer (name);
265a9e55 869 if (NILP (tem))
01050cb5 870 return name;
1ab256cb
RM
871
872 count = 1;
873 while (1)
874 {
666398f3 875 sprintf (number, "<%"pI"d>", ++count);
1ab256cb 876 gentemp = concat2 (name, build_string (number));
638e4fc3 877 tem = Fstring_equal (gentemp, ignore);
c273e647
RS
878 if (!NILP (tem))
879 return gentemp;
1ab256cb 880 tem = Fget_buffer (gentemp);
265a9e55 881 if (NILP (tem))
01050cb5 882 return gentemp;
1ab256cb
RM
883 }
884}
885
886\f
a7ca3326 887DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
7ee72033 888 doc: /* Return the name of BUFFER, as a string.
35f5c1d2
JB
889BUFFER defaults to the current buffer.
890Return nil if BUFFER has been killed. */)
5842a27b 891 (register Lisp_Object buffer)
1ab256cb 892{
265a9e55 893 if (NILP (buffer))
4b4deea2 894 return BVAR (current_buffer, name);
b7826503 895 CHECK_BUFFER (buffer);
4b4deea2 896 return BVAR (XBUFFER (buffer), name);
1ab256cb
RM
897}
898
a7ca3326 899DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
7ee72033
MB
900 doc: /* Return name of file BUFFER is visiting, or nil if none.
901No argument or nil as argument means use the current buffer. */)
5842a27b 902 (register Lisp_Object buffer)
1ab256cb 903{
265a9e55 904 if (NILP (buffer))
4b4deea2 905 return BVAR (current_buffer, filename);
b7826503 906 CHECK_BUFFER (buffer);
4b4deea2 907 return BVAR (XBUFFER (buffer), filename);
1ab256cb
RM
908}
909
336cd056
RS
910DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
911 0, 1, 0,
7ee72033 912 doc: /* Return the base buffer of indirect buffer BUFFER.
5a72efd4
LT
913If BUFFER is not indirect, return nil.
914BUFFER defaults to the current buffer. */)
5842a27b 915 (register Lisp_Object buffer)
336cd056
RS
916{
917 struct buffer *base;
918 Lisp_Object base_buffer;
919
920 if (NILP (buffer))
921 base = current_buffer->base_buffer;
922 else
923 {
b7826503 924 CHECK_BUFFER (buffer);
336cd056
RS
925 base = XBUFFER (buffer)->base_buffer;
926 }
927
928 if (! base)
929 return Qnil;
930 XSETBUFFER (base_buffer, base);
931 return base_buffer;
932}
933
a7ca3326 934DEFUN ("buffer-local-value", Fbuffer_local_value,
177c0ea7 935 Sbuffer_local_value, 2, 2, 0,
79aa712d
RS
936 doc: /* Return the value of VARIABLE in BUFFER.
937If VARIABLE does not have a buffer-local binding in BUFFER, the value
5e2ad10b 938is the default binding of the variable. */)
5842a27b 939 (register Lisp_Object variable, register Lisp_Object buffer)
79aa712d
RS
940{
941 register struct buffer *buf;
942 register Lisp_Object result;
ad97b375 943 struct Lisp_Symbol *sym;
79aa712d 944
5e2ad10b 945 CHECK_SYMBOL (variable);
ae69175b 946 CHECK_BUFFER (buffer);
79aa712d 947 buf = XBUFFER (buffer);
ce5b453a 948 sym = XSYMBOL (variable);
79aa712d 949
ce5b453a
SM
950 start:
951 switch (sym->redirect)
f0bac7de 952 {
ce5b453a
SM
953 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
954 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
955 case SYMBOL_LOCALIZED:
956 { /* Look in local_var_alist. */
957 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
958 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
4b4deea2 959 result = Fassoc (variable, BVAR (buf, local_var_alist));
ce5b453a
SM
960 if (!NILP (result))
961 {
962 if (blv->fwd)
963 { /* What binding is loaded right now? */
964 Lisp_Object current_alist_element = blv->valcell;
f0bac7de 965
ce5b453a
SM
966 /* The value of the currently loaded binding is not
967 stored in it, but rather in the realvalue slot.
968 Store that value into the binding it belongs to
969 in case that is the one we are about to use. */
f0bac7de 970
ce5b453a
SM
971 XSETCDR (current_alist_element,
972 do_symval_forwarding (blv->fwd));
973 }
974 /* Now get the (perhaps updated) value out of the binding. */
975 result = XCDR (result);
976 }
977 else
978 result = Fdefault_value (variable);
979 break;
980 }
981 case SYMBOL_FORWARDED:
982 {
983 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
984 if (BUFFER_OBJFWDP (fwd))
985 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
986 else
987 result = Fdefault_value (variable);
988 break;
989 }
990 default: abort ();
f0bac7de 991 }
79aa712d 992
4c4dc0b0
KS
993 if (!EQ (result, Qunbound))
994 return result;
79aa712d 995
4c4dc0b0 996 xsignal1 (Qvoid_variable, variable);
79aa712d
RS
997}
998
e1688f54 999/* Return an alist of the Lisp-level buffer-local bindings of
7fa57e45 1000 buffer BUF. That is, don't include the variables maintained
e1688f54
RS
1001 in special slots in the buffer object. */
1002
1003static Lisp_Object
d3da34e0 1004buffer_lisp_local_variables (struct buffer *buf)
e1688f54
RS
1005{
1006 Lisp_Object result = Qnil;
1007 register Lisp_Object tail;
4b4deea2 1008 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
e1688f54
RS
1009 {
1010 Lisp_Object val, elt;
1011
1012 elt = XCAR (tail);
1013
1014 /* Reference each variable in the alist in buf.
1015 If inquiring about the current buffer, this gets the current values,
1016 so store them into the alist so the alist is up to date.
1017 If inquiring about some other buffer, this swaps out any values
1018 for that buffer, making the alist up to date automatically. */
1019 val = find_symbol_value (XCAR (elt));
1020 /* Use the current buffer value only if buf is the current buffer. */
1021 if (buf != current_buffer)
1022 val = XCDR (elt);
1023
ce5b453a 1024 result = Fcons (Fcons (XCAR (elt), val), result);
e1688f54
RS
1025 }
1026
1027 return result;
1028}
1029
1ab256cb 1030DEFUN ("buffer-local-variables", Fbuffer_local_variables,
efc7e75f 1031 Sbuffer_local_variables, 0, 1, 0,
7ee72033 1032 doc: /* Return an alist of variables that are buffer-local in BUFFER.
018ba359
PJ
1033Most elements look like (SYMBOL . VALUE), describing one variable.
1034For a symbol that is locally unbound, just the symbol appears in the value.
1035Note that storing new VALUEs in these elements doesn't change the variables.
7ee72033 1036No argument or nil as argument means use current buffer as BUFFER. */)
5842a27b 1037 (register Lisp_Object buffer)
1ab256cb
RM
1038{
1039 register struct buffer *buf;
553defa4 1040 register Lisp_Object result;
1ab256cb 1041
265a9e55 1042 if (NILP (buffer))
1ab256cb
RM
1043 buf = current_buffer;
1044 else
1045 {
b7826503 1046 CHECK_BUFFER (buffer);
1ab256cb
RM
1047 buf = XBUFFER (buffer);
1048 }
1049
e1688f54 1050 result = buffer_lisp_local_variables (buf);
1ab256cb 1051
1ab256cb
RM
1052 /* Add on all the variables stored in special slots. */
1053 {
7c02e886 1054 int offset, idx;
1ab256cb 1055
3ee24aec
SM
1056 /* buffer-local Lisp variables start at `undo_list',
1057 tho only the ones from `name' on are GC'd normally. */
1058 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
1ab256cb 1059 offset < sizeof (struct buffer);
7c02e886
GM
1060 /* sizeof EMACS_INT == sizeof Lisp_Object */
1061 offset += (sizeof (EMACS_INT)))
1ab256cb 1062 {
7313acd0
GM
1063 idx = PER_BUFFER_IDX (offset);
1064 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1065 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1066 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1067 PER_BUFFER_VALUE (buf, offset)),
7c02e886 1068 result);
1ab256cb
RM
1069 }
1070 }
553defa4
RS
1071
1072 return result;
1ab256cb 1073}
1ab256cb 1074\f
a7ca3326 1075DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
efc7e75f 1076 0, 1, 0,
7ee72033
MB
1077 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1078No argument or nil as argument means use current buffer as BUFFER. */)
5842a27b 1079 (register Lisp_Object buffer)
1ab256cb
RM
1080{
1081 register struct buffer *buf;
265a9e55 1082 if (NILP (buffer))
1ab256cb
RM
1083 buf = current_buffer;
1084 else
1085 {
b7826503 1086 CHECK_BUFFER (buffer);
1ab256cb
RM
1087 buf = XBUFFER (buffer);
1088 }
1089
336cd056 1090 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1ab256cb
RM
1091}
1092
a7ca3326 1093DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
efc7e75f 1094 1, 1, 0,
7ee72033
MB
1095 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1096A non-nil FLAG means mark the buffer modified. */)
5842a27b 1097 (register Lisp_Object flag)
1ab256cb
RM
1098{
1099 register int already;
1100 register Lisp_Object fn;
8ec01c70 1101 Lisp_Object buffer, window;
1ab256cb
RM
1102
1103#ifdef CLASH_DETECTION
1104 /* If buffer becoming modified, lock the file.
1105 If buffer becoming unmodified, unlock the file. */
1106
4b4deea2 1107 fn = BVAR (current_buffer, file_truename);
90d456d2 1108 /* Test buffer-file-name so that binding it to nil is effective. */
4b4deea2 1109 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1ab256cb 1110 {
336cd056 1111 already = SAVE_MODIFF < MODIFF;
265a9e55 1112 if (!already && !NILP (flag))
1ab256cb 1113 lock_file (fn);
265a9e55 1114 else if (already && NILP (flag))
1ab256cb
RM
1115 unlock_file (fn);
1116 }
1117#endif /* CLASH_DETECTION */
1118
0b5397c2
SM
1119 /* Here we have a problem. SAVE_MODIFF is used here to encode
1120 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1121 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1122 modify SAVE_MODIFF to affect one, we may affect the other
1123 as well.
1124 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1125 if SAVE_MODIFF<auto_save_modified that means we risk changing
1126 recent-auto-save-p from t to nil.
1127 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1128 we risk changing recent-auto-save-p from nil to t. */
1129 SAVE_MODIFF = (NILP (flag)
1130 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1131 ? MODIFF
1132 /* Let's try to preserve recent-auto-save-p. */
1133 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1134 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1135 we can either decrease SAVE_MODIFF and auto_save_modified
1136 or increase MODIFF. */
1137 : MODIFF++);
177c0ea7 1138
8ec01c70
GM
1139 /* Set update_mode_lines only if buffer is displayed in some window.
1140 Packages like jit-lock or lazy-lock preserve a buffer's modified
1141 state by recording/restoring the state around blocks of code.
1142 Setting update_mode_lines makes redisplay consider all windows
1143 (on all frames). Stealth fontification of buffers not displayed
1144 would incur additional redisplay costs if we'd set
1145 update_modes_lines unconditionally.
1146
1147 Ideally, I think there should be another mechanism for fontifying
1148 buffers without "modifying" buffers, or redisplay should be
1149 smarter about updating the `*' in mode lines. --gerd */
1150 XSETBUFFER (buffer, current_buffer);
1151 window = Fget_buffer_window (buffer, Qt);
1152 if (WINDOWP (window))
d57b83b3
GM
1153 {
1154 ++update_mode_lines;
1155 current_buffer->prevent_redisplay_optimizations_p = 1;
1156 }
177c0ea7 1157
1ab256cb
RM
1158 return flag;
1159}
1160
a8c21b48
GM
1161DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1162 Srestore_buffer_modified_p, 1, 1, 0,
42f47086 1163 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
018ba359 1164It is not ensured that mode lines will be updated to show the modified
7ee72033 1165state of the current buffer. Use with care. */)
5842a27b 1166 (Lisp_Object flag)
a8c21b48
GM
1167{
1168#ifdef CLASH_DETECTION
1169 Lisp_Object fn;
177c0ea7 1170
a8c21b48
GM
1171 /* If buffer becoming modified, lock the file.
1172 If buffer becoming unmodified, unlock the file. */
1173
4b4deea2 1174 fn = BVAR (current_buffer, file_truename);
a8c21b48 1175 /* Test buffer-file-name so that binding it to nil is effective. */
4b4deea2 1176 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
a8c21b48
GM
1177 {
1178 int already = SAVE_MODIFF < MODIFF;
1179 if (!already && !NILP (flag))
1180 lock_file (fn);
1181 else if (already && NILP (flag))
1182 unlock_file (fn);
1183 }
1184#endif /* CLASH_DETECTION */
177c0ea7 1185
a8c21b48
GM
1186 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1187 return flag;
1188}
1189
1ab256cb 1190DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
efc7e75f 1191 0, 1, 0,
7ee72033 1192 doc: /* Return BUFFER's tick counter, incremented for each change in text.
2f064abf
JB
1193Each buffer has a tick counter which is incremented each time the
1194text in that buffer is changed. It wraps around occasionally.
7ee72033 1195No argument or nil as argument means use current buffer as BUFFER. */)
5842a27b 1196 (register Lisp_Object buffer)
1ab256cb
RM
1197{
1198 register struct buffer *buf;
265a9e55 1199 if (NILP (buffer))
1ab256cb
RM
1200 buf = current_buffer;
1201 else
1202 {
b7826503 1203 CHECK_BUFFER (buffer);
1ab256cb
RM
1204 buf = XBUFFER (buffer);
1205 }
1206
1207 return make_number (BUF_MODIFF (buf));
1208}
3e145152
CY
1209
1210DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1211 Sbuffer_chars_modified_tick, 0, 1, 0,
1212 doc: /* Return BUFFER's character-change tick counter.
1213Each buffer has a character-change tick counter, which is set to the
1214value of the buffer's tick counter \(see `buffer-modified-tick'), each
1215time text in that buffer is inserted or deleted. By comparing the
12bd42be 1216values returned by two individual calls of `buffer-chars-modified-tick',
3e145152
CY
1217you can tell whether a character change occurred in that buffer in
1218between these calls. No argument or nil as argument means use current
1219buffer as BUFFER. */)
5842a27b 1220 (register Lisp_Object buffer)
3e145152
CY
1221{
1222 register struct buffer *buf;
1223 if (NILP (buffer))
1224 buf = current_buffer;
1225 else
1226 {
1227 CHECK_BUFFER (buffer);
1228 buf = XBUFFER (buffer);
1229 }
1230
1231 return make_number (BUF_CHARS_MODIFF (buf));
1232}
1ab256cb 1233\f
01050cb5 1234DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
c7d97628
JL
1235 "(list (read-string \"Rename buffer (to new name): \" \
1236 nil 'buffer-name-history (buffer-name (current-buffer))) \
1237 current-prefix-arg)",
7ee72033 1238 doc: /* Change current buffer's name to NEWNAME (a string).
018ba359
PJ
1239If second arg UNIQUE is nil or omitted, it is an error if a
1240buffer named NEWNAME already exists.
1241If UNIQUE is non-nil, come up with a new name using
1242`generate-new-buffer-name'.
1243Interactively, you can set UNIQUE with a prefix argument.
1244We return the name we actually gave the buffer.
7ee72033 1245This does not change the name of the visited file (if any). */)
5842a27b 1246 (register Lisp_Object newname, Lisp_Object unique)
1ab256cb
RM
1247{
1248 register Lisp_Object tem, buf;
1249
b7826503 1250 CHECK_STRING (newname);
d59698c4 1251
d5db4077 1252 if (SCHARS (newname) == 0)
d59698c4
RS
1253 error ("Empty string is invalid as a buffer name");
1254
489c043a 1255 tem = Fget_buffer (newname);
265a9e55 1256 if (!NILP (tem))
01050cb5 1257 {
8801a864
KR
1258 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1259 rename the buffer automatically so you can create another
1260 with the original name. It makes UNIQUE equivalent to
1261 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1262 if (NILP (unique) && XBUFFER (tem) == current_buffer)
4b4deea2 1263 return BVAR (current_buffer, name);
3bd779aa 1264 if (!NILP (unique))
4b4deea2 1265 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
01050cb5 1266 else
d5db4077 1267 error ("Buffer name `%s' is in use", SDATA (newname));
01050cb5 1268 }
1ab256cb 1269
4b4deea2 1270 BVAR (current_buffer, name) = newname;
76f590d7
JB
1271
1272 /* Catch redisplay's attention. Unless we do this, the mode lines for
1273 any windows displaying current_buffer will stay unchanged. */
1274 update_mode_lines++;
1275
67180c6a 1276 XSETBUFFER (buf, current_buffer);
489c043a 1277 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
4b4deea2
TT
1278 if (NILP (BVAR (current_buffer, filename))
1279 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1ab256cb 1280 call0 (intern ("rename-auto-save-file"));
9397e56f
MR
1281
1282 /* Run buffer-list-update-hook. */
1283 if (!NILP (Vrun_hooks))
1284 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1285
fb5eba9c 1286 /* Refetch since that last call may have done GC. */
4b4deea2 1287 return BVAR (current_buffer, name);
1ab256cb
RM
1288}
1289
a7ca3326 1290DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
7ee72033 1291 doc: /* Return most recently selected buffer other than BUFFER.
9397e56f
MR
1292Buffers not visible in windows are preferred to visible buffers, unless
1293optional second argument VISIBLE-OK is non-nil. Ignore the argument
1294BUFFER unless it denotes a live buffer. If the optional third argument
1295FRAME is non-nil, use that frame's buffer list instead of the selected
1296frame's buffer list.
1297
1298The buffer is found by scanning the selected or specified frame's buffer
1299list first, followed by the list of all buffers. If no other buffer
1300exists, return the buffer `*scratch*' (creating it if necessary). */)
5842a27b 1301 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1ab256cb 1302{
9397e56f
MR
1303 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1304 Lisp_Object tail, buf, pred;
1305 Lisp_Object notsogood = Qnil;
1ab256cb 1306
773fbdb9 1307 if (NILP (frame))
9ba9623d 1308 frame = selected_frame;
773fbdb9 1309
d234d13e
JL
1310 CHECK_FRAME (frame);
1311
773fbdb9 1312 pred = frame_buffer_predicate (frame);
9397e56f
MR
1313 /* Consider buffers that have been seen in the frame first. */
1314 tail = XFRAME (frame)->buffer_list;
1315 for (; CONSP (tail); tail = XCDR (tail))
7962a441 1316 {
9397e56f
MR
1317 buf = XCAR (tail);
1318 if (BUFFERP (buf) && !EQ (buf, buffer)
1319 && !NILP (BVAR (XBUFFER (buf), name))
1320 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1321 /* If the frame has a buffer_predicate, disregard buffers that
1322 don't fit the predicate. */
1323 && (NILP (pred) || !NILP (call1 (pred, buf))))
1324 {
1325 if (!NILP (visible_ok)
1326 || NILP (Fget_buffer_window (buf, Qvisible)))
1327 return buf;
1328 else if (NILP (notsogood))
1329 notsogood = buf;
1330 }
7962a441 1331 }
7962a441 1332
9397e56f
MR
1333 /* Consider alist of all buffers next. */
1334 tail = Vbuffer_alist;
6d70a280 1335 for (; CONSP (tail); tail = XCDR (tail))
1ab256cb 1336 {
6d70a280 1337 buf = Fcdr (XCAR (tail));
9397e56f
MR
1338 if (BUFFERP (buf) && !EQ (buf, buffer)
1339 && !NILP (BVAR (XBUFFER (buf), name))
1340 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1341 /* If the frame has a buffer_predicate, disregard buffers that
1342 don't fit the predicate. */
1343 && (NILP (pred) || !NILP (call1 (pred, buf))))
1344 {
1345 if (!NILP (visible_ok)
1346 || NILP (Fget_buffer_window (buf, Qvisible)))
1347 return buf;
1348 else if (NILP (notsogood))
1349 notsogood = buf;
1350 }
1351 }
1352
1353 if (!NILP (notsogood))
1354 return notsogood;
1355 else
1356 {
1357 buf = Fget_buffer (build_string ("*scratch*"));
6b61353c 1358 if (NILP (buf))
04ae1b48 1359 {
9397e56f
MR
1360 buf = Fget_buffer_create (build_string ("*scratch*"));
1361 Fset_buffer_major_mode (buf);
04ae1b48 1362 }
9397e56f
MR
1363 return buf;
1364 }
1365}
04ae1b48 1366
9397e56f
MR
1367/* The following function is a safe variant of Fother_buffer: It doesn't
1368 pay attention to any frame-local buffer lists, doesn't care about
1369 visibility of buffers, and doesn't evaluate any frame predicates. */
1370
1371Lisp_Object
1372other_buffer_safely (Lisp_Object buffer)
1373{
1374 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1375 Lisp_Object tail, buf;
1376
1377 tail = Vbuffer_alist;
1378 for (; CONSP (tail); tail = XCDR (tail))
1379 {
1380 buf = Fcdr (XCAR (tail));
1381 if (BUFFERP (buf) && !EQ (buf, buffer)
1382 && !NILP (BVAR (XBUFFER (buf), name))
1383 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1ab256cb 1384 return buf;
1ab256cb 1385 }
9397e56f 1386
dba1a30a
GM
1387 buf = Fget_buffer (build_string ("*scratch*"));
1388 if (NILP (buf))
1389 {
1390 buf = Fget_buffer_create (build_string ("*scratch*"));
1391 Fset_buffer_major_mode (buf);
1392 }
9397e56f 1393
89132f25 1394 return buf;
1ab256cb
RM
1395}
1396\f
a7ca3326 1397DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1ab256cb 1398 0, 1, "",
7ee72033
MB
1399 doc: /* Start keeping undo information for buffer BUFFER.
1400No argument or nil as argument means do this for the current buffer. */)
5842a27b 1401 (register Lisp_Object buffer)
1ab256cb 1402{
ffd56f97 1403 Lisp_Object real_buffer;
1ab256cb 1404
ffd56f97 1405 if (NILP (buffer))
67180c6a 1406 XSETBUFFER (real_buffer, current_buffer);
1ab256cb
RM
1407 else
1408 {
ffd56f97
JB
1409 real_buffer = Fget_buffer (buffer);
1410 if (NILP (real_buffer))
1411 nsberror (buffer);
1ab256cb
RM
1412 }
1413
4b4deea2
TT
1414 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1415 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1ab256cb
RM
1416
1417 return Qnil;
1418}
1419
1420/*
00b3c7ac 1421 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1ab256cb
RM
1422Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1423The buffer being killed will be current while the hook is running.\n\
1424See `kill-buffer'."
1425 */
a7ca3326 1426DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
c8804c4f
MR
1427 doc: /* Kill buffer BUFFER-OR-NAME.
1428The argument may be a buffer or the name of an existing buffer.
1429Argument nil or omitted means kill the current buffer. Return t if the
1430buffer is actually killed, nil otherwise.
1431
1432This function calls `replace-buffer-in-windows' for cleaning up all
1433windows currently displaying the buffer to be killed. The functions in
1434`kill-buffer-query-functions' are called with the buffer to be killed as
1435the current buffer. If any of them returns nil, the buffer is not
1436killed. The hook `kill-buffer-hook' is run before the buffer is
1437actually killed. The buffer being killed will be current while the hook
1438is running.
018ba359
PJ
1439
1440Any processes that have this buffer as the `process-buffer' are killed
7ee72033 1441with SIGHUP. */)
5842a27b 1442 (Lisp_Object buffer_or_name)
1ab256cb 1443{
c8804c4f 1444 Lisp_Object buffer;
1ab256cb
RM
1445 register struct buffer *b;
1446 register Lisp_Object tem;
1447 register struct Lisp_Marker *m;
6af718a4 1448 struct gcpro gcpro1;
1ab256cb 1449
c8804c4f
MR
1450 if (NILP (buffer_or_name))
1451 buffer = Fcurrent_buffer ();
1ab256cb 1452 else
c8804c4f
MR
1453 buffer = Fget_buffer (buffer_or_name);
1454 if (NILP (buffer))
1455 nsberror (buffer_or_name);
1ab256cb 1456
c8804c4f 1457 b = XBUFFER (buffer);
1ab256cb 1458
4a4a9db5 1459 /* Avoid trouble for buffer already dead. */
4b4deea2 1460 if (NILP (BVAR (b, name)))
4a4a9db5
KH
1461 return Qnil;
1462
1ab256cb 1463 /* Query if the buffer is still modified. */
4b4deea2 1464 if (INTERACTIVE && !NILP (BVAR (b, filename))
336cd056 1465 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1ab256cb 1466 {
c8804c4f 1467 GCPRO1 (buffer);
5c4930b0 1468 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
4b4deea2 1469 BVAR (b, name), make_number (0)));
1ab256cb 1470 UNGCPRO;
265a9e55 1471 if (NILP (tem))
1ab256cb
RM
1472 return Qnil;
1473 }
1474
dcdffbf6 1475 /* Run hooks with the buffer to be killed the current buffer. */
1ab256cb 1476 {
aed13378 1477 int count = SPECPDL_INDEX ();
5b20caf0 1478 Lisp_Object arglist[1];
1ab256cb
RM
1479
1480 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1481 set_buffer_internal (b);
dcdffbf6
RS
1482
1483 /* First run the query functions; if any query is answered no,
1484 don't kill the buffer. */
5b20caf0 1485 arglist[0] = Qkill_buffer_query_functions;
09706e1f
KR
1486 tem = Frun_hook_with_args_until_failure (1, arglist);
1487 if (NILP (tem))
5b20caf0 1488 return unbind_to (count, Qnil);
dcdffbf6
RS
1489
1490 /* Then run the hooks. */
f1597a3a 1491 Frun_hooks (1, &Qkill_buffer_hook);
1ab256cb
RM
1492 unbind_to (count, Qnil);
1493 }
1494
1495 /* We have no more questions to ask. Verify that it is valid
1496 to kill the buffer. This must be done after the questions
1497 since anything can happen within do_yes_or_no_p. */
1498
1499 /* Don't kill the minibuffer now current. */
c8804c4f 1500 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1ab256cb
RM
1501 return Qnil;
1502
4b4deea2 1503 if (NILP (BVAR (b, name)))
1ab256cb
RM
1504 return Qnil;
1505
336cd056
RS
1506 /* When we kill a base buffer, kill all its indirect buffers.
1507 We do it at this stage so nothing terrible happens if they
1508 ask questions or their hooks get errors. */
1509 if (! b->base_buffer)
1510 {
1511 struct buffer *other;
1512
c8804c4f 1513 GCPRO1 (buffer);
336cd056 1514
eab3844f 1515 for (other = all_buffers; other; other = other->header.next.buffer)
4a4a9db5
KH
1516 /* all_buffers contains dead buffers too;
1517 don't re-kill them. */
4b4deea2 1518 if (other->base_buffer == b && !NILP (BVAR (other, name)))
336cd056 1519 {
8f54f30a
PE
1520 Lisp_Object buf;
1521 XSETBUFFER (buf, other);
1522 Fkill_buffer (buf);
336cd056
RS
1523 }
1524
1525 UNGCPRO;
1526 }
177c0ea7 1527
1ab256cb
RM
1528 /* Make this buffer not be current.
1529 In the process, notice if this is the sole visible buffer
1530 and give up if so. */
1531 if (b == current_buffer)
1532 {
c8804c4f 1533 tem = Fother_buffer (buffer, Qnil, Qnil);
1ab256cb
RM
1534 Fset_buffer (tem);
1535 if (b == current_buffer)
1536 return Qnil;
1537 }
1538
77270fac
GM
1539 /* Notice if the buffer to kill is the sole visible buffer
1540 when we're currently in the mini-buffer, and give up if so. */
1541 XSETBUFFER (tem, current_buffer);
1542 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1543 {
c8804c4f
MR
1544 tem = Fother_buffer (buffer, Qnil, Qnil);
1545 if (EQ (buffer, tem))
77270fac
GM
1546 return Qnil;
1547 }
1548
1ab256cb
RM
1549 /* Now there is no question: we can kill the buffer. */
1550
1551#ifdef CLASH_DETECTION
1552 /* Unlock this buffer's file, if it is locked. */
1553 unlock_buffer (b);
1554#endif /* CLASH_DETECTION */
1555
c8804c4f
MR
1556 GCPRO1 (buffer);
1557 kill_buffer_processes (buffer);
49da74e6
KS
1558 UNGCPRO;
1559
1560 /* Killing buffer processes may run sentinels which may
1561 have called kill-buffer. */
1562
4b4deea2 1563 if (NILP (BVAR (b, name)))
49da74e6
KS
1564 return Qnil;
1565
9397e56f
MR
1566 /* These may run Lisp code and into infinite loops (if someone
1567 insisted on circular lists) so allow quitting here. */
1568 replace_buffer_in_windows (buffer);
1569 frames_discard_buffer (buffer);
1570
b93fb365 1571 clear_charpos_cache (b);
1ab256cb
RM
1572
1573 tem = Vinhibit_quit;
1574 Vinhibit_quit = Qt;
9397e56f 1575 /* Remove the buffer from the list of all buffers. */
c8804c4f 1576 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
9397e56f
MR
1577 /* If replace_buffer_in_windows didn't do its job correctly fix that
1578 now. */
1579 replace_buffer_in_windows_safely (buffer);
1ab256cb
RM
1580 Vinhibit_quit = tem;
1581
9cf712eb
RS
1582 /* Delete any auto-save file, if we saved it in this session.
1583 But not if the buffer is modified. */
4b4deea2 1584 if (STRINGP (BVAR (b, auto_save_file_name))
0b5397c2
SM
1585 && BUF_AUTOSAVE_MODIFF (b) != 0
1586 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
6b61353c
KH
1587 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1588 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1ab256cb 1589 {
8f54f30a
PE
1590 Lisp_Object delete;
1591 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1592 if (! NILP (delete))
4b4deea2 1593 internal_delete_file (BVAR (b, auto_save_file_name));
1ab256cb
RM
1594 }
1595
4a4a9db5
KH
1596 if (b->base_buffer)
1597 {
1598 /* Unchain all markers that belong to this indirect buffer.
1599 Don't unchain the markers that belong to the base buffer
1600 or its other indirect buffers. */
65745fad 1601 for (m = BUF_MARKERS (b); m; )
4a4a9db5 1602 {
65745fad 1603 struct Lisp_Marker *next = m->next;
4a4a9db5 1604 if (m->buffer == b)
65745fad
SM
1605 unchain_marker (m);
1606 m = next;
4a4a9db5
KH
1607 }
1608 }
1609 else
1ab256cb 1610 {
4a4a9db5 1611 /* Unchain all markers of this buffer and its indirect buffers.
336cd056 1612 and leave them pointing nowhere. */
65745fad 1613 for (m = BUF_MARKERS (b); m; )
336cd056 1614 {
65745fad 1615 struct Lisp_Marker *next = m->next;
336cd056 1616 m->buffer = 0;
65745fad
SM
1617 m->next = NULL;
1618 m = next;
336cd056 1619 }
65745fad 1620 BUF_MARKERS (b) = NULL;
336cd056 1621 BUF_INTERVALS (b) = NULL_INTERVAL;
336cd056
RS
1622
1623 /* Perhaps we should explicitly free the interval tree here... */
1624 }
33f7013e 1625
2f3f993b
RS
1626 /* Reset the local variables, so that this buffer's local values
1627 won't be protected from GC. They would be protected
1628 if they happened to remain encached in their symbols.
1629 This gets rid of them for certain. */
1630 swap_out_buffer_local_variables (b);
13de9290 1631 reset_buffer_local_variables (b, 1);
2f3f993b 1632
4b4deea2 1633 BVAR (b, name) = Qnil;
336cd056 1634
9ac0d9e0 1635 BLOCK_INPUT;
336cd056 1636 if (! b->base_buffer)
b86af064 1637 free_buffer_text (b);
336cd056 1638
28e969dd
JB
1639 if (b->newline_cache)
1640 {
1641 free_region_cache (b->newline_cache);
1642 b->newline_cache = 0;
1643 }
1644 if (b->width_run_cache)
1645 {
1646 free_region_cache (b->width_run_cache);
1647 b->width_run_cache = 0;
1648 }
4b4deea2 1649 BVAR (b, width_table) = Qnil;
9ac0d9e0 1650 UNBLOCK_INPUT;
4b4deea2 1651 BVAR (b, undo_list) = Qnil;
1ab256cb 1652
9397e56f
MR
1653 /* Run buffer-list-update-hook. */
1654 if (!NILP (Vrun_hooks))
1655 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1656
1ab256cb
RM
1657 return Qt;
1658}
1659\f
9397e56f
MR
1660/* Move association for BUFFER to the front of buffer (a)lists. Since
1661 we do this each time BUFFER is selected visibly, the more recently
1662 selected buffers are always closer to the front of those lists. This
1663 means that other_buffer is more likely to choose a relevant buffer.
1664
1665 Note that this moves BUFFER to the front of the buffer lists of the
1666 selected frame even if BUFFER is not shown there. If BUFFER is not
1667 shown in the selected frame, consider the present behavior a feature.
1668 `select-window' gets this right since it shows BUFFER in the selected
1669 window when calling us. */
1ab256cb 1670
01136e9b 1671void
9397e56f 1672record_buffer (Lisp_Object buffer)
1ab256cb 1673{
4475bec4 1674 Lisp_Object aelt, aelt_cons, tem;
9397e56f 1675 register struct frame *f = XFRAME (selected_frame);
1ab256cb 1676
9397e56f 1677 CHECK_BUFFER (buffer);
1ab256cb 1678
9397e56f
MR
1679 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1680 Don't allow quitting since this might leave the buffer list in an
1681 inconsistent state. */
1682 tem = Vinhibit_quit;
1683 Vinhibit_quit = Qt;
1684 aelt = Frassq (buffer, Vbuffer_alist);
4475bec4 1685 aelt_cons = Fmemq (aelt, Vbuffer_alist);
9397e56f 1686 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
4475bec4
PE
1687 XSETCDR (aelt_cons, Vbuffer_alist);
1688 Vbuffer_alist = aelt_cons;
9397e56f 1689 Vinhibit_quit = tem;
1ab256cb 1690
9397e56f
MR
1691 /* Update buffer list of selected frame. */
1692 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1693 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
177c0ea7 1694
9397e56f
MR
1695 /* Run buffer-list-update-hook. */
1696 if (!NILP (Vrun_hooks))
1697 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1698}
7962a441 1699
9397e56f
MR
1700DEFUN ("record-buffer", Frecord_buffer, Srecord_buffer, 1, 1, 0,
1701 doc: /* Move BUFFER to the front of the buffer list.
1702Return BUFFER. */)
1703 (Lisp_Object buffer)
1704{
1705 CHECK_BUFFER (buffer);
7723e095 1706
9397e56f 1707 record_buffer (buffer);
a18b8cb5 1708
9397e56f
MR
1709 return buffer;
1710}
7962a441 1711
9397e56f
MR
1712 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1713 buffer is killed. For the selected frame's buffer list this moves
1714 BUFFER to its end even if it was never shown in that frame. If
1715 this happens we have a feature, hence `unrecord-buffer' should be
1716 called only when BUFFER was shown in the selected frame. */
7962a441 1717
9397e56f
MR
1718DEFUN ("unrecord-buffer", Funrecord_buffer, Sunrecord_buffer, 1, 1, 0,
1719 doc: /* Move BUFFER to the end of the buffer list.
1720Return BUFFER. */)
1721 (Lisp_Object buffer)
1722{
4475bec4 1723 Lisp_Object aelt, aelt_cons, tem;
9397e56f 1724 register struct frame *f = XFRAME (selected_frame);
7962a441 1725
9397e56f 1726 CHECK_BUFFER (buffer);
177c0ea7 1727
9397e56f
MR
1728 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1729 Don't allow quitting since this might leave the buffer list in an
1730 inconsistent state. */
1731 tem = Vinhibit_quit;
1732 Vinhibit_quit = Qt;
1733 aelt = Frassq (buffer, Vbuffer_alist);
4475bec4 1734 aelt_cons = Fmemq (aelt, Vbuffer_alist);
9397e56f 1735 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
4475bec4
PE
1736 XSETCDR (aelt_cons, Qnil);
1737 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
9397e56f
MR
1738 Vinhibit_quit = tem;
1739
1740 /* Update buffer lists of selected frame. */
1741 f->buffer_list = Fdelq (buffer, f->buffer_list);
1742 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1743
1744 /* Run buffer-list-update-hook. */
1745 if (!NILP (Vrun_hooks))
1746 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1747
1748 return buffer;
1ab256cb
RM
1749}
1750
a9ee7a59 1751DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
7ee72033 1752 doc: /* Set an appropriate major mode for BUFFER.
864b90c9 1753For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
71a0f2c6 1754according to `default-major-mode'.
018ba359 1755Use this function before selecting the buffer, since it may need to inspect
7ee72033 1756the current buffer's major mode. */)
5842a27b 1757 (Lisp_Object buffer)
a9ee7a59
KH
1758{
1759 int count;
1760 Lisp_Object function;
1761
ea4fddd8
JB
1762 CHECK_BUFFER (buffer);
1763
4b4deea2
TT
1764 if (STRINGP (BVAR (XBUFFER (buffer), name))
1765 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
71a0f2c6
GM
1766 function = find_symbol_value (intern ("initial-major-mode"));
1767 else
1768 {
4b4deea2 1769 function = BVAR (&buffer_defaults, major_mode);
71a0f2c6 1770 if (NILP (function)
4b4deea2
TT
1771 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1772 function = BVAR (current_buffer, major_mode);
71a0f2c6 1773 }
177c0ea7 1774
48265e61
DL
1775 if (NILP (function) || EQ (function, Qfundamental_mode))
1776 return Qnil;
1777
aed13378 1778 count = SPECPDL_INDEX ();
a9ee7a59 1779
48265e61
DL
1780 /* To select a nonfundamental mode,
1781 select the buffer temporarily and then call the mode function. */
a9ee7a59
KH
1782
1783 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1784
a2428fa2 1785 Fset_buffer (buffer);
48265e61 1786 call0 (function);
a9ee7a59
KH
1787
1788 return unbind_to (count, Qnil);
1789}
1790
a7ca3326 1791DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
7ee72033 1792 doc: /* Return the current buffer as a Lisp object. */)
5842a27b 1793 (void)
1ab256cb
RM
1794{
1795 register Lisp_Object buf;
67180c6a 1796 XSETBUFFER (buf, current_buffer);
1ab256cb
RM
1797 return buf;
1798}
1799\f
7ec44ec6
GM
1800/* Set the current buffer to B.
1801
1802 We previously set windows_or_buffers_changed here to invalidate
1803 global unchanged information in beg_unchanged and end_unchanged.
1804 This is no longer necessary because we now compute unchanged
1805 information on a buffer-basis. Every action affecting other
1806 windows than the selected one requires a select_window at some
1807 time, and that increments windows_or_buffers_changed. */
1ab256cb
RM
1808
1809void
d3da34e0 1810set_buffer_internal (register struct buffer *b)
1ab256cb 1811{
b5a225b4 1812 if (current_buffer != b)
7ec44ec6 1813 set_buffer_internal_1 (b);
c7aa5005
KH
1814}
1815
1816/* Set the current buffer to B, and do not set windows_or_buffers_changed.
1817 This is used by redisplay. */
1818
1819void
d3da34e0 1820set_buffer_internal_1 (register struct buffer *b)
c7aa5005
KH
1821{
1822 register struct buffer *old_buf;
ce5b453a 1823 register Lisp_Object tail;
c7aa5005 1824
b86af064 1825#ifdef USE_MMAP_FOR_BUFFERS
684b01ee 1826 if (b->text->beg == NULL)
b86af064
GM
1827 enlarge_buffer_text (b, 0);
1828#endif /* USE_MMAP_FOR_BUFFERS */
177c0ea7 1829
c7aa5005
KH
1830 if (current_buffer == b)
1831 return;
1832
1ab256cb
RM
1833 old_buf = current_buffer;
1834 current_buffer = b;
1835 last_known_column_point = -1; /* invalidate indentation cache */
1836
336cd056
RS
1837 if (old_buf)
1838 {
1839 /* Put the undo list back in the base buffer, so that it appears
1840 that an indirect buffer shares the undo list of its base. */
1841 if (old_buf->base_buffer)
4b4deea2 1842 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
336cd056
RS
1843
1844 /* If the old current buffer has markers to record PT, BEGV and ZV
1845 when it is not current, update them now. */
cffc6f3b 1846 record_buffer_markers (old_buf);
336cd056
RS
1847 }
1848
1849 /* Get the undo list from the base buffer, so that it appears
1850 that an indirect buffer shares the undo list of its base. */
1851 if (b->base_buffer)
4b4deea2 1852 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
336cd056
RS
1853
1854 /* If the new current buffer has markers to record PT, BEGV and ZV
1855 when it is not current, fetch them now. */
cffc6f3b 1856 fetch_buffer_markers (b);
336cd056 1857
1ab256cb
RM
1858 /* Look down buffer's list of local Lisp variables
1859 to find and update any that forward into C variables. */
1860
ce5b453a 1861 do
1ab256cb 1862 {
4b4deea2 1863 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
ce5b453a
SM
1864 {
1865 Lisp_Object var = XCAR (XCAR (tail));
1866 struct Lisp_Symbol *sym = XSYMBOL (var);
1867 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1868 && SYMBOL_BLV (sym)->fwd)
1869 /* Just reference the variable
1870 to cause it to become set for this buffer. */
1871 Fsymbol_value (var);
1872 }
1ab256cb 1873 }
1ab256cb 1874 /* Do the same with any others that were local to the previous buffer */
ce5b453a 1875 while (b != old_buf && (b = old_buf, b));
1ab256cb
RM
1876}
1877
336cd056 1878/* Switch to buffer B temporarily for redisplay purposes.
bbbe9545 1879 This avoids certain things that don't need to be done within redisplay. */
336cd056
RS
1880
1881void
d3da34e0 1882set_buffer_temp (struct buffer *b)
336cd056
RS
1883{
1884 register struct buffer *old_buf;
1885
1886 if (current_buffer == b)
1887 return;
1888
1889 old_buf = current_buffer;
1890 current_buffer = b;
1891
cffc6f3b
CY
1892 /* If the old current buffer has markers to record PT, BEGV and ZV
1893 when it is not current, update them now. */
1894 record_buffer_markers (old_buf);
336cd056
RS
1895
1896 /* If the new current buffer has markers to record PT, BEGV and ZV
1897 when it is not current, fetch them now. */
cffc6f3b 1898 fetch_buffer_markers (b);
336cd056
RS
1899}
1900
a7ca3326 1901DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
c8804c4f
MR
1902 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1903BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1904also `save-excursion' when you want to make a buffer current
1905temporarily. This function does not display the buffer, so its effect
1906ends when the current command terminates. Use `switch-to-buffer' or
1907`pop-to-buffer' to switch buffers permanently. */)
5842a27b 1908 (register Lisp_Object buffer_or_name)
1ab256cb 1909{
c8804c4f
MR
1910 register Lisp_Object buffer;
1911 buffer = Fget_buffer (buffer_or_name);
1912 if (NILP (buffer))
1913 nsberror (buffer_or_name);
4b4deea2 1914 if (NILP (BVAR (XBUFFER (buffer), name)))
1ab256cb 1915 error ("Selecting deleted buffer");
c8804c4f
MR
1916 set_buffer_internal (XBUFFER (buffer));
1917 return buffer;
1ab256cb 1918}
d0628b06
RS
1919
1920/* Set the current buffer to BUFFER provided it is alive. */
1921
1922Lisp_Object
d3da34e0 1923set_buffer_if_live (Lisp_Object buffer)
d0628b06 1924{
4b4deea2 1925 if (! NILP (BVAR (XBUFFER (buffer), name)))
d0628b06
RS
1926 Fset_buffer (buffer);
1927 return Qnil;
1928}
1ab256cb 1929\f
a7ca3326 1930DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1ab256cb 1931 Sbarf_if_buffer_read_only, 0, 0, 0,
7ee72033 1932 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
5842a27b 1933 (void)
1ab256cb 1934{
4b4deea2 1935 if (!NILP (BVAR (current_buffer, read_only))
a96b68f1 1936 && NILP (Vinhibit_read_only))
4c4dc0b0 1937 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1ab256cb
RM
1938 return Qnil;
1939}
1ab256cb 1940\f
a7ca3326 1941DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
7ee72033 1942 doc: /* Delete the entire contents of the current buffer.
018ba359 1943Any narrowing restriction in effect (see `narrow-to-region') is removed,
7ee72033 1944so the buffer is truly empty after this. */)
5842a27b 1945 (void)
1ab256cb
RM
1946{
1947 Fwiden ();
c0d9a0c3
GM
1948
1949 del_range (BEG, Z);
c280bc6a 1950
1ab256cb
RM
1951 current_buffer->last_window_start = 1;
1952 /* Prevent warnings, or suspension of auto saving, that would happen
1953 if future size is less than past size. Use of erase-buffer
1954 implies that the future text is not really related to the past text. */
4b4deea2 1955 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1ab256cb
RM
1956 return Qnil;
1957}
1958
01136e9b 1959void
d3da34e0 1960validate_region (register Lisp_Object *b, register Lisp_Object *e)
1ab256cb 1961{
b7826503
PJ
1962 CHECK_NUMBER_COERCE_MARKER (*b);
1963 CHECK_NUMBER_COERCE_MARKER (*e);
1ab256cb
RM
1964
1965 if (XINT (*b) > XINT (*e))
1966 {
03192067
KH
1967 Lisp_Object tem;
1968 tem = *b; *b = *e; *e = tem;
1ab256cb
RM
1969 }
1970
1971 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1972 && XINT (*e) <= ZV))
1973 args_out_of_range (*b, *e);
1974}
1975\f
b05525fa
RS
1976/* Advance BYTE_POS up to a character boundary
1977 and return the adjusted position. */
1978
0ceccced 1979static EMACS_INT
145582a0 1980advance_to_char_boundary (EMACS_INT byte_pos)
b05525fa 1981{
f8449323 1982 int c;
b05525fa 1983
f8449323
RS
1984 if (byte_pos == BEG)
1985 /* Beginning of buffer is always a character boundary. */
6d70a280 1986 return BEG;
f8449323
RS
1987
1988 c = FETCH_BYTE (byte_pos);
1989 if (! CHAR_HEAD_P (c))
b05525fa 1990 {
1be6387d 1991 /* We should advance BYTE_POS only when C is a constituent of a
f8449323 1992 multibyte sequence. */
145582a0 1993 EMACS_INT orig_byte_pos = byte_pos;
a9bcded1
KH
1994
1995 do
1996 {
1997 byte_pos--;
1998 c = FETCH_BYTE (byte_pos);
1999 }
2000 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
f8449323 2001 INC_POS (byte_pos);
a9bcded1
KH
2002 if (byte_pos < orig_byte_pos)
2003 byte_pos = orig_byte_pos;
f8449323
RS
2004 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2005 surely advance to the correct character boundary. If C is
2006 not, BYTE_POS was unchanged. */
b05525fa
RS
2007 }
2008
20773569 2009 return byte_pos;
b05525fa
RS
2010}
2011
baae5c2d 2012#ifdef REL_ALLOC
f57e2426 2013extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
baae5c2d
JR
2014#endif /* REL_ALLOC */
2015
13cda5f9
SM
2016DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2017 1, 1, 0,
2018 doc: /* Swap the text between current buffer and BUFFER. */)
5842a27b 2019 (Lisp_Object buffer)
13cda5f9
SM
2020{
2021 struct buffer *other_buffer;
2022 CHECK_BUFFER (buffer);
2023 other_buffer = XBUFFER (buffer);
2024
4b4deea2 2025 if (NILP (BVAR (other_buffer, name)))
409f2919 2026 error ("Cannot swap a dead buffer's text");
dc9cc574 2027
13cda5f9
SM
2028 /* Actually, it probably works just fine.
2029 * if (other_buffer == current_buffer)
2030 * error ("Cannot swap a buffer's text with itself"); */
2031
2032 /* Actually, this may be workable as well, tho probably only if they're
2033 *both* indirect. */
2034 if (other_buffer->base_buffer
2035 || current_buffer->base_buffer)
2036 error ("Cannot swap indirect buffers's text");
2037
2038 { /* This is probably harder to make work. */
2039 struct buffer *other;
eab3844f 2040 for (other = all_buffers; other; other = other->header.next.buffer)
13cda5f9
SM
2041 if (other->base_buffer == other_buffer
2042 || other->base_buffer == current_buffer)
2043 error ("One of the buffers to swap has indirect buffers");
2044 }
2045
2046#define swapfield(field, type) \
2047 do { \
2048 type tmp##field = other_buffer->field; \
2049 other_buffer->field = current_buffer->field; \
2050 current_buffer->field = tmp##field; \
2051 } while (0)
5d8ea120
TT
2052#define swapfield_(field, type) \
2053 do { \
4b4deea2
TT
2054 type tmp##field = BVAR (other_buffer, field); \
2055 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2056 BVAR (current_buffer, field) = tmp##field; \
5d8ea120 2057 } while (0)
13cda5f9
SM
2058
2059 swapfield (own_text, struct buffer_text);
2060 eassert (current_buffer->text == &current_buffer->own_text);
2061 eassert (other_buffer->text == &other_buffer->own_text);
baae5c2d 2062#ifdef REL_ALLOC
40b615d6
JR
2063 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2064 (POINTER_TYPE **) &other_buffer->own_text.beg);
2065 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2066 (POINTER_TYPE **) &current_buffer->own_text.beg);
baae5c2d
JR
2067#endif /* REL_ALLOC */
2068
13cda5f9
SM
2069 swapfield (pt, EMACS_INT);
2070 swapfield (pt_byte, EMACS_INT);
2071 swapfield (begv, EMACS_INT);
2072 swapfield (begv_byte, EMACS_INT);
2073 swapfield (zv, EMACS_INT);
2074 swapfield (zv_byte, EMACS_INT);
2075 eassert (!current_buffer->base_buffer);
2076 eassert (!other_buffer->base_buffer);
2077 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2078 swapfield (newline_cache, struct region_cache *);
2079 swapfield (width_run_cache, struct region_cache *);
2080 current_buffer->prevent_redisplay_optimizations_p = 1;
2081 other_buffer->prevent_redisplay_optimizations_p = 1;
2082 swapfield (overlays_before, struct Lisp_Overlay *);
2083 swapfield (overlays_after, struct Lisp_Overlay *);
2084 swapfield (overlay_center, EMACS_INT);
5d8ea120
TT
2085 swapfield_ (undo_list, Lisp_Object);
2086 swapfield_ (mark, Lisp_Object);
2087 swapfield_ (enable_multibyte_characters, Lisp_Object);
2088 swapfield_ (bidi_display_reordering, Lisp_Object);
2089 swapfield_ (bidi_paragraph_direction, Lisp_Object);
13cda5f9
SM
2090 /* FIXME: Not sure what we should do with these *_marker fields.
2091 Hopefully they're just nil anyway. */
5d8ea120
TT
2092 swapfield_ (pt_marker, Lisp_Object);
2093 swapfield_ (begv_marker, Lisp_Object);
2094 swapfield_ (zv_marker, Lisp_Object);
4b4deea2
TT
2095 BVAR (current_buffer, point_before_scroll) = Qnil;
2096 BVAR (other_buffer, point_before_scroll) = Qnil;
13cda5f9
SM
2097
2098 current_buffer->text->modiff++; other_buffer->text->modiff++;
2099 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2100 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2101 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2102 current_buffer->text->end_unchanged = current_buffer->text->gpt;
b8ff72fa
SM
2103 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2104 other_buffer->text->end_unchanged = other_buffer->text->gpt;
13cda5f9
SM
2105 {
2106 struct Lisp_Marker *m;
2107 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2108 if (m->buffer == other_buffer)
2109 m->buffer = current_buffer;
b8ff72fa
SM
2110 else
2111 /* Since there's no indirect buffer in sight, markers on
2112 BUF_MARKERS(buf) should either be for `buf' or dead. */
2113 eassert (!m->buffer);
13cda5f9
SM
2114 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2115 if (m->buffer == current_buffer)
2116 m->buffer = other_buffer;
b8ff72fa
SM
2117 else
2118 /* Since there's no indirect buffer in sight, markers on
2119 BUF_MARKERS(buf) should either be for `buf' or dead. */
2120 eassert (!m->buffer);
13cda5f9 2121 }
126f1fc1
SM
2122 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2123 So since we just swapped the markers between the two buffers, we need
2124 to undo the effect of this swap for window markers. */
2125 Lisp_Object w = Fselected_window (), ws = Qnil;
2126 Lisp_Object buf1, buf2;
2127 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2128
2129 while (NILP (Fmemq (w, ws)))
2130 {
2131 ws = Fcons (w, ws);
2132 if (MARKERP (XWINDOW (w)->pointm)
2133 && (EQ (XWINDOW (w)->buffer, buf1)
2134 || EQ (XWINDOW (w)->buffer, buf2)))
2135 Fset_marker (XWINDOW (w)->pointm,
2136 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2137 XWINDOW (w)->buffer);
2138 w = Fnext_window (w, Qt, Qt);
2139 }
2140 }
2141
13cda5f9
SM
2142 if (current_buffer->text->intervals)
2143 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2144 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2145 if (other_buffer->text->intervals)
2146 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2147 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2148
2149 return Qnil;
2150}
2151
a7ca3326 2152DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
3ac81adb 2153 1, 1, 0,
7ee72033 2154 doc: /* Set the multibyte flag of the current buffer to FLAG.
018ba359
PJ
2155If FLAG is t, this makes the buffer a multibyte buffer.
2156If FLAG is nil, this makes the buffer a single-byte buffer.
8f924df7
KH
2157In these cases, the buffer contents remain unchanged as a sequence of
2158bytes but the contents viewed as characters do change.
2159If FLAG is `to', this makes the buffer a multibyte buffer by changing
6b61353c
KH
2160all eight-bit bytes to eight-bit characters.
2161If the multibyte flag was really changed, undo information of the
2162current buffer is cleared. */)
5842a27b 2163 (Lisp_Object flag)
3ac81adb 2164{
65745fad 2165 struct Lisp_Marker *tail, *markers;
abc9d959 2166 struct buffer *other;
145582a0 2167 EMACS_INT begv, zv;
8d1203ea 2168 int narrowed = (BEG != BEGV || Z != ZV);
ed00559d 2169 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
4b4deea2 2170 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
38babc07 2171 struct gcpro gcpro1;
3ac81adb 2172
6e553d5e
RS
2173 if (current_buffer->base_buffer)
2174 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2175
70e77119 2176 /* Do nothing if nothing actually changes. */
4b4deea2 2177 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
70e77119
AS
2178 return flag;
2179
38babc07
KS
2180 GCPRO1 (old_undo);
2181
2182 /* Don't record these buffer changes. We will put a special undo entry
2183 instead. */
4b4deea2 2184 BVAR (current_buffer, undo_list) = Qt;
b05525fa 2185
3ac81adb
RS
2186 /* If the cached position is for this buffer, clear it out. */
2187 clear_charpos_cache (current_buffer);
2188
458c8af4
KH
2189 if (NILP (flag))
2190 begv = BEGV_BYTE, zv = ZV_BYTE;
2191 else
2192 begv = BEGV, zv = ZV;
2193
a9bcded1
KH
2194 if (narrowed)
2195 Fwiden ();
2196
3ac81adb
RS
2197 if (NILP (flag))
2198 {
145582a0 2199 EMACS_INT pos, stop;
a9bcded1
KH
2200 unsigned char *p;
2201
3ac81adb
RS
2202 /* Do this first, so it can use CHAR_TO_BYTE
2203 to calculate the old correspondences. */
2204 set_intervals_multibyte (0);
2205
4b4deea2 2206 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
3ac81adb
RS
2207
2208 Z = Z_BYTE;
2209 BEGV = BEGV_BYTE;
2210 ZV = ZV_BYTE;
2211 GPT = GPT_BYTE;
2212 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2213
60ebfdf3 2214
65745fad
SM
2215 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2216 tail->charpos = tail->bytepos;
a9bcded1
KH
2217
2218 /* Convert multibyte form of 8-bit characters to unibyte. */
2219 pos = BEG;
2220 stop = GPT;
2221 p = BEG_ADDR;
2222 while (1)
2223 {
2224 int c, bytes;
2225
2226 if (pos == stop)
2227 {
2228 if (pos == Z)
2229 break;
2230 p = GAP_END_ADDR;
2231 stop = Z;
2232 }
8f348ed5
KH
2233 if (ASCII_BYTE_P (*p))
2234 p++, pos++;
2235 else if (CHAR_BYTE8_HEAD_P (*p))
a9bcded1 2236 {
62a6e103 2237 c = STRING_CHAR_AND_LENGTH (p, bytes);
a9bcded1 2238 /* Delete all bytes for this 8-bit character but the
3b59c351 2239 last one, and change the last one to the character
a9bcded1
KH
2240 code. */
2241 bytes--;
2242 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2243 p = GAP_END_ADDR;
2244 *p++ = c;
2245 pos++;
2246 if (begv > pos)
2247 begv -= bytes;
2248 if (zv > pos)
2249 zv -= bytes;
2250 stop = Z;
2251 }
8f924df7 2252 else
8f348ed5
KH
2253 {
2254 bytes = BYTES_BY_CHAR_HEAD (*p);
2255 p += bytes, pos += bytes;
2256 }
a9bcded1
KH
2257 }
2258 if (narrowed)
2259 Fnarrow_to_region (make_number (begv), make_number (zv));
3ac81adb
RS
2260 }
2261 else
2262 {
145582a0
EZ
2263 EMACS_INT pt = PT;
2264 EMACS_INT pos, stop;
8f348ed5 2265 unsigned char *p, *pend;
a9bcded1 2266
673c57d2 2267 /* Be sure not to have a multibyte sequence striding over the GAP.
8f348ed5
KH
2268 Ex: We change this: "...abc\302 _GAP_ \241def..."
2269 to: "...abc _GAP_ \302\241def..." */
673c57d2 2270
8f924df7 2271 if (EQ (flag, Qt)
a3a303df 2272 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
673c57d2
KH
2273 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2274 {
8f54f30a 2275 unsigned char *q = GPT_ADDR - 1;
673c57d2 2276
8f54f30a
PE
2277 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2278 if (LEADING_CODE_P (*q))
673c57d2 2279 {
8f54f30a 2280 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
673c57d2
KH
2281
2282 move_gap_both (new_gpt, new_gpt);
2283 }
2284 }
2285
a9bcded1
KH
2286 /* Make the buffer contents valid as multibyte by converting
2287 8-bit characters to multibyte form. */
2288 pos = BEG;
2289 stop = GPT;
2290 p = BEG_ADDR;
8f348ed5 2291 pend = GPT_ADDR;
a9bcded1
KH
2292 while (1)
2293 {
2294 int bytes;
2295
2296 if (pos == stop)
2297 {
2298 if (pos == Z)
2299 break;
2300 p = GAP_END_ADDR;
8f348ed5 2301 pend = Z_ADDR;
a9bcded1
KH
2302 stop = Z;
2303 }
177c0ea7 2304
a3a303df
KH
2305 if (ASCII_BYTE_P (*p))
2306 p++, pos++;
dcfb9bc4
KH
2307 else if (EQ (flag, Qt)
2308 && ! CHAR_BYTE8_HEAD_P (*p)
2309 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
a9bcded1
KH
2310 p += bytes, pos += bytes;
2311 else
2312 {
2313 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
a3a303df 2314 int c;
a9bcded1 2315
8f924df7 2316 c = BYTE8_TO_CHAR (*p);
8c2fc311 2317 bytes = CHAR_STRING (c, tmp);
a9bcded1
KH
2318 *p = tmp[0];
2319 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2320 bytes--;
b68864e5 2321 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
a9bcded1
KH
2322 /* Now the gap is after the just inserted data. */
2323 pos = GPT;
2324 p = GAP_END_ADDR;
2325 if (pos <= begv)
2326 begv += bytes;
2327 if (pos <= zv)
2328 zv += bytes;
2329 if (pos <= pt)
2330 pt += bytes;
31285a8f 2331 pend = Z_ADDR;
a9bcded1
KH
2332 stop = Z;
2333 }
2334 }
2335
2336 if (pt != PT)
2337 TEMP_SET_PT (pt);
2338
2339 if (narrowed)
2340 Fnarrow_to_region (make_number (begv), make_number (zv));
2341
3ac81adb
RS
2342 /* Do this first, so that chars_in_text asks the right question.
2343 set_intervals_multibyte needs it too. */
4b4deea2 2344 BVAR (current_buffer, enable_multibyte_characters) = Qt;
3ac81adb 2345
b05525fa 2346 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
3ac81adb 2347 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
b05525fa 2348
673c57d2 2349 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
b05525fa
RS
2350
2351 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
3ac81adb 2352 if (BEGV_BYTE > GPT_BYTE)
673c57d2 2353 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
3ac81adb
RS
2354 else
2355 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
b05525fa
RS
2356
2357 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
3ac81adb 2358 if (ZV_BYTE > GPT_BYTE)
673c57d2 2359 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
3ac81adb
RS
2360 else
2361 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
b05525fa
RS
2362
2363 {
8f54f30a
PE
2364 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2365 EMACS_INT position;
b05525fa 2366
8f54f30a
PE
2367 if (byte > GPT_BYTE)
2368 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
b05525fa 2369 else
8f54f30a
PE
2370 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2371 TEMP_SET_PT_BOTH (position, byte);
b05525fa 2372 }
3ac81adb
RS
2373
2374 tail = markers = BUF_MARKERS (current_buffer);
95fb069b
RS
2375
2376 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2377 getting confused by the markers that have not yet been updated.
2378 It is also a signal that it should never create a marker. */
65745fad 2379 BUF_MARKERS (current_buffer) = NULL;
3ac81adb 2380
65745fad 2381 for (; tail; tail = tail->next)
3ac81adb 2382 {
65745fad
SM
2383 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2384 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
3ac81adb 2385 }
b69f9797
RS
2386
2387 /* Make sure no markers were put on the chain
2388 while the chain value was incorrect. */
65745fad 2389 if (BUF_MARKERS (current_buffer))
b69f9797
RS
2390 abort ();
2391
3ac81adb
RS
2392 BUF_MARKERS (current_buffer) = markers;
2393
2394 /* Do this last, so it can calculate the new correspondences
2395 between chars and bytes. */
2396 set_intervals_multibyte (1);
2397 }
2398
38babc07
KS
2399 if (!EQ (old_undo, Qt))
2400 {
2401 /* Represent all the above changes by a special undo entry. */
4b4deea2 2402 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
8929fd87
KS
2403 intern ("set-buffer-multibyte"),
2404 NILP (flag) ? Qt : Qnil),
2405 old_undo);
38babc07
KS
2406 }
2407
2408 UNGCPRO;
a9bcded1 2409
724b203f
GM
2410 /* Changing the multibyteness of a buffer means that all windows
2411 showing that buffer must be updated thoroughly. */
2412 current_buffer->prevent_redisplay_optimizations_p = 1;
2413 ++windows_or_buffers_changed;
2414
abc9d959
RS
2415 /* Copy this buffer's new multibyte status
2416 into all of its indirect buffers. */
eab3844f 2417 for (other = all_buffers; other; other = other->header.next.buffer)
4b4deea2 2418 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
724b203f 2419 {
4b4deea2
TT
2420 BVAR (other, enable_multibyte_characters)
2421 = BVAR (current_buffer, enable_multibyte_characters);
724b203f
GM
2422 other->prevent_redisplay_optimizations_p = 1;
2423 }
abc9d959 2424
ed00559d
KH
2425 /* Restore the modifiedness of the buffer. */
2426 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2427 Fset_buffer_modified_p (Qnil);
2428
172f9454
KH
2429 /* Update coding systems of this buffer's process (if any). */
2430 {
2431 Lisp_Object process;
2432
2433 process = Fget_buffer_process (Fcurrent_buffer ());
2434 if (PROCESSP (process))
2435 setup_process_coding_systems (process);
2436 }
2437
3ac81adb
RS
2438 return flag;
2439}
2440\f
a7ca3326 2441DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
16a97296 2442 Skill_all_local_variables, 0, 0, 0,
7ee72033 2443 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
018ba359
PJ
2444Most local variable bindings are eliminated so that the default values
2445become effective once more. Also, the syntax table is set from
2446`standard-syntax-table', the local keymap is set to nil,
2447and the abbrev table from `fundamental-mode-abbrev-table'.
2448This function also forces redisplay of the mode line.
2449
2450Every function to select a new major mode starts by
2451calling this function.
2452
2453As a special exception, local variables whose names have
2454a non-nil `permanent-local' property are not eliminated by this function.
2455
2456The first thing this function does is run
7ee72033 2457the normal hook `change-major-mode-hook'. */)
5842a27b 2458 (void)
1ab256cb 2459{
dee091a3 2460 Frun_hooks (1, &Qchange_major_mode_hook);
1ab256cb 2461
3709505e 2462 /* Make sure none of the bindings in local_var_alist
2f3f993b 2463 remain swapped in, in their symbols. */
1ab256cb 2464
2f3f993b 2465 swap_out_buffer_local_variables (current_buffer);
1ab256cb
RM
2466
2467 /* Actually eliminate all local bindings of this buffer. */
2468
13de9290 2469 reset_buffer_local_variables (current_buffer, 0);
1ab256cb 2470
1ab256cb
RM
2471 /* Force mode-line redisplay. Useful here because all major mode
2472 commands call this function. */
2473 update_mode_lines++;
2474
2475 return Qnil;
2476}
2f3f993b
RS
2477
2478/* Make sure no local variables remain set up with buffer B
2479 for their current values. */
2480
2481static void
d3da34e0 2482swap_out_buffer_local_variables (struct buffer *b)
2f3f993b 2483{
ce5b453a 2484 Lisp_Object oalist, alist, buffer;
2f3f993b
RS
2485
2486 XSETBUFFER (buffer, b);
4b4deea2 2487 oalist = BVAR (b, local_var_alist);
2f3f993b 2488
67ee9f6e 2489 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2f3f993b 2490 {
ce5b453a
SM
2491 Lisp_Object sym = XCAR (XCAR (alist));
2492 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2493 /* Need not do anything if some other buffer's binding is
2494 now encached. */
2495 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2f3f993b 2496 {
e7c10f83
SM
2497 /* Symbol is set up for this buffer's old local value:
2498 swap it out! */
ce5b453a 2499 swap_in_global_binding (XSYMBOL (sym));
2f3f993b
RS
2500 }
2501 }
2502}
1ab256cb 2503\f
2eec3b4e 2504/* Find all the overlays in the current buffer that contain position POS.
177c0ea7 2505 Return the number found, and store them in a vector in *VEC_PTR.
2eec3b4e 2506 Store in *LEN_PTR the size allocated for the vector.
52f8ec73 2507 Store in *NEXT_PTR the next position after POS where an overlay starts,
624d2678 2508 or ZV if there are no more overlays between POS and ZV.
bbbe9545 2509 Store in *PREV_PTR the previous position before POS where an overlay ends,
413e06a4 2510 or where an overlay starts which ends at or after POS;
624d2678 2511 or BEGV if there are no such overlays from BEGV to POS.
239c932b 2512 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2eec3b4e
RS
2513
2514 *VEC_PTR and *LEN_PTR should contain a valid vector and size
61d54cd5
RS
2515 when this function is called.
2516
2517 If EXTEND is non-zero, we make the vector bigger if necessary.
2518 If EXTEND is zero, we never extend the vector,
2519 and we store only as many overlays as will fit.
ac869cf7
MB
2520 But we still return the total number of overlays.
2521
2522 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2523 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2524 default (BEGV or ZV). */
2eec3b4e 2525
b081724f
PE
2526ptrdiff_t
2527overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2528 ptrdiff_t *len_ptr,
d3da34e0 2529 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
1ab256cb 2530{
2410d73a
SM
2531 Lisp_Object overlay, start, end;
2532 struct Lisp_Overlay *tail;
b081724f
PE
2533 ptrdiff_t idx = 0;
2534 ptrdiff_t len = *len_ptr;
2eec3b4e 2535 Lisp_Object *vec = *vec_ptr;
145582a0
EZ
2536 EMACS_INT next = ZV;
2537 EMACS_INT prev = BEGV;
61d54cd5
RS
2538 int inhibit_storing = 0;
2539
2410d73a 2540 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2eec3b4e 2541 {
145582a0 2542 EMACS_INT startpos, endpos;
52f8ec73 2543
2410d73a 2544 XSETMISC (overlay, tail);
1ab256cb 2545
2eec3b4e
RS
2546 start = OVERLAY_START (overlay);
2547 end = OVERLAY_END (overlay);
239c932b
RS
2548 endpos = OVERLAY_POSITION (end);
2549 if (endpos < pos)
2550 {
2551 if (prev < endpos)
2552 prev = endpos;
2553 break;
2554 }
413e06a4
RS
2555 startpos = OVERLAY_POSITION (start);
2556 /* This one ends at or after POS
daa1c109 2557 so its start counts for PREV_PTR if it's before POS. */
413e06a4
RS
2558 if (prev < startpos && startpos < pos)
2559 prev = startpos;
239c932b
RS
2560 if (endpos == pos)
2561 continue;
2eec3b4e
RS
2562 if (startpos <= pos)
2563 {
2564 if (idx == len)
2565 {
61d54cd5
RS
2566 /* The supplied vector is full.
2567 Either make it bigger, or don't store any more in it. */
2568 if (extend)
2569 {
21514da7 2570 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
b081724f 2571 memory_full (SIZE_MAX);
0552666b 2572 /* Make it work with an initial len == 0. */
b081724f 2573 len = len * 2 + 4;
0552666b 2574 *len_ptr = len;
61d54cd5
RS
2575 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2576 *vec_ptr = vec;
2577 }
2578 else
2579 inhibit_storing = 1;
2eec3b4e 2580 }
61d54cd5
RS
2581
2582 if (!inhibit_storing)
2583 vec[idx] = overlay;
2584 /* Keep counting overlays even if we can't return them all. */
2585 idx++;
2eec3b4e
RS
2586 }
2587 else if (startpos < next)
2588 next = startpos;
2589 }
2590
2410d73a 2591 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
1ab256cb 2592 {
145582a0 2593 EMACS_INT startpos, endpos;
52f8ec73 2594
2410d73a 2595 XSETMISC (overlay, tail);
2eec3b4e
RS
2596
2597 start = OVERLAY_START (overlay);
2598 end = OVERLAY_END (overlay);
2599 startpos = OVERLAY_POSITION (start);
52f8ec73 2600 if (pos < startpos)
2eec3b4e
RS
2601 {
2602 if (startpos < next)
2603 next = startpos;
2604 break;
2605 }
239c932b
RS
2606 endpos = OVERLAY_POSITION (end);
2607 if (pos < endpos)
2eec3b4e
RS
2608 {
2609 if (idx == len)
2610 {
61d54cd5
RS
2611 if (extend)
2612 {
21514da7 2613 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
b081724f 2614 memory_full (SIZE_MAX);
4b0e44fc 2615 /* Make it work with an initial len == 0. */
b081724f 2616 len = len * 2 + 4;
4b0e44fc 2617 *len_ptr = len;
61d54cd5
RS
2618 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2619 *vec_ptr = vec;
2620 }
2621 else
2622 inhibit_storing = 1;
2eec3b4e 2623 }
61d54cd5
RS
2624
2625 if (!inhibit_storing)
2626 vec[idx] = overlay;
2627 idx++;
413e06a4
RS
2628
2629 if (startpos < pos && startpos > prev)
2630 prev = startpos;
2eec3b4e 2631 }
239c932b
RS
2632 else if (endpos < pos && endpos > prev)
2633 prev = endpos;
1d5f4c1d
MB
2634 else if (endpos == pos && startpos > prev
2635 && (!change_req || startpos < pos))
413e06a4 2636 prev = startpos;
1ab256cb
RM
2637 }
2638
239c932b
RS
2639 if (next_ptr)
2640 *next_ptr = next;
2641 if (prev_ptr)
2642 *prev_ptr = prev;
2eec3b4e
RS
2643 return idx;
2644}
74514898 2645\f
7723e095
MR
2646/* Find all the overlays in the current buffer that overlap the range
2647 BEG-END, or are empty at BEG, or are empty at END provided END
2648 denotes the position at the end of the current buffer.
2a3eeee7 2649
177c0ea7 2650 Return the number found, and store them in a vector in *VEC_PTR.
74514898
RS
2651 Store in *LEN_PTR the size allocated for the vector.
2652 Store in *NEXT_PTR the next position after POS where an overlay starts,
2653 or ZV if there are no more overlays.
2654 Store in *PREV_PTR the previous position before POS where an overlay ends,
2655 or BEGV if there are no previous overlays.
2656 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2657
2658 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2659 when this function is called.
2660
2661 If EXTEND is non-zero, we make the vector bigger if necessary.
2662 If EXTEND is zero, we never extend the vector,
2663 and we store only as many overlays as will fit.
2664 But we still return the total number of overlays. */
2665
21514da7 2666static ptrdiff_t
145582a0 2667overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
21514da7 2668 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
145582a0 2669 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
74514898 2670{
2410d73a
SM
2671 Lisp_Object overlay, ostart, oend;
2672 struct Lisp_Overlay *tail;
21514da7
PE
2673 ptrdiff_t idx = 0;
2674 ptrdiff_t len = *len_ptr;
74514898 2675 Lisp_Object *vec = *vec_ptr;
145582a0
EZ
2676 EMACS_INT next = ZV;
2677 EMACS_INT prev = BEGV;
74514898 2678 int inhibit_storing = 0;
7723e095 2679 int end_is_Z = end == Z;
74514898 2680
2410d73a 2681 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
74514898 2682 {
145582a0 2683 EMACS_INT startpos, endpos;
74514898 2684
2410d73a 2685 XSETMISC (overlay, tail);
74514898
RS
2686
2687 ostart = OVERLAY_START (overlay);
2688 oend = OVERLAY_END (overlay);
2689 endpos = OVERLAY_POSITION (oend);
2690 if (endpos < beg)
2691 {
2692 if (prev < endpos)
2693 prev = endpos;
2694 break;
2695 }
2696 startpos = OVERLAY_POSITION (ostart);
7723e095
MR
2697 /* Count an interval if it overlaps the range, is empty at the
2698 start of the range, or is empty at END provided END denotes the
2699 end of the buffer. */
74514898 2700 if ((beg < endpos && startpos < end)
7723e095
MR
2701 || (startpos == endpos
2702 && (beg == endpos || (end_is_Z && endpos == end))))
74514898
RS
2703 {
2704 if (idx == len)
2705 {
2706 /* The supplied vector is full.
2707 Either make it bigger, or don't store any more in it. */
2708 if (extend)
2709 {
21514da7
PE
2710 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2711 memory_full (SIZE_MAX);
4b0e44fc 2712 /* Make it work with an initial len == 0. */
21514da7 2713 len = len * 2 + 4;
4b0e44fc 2714 *len_ptr = len;
74514898
RS
2715 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2716 *vec_ptr = vec;
2717 }
2718 else
2719 inhibit_storing = 1;
2720 }
2721
2722 if (!inhibit_storing)
2723 vec[idx] = overlay;
2724 /* Keep counting overlays even if we can't return them all. */
2725 idx++;
2726 }
2727 else if (startpos < next)
2728 next = startpos;
2729 }
2730
2410d73a 2731 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
74514898 2732 {
145582a0 2733 EMACS_INT startpos, endpos;
74514898 2734
2410d73a 2735 XSETMISC (overlay, tail);
74514898
RS
2736
2737 ostart = OVERLAY_START (overlay);
2738 oend = OVERLAY_END (overlay);
2739 startpos = OVERLAY_POSITION (ostart);
2740 if (end < startpos)
2741 {
2742 if (startpos < next)
2743 next = startpos;
2744 break;
2745 }
2746 endpos = OVERLAY_POSITION (oend);
7723e095
MR
2747 /* Count an interval if it overlaps the range, is empty at the
2748 start of the range, or is empty at END provided END denotes the
2749 end of the buffer. */
74514898 2750 if ((beg < endpos && startpos < end)
7723e095
MR
2751 || (startpos == endpos
2752 && (beg == endpos || (end_is_Z && endpos == end))))
74514898
RS
2753 {
2754 if (idx == len)
2755 {
2756 if (extend)
2757 {
21514da7
PE
2758 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2759 memory_full (SIZE_MAX);
4b0e44fc 2760 /* Make it work with an initial len == 0. */
21514da7 2761 len = len * 2 + 4;
4b0e44fc 2762 *len_ptr = len;
74514898
RS
2763 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2764 *vec_ptr = vec;
2765 }
2766 else
2767 inhibit_storing = 1;
2768 }
2769
2770 if (!inhibit_storing)
2771 vec[idx] = overlay;
2772 idx++;
2773 }
2774 else if (endpos < beg && endpos > prev)
2775 prev = endpos;
2776 }
fc04fa47 2777
74514898
RS
2778 if (next_ptr)
2779 *next_ptr = next;
2780 if (prev_ptr)
2781 *prev_ptr = prev;
2782 return idx;
2783}
09a22085
GM
2784
2785
2786/* Return non-zero if there exists an overlay with a non-nil
2787 `mouse-face' property overlapping OVERLAY. */
2788
2789int
d3da34e0 2790mouse_face_overlay_overlaps (Lisp_Object overlay)
09a22085 2791{
145582a0
EZ
2792 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2793 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
21514da7 2794 ptrdiff_t n, i, size;
09a22085 2795 Lisp_Object *v, tem;
177c0ea7 2796
bfd8410f
GM
2797 size = 10;
2798 v = (Lisp_Object *) alloca (size * sizeof *v);
2799 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2800 if (n > size)
09a22085 2801 {
09a22085
GM
2802 v = (Lisp_Object *) alloca (n * sizeof *v);
2803 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2804 }
2805
2806 for (i = 0; i < n; ++i)
2807 if (!EQ (v[i], overlay)
2808 && (tem = Foverlay_get (overlay, Qmouse_face),
2809 !NILP (tem)))
2810 break;
2811
2812 return i < n;
2813}
2814
2815
74514898 2816\f
fc04fa47
KH
2817/* Fast function to just test if we're at an overlay boundary. */
2818int
145582a0 2819overlay_touches_p (EMACS_INT pos)
fc04fa47 2820{
2410d73a
SM
2821 Lisp_Object overlay;
2822 struct Lisp_Overlay *tail;
fc04fa47 2823
2410d73a 2824 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
fc04fa47 2825 {
145582a0 2826 EMACS_INT endpos;
fc04fa47 2827
2410d73a 2828 XSETMISC (overlay ,tail);
8e50cc2d 2829 if (!OVERLAYP (overlay))
fc04fa47
KH
2830 abort ();
2831
2832 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2833 if (endpos < pos)
2834 break;
2835 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2836 return 1;
2837 }
2838
2410d73a 2839 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
fc04fa47 2840 {
145582a0 2841 EMACS_INT startpos;
fc04fa47 2842
2410d73a 2843 XSETMISC (overlay, tail);
8e50cc2d 2844 if (!OVERLAYP (overlay))
fc04fa47
KH
2845 abort ();
2846
2847 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2848 if (pos < startpos)
2849 break;
2850 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2851 return 1;
2852 }
2853 return 0;
2854}
2eec3b4e 2855\f
5985d248
KH
2856struct sortvec
2857{
2858 Lisp_Object overlay;
145582a0 2859 EMACS_INT beg, end;
fadf4e30 2860 EMACS_INT priority;
5985d248
KH
2861};
2862
2863static int
d3da34e0 2864compare_overlays (const void *v1, const void *v2)
5985d248 2865{
dfcf069d
AS
2866 const struct sortvec *s1 = (const struct sortvec *) v1;
2867 const struct sortvec *s2 = (const struct sortvec *) v2;
5985d248 2868 if (s1->priority != s2->priority)
c20998a7 2869 return s1->priority < s2->priority ? -1 : 1;
5985d248 2870 if (s1->beg != s2->beg)
c20998a7 2871 return s1->beg < s2->beg ? -1 : 1;
5985d248 2872 if (s1->end != s2->end)
c20998a7 2873 return s2->end < s1->end ? -1 : 1;
5985d248
KH
2874 return 0;
2875}
2876
2877/* Sort an array of overlays by priority. The array is modified in place.
2878 The return value is the new size; this may be smaller than the original
2879 size if some of the overlays were invalid or were window-specific. */
b081724f
PE
2880ptrdiff_t
2881sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
5985d248 2882{
b081724f 2883 ptrdiff_t i, j;
5985d248
KH
2884 struct sortvec *sortvec;
2885 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2886
2887 /* Put the valid and relevant overlays into sortvec. */
2888
2889 for (i = 0, j = 0; i < noverlays; i++)
2890 {
0fa767e7 2891 Lisp_Object tem;
c99fc30f 2892 Lisp_Object overlay;
5985d248 2893
c99fc30f 2894 overlay = overlay_vec[i];
5985d248
KH
2895 if (OVERLAY_VALID (overlay)
2896 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2897 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2898 {
0fa767e7
KH
2899 /* If we're interested in a specific window, then ignore
2900 overlays that are limited to some other window. */
2901 if (w)
5985d248 2902 {
e43b6e43 2903 Lisp_Object window, clone_number;
0fa767e7
KH
2904
2905 window = Foverlay_get (overlay, Qwindow);
e43b6e43
MR
2906 clone_number = Foverlay_get (overlay, Qclone_number);
2907 if (WINDOWP (window) && XWINDOW (window) != w
2908 && (! NUMBERP (clone_number)
2909 || XFASTINT (clone_number) != XFASTINT (w->clone_number)))
0fa767e7 2910 continue;
5985d248 2911 }
0fa767e7
KH
2912
2913 /* This overlay is good and counts: put it into sortvec. */
2914 sortvec[j].overlay = overlay;
2915 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2916 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2917 tem = Foverlay_get (overlay, Qpriority);
2918 if (INTEGERP (tem))
2919 sortvec[j].priority = XINT (tem);
2920 else
2921 sortvec[j].priority = 0;
2922 j++;
5985d248
KH
2923 }
2924 }
2925 noverlays = j;
2926
2927 /* Sort the overlays into the proper order: increasing priority. */
2928
2929 if (noverlays > 1)
2930 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2931
2932 for (i = 0; i < noverlays; i++)
2933 overlay_vec[i] = sortvec[i].overlay;
2934 return (noverlays);
2935}
2936\f
bbbe9545
KH
2937struct sortstr
2938{
cb26008f 2939 Lisp_Object string, string2;
93cb6be3 2940 ptrdiff_t size;
8961a454 2941 EMACS_INT priority;
bbbe9545
KH
2942};
2943
e8185fa8
KH
2944struct sortstrlist
2945{
2946 struct sortstr *buf; /* An array that expands as needed; never freed. */
67c36fce
PE
2947 ptrdiff_t size; /* Allocated length of that array. */
2948 ptrdiff_t used; /* How much of the array is currently in use. */
145582a0 2949 EMACS_INT bytes; /* Total length of the strings in buf. */
e8185fa8
KH
2950};
2951
2952/* Buffers for storing information about the overlays touching a given
2953 position. These could be automatic variables in overlay_strings, but
2954 it's more efficient to hold onto the memory instead of repeatedly
2955 allocating and freeing it. */
2956static struct sortstrlist overlay_heads, overlay_tails;
9492daf2 2957static unsigned char *overlay_str_buf;
e8185fa8
KH
2958
2959/* Allocated length of overlay_str_buf. */
145582a0 2960static EMACS_INT overlay_str_len;
e8185fa8 2961
bbbe9545
KH
2962/* A comparison function suitable for passing to qsort. */
2963static int
d3da34e0 2964cmp_for_strings (const void *as1, const void *as2)
bbbe9545
KH
2965{
2966 struct sortstr *s1 = (struct sortstr *)as1;
2967 struct sortstr *s2 = (struct sortstr *)as2;
2968 if (s1->size != s2->size)
c20998a7 2969 return s2->size < s1->size ? -1 : 1;
bbbe9545 2970 if (s1->priority != s2->priority)
c20998a7 2971 return s1->priority < s2->priority ? -1 : 1;
bbbe9545
KH
2972 return 0;
2973}
2974
e8185fa8 2975static void
93cb6be3
PE
2976record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2977 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
e8185fa8 2978{
145582a0 2979 EMACS_INT nbytes;
43d27a72 2980
e8185fa8
KH
2981 if (ssl->used == ssl->size)
2982 {
67c36fce
PE
2983 if (min (PTRDIFF_MAX, SIZE_MAX) / (sizeof (struct sortstr) * 2)
2984 < ssl->size)
2985 memory_full (SIZE_MAX);
2986 else if (0 < ssl->size)
e8185fa8
KH
2987 ssl->size *= 2;
2988 else
2989 ssl->size = 5;
2990 ssl->buf = ((struct sortstr *)
2991 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2992 }
2993 ssl->buf[ssl->used].string = str;
cb26008f 2994 ssl->buf[ssl->used].string2 = str2;
e8185fa8
KH
2995 ssl->buf[ssl->used].size = size;
2996 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2997 ssl->used++;
43d27a72 2998
4b4deea2 2999 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
d5db4077 3000 nbytes = SCHARS (str);
43d27a72 3001 else if (! STRING_MULTIBYTE (str))
d5db4077
KR
3002 nbytes = count_size_as_multibyte (SDATA (str),
3003 SBYTES (str));
43d27a72 3004 else
d5db4077 3005 nbytes = SBYTES (str);
43d27a72
RS
3006
3007 ssl->bytes += nbytes;
3008
cb26008f 3009 if (STRINGP (str2))
43d27a72 3010 {
4b4deea2 3011 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
d5db4077 3012 nbytes = SCHARS (str2);
43d27a72 3013 else if (! STRING_MULTIBYTE (str2))
d5db4077
KR
3014 nbytes = count_size_as_multibyte (SDATA (str2),
3015 SBYTES (str2));
43d27a72 3016 else
d5db4077 3017 nbytes = SBYTES (str2);
43d27a72
RS
3018
3019 ssl->bytes += nbytes;
3020 }
e8185fa8 3021}
bbbe9545
KH
3022
3023/* Return the concatenation of the strings associated with overlays that
3024 begin or end at POS, ignoring overlays that are specific to a window
3025 other than W. The strings are concatenated in the appropriate order:
3026 shorter overlays nest inside longer ones, and higher priority inside
cb26008f
KH
3027 lower. Normally all of the after-strings come first, but zero-sized
3028 overlays have their after-strings ride along with the before-strings
3029 because it would look strange to print them inside-out.
3030
3031 Returns the string length, and stores the contents indirectly through
3032 PSTR, if that variable is non-null. The string may be overwritten by
3033 subsequent calls. */
6b5d3b89 3034
5816888b 3035EMACS_INT
d3da34e0 3036overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
bbbe9545 3037{
e43b6e43 3038 Lisp_Object overlay, window, clone_number, str;
2410d73a 3039 struct Lisp_Overlay *ov;
145582a0 3040 EMACS_INT startpos, endpos;
4b4deea2 3041 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
bbbe9545 3042
e8185fa8
KH
3043 overlay_heads.used = overlay_heads.bytes = 0;
3044 overlay_tails.used = overlay_tails.bytes = 0;
2410d73a 3045 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
bbbe9545 3046 {
2410d73a 3047 XSETMISC (overlay, ov);
c2d5b10f 3048 eassert (OVERLAYP (overlay));
bbbe9545
KH
3049
3050 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3051 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3052 if (endpos < pos)
3053 break;
3054 if (endpos != pos && startpos != pos)
3055 continue;
3056 window = Foverlay_get (overlay, Qwindow);
e43b6e43
MR
3057 clone_number = Foverlay_get (overlay, Qclone_number);
3058 if (WINDOWP (window) && XWINDOW (window) != w
3059 && (! NUMBERP (clone_number)
3060 || XFASTINT (clone_number) != XFASTINT (w->clone_number)))
bbbe9545 3061 continue;
e43b6e43 3062
e8185fa8
KH
3063 if (startpos == pos
3064 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3065 record_overlay_string (&overlay_heads, str,
cb26008f
KH
3066 (startpos == endpos
3067 ? Foverlay_get (overlay, Qafter_string)
3068 : Qnil),
3069 Foverlay_get (overlay, Qpriority),
3070 endpos - startpos);
3071 else if (endpos == pos
3072 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3073 record_overlay_string (&overlay_tails, str, Qnil,
e8185fa8
KH
3074 Foverlay_get (overlay, Qpriority),
3075 endpos - startpos);
bbbe9545 3076 }
2410d73a 3077 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
bbbe9545 3078 {
2410d73a
SM
3079 XSETMISC (overlay, ov);
3080 eassert (OVERLAYP (overlay));
bbbe9545
KH
3081
3082 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3083 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3084 if (startpos > pos)
3085 break;
e8185fa8
KH
3086 if (endpos != pos && startpos != pos)
3087 continue;
3088 window = Foverlay_get (overlay, Qwindow);
e43b6e43
MR
3089 clone_number = Foverlay_get (overlay, Qclone_number);
3090 if (WINDOWP (window) && XWINDOW (window) != w
3091 && (! NUMBERP (clone_number)
3092 || XFASTINT (clone_number) != XFASTINT (w->clone_number)))
e8185fa8 3093 continue;
e8185fa8
KH
3094 if (startpos == pos
3095 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3096 record_overlay_string (&overlay_heads, str,
cb26008f
KH
3097 (startpos == endpos
3098 ? Foverlay_get (overlay, Qafter_string)
3099 : Qnil),
3100 Foverlay_get (overlay, Qpriority),
3101 endpos - startpos);
3102 else if (endpos == pos
3103 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3104 record_overlay_string (&overlay_tails, str, Qnil,
e8185fa8
KH
3105 Foverlay_get (overlay, Qpriority),
3106 endpos - startpos);
bbbe9545 3107 }
e8185fa8
KH
3108 if (overlay_tails.used > 1)
3109 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3110 cmp_for_strings);
3111 if (overlay_heads.used > 1)
3112 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3113 cmp_for_strings);
3114 if (overlay_heads.bytes || overlay_tails.bytes)
bbbe9545 3115 {
e8185fa8 3116 Lisp_Object tem;
145582a0 3117 EMACS_INT i;
9f4d7cde 3118 unsigned char *p;
145582a0 3119 EMACS_INT total = overlay_heads.bytes + overlay_tails.bytes;
bbbe9545
KH
3120
3121 if (total > overlay_str_len)
9f4d7cde
RS
3122 {
3123 overlay_str_len = total;
3124 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3125 total);
3126 }
bbbe9545 3127 p = overlay_str_buf;
e8185fa8 3128 for (i = overlay_tails.used; --i >= 0;)
bbbe9545 3129 {
145582a0 3130 EMACS_INT nbytes;
e8185fa8 3131 tem = overlay_tails.buf[i].string;
d5db4077
KR
3132 nbytes = copy_text (SDATA (tem), p,
3133 SBYTES (tem),
43d27a72
RS
3134 STRING_MULTIBYTE (tem), multibyte);
3135 p += nbytes;
bbbe9545 3136 }
e8185fa8 3137 for (i = 0; i < overlay_heads.used; ++i)
bbbe9545 3138 {
145582a0 3139 EMACS_INT nbytes;
e8185fa8 3140 tem = overlay_heads.buf[i].string;
d5db4077
KR
3141 nbytes = copy_text (SDATA (tem), p,
3142 SBYTES (tem),
43d27a72
RS
3143 STRING_MULTIBYTE (tem), multibyte);
3144 p += nbytes;
cb26008f
KH
3145 tem = overlay_heads.buf[i].string2;
3146 if (STRINGP (tem))
3147 {
d5db4077
KR
3148 nbytes = copy_text (SDATA (tem), p,
3149 SBYTES (tem),
43d27a72
RS
3150 STRING_MULTIBYTE (tem), multibyte);
3151 p += nbytes;
cb26008f 3152 }
bbbe9545 3153 }
cb26008f
KH
3154 if (p != overlay_str_buf + total)
3155 abort ();
bbbe9545
KH
3156 if (pstr)
3157 *pstr = overlay_str_buf;
e8185fa8 3158 return total;
bbbe9545 3159 }
e8185fa8 3160 return 0;
bbbe9545
KH
3161}
3162\f
5c4f68f1 3163/* Shift overlays in BUF's overlay lists, to center the lists at POS. */
1ab256cb 3164
2eec3b4e 3165void
d3da34e0 3166recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
2eec3b4e 3167{
2410d73a
SM
3168 Lisp_Object overlay, beg, end;
3169 struct Lisp_Overlay *prev, *tail, *next;
2eec3b4e
RS
3170
3171 /* See if anything in overlays_before should move to overlays_after. */
3172
3173 /* We don't strictly need prev in this loop; it should always be nil.
3174 But we use it for symmetry and in case that should cease to be true
3175 with some future change. */
2410d73a
SM
3176 prev = NULL;
3177 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
1ab256cb 3178 {
2410d73a
SM
3179 next = tail->next;
3180 XSETMISC (overlay, tail);
2eec3b4e
RS
3181
3182 /* If the overlay is not valid, get rid of it. */
3183 if (!OVERLAY_VALID (overlay))
52f8ec73
JB
3184#if 1
3185 abort ();
3186#else
2eec3b4e
RS
3187 {
3188 /* Splice the cons cell TAIL out of overlays_before. */
3189 if (!NILP (prev))
7539e11f 3190 XCDR (prev) = next;
2eec3b4e 3191 else
5c4f68f1 3192 buf->overlays_before = next;
2eec3b4e
RS
3193 tail = prev;
3194 continue;
3195 }
52f8ec73 3196#endif
1ab256cb 3197
2eec3b4e
RS
3198 beg = OVERLAY_START (overlay);
3199 end = OVERLAY_END (overlay);
1ab256cb 3200
2eec3b4e 3201 if (OVERLAY_POSITION (end) > pos)
1ab256cb 3202 {
2eec3b4e 3203 /* OVERLAY needs to be moved. */
145582a0 3204 EMACS_INT where = OVERLAY_POSITION (beg);
2410d73a 3205 struct Lisp_Overlay *other, *other_prev;
2eec3b4e
RS
3206
3207 /* Splice the cons cell TAIL out of overlays_before. */
2410d73a
SM
3208 if (prev)
3209 prev->next = next;
2eec3b4e 3210 else
5c4f68f1 3211 buf->overlays_before = next;
2eec3b4e
RS
3212
3213 /* Search thru overlays_after for where to put it. */
2410d73a
SM
3214 other_prev = NULL;
3215 for (other = buf->overlays_after; other;
3216 other_prev = other, other = other->next)
1ab256cb 3217 {
6af718a4 3218 Lisp_Object otherbeg, otheroverlay;
2eec3b4e 3219
2410d73a
SM
3220 XSETMISC (otheroverlay, other);
3221 eassert (OVERLAY_VALID (otheroverlay));
2eec3b4e
RS
3222
3223 otherbeg = OVERLAY_START (otheroverlay);
3224 if (OVERLAY_POSITION (otherbeg) >= where)
3225 break;
1ab256cb 3226 }
2eec3b4e
RS
3227
3228 /* Add TAIL to overlays_after before OTHER. */
2410d73a
SM
3229 tail->next = other;
3230 if (other_prev)
3231 other_prev->next = tail;
1ab256cb 3232 else
5c4f68f1 3233 buf->overlays_after = tail;
2eec3b4e 3234 tail = prev;
1ab256cb 3235 }
2eec3b4e
RS
3236 else
3237 /* We've reached the things that should stay in overlays_before.
3238 All the rest of overlays_before must end even earlier,
3239 so stop now. */
3240 break;
3241 }
3242
3243 /* See if anything in overlays_after should be in overlays_before. */
2410d73a
SM
3244 prev = NULL;
3245 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
2eec3b4e 3246 {
2410d73a
SM
3247 next = tail->next;
3248 XSETMISC (overlay, tail);
2eec3b4e
RS
3249
3250 /* If the overlay is not valid, get rid of it. */
3251 if (!OVERLAY_VALID (overlay))
52f8ec73
JB
3252#if 1
3253 abort ();
3254#else
2eec3b4e
RS
3255 {
3256 /* Splice the cons cell TAIL out of overlays_after. */
3257 if (!NILP (prev))
7539e11f 3258 XCDR (prev) = next;
2eec3b4e 3259 else
5c4f68f1 3260 buf->overlays_after = next;
2eec3b4e
RS
3261 tail = prev;
3262 continue;
3263 }
52f8ec73 3264#endif
2eec3b4e
RS
3265
3266 beg = OVERLAY_START (overlay);
3267 end = OVERLAY_END (overlay);
3268
3269 /* Stop looking, when we know that nothing further
3270 can possibly end before POS. */
3271 if (OVERLAY_POSITION (beg) > pos)
3272 break;
3273
3274 if (OVERLAY_POSITION (end) <= pos)
3275 {
3276 /* OVERLAY needs to be moved. */
145582a0 3277 EMACS_INT where = OVERLAY_POSITION (end);
2410d73a 3278 struct Lisp_Overlay *other, *other_prev;
2eec3b4e
RS
3279
3280 /* Splice the cons cell TAIL out of overlays_after. */
2410d73a
SM
3281 if (prev)
3282 prev->next = next;
2eec3b4e 3283 else
5c4f68f1 3284 buf->overlays_after = next;
2eec3b4e
RS
3285
3286 /* Search thru overlays_before for where to put it. */
2410d73a
SM
3287 other_prev = NULL;
3288 for (other = buf->overlays_before; other;
3289 other_prev = other, other = other->next)
2eec3b4e
RS
3290 {
3291 Lisp_Object otherend, otheroverlay;
2eec3b4e 3292
2410d73a
SM
3293 XSETMISC (otheroverlay, other);
3294 eassert (OVERLAY_VALID (otheroverlay));
2eec3b4e
RS
3295
3296 otherend = OVERLAY_END (otheroverlay);
3297 if (OVERLAY_POSITION (otherend) <= where)
3298 break;
3299 }
3300
3301 /* Add TAIL to overlays_before before OTHER. */
2410d73a
SM
3302 tail->next = other;
3303 if (other_prev)
3304 other_prev->next = tail;
2eec3b4e 3305 else
5c4f68f1 3306 buf->overlays_before = tail;
2eec3b4e
RS
3307 tail = prev;
3308 }
3309 }
3310
c2d5b10f 3311 buf->overlay_center = pos;
2eec3b4e 3312}
2b1bdf65 3313
423cdb46 3314void
d3da34e0 3315adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
423cdb46
KH
3316{
3317 /* After an insertion, the lists are still sorted properly,
3318 but we may need to update the value of the overlay center. */
c2d5b10f
SM
3319 if (current_buffer->overlay_center >= pos)
3320 current_buffer->overlay_center += length;
423cdb46
KH
3321}
3322
3323void
d3da34e0 3324adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
423cdb46 3325{
c2d5b10f 3326 if (current_buffer->overlay_center < pos)
423cdb46
KH
3327 /* The deletion was to our right. No change needed; the before- and
3328 after-lists are still consistent. */
3329 ;
c2d5b10f 3330 else if (current_buffer->overlay_center > pos + length)
423cdb46
KH
3331 /* The deletion was to our left. We need to adjust the center value
3332 to account for the change in position, but the lists are consistent
3333 given the new value. */
c2d5b10f 3334 current_buffer->overlay_center -= length;
423cdb46
KH
3335 else
3336 /* We're right in the middle. There might be things on the after-list
3337 that now belong on the before-list. Recentering will move them,
3338 and also update the center point. */
3339 recenter_overlay_lists (current_buffer, pos);
3340}
3341
2b1bdf65
KH
3342/* Fix up overlays that were garbled as a result of permuting markers
3343 in the range START through END. Any overlay with at least one
3344 endpoint in this range will need to be unlinked from the overlay
3345 list and reinserted in its proper place.
3346 Such an overlay might even have negative size at this point.
6b61353c 3347 If so, we'll make the overlay empty. */
2b1bdf65 3348void
145582a0 3349fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
2b1bdf65 3350{
6af718a4 3351 Lisp_Object overlay;
5df8f01b
PE
3352 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3353 struct Lisp_Overlay *after_list IF_LINT (= NULL);
1138e742
KR
3354 /* These are either nil, indicating that before_list or after_list
3355 should be assigned, or the cons cell the cdr of which should be
3356 assigned. */
2410d73a 3357 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
1138e742
KR
3358 /* 'Parent', likewise, indicates a cons cell or
3359 current_buffer->overlays_before or overlays_after, depending
3360 which loop we're in. */
2410d73a 3361 struct Lisp_Overlay *tail, *parent;
145582a0 3362 EMACS_INT startpos, endpos;
2b1bdf65
KH
3363
3364 /* This algorithm shifts links around instead of consing and GCing.
3365 The loop invariant is that before_list (resp. after_list) is a
1138e742
KR
3366 well-formed list except that its last element, the CDR of beforep
3367 (resp. afterp) if beforep (afterp) isn't nil or before_list
3368 (after_list) if it is, is still uninitialized. So it's not a bug
3369 that before_list isn't initialized, although it may look
3370 strange. */
2410d73a 3371 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
2b1bdf65 3372 {
2410d73a 3373 XSETMISC (overlay, tail);
6b61353c 3374
2b1bdf65 3375 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
6b61353c
KH
3376 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3377
3378 /* If the overlay is backwards, make it empty. */
3379 if (endpos < startpos)
3380 {
3381 startpos = endpos;
3382 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3383 Qnil);
3384 }
3385
2b1bdf65
KH
3386 if (endpos < start)
3387 break;
60ebfdf3 3388
2b1bdf65
KH
3389 if (endpos < end
3390 || (startpos >= start && startpos < end))
3391 {
2b1bdf65
KH
3392 /* Add it to the end of the wrong list. Later on,
3393 recenter_overlay_lists will move it to the right place. */
c2d5b10f 3394 if (endpos < current_buffer->overlay_center)
2b1bdf65 3395 {
2410d73a 3396 if (!afterp)
1138e742
KR
3397 after_list = tail;
3398 else
2410d73a 3399 afterp->next = tail;
1138e742 3400 afterp = tail;
2b1bdf65
KH
3401 }
3402 else
3403 {
2410d73a 3404 if (!beforep)
1138e742
KR
3405 before_list = tail;
3406 else
2410d73a 3407 beforep->next = tail;
1138e742 3408 beforep = tail;
2b1bdf65 3409 }
2410d73a
SM
3410 if (!parent)
3411 current_buffer->overlays_before = tail->next;
1138e742 3412 else
2410d73a
SM
3413 parent->next = tail->next;
3414 tail = tail->next;
2b1bdf65
KH
3415 }
3416 else
2410d73a 3417 parent = tail, tail = parent->next;
2b1bdf65 3418 }
2410d73a 3419 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
2b1bdf65 3420 {
2410d73a 3421 XSETMISC (overlay, tail);
6b61353c 3422
2b1bdf65 3423 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
6b61353c
KH
3424 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3425
3426 /* If the overlay is backwards, make it empty. */
3427 if (endpos < startpos)
3428 {
3429 startpos = endpos;
3430 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
60ebfdf3 3431 Qnil);
6b61353c
KH
3432 }
3433
2b1bdf65
KH
3434 if (startpos >= end)
3435 break;
6b61353c 3436
2b1bdf65
KH
3437 if (startpos >= start
3438 || (endpos >= start && endpos < end))
3439 {
c2d5b10f 3440 if (endpos < current_buffer->overlay_center)
2b1bdf65 3441 {
2410d73a 3442 if (!afterp)
1138e742
KR
3443 after_list = tail;
3444 else
2410d73a 3445 afterp->next = tail;
1138e742 3446 afterp = tail;
2b1bdf65
KH
3447 }
3448 else
3449 {
2410d73a 3450 if (!beforep)
1138e742
KR
3451 before_list = tail;
3452 else
2410d73a 3453 beforep->next = tail;
1138e742 3454 beforep = tail;
2b1bdf65 3455 }
2410d73a
SM
3456 if (!parent)
3457 current_buffer->overlays_after = tail->next;
1138e742 3458 else
2410d73a
SM
3459 parent->next = tail->next;
3460 tail = tail->next;
2b1bdf65
KH
3461 }
3462 else
2410d73a 3463 parent = tail, tail = parent->next;
2b1bdf65
KH
3464 }
3465
3466 /* Splice the constructed (wrong) lists into the buffer's lists,
3467 and let the recenter function make it sane again. */
2410d73a 3468 if (beforep)
1138e742 3469 {
2410d73a 3470 beforep->next = current_buffer->overlays_before;
1138e742
KR
3471 current_buffer->overlays_before = before_list;
3472 }
c2d5b10f 3473 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
2b1bdf65 3474
2410d73a 3475 if (afterp)
1138e742 3476 {
2410d73a 3477 afterp->next = current_buffer->overlays_after;
1138e742
KR
3478 current_buffer->overlays_after = after_list;
3479 }
c2d5b10f 3480 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
2b1bdf65 3481}
3b06f880
KH
3482
3483/* We have two types of overlay: the one whose ending marker is
3484 after-insertion-marker (this is the usual case) and the one whose
3485 ending marker is before-insertion-marker. When `overlays_before'
3486 contains overlays of the latter type and the former type in this
3487 order and both overlays end at inserting position, inserting a text
3488 increases only the ending marker of the latter type, which results
3489 in incorrect ordering of `overlays_before'.
3490
3491 This function fixes ordering of overlays in the slot
3492 `overlays_before' of the buffer *BP. Before the insertion, `point'
3493 was at PREV, and now is at POS. */
3494
01136e9b 3495void
d3da34e0 3496fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3b06f880 3497{
2410d73a
SM
3498 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3499 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3500 Lisp_Object tem;
5df8f01b 3501 EMACS_INT end IF_LINT (= 0);
3b06f880
KH
3502
3503 /* After the insertion, the several overlays may be in incorrect
3504 order. The possibility is that, in the list `overlays_before',
3505 an overlay which ends at POS appears after an overlay which ends
3506 at PREV. Since POS is greater than PREV, we must fix the
3507 ordering of these overlays, by moving overlays ends at POS before
3508 the overlays ends at PREV. */
3509
3510 /* At first, find a place where disordered overlays should be linked
3511 in. It is where an overlay which end before POS exists. (i.e. an
3512 overlay whose ending marker is after-insertion-marker if disorder
3513 exists). */
2410d73a
SM
3514 while (tail
3515 && (XSETMISC (tem, tail),
3516 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
1138e742
KR
3517 {
3518 parent = tail;
2410d73a 3519 tail = tail->next;
1138e742 3520 }
3b06f880
KH
3521
3522 /* If we don't find such an overlay,
3523 or the found one ends before PREV,
3524 or the found one is the last one in the list,
3525 we don't have to fix anything. */
f93ad4cf 3526 if (!tail || end < prev || !tail->next)
3b06f880
KH
3527 return;
3528
1138e742
KR
3529 right_pair = parent;
3530 parent = tail;
2410d73a 3531 tail = tail->next;
3b06f880 3532
1138e742 3533 /* Now, end position of overlays in the list TAIL should be before
3b06f880 3534 or equal to PREV. In the loop, an overlay which ends at POS is
1138e742
KR
3535 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3536 we found an overlay which ends before PREV, the remaining
3537 overlays are in correct order. */
2410d73a 3538 while (tail)
3b06f880 3539 {
2410d73a
SM
3540 XSETMISC (tem, tail);
3541 end = OVERLAY_POSITION (OVERLAY_END (tem));
3b06f880
KH
3542
3543 if (end == pos)
3544 { /* This overlay is disordered. */
2410d73a 3545 struct Lisp_Overlay *found = tail;
3b06f880
KH
3546
3547 /* Unlink the found overlay. */
2410d73a
SM
3548 tail = found->next;
3549 parent->next = tail;
1138e742
KR
3550 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3551 and link it into the right place. */
2410d73a 3552 if (!right_pair)
1138e742 3553 {
2410d73a 3554 found->next = bp->overlays_before;
1138e742
KR
3555 bp->overlays_before = found;
3556 }
3557 else
3558 {
2410d73a
SM
3559 found->next = right_pair->next;
3560 right_pair->next = found;
1138e742 3561 }
3b06f880
KH
3562 }
3563 else if (end == prev)
1138e742
KR
3564 {
3565 parent = tail;
2410d73a 3566 tail = tail->next;
1138e742 3567 }
3b06f880
KH
3568 else /* No more disordered overlay. */
3569 break;
3570 }
3571}
2eec3b4e 3572\f
52f8ec73 3573DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
7ee72033 3574 doc: /* Return t if OBJECT is an overlay. */)
5842a27b 3575 (Lisp_Object object)
52f8ec73
JB
3576{
3577 return (OVERLAYP (object) ? Qt : Qnil);
3578}
3579
acac2700 3580DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
7ee72033 3581 doc: /* Create a new overlay with range BEG to END in BUFFER.
018ba359
PJ
3582If omitted, BUFFER defaults to the current buffer.
3583BEG and END may be integers or markers.
a625ee20
RS
3584The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3585for the front of the overlay advance when text is inserted there
63af6055 3586\(which means the text *is not* included in the overlay).
a625ee20
RS
3587The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3588for the rear of the overlay advance when text is inserted there
63af6055 3589\(which means the text *is* included in the overlay). */)
5842a27b 3590 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
2eec3b4e
RS
3591{
3592 Lisp_Object overlay;
5c4f68f1 3593 struct buffer *b;
2eec3b4e 3594
5c4f68f1 3595 if (NILP (buffer))
67180c6a 3596 XSETBUFFER (buffer, current_buffer);
883047b9 3597 else
b7826503 3598 CHECK_BUFFER (buffer);
883047b9
JB
3599 if (MARKERP (beg)
3600 && ! EQ (Fmarker_buffer (beg), buffer))
3601 error ("Marker points into wrong buffer");
3602 if (MARKERP (end)
3603 && ! EQ (Fmarker_buffer (end), buffer))
3604 error ("Marker points into wrong buffer");
2eec3b4e 3605
b7826503
PJ
3606 CHECK_NUMBER_COERCE_MARKER (beg);
3607 CHECK_NUMBER_COERCE_MARKER (end);
5c4f68f1 3608
883047b9 3609 if (XINT (beg) > XINT (end))
5c4f68f1 3610 {
c99fc30f
KH
3611 Lisp_Object temp;
3612 temp = beg; beg = end; end = temp;
5c4f68f1 3613 }
883047b9
JB
3614
3615 b = XBUFFER (buffer);
3616
3617 beg = Fset_marker (Fmake_marker (), beg, buffer);
3618 end = Fset_marker (Fmake_marker (), end, buffer);
5c4f68f1 3619
acac2700
RS
3620 if (!NILP (front_advance))
3621 XMARKER (beg)->insertion_type = 1;
3622 if (!NILP (rear_advance))
3623 XMARKER (end)->insertion_type = 1;
597dd755 3624
48e2e3ba 3625 overlay = allocate_misc ();
89ca3e1b 3626 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
48e2e3ba
KH
3627 XOVERLAY (overlay)->start = beg;
3628 XOVERLAY (overlay)->end = end;
3629 XOVERLAY (overlay)->plist = Qnil;
2410d73a 3630 XOVERLAY (overlay)->next = NULL;
2eec3b4e 3631
177c0ea7 3632 /* Put the new overlay on the wrong list. */
2eec3b4e 3633 end = OVERLAY_END (overlay);
c2d5b10f 3634 if (OVERLAY_POSITION (end) < b->overlay_center)
2410d73a
SM
3635 {
3636 if (b->overlays_after)
3637 XOVERLAY (overlay)->next = b->overlays_after;
3638 b->overlays_after = XOVERLAY (overlay);
3639 }
2eec3b4e 3640 else
2410d73a
SM
3641 {
3642 if (b->overlays_before)
3643 XOVERLAY (overlay)->next = b->overlays_before;
3644 b->overlays_before = XOVERLAY (overlay);
3645 }
2eec3b4e
RS
3646
3647 /* This puts it in the right list, and in the right order. */
c2d5b10f 3648 recenter_overlay_lists (b, b->overlay_center);
2eec3b4e 3649
b61982dd
JB
3650 /* We don't need to redisplay the region covered by the overlay, because
3651 the overlay has no properties at the moment. */
3652
2eec3b4e
RS
3653 return overlay;
3654}
876aa27c
RS
3655\f
3656/* Mark a section of BUF as needing redisplay because of overlays changes. */
3657
3658static void
d3da34e0 3659modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
876aa27c 3660{
876aa27c
RS
3661 if (start > end)
3662 {
145582a0 3663 EMACS_INT temp = start;
26f545d7
GM
3664 start = end;
3665 end = temp;
876aa27c
RS
3666 }
3667
481b5054 3668 BUF_COMPUTE_UNCHANGED (buf, start, end);
177c0ea7 3669
876aa27c
RS
3670 /* If this is a buffer not in the selected window,
3671 we must do other windows. */
3672 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3673 windows_or_buffers_changed = 1;
876aa27c
RS
3674 /* If multiple windows show this buffer, we must do other windows. */
3675 else if (buffer_shared > 1)
3676 windows_or_buffers_changed = 1;
18700091
KS
3677 /* If we modify an overlay at the end of the buffer, we cannot
3678 be sure that window end is still valid. */
3679 else if (end >= ZV && start <= ZV)
3680 windows_or_buffers_changed = 1;
876aa27c 3681
d8b9150f 3682 ++BUF_OVERLAY_MODIFF (buf);
876aa27c 3683}
2eec3b4e 3684
018ba359 3685\f
2410d73a 3686static struct Lisp_Overlay *
d3da34e0 3687unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
2410d73a
SM
3688{
3689 struct Lisp_Overlay *tmp, *prev;
3690 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3691 if (tmp == overlay)
3692 {
3693 if (prev)
3694 prev->next = tmp->next;
3695 else
3696 list = tmp->next;
3697 overlay->next = NULL;
3698 break;
3699 }
3700 return list;
3701}
3702
5c4f68f1 3703DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
7ee72033 3704 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
018ba359
PJ
3705If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3706If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
7ee72033 3707buffer. */)
5842a27b 3708 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
2eec3b4e 3709{
0a4469c9
RS
3710 struct buffer *b, *ob;
3711 Lisp_Object obuffer;
aed13378 3712 int count = SPECPDL_INDEX ();
5c4f68f1 3713
b7826503 3714 CHECK_OVERLAY (overlay);
5c4f68f1
JB
3715 if (NILP (buffer))
3716 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3ece337a 3717 if (NILP (buffer))
67180c6a 3718 XSETBUFFER (buffer, current_buffer);
b7826503 3719 CHECK_BUFFER (buffer);
883047b9
JB
3720
3721 if (MARKERP (beg)
3722 && ! EQ (Fmarker_buffer (beg), buffer))
3723 error ("Marker points into wrong buffer");
3724 if (MARKERP (end)
3725 && ! EQ (Fmarker_buffer (end), buffer))
3726 error ("Marker points into wrong buffer");
3727
b7826503
PJ
3728 CHECK_NUMBER_COERCE_MARKER (beg);
3729 CHECK_NUMBER_COERCE_MARKER (end);
b61982dd 3730
9d7608b7
KH
3731 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3732 return Fdelete_overlay (overlay);
0a4469c9 3733
b61982dd
JB
3734 if (XINT (beg) > XINT (end))
3735 {
c99fc30f
KH
3736 Lisp_Object temp;
3737 temp = beg; beg = end; end = temp;
b61982dd
JB
3738 }
3739
9d7608b7
KH
3740 specbind (Qinhibit_quit, Qt);
3741
0a4469c9 3742 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
5c4f68f1 3743 b = XBUFFER (buffer);
8801a864 3744 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
2eec3b4e 3745
c82ed728 3746 /* If the overlay has changed buffers, do a thorough redisplay. */
0a4469c9 3747 if (!EQ (buffer, obuffer))
50760c4a
RS
3748 {
3749 /* Redisplay where the overlay was. */
3750 if (!NILP (obuffer))
3751 {
145582a0
EZ
3752 EMACS_INT o_beg;
3753 EMACS_INT o_end;
50760c4a 3754
80509f2f
RS
3755 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3756 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
50760c4a 3757
2e34157c 3758 modify_overlay (ob, o_beg, o_end);
50760c4a
RS
3759 }
3760
3761 /* Redisplay where the overlay is going to be. */
876aa27c 3762 modify_overlay (b, XINT (beg), XINT (end));
50760c4a 3763 }
c82ed728
JB
3764 else
3765 /* Redisplay the area the overlay has just left, or just enclosed. */
3766 {
145582a0 3767 EMACS_INT o_beg, o_end;
c82ed728 3768
80509f2f
RS
3769 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3770 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
c82ed728 3771
2e34157c
RS
3772 if (o_beg == XINT (beg))
3773 modify_overlay (b, o_end, XINT (end));
3774 else if (o_end == XINT (end))
3775 modify_overlay (b, o_beg, XINT (beg));
c82ed728
JB
3776 else
3777 {
2e34157c
RS
3778 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3779 if (XINT (end) > o_end) o_end = XINT (end);
3780 modify_overlay (b, o_beg, o_end);
c82ed728
JB
3781 }
3782 }
b61982dd 3783
0a4469c9
RS
3784 if (!NILP (obuffer))
3785 {
2410d73a
SM
3786 ob->overlays_before
3787 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3788 ob->overlays_after
3789 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3790 eassert (XOVERLAY (overlay)->next == NULL);
0a4469c9 3791 }
5c4f68f1
JB
3792
3793 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3794 Fset_marker (OVERLAY_END (overlay), end, buffer);
2eec3b4e 3795
177c0ea7 3796 /* Put the overlay on the wrong list. */
2eec3b4e 3797 end = OVERLAY_END (overlay);
c2d5b10f 3798 if (OVERLAY_POSITION (end) < b->overlay_center)
2410d73a 3799 {
8f924df7
KH
3800 XOVERLAY (overlay)->next = b->overlays_after;
3801 b->overlays_after = XOVERLAY (overlay);
2410d73a 3802 }
2eec3b4e 3803 else
2410d73a 3804 {
8f924df7
KH
3805 XOVERLAY (overlay)->next = b->overlays_before;
3806 b->overlays_before = XOVERLAY (overlay);
2410d73a 3807 }
2eec3b4e
RS
3808
3809 /* This puts it in the right list, and in the right order. */
c2d5b10f 3810 recenter_overlay_lists (b, b->overlay_center);
2eec3b4e 3811
0a4469c9 3812 return unbind_to (count, overlay);
2eec3b4e
RS
3813}
3814
3815DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
7ee72033 3816 doc: /* Delete the overlay OVERLAY from its buffer. */)
5842a27b 3817 (Lisp_Object overlay)
2eec3b4e 3818{
0a4469c9 3819 Lisp_Object buffer;
5c4f68f1 3820 struct buffer *b;
aed13378 3821 int count = SPECPDL_INDEX ();
5c4f68f1 3822
b7826503 3823 CHECK_OVERLAY (overlay);
52f8ec73 3824
0a4469c9
RS
3825 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3826 if (NILP (buffer))
3827 return Qnil;
3828
3829 b = XBUFFER (buffer);
0a4469c9 3830 specbind (Qinhibit_quit, Qt);
177c0ea7 3831
2410d73a
SM
3832 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3833 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3834 eassert (XOVERLAY (overlay)->next == NULL);
876aa27c 3835 modify_overlay (b,
8231a9aa
RS
3836 marker_position (OVERLAY_START (overlay)),
3837 marker_position (OVERLAY_END (overlay)));
3ece337a
JB
3838 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3839 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3840
e58c389d 3841 /* When deleting an overlay with before or after strings, turn off
26f545d7
GM
3842 display optimizations for the affected buffer, on the basis that
3843 these strings may contain newlines. This is easier to do than to
3844 check for that situation during redisplay. */
3845 if (!windows_or_buffers_changed
3846 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3847 || !NILP (Foverlay_get (overlay, Qafter_string))))
3848 b->prevent_redisplay_optimizations_p = 1;
3849
0a4469c9 3850 return unbind_to (count, Qnil);
2eec3b4e
RS
3851}
3852\f
8ebafa8d
JB
3853/* Overlay dissection functions. */
3854
a7ca3326 3855DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
7ee72033 3856 doc: /* Return the position at which OVERLAY starts. */)
5842a27b 3857 (Lisp_Object overlay)
8ebafa8d 3858{
b7826503 3859 CHECK_OVERLAY (overlay);
8ebafa8d
JB
3860
3861 return (Fmarker_position (OVERLAY_START (overlay)));
3862}
3863
a7ca3326 3864DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
7ee72033 3865 doc: /* Return the position at which OVERLAY ends. */)
5842a27b 3866 (Lisp_Object overlay)
8ebafa8d 3867{
b7826503 3868 CHECK_OVERLAY (overlay);
8ebafa8d
JB
3869
3870 return (Fmarker_position (OVERLAY_END (overlay)));
3871}
3872
3873DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
563f7128
LK
3874 doc: /* Return the buffer OVERLAY belongs to.
3875Return nil if OVERLAY has been deleted. */)
5842a27b 3876 (Lisp_Object overlay)
8ebafa8d 3877{
b7826503 3878 CHECK_OVERLAY (overlay);
8ebafa8d
JB
3879
3880 return Fmarker_buffer (OVERLAY_START (overlay));
3881}
3882
3883DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
7ee72033 3884 doc: /* Return a list of the properties on OVERLAY.
018ba359 3885This is a copy of OVERLAY's plist; modifying its conses has no effect on
7ee72033 3886OVERLAY. */)
5842a27b 3887 (Lisp_Object overlay)
8ebafa8d 3888{
b7826503 3889 CHECK_OVERLAY (overlay);
8ebafa8d 3890
48e2e3ba 3891 return Fcopy_sequence (XOVERLAY (overlay)->plist);
8ebafa8d
JB
3892}
3893
3894\f
2eec3b4e 3895DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
aabc29c8 3896 doc: /* Return a list of the overlays that contain the character at POS. */)
5842a27b 3897 (Lisp_Object pos)
2eec3b4e 3898{
b081724f 3899 ptrdiff_t len, noverlays;
2eec3b4e 3900 Lisp_Object *overlay_vec;
2eec3b4e
RS
3901 Lisp_Object result;
3902
b7826503 3903 CHECK_NUMBER_COERCE_MARKER (pos);
2eec3b4e
RS
3904
3905 len = 10;
a9800ae8 3906 /* We can't use alloca here because overlays_at can call xrealloc. */
2eec3b4e
RS
3907 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3908
3909 /* Put all the overlays we want in a vector in overlay_vec.
3910 Store the length in len. */
2a77a7d7 3911 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
0f8b27ea 3912 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
2eec3b4e
RS
3913
3914 /* Make a list of them all. */
3915 result = Flist (noverlays, overlay_vec);
3916
9ac0d9e0 3917 xfree (overlay_vec);
2eec3b4e
RS
3918 return result;
3919}
3920
74514898 3921DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
7ee72033 3922 doc: /* Return a list of the overlays that overlap the region BEG ... END.
018ba359
PJ
3923Overlap means that at least one character is contained within the overlay
3924and also contained within the specified region.
7723e095
MR
3925Empty overlays are included in the result if they are located at BEG,
3926between BEG and END, or at END provided END denotes the position at the
3927end of the buffer. */)
5842a27b 3928 (Lisp_Object beg, Lisp_Object end)
74514898 3929{
21514da7 3930 ptrdiff_t len, noverlays;
74514898 3931 Lisp_Object *overlay_vec;
74514898
RS
3932 Lisp_Object result;
3933
b7826503
PJ
3934 CHECK_NUMBER_COERCE_MARKER (beg);
3935 CHECK_NUMBER_COERCE_MARKER (end);
74514898
RS
3936
3937 len = 10;
3938 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3939
3940 /* Put all the overlays we want in a vector in overlay_vec.
3941 Store the length in len. */
3942 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
145582a0 3943 NULL, NULL);
74514898
RS
3944
3945 /* Make a list of them all. */
3946 result = Flist (noverlays, overlay_vec);
3947
3948 xfree (overlay_vec);
3949 return result;
3950}
3951
a7ca3326 3952DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
efc7e75f 3953 1, 1, 0,
7ee72033 3954 doc: /* Return the next position after POS where an overlay starts or ends.
624d2678
RS
3955If there are no overlay boundaries from POS to (point-max),
3956the value is (point-max). */)
5842a27b 3957 (Lisp_Object pos)
2eec3b4e 3958{
b081724f 3959 ptrdiff_t i, len, noverlays;
0f8b27ea 3960 EMACS_INT endpos;
2eec3b4e 3961 Lisp_Object *overlay_vec;
2eec3b4e 3962
b7826503 3963 CHECK_NUMBER_COERCE_MARKER (pos);
2eec3b4e
RS
3964
3965 len = 10;
3966 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3967
3968 /* Put all the overlays we want in a vector in overlay_vec.
3969 Store the length in len.
3970 endpos gets the position where the next overlay starts. */
2a77a7d7 3971 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
0f8b27ea 3972 &endpos, (EMACS_INT *) 0, 1);
2eec3b4e
RS
3973
3974 /* If any of these overlays ends before endpos,
3975 use its ending point instead. */
3976 for (i = 0; i < noverlays; i++)
3977 {
3978 Lisp_Object oend;
0f8b27ea 3979 EMACS_INT oendpos;
2eec3b4e
RS
3980
3981 oend = OVERLAY_END (overlay_vec[i]);
3982 oendpos = OVERLAY_POSITION (oend);
3983 if (oendpos < endpos)
3984 endpos = oendpos;
1ab256cb
RM
3985 }
3986
9ac0d9e0 3987 xfree (overlay_vec);
2eec3b4e
RS
3988 return make_number (endpos);
3989}
239c932b 3990
a7ca3326 3991DEFUN ("previous-overlay-change", Fprevious_overlay_change,
239c932b 3992 Sprevious_overlay_change, 1, 1, 0,
7ee72033 3993 doc: /* Return the previous position before POS where an overlay starts or ends.
624d2678
RS
3994If there are no overlay boundaries from (point-min) to POS,
3995the value is (point-min). */)
5842a27b 3996 (Lisp_Object pos)
239c932b 3997{
0f8b27ea 3998 EMACS_INT prevpos;
239c932b 3999 Lisp_Object *overlay_vec;
b081724f 4000 ptrdiff_t len;
239c932b 4001
b7826503 4002 CHECK_NUMBER_COERCE_MARKER (pos);
239c932b 4003
624bbdc4
RS
4004 /* At beginning of buffer, we know the answer;
4005 avoid bug subtracting 1 below. */
4006 if (XINT (pos) == BEGV)
4007 return pos;
4008
017f0539
GM
4009 len = 10;
4010 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4011
239c932b
RS
4012 /* Put all the overlays we want in a vector in overlay_vec.
4013 Store the length in len.
daa1c109 4014 prevpos gets the position of the previous change. */
328ab8e7
PE
4015 overlays_at (XINT (pos), 1, &overlay_vec, &len,
4016 (EMACS_INT *) 0, &prevpos, 1);
239c932b 4017
239c932b
RS
4018 xfree (overlay_vec);
4019 return make_number (prevpos);
4020}
2eec3b4e
RS
4021\f
4022/* These functions are for debugging overlays. */
4023
4024DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
7ee72033 4025 doc: /* Return a pair of lists giving all the overlays of the current buffer.
018ba359
PJ
4026The car has all the overlays before the overlay center;
4027the cdr has all the overlays after the overlay center.
4028Recentering overlays moves overlays between these lists.
4029The lists you get are copies, so that changing them has no effect.
7ee72033 4030However, the overlays you get are the real objects that the buffer uses. */)
5842a27b 4031 (void)
2eec3b4e 4032{
2410d73a
SM
4033 struct Lisp_Overlay *ol;
4034 Lisp_Object before = Qnil, after = Qnil, tmp;
4035 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4036 {
4037 XSETMISC (tmp, ol);
4038 before = Fcons (tmp, before);
4039 }
4040 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4041 {
4042 XSETMISC (tmp, ol);
4043 after = Fcons (tmp, after);
4044 }
4045 return Fcons (Fnreverse (before), Fnreverse (after));
2eec3b4e
RS
4046}
4047
4048DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
c87426c5
RS
4049 doc: /* Recenter the overlays of the current buffer around position POS.
4050That makes overlay lookup faster for positions near POS (but perhaps slower
4051for positions far away from POS). */)
5842a27b 4052 (Lisp_Object pos)
2eec3b4e 4053{
b7826503 4054 CHECK_NUMBER_COERCE_MARKER (pos);
2eec3b4e 4055
5c4f68f1 4056 recenter_overlay_lists (current_buffer, XINT (pos));
2eec3b4e
RS
4057 return Qnil;
4058}
4059\f
a7ca3326 4060DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
7ee72033 4061 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
5842a27b 4062 (Lisp_Object overlay, Lisp_Object prop)
2eec3b4e 4063{
b7826503 4064 CHECK_OVERLAY (overlay);
9a593927 4065 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
2eec3b4e
RS
4066}
4067
4068DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
7ee72033 4069 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
5842a27b 4070 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
2eec3b4e 4071{
48e2e3ba 4072 Lisp_Object tail, buffer;
9d7608b7 4073 int changed;
2eec3b4e 4074
b7826503 4075 CHECK_OVERLAY (overlay);
b61982dd 4076
274a9425
RS
4077 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4078
48e2e3ba 4079 for (tail = XOVERLAY (overlay)->plist;
7539e11f
KR
4080 CONSP (tail) && CONSP (XCDR (tail));
4081 tail = XCDR (XCDR (tail)))
4082 if (EQ (XCAR (tail), prop))
274a9425 4083 {
7539e11f 4084 changed = !EQ (XCAR (XCDR (tail)), value);
f3fbd155 4085 XSETCAR (XCDR (tail), value);
9d7608b7 4086 goto found;
274a9425 4087 }
9d7608b7
KH
4088 /* It wasn't in the list, so add it to the front. */
4089 changed = !NILP (value);
48e2e3ba
KH
4090 XOVERLAY (overlay)->plist
4091 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
9d7608b7
KH
4092 found:
4093 if (! NILP (buffer))
4094 {
4095 if (changed)
876aa27c 4096 modify_overlay (XBUFFER (buffer),
26f545d7
GM
4097 marker_position (OVERLAY_START (overlay)),
4098 marker_position (OVERLAY_END (overlay)));
9d7608b7
KH
4099 if (EQ (prop, Qevaporate) && ! NILP (value)
4100 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4101 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4102 Fdelete_overlay (overlay);
4103 }
7d63db98 4104
2eec3b4e 4105 return value;
1ab256cb
RM
4106}
4107\f
9115729e
KH
4108/* Subroutine of report_overlay_modification. */
4109
4110/* Lisp vector holding overlay hook functions to call.
4111 Vector elements come in pairs.
4112 Each even-index element is a list of hook functions.
4113 The following odd-index element is the overlay they came from.
4114
4115 Before the buffer change, we fill in this vector
4116 as we call overlay hook functions.
4117 After the buffer change, we get the functions to call from this vector.
4118 This way we always call the same functions before and after the change. */
4119static Lisp_Object last_overlay_modification_hooks;
4120
4121/* Number of elements actually used in last_overlay_modification_hooks. */
4122static int last_overlay_modification_hooks_used;
4123
4124/* Add one functionlist/overlay pair
4125 to the end of last_overlay_modification_hooks. */
4126
4127static void
d3da34e0 4128add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
9115729e 4129{
77b37c05 4130 int oldsize = ASIZE (last_overlay_modification_hooks);
9115729e
KH
4131
4132 if (last_overlay_modification_hooks_used == oldsize)
409f2919 4133 last_overlay_modification_hooks = larger_vector
de0280a2 4134 (last_overlay_modification_hooks, oldsize * 2, Qnil);
3ae565b3
SM
4135 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4136 functionlist); last_overlay_modification_hooks_used++;
4137 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4138 overlay); last_overlay_modification_hooks_used++;
9115729e
KH
4139}
4140\f
173f2a64
RS
4141/* Run the modification-hooks of overlays that include
4142 any part of the text in START to END.
9115729e
KH
4143 If this change is an insertion, also
4144 run the insert-before-hooks of overlay starting at END,
930a9140
RS
4145 and the insert-after-hooks of overlay ending at START.
4146
4147 This is called both before and after the modification.
4148 AFTER is nonzero when we call after the modification.
4149
9115729e
KH
4150 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4151 When AFTER is nonzero, they are the start position,
4152 the position after the inserted new text,
4153 and the length of deleted or replaced old text. */
173f2a64
RS
4154
4155void
d3da34e0
JB
4156report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4157 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
173f2a64 4158{
2410d73a
SM
4159 Lisp_Object prop, overlay;
4160 struct Lisp_Overlay *tail;
9115729e
KH
4161 /* 1 if this change is an insertion. */
4162 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
a615c6dc 4163 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
55b48893
RS
4164
4165 overlay = Qnil;
2410d73a 4166 tail = NULL;
9115729e 4167
27c6b98e
SM
4168 /* We used to run the functions as soon as we found them and only register
4169 them in last_overlay_modification_hooks for the purpose of the `after'
4170 case. But running elisp code as we traverse the list of overlays is
4171 painful because the list can be modified by the elisp code so we had to
4172 copy at several places. We now simply do a read-only traversal that
4173 only collects the functions to run and we run them afterwards. It's
4174 simpler, especially since all the code was already there. -stef */
4175
a615c6dc 4176 if (!after)
173f2a64 4177 {
a615c6dc
SM
4178 /* We are being called before a change.
4179 Scan the overlays to find the functions to call. */
4180 last_overlay_modification_hooks_used = 0;
2410d73a 4181 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
173f2a64 4182 {
145582a0 4183 EMACS_INT startpos, endpos;
a615c6dc
SM
4184 Lisp_Object ostart, oend;
4185
2410d73a 4186 XSETMISC (overlay, tail);
a615c6dc
SM
4187
4188 ostart = OVERLAY_START (overlay);
4189 oend = OVERLAY_END (overlay);
4190 endpos = OVERLAY_POSITION (oend);
4191 if (XFASTINT (start) > endpos)
4192 break;
4193 startpos = OVERLAY_POSITION (ostart);
4194 if (insertion && (XFASTINT (start) == startpos
4195 || XFASTINT (end) == startpos))
5fb5aa33 4196 {
a615c6dc
SM
4197 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4198 if (!NILP (prop))
4199 add_overlay_mod_hooklist (prop, overlay);
5fb5aa33 4200 }
a615c6dc
SM
4201 if (insertion && (XFASTINT (start) == endpos
4202 || XFASTINT (end) == endpos))
5fb5aa33 4203 {
a615c6dc
SM
4204 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4205 if (!NILP (prop))
4206 add_overlay_mod_hooklist (prop, overlay);
5fb5aa33 4207 }
a615c6dc
SM
4208 /* Test for intersecting intervals. This does the right thing
4209 for both insertion and deletion. */
4210 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
5fb5aa33 4211 {
a615c6dc
SM
4212 prop = Foverlay_get (overlay, Qmodification_hooks);
4213 if (!NILP (prop))
4214 add_overlay_mod_hooklist (prop, overlay);
5fb5aa33 4215 }
173f2a64 4216 }
60ebfdf3 4217
2410d73a 4218 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
173f2a64 4219 {
145582a0 4220 EMACS_INT startpos, endpos;
a615c6dc
SM
4221 Lisp_Object ostart, oend;
4222
2410d73a 4223 XSETMISC (overlay, tail);
a615c6dc
SM
4224
4225 ostart = OVERLAY_START (overlay);
4226 oend = OVERLAY_END (overlay);
4227 startpos = OVERLAY_POSITION (ostart);
4228 endpos = OVERLAY_POSITION (oend);
4229 if (XFASTINT (end) < startpos)
4230 break;
4231 if (insertion && (XFASTINT (start) == startpos
4232 || XFASTINT (end) == startpos))
5fb5aa33 4233 {
a615c6dc
SM
4234 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4235 if (!NILP (prop))
4236 add_overlay_mod_hooklist (prop, overlay);
5fb5aa33 4237 }
a615c6dc
SM
4238 if (insertion && (XFASTINT (start) == endpos
4239 || XFASTINT (end) == endpos))
5fb5aa33 4240 {
a615c6dc
SM
4241 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4242 if (!NILP (prop))
4243 add_overlay_mod_hooklist (prop, overlay);
5fb5aa33 4244 }
a615c6dc
SM
4245 /* Test for intersecting intervals. This does the right thing
4246 for both insertion and deletion. */
4247 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
5fb5aa33 4248 {
a615c6dc
SM
4249 prop = Foverlay_get (overlay, Qmodification_hooks);
4250 if (!NILP (prop))
4251 add_overlay_mod_hooklist (prop, overlay);
5fb5aa33 4252 }
173f2a64
RS
4253 }
4254 }
55b48893 4255
a615c6dc
SM
4256 GCPRO4 (overlay, arg1, arg2, arg3);
4257 {
4258 /* Call the functions recorded in last_overlay_modification_hooks.
4259 First copy the vector contents, in case some of these hooks
4260 do subsequent modification of the buffer. */
4261 int size = last_overlay_modification_hooks_used;
4262 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4263 int i;
4264
72af86bd
AS
4265 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4266 size * sizeof (Lisp_Object));
a615c6dc
SM
4267 gcpro1.var = copy;
4268 gcpro1.nvars = size;
4269
4270 for (i = 0; i < size;)
4271 {
8f54f30a
PE
4272 Lisp_Object prop_i, overlay_i;
4273 prop_i = copy[i++];
4274 overlay_i = copy[i++];
4275 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
a615c6dc
SM
4276 }
4277 }
55b48893 4278 UNGCPRO;
173f2a64
RS
4279}
4280
4281static void
d3da34e0
JB
4282call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4283 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
173f2a64 4284{
930a9140 4285 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9115729e 4286
930a9140 4287 GCPRO4 (list, arg1, arg2, arg3);
9115729e 4288
6d70a280 4289 while (CONSP (list))
173f2a64 4290 {
930a9140 4291 if (NILP (arg3))
6d70a280 4292 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
930a9140 4293 else
6d70a280
SM
4294 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4295 list = XCDR (list);
173f2a64
RS
4296 }
4297 UNGCPRO;
4298}
9d7608b7
KH
4299
4300/* Delete any zero-sized overlays at position POS, if the `evaporate'
4301 property is set. */
4302void
d3da34e0 4303evaporate_overlays (EMACS_INT pos)
9d7608b7 4304{
2410d73a
SM
4305 Lisp_Object overlay, hit_list;
4306 struct Lisp_Overlay *tail;
9d7608b7
KH
4307
4308 hit_list = Qnil;
c2d5b10f 4309 if (pos <= current_buffer->overlay_center)
2410d73a 4310 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
9d7608b7 4311 {
145582a0 4312 EMACS_INT endpos;
2410d73a 4313 XSETMISC (overlay, tail);
9d7608b7
KH
4314 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4315 if (endpos < pos)
4316 break;
4317 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
c3935f9d 4318 && ! NILP (Foverlay_get (overlay, Qevaporate)))
9d7608b7
KH
4319 hit_list = Fcons (overlay, hit_list);
4320 }
4321 else
2410d73a 4322 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
9d7608b7 4323 {
145582a0 4324 EMACS_INT startpos;
2410d73a 4325 XSETMISC (overlay, tail);
9d7608b7
KH
4326 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4327 if (startpos > pos)
4328 break;
4329 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
c3935f9d 4330 && ! NILP (Foverlay_get (overlay, Qevaporate)))
9d7608b7
KH
4331 hit_list = Fcons (overlay, hit_list);
4332 }
7539e11f
KR
4333 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4334 Fdelete_overlay (XCAR (hit_list));
9d7608b7 4335}
173f2a64 4336\f
54dfdeb0 4337/* Somebody has tried to store a value with an unacceptable type
1bf08baf
KH
4338 in the slot with offset OFFSET. */
4339
0fa3ba92 4340void
d3da34e0 4341buffer_slot_type_mismatch (Lisp_Object newval, int type)
0fa3ba92 4342{
ad97b375 4343 Lisp_Object predicate;
177c0ea7 4344
64e16c3c 4345 switch (type)
0fa3ba92 4346 {
2de9f71c 4347 case_Lisp_Int: predicate = Qintegerp; break;
ad97b375
SM
4348 case Lisp_String: predicate = Qstringp; break;
4349 case Lisp_Symbol: predicate = Qsymbolp; break;
4350 default: abort ();
0fa3ba92
JB
4351 }
4352
ad97b375 4353 wrong_type_argument (predicate, newval);
0fa3ba92 4354}
7c02e886 4355
0fa3ba92 4356\f
b86af064
GM
4357/***********************************************************************
4358 Allocation with mmap
4359 ***********************************************************************/
4360
4361#ifdef USE_MMAP_FOR_BUFFERS
4362
4363#include <sys/types.h>
4364#include <sys/mman.h>
4365
4366#ifndef MAP_ANON
4367#ifdef MAP_ANONYMOUS
4368#define MAP_ANON MAP_ANONYMOUS
4369#else
4370#define MAP_ANON 0
4371#endif
4372#endif
4373
09dfdf85
GM
4374#ifndef MAP_FAILED
4375#define MAP_FAILED ((void *) -1)
4376#endif
4377
b86af064 4378#include <stdio.h>
b86af064
GM
4379
4380#if MAP_ANON == 0
4381#include <fcntl.h>
4382#endif
4383
4384#include "coding.h"
4385
4386
4387/* Memory is allocated in regions which are mapped using mmap(2).
4388 The current implementation lets the system select mapped
4389 addresses; we're not using MAP_FIXED in general, except when
4390 trying to enlarge regions.
4391
4392 Each mapped region starts with a mmap_region structure, the user
4393 area starts after that structure, aligned to MEM_ALIGN.
4394
4395 +-----------------------+
4396 | struct mmap_info + |
4397 | padding |
4398 +-----------------------+
4399 | user data |
4400 | |
4401 | |
4402 +-----------------------+ */
4403
4404struct mmap_region
4405{
4406 /* User-specified size. */
4407 size_t nbytes_specified;
177c0ea7 4408
b86af064
GM
4409 /* Number of bytes mapped */
4410 size_t nbytes_mapped;
4411
4412 /* Pointer to the location holding the address of the memory
4413 allocated with the mmap'd block. The variable actually points
4414 after this structure. */
4415 POINTER_TYPE **var;
4416
4417 /* Next and previous in list of all mmap'd regions. */
4418 struct mmap_region *next, *prev;
4419};
4420
4421/* Doubly-linked list of mmap'd regions. */
4422
4423static struct mmap_region *mmap_regions;
4424
4425/* File descriptor for mmap. If we don't have anonymous mapping,
4426 /dev/zero will be opened on it. */
4427
4428static int mmap_fd;
4429
4430/* Temporary storage for mmap_set_vars, see there. */
4431
4432static struct mmap_region *mmap_regions_1;
4433static int mmap_fd_1;
4434
4435/* Page size on this system. */
4436
4437static int mmap_page_size;
4438
4439/* 1 means mmap has been intialized. */
4440
4441static int mmap_initialized_p;
4442
4443/* Value is X rounded up to the next multiple of N. */
4444
4445#define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4446
4447/* Size of mmap_region structure plus padding. */
4448
4449#define MMAP_REGION_STRUCT_SIZE \
4450 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4451
4452/* Given a pointer P to the start of the user-visible part of a mapped
4453 region, return a pointer to the start of the region. */
4454
4455#define MMAP_REGION(P) \
4456 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4457
4458/* Given a pointer P to the start of a mapped region, return a pointer
4459 to the start of the user-visible part of the region. */
4460
4461#define MMAP_USER_AREA(P) \
4462 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4463
4464#define MEM_ALIGN sizeof (double)
4465
7273faa1
DL
4466/* Predicate returning true if part of the address range [START .. END]
4467 is currently mapped. Used to prevent overwriting an existing
08327b22
GM
4468 memory mapping.
4469
4470 Default is to conservativly assume the address range is occupied by
4471 something else. This can be overridden by system configuration
4472 files if system-specific means to determine this exists. */
4473
4474#ifndef MMAP_ALLOCATED_P
4475#define MMAP_ALLOCATED_P(start, end) 1
4476#endif
4477
b86af064
GM
4478/* Function prototypes. */
4479
f57e2426
J
4480static int mmap_free_1 (struct mmap_region *);
4481static int mmap_enlarge (struct mmap_region *, int);
4482static struct mmap_region *mmap_find (POINTER_TYPE *, POINTER_TYPE *);
4483static POINTER_TYPE *mmap_alloc (POINTER_TYPE **, size_t);
4484static POINTER_TYPE *mmap_realloc (POINTER_TYPE **, size_t);
4485static void mmap_free (POINTER_TYPE **ptr);
4486static void mmap_init (void);
b86af064
GM
4487
4488
4489/* Return a region overlapping address range START...END, or null if
4490 none. END is not including, i.e. the last byte in the range
4491 is at END - 1. */
4492
4493static struct mmap_region *
4494mmap_find (start, end)
4495 POINTER_TYPE *start, *end;
4496{
4497 struct mmap_region *r;
4498 char *s = (char *) start, *e = (char *) end;
177c0ea7 4499
b86af064
GM
4500 for (r = mmap_regions; r; r = r->next)
4501 {
4502 char *rstart = (char *) r;
4503 char *rend = rstart + r->nbytes_mapped;
4504
4505 if (/* First byte of range, i.e. START, in this region? */
4506 (s >= rstart && s < rend)
4507 /* Last byte of range, i.e. END - 1, in this region? */
4508 || (e > rstart && e <= rend)
4509 /* First byte of this region in the range? */
4510 || (rstart >= s && rstart < e)
4511 /* Last byte of this region in the range? */
4512 || (rend > s && rend <= e))
4513 break;
4514 }
4515
4516 return r;
4517}
4518
4519
4520/* Unmap a region. P is a pointer to the start of the user-araa of
4521 the region. Value is non-zero if successful. */
4522
4523static int
4524mmap_free_1 (r)
4525 struct mmap_region *r;
4526{
4527 if (r->next)
4528 r->next->prev = r->prev;
4529 if (r->prev)
4530 r->prev->next = r->next;
4531 else
4532 mmap_regions = r->next;
177c0ea7 4533
1a15cca0 4534 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
b86af064
GM
4535 {
4536 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4537 return 0;
4538 }
4539
4540 return 1;
4541}
4542
4543
4544/* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4545 Value is non-zero if successful. */
4546
4547static int
4548mmap_enlarge (r, npages)
4549 struct mmap_region *r;
4550 int npages;
4551{
4552 char *region_end = (char *) r + r->nbytes_mapped;
4553 size_t nbytes;
4554 int success = 0;
4555
4556 if (npages < 0)
4557 {
4558 /* Unmap pages at the end of the region. */
4559 nbytes = - npages * mmap_page_size;
4560 if (munmap (region_end - nbytes, nbytes) == -1)
4561 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4562 else
4563 {
4564 r->nbytes_mapped -= nbytes;
4565 success = 1;
4566 }
4567 }
4568 else if (npages > 0)
4569 {
b86af064 4570 nbytes = npages * mmap_page_size;
177c0ea7 4571
b86af064
GM
4572 /* Try to map additional pages at the end of the region. We
4573 cannot do this if the address range is already occupied by
4574 something else because mmap deletes any previous mapping.
4575 I'm not sure this is worth doing, let's see. */
08327b22 4576 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
b86af064
GM
4577 {
4578 POINTER_TYPE *p;
177c0ea7 4579
b86af064
GM
4580 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4581 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4582 if (p == MAP_FAILED)
edaa9aed 4583 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
b86af064
GM
4584 else if (p != (POINTER_TYPE *) region_end)
4585 {
4586 /* Kernels are free to choose a different address. In
4587 that case, unmap what we've mapped above; we have
4588 no use for it. */
4589 if (munmap (p, nbytes) == -1)
4590 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4591 }
4592 else
4593 {
4594 r->nbytes_mapped += nbytes;
4595 success = 1;
4596 }
4597 }
4598 }
4599
4600 return success;
4601}
4602
4603
4604/* Set or reset variables holding references to mapped regions. If
4605 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4606 non-zero, set all variables to the start of the user-areas
4607 of mapped regions.
4608
4609 This function is called from Fdump_emacs to ensure that the dumped
4610 Emacs doesn't contain references to memory that won't be mapped
4611 when Emacs starts. */
4612
4613void
4614mmap_set_vars (restore_p)
4615 int restore_p;
4616{
4617 struct mmap_region *r;
4618
4619 if (restore_p)
4620 {
4621 mmap_regions = mmap_regions_1;
4622 mmap_fd = mmap_fd_1;
4623 for (r = mmap_regions; r; r = r->next)
4624 *r->var = MMAP_USER_AREA (r);
4625 }
4626 else
4627 {
4628 for (r = mmap_regions; r; r = r->next)
4629 *r->var = NULL;
4630 mmap_regions_1 = mmap_regions;
4631 mmap_regions = NULL;
4632 mmap_fd_1 = mmap_fd;
4633 mmap_fd = -1;
4634 }
4635}
4636
4637
4638/* Allocate a block of storage large enough to hold NBYTES bytes of
4639 data. A pointer to the data is returned in *VAR. VAR is thus the
4640 address of some variable which will use the data area.
4641
4642 The allocation of 0 bytes is valid.
4643
4644 If we can't allocate the necessary memory, set *VAR to null, and
4645 return null. */
4646
4647static POINTER_TYPE *
4648mmap_alloc (var, nbytes)
4649 POINTER_TYPE **var;
4650 size_t nbytes;
4651{
4652 void *p;
4653 size_t map;
4654
4655 mmap_init ();
4656
4657 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4658 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4659 mmap_fd, 0);
177c0ea7 4660
b86af064
GM
4661 if (p == MAP_FAILED)
4662 {
4663 if (errno != ENOMEM)
4664 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4665 p = NULL;
4666 }
4667 else
4668 {
4669 struct mmap_region *r = (struct mmap_region *) p;
177c0ea7 4670
b86af064
GM
4671 r->nbytes_specified = nbytes;
4672 r->nbytes_mapped = map;
4673 r->var = var;
4674 r->prev = NULL;
4675 r->next = mmap_regions;
4676 if (r->next)
4677 r->next->prev = r;
4678 mmap_regions = r;
177c0ea7 4679
b86af064
GM
4680 p = MMAP_USER_AREA (p);
4681 }
177c0ea7 4682
b86af064
GM
4683 return *var = p;
4684}
4685
4686
4687/* Given a pointer at address VAR to data allocated with mmap_alloc,
4688 resize it to size NBYTES. Change *VAR to reflect the new block,
4689 and return this value. If more memory cannot be allocated, then
4690 leave *VAR unchanged, and return null. */
4691
4692static POINTER_TYPE *
4693mmap_realloc (var, nbytes)
4694 POINTER_TYPE **var;
4695 size_t nbytes;
4696{
4697 POINTER_TYPE *result;
177c0ea7 4698
b86af064
GM
4699 mmap_init ();
4700
4701 if (*var == NULL)
4702 result = mmap_alloc (var, nbytes);
177c0ea7 4703 else if (nbytes == 0)
b86af064
GM
4704 {
4705 mmap_free (var);
4706 result = mmap_alloc (var, nbytes);
4707 }
4708 else
4709 {
4710 struct mmap_region *r = MMAP_REGION (*var);
4711 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
177c0ea7 4712
b86af064
GM
4713 if (room < nbytes)
4714 {
4715 /* Must enlarge. */
4716 POINTER_TYPE *old_ptr = *var;
4717
4718 /* Try to map additional pages at the end of the region.
4719 If that fails, allocate a new region, copy data
4720 from the old region, then free it. */
4721 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4722 / mmap_page_size)))
4723 {
4724 r->nbytes_specified = nbytes;
4725 *var = result = old_ptr;
4726 }
4727 else if (mmap_alloc (var, nbytes))
4728 {
72af86bd 4729 memcpy (*var, old_ptr, r->nbytes_specified);
b86af064
GM
4730 mmap_free_1 (MMAP_REGION (old_ptr));
4731 result = *var;
4732 r = MMAP_REGION (result);
4733 r->nbytes_specified = nbytes;
4734 }
4735 else
4736 {
4737 *var = old_ptr;
4738 result = NULL;
4739 }
4740 }
4741 else if (room - nbytes >= mmap_page_size)
4742 {
4743 /* Shrinking by at least a page. Let's give some
6bcdeb8c
KR
4744 memory back to the system.
4745
4746 The extra parens are to make the division happens first,
4747 on positive values, so we know it will round towards
4748 zero. */
bb63c5c9 4749 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
b86af064
GM
4750 result = *var;
4751 r->nbytes_specified = nbytes;
4752 }
4753 else
4754 {
4755 /* Leave it alone. */
4756 result = *var;
4757 r->nbytes_specified = nbytes;
4758 }
4759 }
4760
4761 return result;
4762}
4763
4764
4765/* Free a block of relocatable storage whose data is pointed to by
4766 PTR. Store 0 in *PTR to show there's no block allocated. */
4767
4768static void
4769mmap_free (var)
4770 POINTER_TYPE **var;
4771{
4772 mmap_init ();
177c0ea7 4773
b86af064
GM
4774 if (*var)
4775 {
4776 mmap_free_1 (MMAP_REGION (*var));
4777 *var = NULL;
4778 }
4779}
4780
4781
4782/* Perform necessary intializations for the use of mmap. */
4783
4784static void
4785mmap_init ()
4786{
4787#if MAP_ANON == 0
4788 /* The value of mmap_fd is initially 0 in temacs, and -1
4789 in a dumped Emacs. */
4790 if (mmap_fd <= 0)
4791 {
4792 /* No anonymous mmap -- we need the file descriptor. */
4793 mmap_fd = open ("/dev/zero", O_RDONLY);
4794 if (mmap_fd == -1)
4795 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4796 }
4797#endif /* MAP_ANON == 0 */
4798
4799 if (mmap_initialized_p)
4800 return;
4801 mmap_initialized_p = 1;
177c0ea7 4802
b86af064
GM
4803#if MAP_ANON != 0
4804 mmap_fd = -1;
4805#endif
177c0ea7 4806
b86af064
GM
4807 mmap_page_size = getpagesize ();
4808}
4809
4810#endif /* USE_MMAP_FOR_BUFFERS */
4811
4812
4813\f
4814/***********************************************************************
4815 Buffer-text Allocation
4816 ***********************************************************************/
4817
4818#ifdef REL_ALLOC
f57e2426
J
4819extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4820extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4821extern void r_alloc_free (POINTER_TYPE **ptr);
b86af064
GM
4822#endif /* REL_ALLOC */
4823
4824
4825/* Allocate NBYTES bytes for buffer B's text buffer. */
4826
4827static void
d3da34e0 4828alloc_buffer_text (struct buffer *b, size_t nbytes)
b86af064
GM
4829{
4830 POINTER_TYPE *p;
177c0ea7 4831
b86af064
GM
4832 BLOCK_INPUT;
4833#if defined USE_MMAP_FOR_BUFFERS
4834 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4835#elif defined REL_ALLOC
4836 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4837#else
815add84 4838 p = xmalloc (nbytes);
b86af064 4839#endif
177c0ea7 4840
b86af064
GM
4841 if (p == NULL)
4842 {
4843 UNBLOCK_INPUT;
531b0165 4844 memory_full (nbytes);
b86af064
GM
4845 }
4846
4847 b->text->beg = (unsigned char *) p;
4848 UNBLOCK_INPUT;
4849}
4850
4851/* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4852 shrink it. */
4853
4854void
5371d722 4855enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
b86af064
GM
4856{
4857 POINTER_TYPE *p;
4858 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4859 + delta);
4860 BLOCK_INPUT;
4861#if defined USE_MMAP_FOR_BUFFERS
4862 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4863#elif defined REL_ALLOC
4864 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4865#else
4866 p = xrealloc (b->text->beg, nbytes);
4867#endif
177c0ea7 4868
b86af064
GM
4869 if (p == NULL)
4870 {
4871 UNBLOCK_INPUT;
531b0165 4872 memory_full (nbytes);
b86af064
GM
4873 }
4874
4875 BUF_BEG_ADDR (b) = (unsigned char *) p;
4876 UNBLOCK_INPUT;
4877}
4878
4879
4880/* Free buffer B's text buffer. */
4881
4882static void
d3da34e0 4883free_buffer_text (struct buffer *b)
b86af064
GM
4884{
4885 BLOCK_INPUT;
4886
4887#if defined USE_MMAP_FOR_BUFFERS
4888 mmap_free ((POINTER_TYPE **) &b->text->beg);
4889#elif defined REL_ALLOC
4890 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4891#else
4892 xfree (b->text->beg);
4893#endif
177c0ea7 4894
b86af064
GM
4895 BUF_BEG_ADDR (b) = NULL;
4896 UNBLOCK_INPUT;
4897}
4898
4899
4900\f
4901/***********************************************************************
4902 Initialization
4903 ***********************************************************************/
4904
dfcf069d 4905void
d3da34e0 4906init_buffer_once (void)
1ab256cb 4907{
7c02e886
GM
4908 int idx;
4909
72af86bd 4910 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
13de9290 4911
1ab256cb
RM
4912 /* Make sure all markable slots in buffer_defaults
4913 are initialized reasonably, so mark_buffer won't choke. */
4914 reset_buffer (&buffer_defaults);
4b4deea2 4915 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
13de9290 4916 reset_buffer_local_variables (&buffer_defaults, 1);
4b4deea2 4917 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
1ab256cb 4918 reset_buffer (&buffer_local_symbols);
13de9290 4919 reset_buffer_local_variables (&buffer_local_symbols, 1);
336cd056
RS
4920 /* Prevent GC from getting confused. */
4921 buffer_defaults.text = &buffer_defaults.own_text;
4922 buffer_local_symbols.text = &buffer_local_symbols.own_text;
336cd056
RS
4923 BUF_INTERVALS (&buffer_defaults) = 0;
4924 BUF_INTERVALS (&buffer_local_symbols) = 0;
eab3844f 4925 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
67180c6a 4926 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
eab3844f 4927 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
67180c6a 4928 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
1ab256cb
RM
4929
4930 /* Set up the default values of various buffer slots. */
4931 /* Must do these before making the first buffer! */
4932
f532dca0 4933 /* real setup is done in bindings.el */
4b4deea2
TT
4934 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4935 BVAR (&buffer_defaults, header_line_format) = Qnil;
4936 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4937 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4938 BVAR (&buffer_defaults, case_fold_search) = Qt;
4939 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4940 BVAR (&buffer_defaults, selective_display) = Qnil;
1ab256cb 4941#ifndef old
4b4deea2 4942 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
1ab256cb 4943#endif
4b4deea2
TT
4944 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4945 BVAR (&buffer_defaults, display_table) = Qnil;
4946 BVAR (&buffer_defaults, undo_list) = Qnil;
4947 BVAR (&buffer_defaults, mark_active) = Qnil;
4948 BVAR (&buffer_defaults, file_format) = Qnil;
4949 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
2410d73a
SM
4950 buffer_defaults.overlays_before = NULL;
4951 buffer_defaults.overlays_after = NULL;
c2d5b10f 4952 buffer_defaults.overlay_center = BEG;
1ab256cb 4953
4b4deea2
TT
4954 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4955 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4956 BVAR (&buffer_defaults, word_wrap) = Qnil;
4957 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4958 BVAR (&buffer_defaults, bidi_display_reordering) = Qnil;
4959 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4960 BVAR (&buffer_defaults, cursor_type) = Qt;
4961 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4962 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
1ab256cb 4963
4b4deea2
TT
4964 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4965 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4966 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4967 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4968 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4969 BVAR (&buffer_defaults, file_truename) = Qnil;
4970 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4971 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4972 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4973 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4974 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4975 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4976 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4977 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4978 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4979 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4980 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4981 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4982 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4983 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4984 BVAR (&buffer_defaults, display_time) = Qnil;
1ab256cb
RM
4985
4986 /* Assign the local-flags to the slots that have default values.
4987 The local flag is a bit that is used in the buffer
4988 to say that it has its own local value for the slot.
4989 The local flag bits are in the local_var_flags slot of the buffer. */
4990
4991 /* Nothing can work if this isn't true */
d6202519 4992 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
1ab256cb
RM
4993
4994 /* 0 means not a lisp var, -1 means always local, else mask */
72af86bd 4995 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4b4deea2
TT
4996 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4997 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4998 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4999 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
5000 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
5001 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
5002 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
5003 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
5004 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
5005 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
5006 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
5007 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
5008 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
5009 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
5010 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
5011 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
5012 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
5013 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
8d7a4592 5014
7c02e886 5015 idx = 1;
4b4deea2
TT
5016 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
5017 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
5018 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
5019 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
5020 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
5021 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
1ab256cb 5022#ifndef old
4b4deea2 5023 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
54ad07d3 5024#endif
4b4deea2
TT
5025 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
5026 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
5027 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
5028 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
5029 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5030 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5031 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5032 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
4b4deea2
TT
5033 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5034 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
5035 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5036 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5037 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5038 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
a1a17b61 5039 /* Make this one a permanent local. */
7c02e886 5040 buffer_permanent_local_flags[idx++] = 1;
4b4deea2
TT
5041 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5042 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5043 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5044 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5045 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5046 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5047 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5048 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5049 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5050 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5051 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5052 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5053 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5054 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5055 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5056 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5057 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
7c02e886
GM
5058
5059 /* Need more room? */
7313acd0 5060 if (idx >= MAX_PER_BUFFER_VARS)
7c02e886 5061 abort ();
7313acd0 5062 last_per_buffer_idx = idx;
177c0ea7 5063
1ab256cb
RM
5064 Vbuffer_alist = Qnil;
5065 current_buffer = 0;
5066 all_buffers = 0;
5067
f4265f6c 5068 QSFundamental = make_pure_c_string ("Fundamental");
1ab256cb 5069
d67b4f80 5070 Qfundamental_mode = intern_c_string ("fundamental-mode");
4b4deea2 5071 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
1ab256cb 5072
d67b4f80 5073 Qmode_class = intern_c_string ("mode-class");
1ab256cb 5074
d67b4f80 5075 Qprotected_field = intern_c_string ("protected-field");
1ab256cb 5076
d67b4f80 5077 Qpermanent_local = intern_c_string ("permanent-local");
1ab256cb 5078
d67b4f80 5079 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
fd6cfe11 5080 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
1ab256cb 5081
d67b4f80 5082 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
48265e61 5083
1ab256cb 5084 /* super-magic invisible buffer */
d67b4f80 5085 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
1ab256cb
RM
5086 Vbuffer_alist = Qnil;
5087
d67b4f80 5088 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
7775635d
KH
5089
5090 inhibit_modification_hooks = 0;
1ab256cb
RM
5091}
5092
dfcf069d 5093void
d3da34e0 5094init_buffer (void)
1ab256cb 5095{
2381d133 5096 char *pwd;
136351b7 5097 Lisp_Object temp;
965d34eb 5098 ptrdiff_t len;
1ab256cb 5099
b86af064 5100#ifdef USE_MMAP_FOR_BUFFERS
93c27ef1
GM
5101 {
5102 /* When using the ralloc implementation based on mmap(2), buffer
5103 text pointers will have been set to null in the dumped Emacs.
5104 Map new memory. */
5105 struct buffer *b;
177c0ea7 5106
f61f41d7 5107 for (b = all_buffers; b; b = b->header.next.buffer)
93c27ef1 5108 if (b->text->beg == NULL)
b86af064 5109 enlarge_buffer_text (b, 0);
93c27ef1 5110 }
b86af064 5111#endif /* USE_MMAP_FOR_BUFFERS */
177c0ea7 5112
1ab256cb 5113 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
4b4deea2 5114 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
3d871c85 5115 Fset_buffer_multibyte (Qnil);
2381d133 5116
01537133 5117 pwd = get_current_dir_name ();
a17b5ed1 5118
156bdb41 5119 if (!pwd)
a17b5ed1 5120 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
1ab256cb 5121
1ab256cb
RM
5122 /* Maybe this should really use some standard subroutine
5123 whose definition is filename syntax dependent. */
b639c9be
RF
5124 len = strlen (pwd);
5125 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
f7975d07 5126 {
156bdb41 5127 /* Grow buffer to add directory separator and '\0'. */
8b146312
AS
5128 pwd = (char *) realloc (pwd, len + 2);
5129 if (!pwd)
5130 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
b639c9be
RF
5131 pwd[len] = DIRECTORY_SEP;
5132 pwd[len + 1] = '\0';
f7975d07 5133 }
0995fa35 5134
4b4deea2
TT
5135 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5136 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
f9962371 5137 /* At this moment, we still don't know how to decode the
156bdb41 5138 directory name. So, we keep the bytes in multibyte form so
dcd74c5f 5139 that ENCODE_FILE correctly gets the original bytes. */
4b4deea2
TT
5140 BVAR (current_buffer, directory)
5141 = string_to_multibyte (BVAR (current_buffer, directory));
136351b7 5142
0995fa35
RS
5143 /* Add /: to the front of the name
5144 if it would otherwise be treated as magic. */
4b4deea2 5145 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
81ab2e07
KH
5146 if (! NILP (temp)
5147 /* If the default dir is just /, TEMP is non-nil
5148 because of the ange-ftp completion handler.
5149 However, it is not necessary to turn / into /:/.
5150 So avoid doing that. */
4b4deea2
TT
5151 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5152 BVAR (current_buffer, directory)
5153 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
0995fa35 5154
136351b7 5155 temp = get_minibuffer (0);
4b4deea2 5156 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
01537133
EZ
5157
5158 free (pwd);
1ab256cb
RM
5159}
5160
d6aa1876
SM
5161/* Similar to defvar_lisp but define a variable whose value is the Lisp
5162 Object stored in the current buffer. address is the address of the slot
5163 in the buffer that is current now. */
5164
5165/* TYPE is nil for a general Lisp variable.
ce5b453a 5166 An integer specifies a type; then only Lisp values
d6aa1876 5167 with that type code are allowed (except that nil is allowed too).
ce5b453a 5168 LNAME is the Lisp-level variable name.
d6aa1876
SM
5169 VNAME is the name of the buffer slot.
5170 DOC is a dummy where you write the doc string as a comment. */
ce5b453a
SM
5171#define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5172 do { \
5173 static struct Lisp_Buffer_Objfwd bo_fwd; \
6b1f9ba4 5174 defvar_per_buffer (&bo_fwd, lname, vname, type); \
ce5b453a 5175 } while (0)
d6aa1876
SM
5176
5177static void
8ea90aa3 5178defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
6b1f9ba4 5179 Lisp_Object *address, Lisp_Object type)
d6aa1876 5180{
ce5b453a 5181 struct Lisp_Symbol *sym;
d6aa1876
SM
5182 int offset;
5183
ce5b453a 5184 sym = XSYMBOL (intern (namestring));
d6aa1876
SM
5185 offset = (char *)address - (char *)current_buffer;
5186
ce5b453a
SM
5187 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5188 bo_fwd->offset = offset;
5189 bo_fwd->slottype = type;
b9598260 5190 sym->declared_special = 1;
ce5b453a
SM
5191 sym->redirect = SYMBOL_FORWARDED;
5192 {
5193 /* I tried to do the job without a cast, but it seems impossible.
5194 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5195 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5196 }
5197 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
d6aa1876
SM
5198
5199 if (PER_BUFFER_IDX (offset) == 0)
5200 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5201 slot of buffer_local_flags */
5202 abort ();
5203}
5204
5205
1ab256cb 5206/* initialize the buffer routines */
dfcf069d 5207void
d3da34e0 5208syms_of_buffer (void)
1ab256cb 5209{
9115729e
KH
5210 staticpro (&last_overlay_modification_hooks);
5211 last_overlay_modification_hooks
5212 = Fmake_vector (make_number (10), Qnil);
5213
1ab256cb
RM
5214 staticpro (&Vbuffer_defaults);
5215 staticpro (&Vbuffer_local_symbols);
5216 staticpro (&Qfundamental_mode);
5217 staticpro (&Qmode_class);
5218 staticpro (&QSFundamental);
5219 staticpro (&Vbuffer_alist);
5220 staticpro (&Qprotected_field);
5221 staticpro (&Qpermanent_local);
5222 staticpro (&Qkill_buffer_hook);
cd3520a4
JB
5223
5224 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5225 DEFSYM (Qoverlayp, "overlayp");
5226 DEFSYM (Qevaporate, "evaporate");
5227 DEFSYM (Qmodification_hooks, "modification-hooks");
5228 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5229 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5230 DEFSYM (Qget_file_buffer, "get-file-buffer");
5231 DEFSYM (Qpriority, "priority");
e43b6e43 5232 DEFSYM (Qclone_number, "clone-number");
cd3520a4
JB
5233 DEFSYM (Qbefore_string, "before-string");
5234 DEFSYM (Qafter_string, "after-string");
5235 DEFSYM (Qfirst_change_hook, "first-change-hook");
5236 DEFSYM (Qbefore_change_functions, "before-change-functions");
5237 DEFSYM (Qafter_change_functions, "after-change-functions");
5238 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5239
2f7a359d 5240 /* The next one is initialized in init_buffer_once. */
48265e61 5241 staticpro (&Qucs_set_table_for_input);
1ab256cb
RM
5242
5243 Fput (Qprotected_field, Qerror_conditions,
d67b4f80 5244 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
1ab256cb 5245 Fput (Qprotected_field, Qerror_message,
d67b4f80 5246 make_pure_c_string ("Attempt to modify a protected field"));
1ab256cb 5247
422745d0
TT
5248 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5249 mode_line_format,
5250 doc: /* Default value of `mode-line-format' for buffers that don't override it.
018ba359 5251This is the same as (default-value 'mode-line-format). */);
1ab256cb 5252
422745d0
TT
5253 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5254 header_line_format,
5255 doc: /* Default value of `header-line-format' for buffers that don't override it.
018ba359 5256This is the same as (default-value 'header-line-format). */);
0552666b 5257
422745d0
TT
5258 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5259 doc: /* Default value of `cursor-type' for buffers that don't override it.
018ba359 5260This is the same as (default-value 'cursor-type). */);
bd96bd79 5261
422745d0
TT
5262 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5263 extra_line_spacing,
5264 doc: /* Default value of `line-spacing' for buffers that don't override it.
018ba359 5265This is the same as (default-value 'line-spacing). */);
a3bbced0 5266
422745d0
TT
5267 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5268 cursor_in_non_selected_windows,
5269 doc: /* Default value of `cursor-in-non-selected-windows'.
187ccf49
KS
5270This is the same as (default-value 'cursor-in-non-selected-windows). */);
5271
422745d0
TT
5272 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5273 abbrev_mode,
5274 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
018ba359 5275This is the same as (default-value 'abbrev-mode). */);
1ab256cb 5276
422745d0
TT
5277 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5278 ctl_arrow,
5279 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
018ba359 5280This is the same as (default-value 'ctl-arrow). */);
1ab256cb 5281
422745d0
TT
5282 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5283 enable_multibyte_characters,
5284 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
018ba359 5285This is the same as (default-value 'enable-multibyte-characters). */);
177c0ea7 5286
422745d0
TT
5287 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5288 buffer_file_coding_system,
5289 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
018ba359 5290This is the same as (default-value 'buffer-file-coding-system). */);
177c0ea7 5291
422745d0
TT
5292 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5293 truncate_lines,
5294 doc: /* Default value of `truncate-lines' for buffers that do not override it.
018ba359 5295This is the same as (default-value 'truncate-lines). */);
1ab256cb 5296
422745d0
TT
5297 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5298 fill_column,
5299 doc: /* Default value of `fill-column' for buffers that do not override it.
018ba359 5300This is the same as (default-value 'fill-column). */);
1ab256cb 5301
422745d0
TT
5302 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5303 left_margin,
5304 doc: /* Default value of `left-margin' for buffers that do not override it.
018ba359 5305This is the same as (default-value 'left-margin). */);
1ab256cb 5306
422745d0
TT
5307 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5308 tab_width,
5309 doc: /* Default value of `tab-width' for buffers that do not override it.
018ba359 5310This is the same as (default-value 'tab-width). */);
1ab256cb 5311
422745d0
TT
5312 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5313 case_fold_search,
5314 doc: /* Default value of `case-fold-search' for buffers that don't override it.
018ba359 5315This is the same as (default-value 'case-fold-search). */);
1ab256cb 5316
422745d0
TT
5317 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5318 left_margin_cols,
5319 doc: /* Default value of `left-margin-width' for buffers that don't override it.
018ba359 5320This is the same as (default-value 'left-margin-width). */);
0552666b 5321
422745d0
TT
5322 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5323 right_margin_cols,
5324 doc: /* Default value of `right-margin-width' for buffers that don't override it.
018ba359 5325This is the same as (default-value 'right-margin-width). */);
177c0ea7 5326
422745d0
TT
5327 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5328 left_fringe_width,
5329 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
2ad8731a
KS
5330This is the same as (default-value 'left-fringe-width). */);
5331
422745d0
TT
5332 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5333 right_fringe_width,
5334 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
2ad8731a
KS
5335This is the same as (default-value 'right-fringe-width). */);
5336
422745d0
TT
5337 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5338 fringes_outside_margins,
5339 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
2ad8731a
KS
5340This is the same as (default-value 'fringes-outside-margins). */);
5341
422745d0
TT
5342 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5343 scroll_bar_width,
5344 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
2ad8731a
KS
5345This is the same as (default-value 'scroll-bar-width). */);
5346
422745d0
TT
5347 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5348 vertical_scroll_bar_type,
5349 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
2ad8731a
KS
5350This is the same as (default-value 'vertical-scroll-bar). */);
5351
422745d0
TT
5352 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5353 indicate_empty_lines,
5354 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
018ba359 5355This is the same as (default-value 'indicate-empty-lines). */);
177c0ea7 5356
422745d0
TT
5357 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5358 indicate_buffer_boundaries,
5359 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
6b61353c
KH
5360This is the same as (default-value 'indicate-buffer-boundaries). */);
5361
422745d0
TT
5362 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5363 fringe_indicator_alist,
5364 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
c6a46372
KS
5365This is the same as (default-value 'fringe-indicator-alist'). */);
5366
422745d0
TT
5367 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5368 fringe_cursor_alist,
5369 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
c6a46372
KS
5370This is the same as (default-value 'fringe-cursor-alist'). */);
5371
422745d0
TT
5372 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5373 scroll_up_aggressively,
5374 doc: /* Default value of `scroll-up-aggressively'.
7614d762 5375This value applies in buffers that don't have their own local values.
fc961256 5376This is the same as (default-value 'scroll-up-aggressively). */);
177c0ea7 5377
422745d0
TT
5378 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5379 scroll_down_aggressively,
5380 doc: /* Default value of `scroll-down-aggressively'.
7614d762 5381This value applies in buffers that don't have their own local values.
fc961256 5382This is the same as (default-value 'scroll-down-aggressively). */);
177c0ea7 5383
045dee35 5384 DEFVAR_PER_BUFFER ("header-line-format",
4b4deea2 5385 &BVAR (current_buffer, header_line_format),
7ee72033 5386 Qnil,
7614d762
RS
5387 doc: /* Analogous to `mode-line-format', but controls the header line.
5388The header line appears, optionally, at the top of a window;
5389the mode line appears at the bottom. */);
177c0ea7 5390
4b4deea2 5391 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
efc7e75f
PJ
5392 Qnil,
5393 doc: /* Template for displaying mode line for current buffer.
018ba359
PJ
5394Each buffer has its own value of this variable.
5395Value may be nil, a string, a symbol or a list or cons cell.
5396A value of nil means don't display a mode line.
5397For a symbol, its value is used (but it is ignored if t or nil).
5398 A string appearing directly as the value of a symbol is processed verbatim
5399 in that the %-constructs below are not recognized.
ed463255 5400 Note that unless the symbol is marked as a `risky-local-variable', all
177c0ea7 5401 properties in any strings, as well as all :eval and :propertize forms
ed463255 5402 in the value of that symbol will be ignored.
018ba359 5403For a list of the form `(:eval FORM)', FORM is evaluated and the result
9c3eecf3
RS
5404 is used as a mode line element. Be careful--FORM should not load any files,
5405 because that can cause an infinite recursion.
ed463255
KS
5406For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5407 with the specified properties PROPS applied.
018ba359
PJ
5408For a list whose car is a symbol, the symbol's value is taken,
5409 and if that is non-nil, the cadr of the list is processed recursively.
5410 Otherwise, the caddr of the list (if there is one) is processed.
5411For a list whose car is a string or list, each element is processed
5412 recursively and the results are effectively concatenated.
5413For a list whose car is an integer, the cdr of the list is processed
5414 and padded (if the number is positive) or truncated (if negative)
5415 to the width specified by that number.
5416A string is printed verbatim in the mode line except for %-constructs:
5417 (%-constructs are allowed when the string is the entire mode-line-format
5418 or when it is found in a cons-cell or a list)
5419 %b -- print buffer name. %f -- print visited file name.
5420 %F -- print frame name.
5421 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5422 %& is like %*, but ignore read-only-ness.
5423 % means buffer is read-only and * means it is modified.
5424 For a modified read-only buffer, %* gives % and %+ gives *.
5425 %s -- print process status. %l -- print the current line number.
5426 %c -- print the current column number (this makes editing slower).
5427 To make the column number update correctly in all cases,
5428 `column-number-mode' must be non-nil.
6b61353c
KH
5429 %i -- print the size of the buffer.
5430 %I -- like %i, but use k, M, G, etc., to abbreviate.
018ba359
PJ
5431 %p -- print percent of buffer above top of window, or Top, Bot or All.
5432 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5433 or print Bottom or All.
018ba359 5434 %n -- print Narrow if appropriate.
dafbe726 5435 %t -- visited file is text or binary (if OS supports this distinction).
47419860 5436 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
018ba359 5437 %Z -- like %z, but including the end-of-line format.
dafbe726 5438 %e -- print error message about full memory.
f7165034
NR
5439 %@ -- print @ or hyphen. @ means that default-directory is on a
5440 remote machine.
018ba359
PJ
5441 %[ -- print one [ for each recursive editing level. %] similar.
5442 %% -- print %. %- -- print infinitely many dashes.
5443Decimal digits after the % specify field width to which to pad. */);
5444
422745d0
TT
5445 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5446 doc: /* *Value of `major-mode' for new buffers. */);
1ab256cb 5447
4b4deea2 5448 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
7ee72033 5449 make_number (Lisp_Symbol),
5a021dd0
GM
5450 doc: /* Symbol for current buffer's major mode.
5451The default value (normally `fundamental-mode') affects new buffers.
5452A value of nil means to use the current buffer's major mode, provided
5453it is not marked as "special".
5454
5455When a mode is used by default, `find-file' switches to it before it
5456reads the contents into the buffer and before it finishes setting up
5457the buffer. Thus, the mode and its hooks should not expect certain
5458variables such as `buffer-read-only' and `buffer-file-coding-system'
5459to be set up. */);
1ab256cb 5460
4b4deea2 5461 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
c01d0677 5462 Qnil,
64a7c220 5463 doc: /* Pretty name of current buffer's major mode.
7cb70974
EZ
5464Usually a string, but can use any of the constructs for `mode-line-format',
5465which see.
5466Format with `format-mode-line' to produce a string value. */);
1ab256cb 5467
4b4deea2 5468 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
d6aa1876
SM
5469 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5470
4b4deea2 5471 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
9d794026
GM
5472 doc: /* Non-nil if Abbrev mode is enabled.
5473Use the command `abbrev-mode' to change this variable. */);
1ab256cb 5474
4b4deea2 5475 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
7ee72033 5476 Qnil,
efc7e75f 5477 doc: /* *Non-nil if searches and matches should ignore case. */);
1ab256cb 5478
4b4deea2 5479 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
2de9f71c 5480 make_number (LISP_INT_TAG),
1ac5826d 5481 doc: /* *Column beyond which automatic line-wrapping should happen.
f1ccb329 5482Interactively, you can set the buffer local value using \\[set-fill-column]. */);
1ab256cb 5483
4b4deea2 5484 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
2de9f71c 5485 make_number (LISP_INT_TAG),
fc961256 5486 doc: /* *Column for the default `indent-line-function' to indent to.
018ba359 5487Linefeed indents to this column in Fundamental mode. */);
1ab256cb 5488
4b4deea2 5489 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
2de9f71c 5490 make_number (LISP_INT_TAG),
fde4eb86
CY
5491 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5492This should be an integer greater than zero. */);
1ab256cb 5493
4b4deea2 5494 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
efc7e75f 5495 doc: /* *Non-nil means display control chars with uparrow.
018ba359
PJ
5496A value of nil means use backslash and octal digits.
5497This variable does not apply to characters whose display is specified
5498in the current display table (if there is one). */);
1ab256cb 5499
3b06f880 5500 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
4b4deea2 5501 &BVAR (current_buffer, enable_multibyte_characters),
a9b9a780 5502 Qnil,
efc7e75f 5503 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
018ba359
PJ
5504Otherwise they are regarded as unibyte. This affects the display,
5505file I/O and the behavior of various editing commands.
5506
5507This variable is buffer-local but you cannot set it directly;
5508use the function `set-buffer-multibyte' to change a buffer's representation.
5509Changing its default value with `setq-default' is supported.
5510See also variable `default-enable-multibyte-characters' and Info node
5511`(elisp)Text Representations'. */);
d67b4f80 5512 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
3b06f880 5513
c71b5d9b 5514 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
4b4deea2 5515 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
efc7e75f 5516 doc: /* Coding system to be used for encoding the buffer contents on saving.
018ba359
PJ
5517This variable applies to saving the buffer, and also to `write-region'
5518and other functions that use `write-region'.
5519It does not apply to sending output to subprocesses, however.
5520
5521If this is nil, the buffer is saved without any code conversion
5522unless some coding system is specified in `file-coding-system-alist'
5523for the buffer file.
5524
31a6cb06
EZ
5525If the text to be saved cannot be encoded as specified by this variable,
5526an alternative encoding is selected by `select-safe-coding-system', which see.
5527
018ba359
PJ
5528The variable `coding-system-for-write', if non-nil, overrides this variable.
5529
5530This variable is never applied to a way of decoding a file while reading it. */);
c71b5d9b 5531
f44e260c 5532 DEFVAR_PER_BUFFER ("bidi-display-reordering",
4b4deea2 5533 &BVAR (current_buffer, bidi_display_reordering), Qnil,
938efb77 5534 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
3b06f880 5535
6c0cf218 5536 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
4b4deea2 5537 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
b44d9321 5538 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
b4bf28b7 5539
b44d9321
EZ
5540If this is nil (the default), the direction of each paragraph is
5541determined by the first strong directional character of its text.
5542The values of `right-to-left' and `left-to-right' override that.
5543Any other value is treated as nil.
b4bf28b7 5544
b44d9321
EZ
5545This variable has no effect unless the buffer's value of
5546\`bidi-display-reordering' is non-nil. */);
5547
4b4deea2 5548 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
7614d762
RS
5549 doc: /* *Non-nil means do not display continuation lines.
5550Instead, give each line of text just one screen line.
018ba359
PJ
5551
5552Note that this is overridden by the variable
5553`truncate-partial-width-windows' if that variable is non-nil
5554and this buffer is not full-frame width. */);
1ab256cb 5555
4b4deea2 5556 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
0858cd02
CY
5557 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5558When word-wrapping is on, continuation lines are wrapped at the space
5559or tab character nearest to the right window edge.
5560If nil, continuation lines are wrapped at the right screen edge.
5561
5562This variable has no effect if long lines are truncated (see
eb577e27
GM
5563`truncate-lines' and `truncate-partial-width-windows'). If you use
5564word-wrapping, you might want to reduce the value of
5565`truncate-partial-width-windows', since wrapping can make text readable
5566in narrower windows. */);
0858cd02 5567
4b4deea2 5568 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
7ee72033 5569 make_number (Lisp_String),
efc7e75f 5570 doc: /* Name of default directory of current buffer. Should end with slash.
018ba359 5571To interactively change the default directory, use command `cd'. */);
1ab256cb 5572
4b4deea2 5573 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
7ee72033 5574 Qnil,
efc7e75f 5575 doc: /* Function called (if non-nil) to perform auto-fill.
018ba359
PJ
5576It is called after self-inserting any character specified in
5577the `auto-fill-chars' table.
5578NOTE: This variable is not a hook;
5579its value may not be a list of functions. */);
1ab256cb 5580
4b4deea2 5581 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
7ee72033 5582 make_number (Lisp_String),
efc7e75f 5583 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
1ab256cb 5584
4b4deea2 5585 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
7ee72033 5586 make_number (Lisp_String),
efc7e75f 5587 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
018ba359
PJ
5588The truename of a file is calculated by `file-truename'
5589and then abbreviated with `abbreviate-file-name'. */);
f6ed2e84 5590
1ab256cb 5591 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
4b4deea2 5592 &BVAR (current_buffer, auto_save_file_name),
7ee72033 5593 make_number (Lisp_String),
7614d762
RS
5594 doc: /* Name of file for auto-saving current buffer.
5595If it is nil, that means don't auto-save this buffer. */);
1ab256cb 5596
4b4deea2 5597 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
efc7e75f 5598 doc: /* Non-nil if this buffer is read-only. */);
1ab256cb 5599
4b4deea2 5600 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
efc7e75f 5601 doc: /* Non-nil if this buffer's file has been backed up.
018ba359 5602Backing up is done before the first time the file is saved. */);
1ab256cb 5603
4b4deea2 5604 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
2de9f71c 5605 make_number (LISP_INT_TAG),
efc7e75f 5606 doc: /* Length of current buffer when last read in, saved or auto-saved.
4be941e3
RS
56070 initially.
5608-1 means auto-saving turned off until next real save.
5609
5610If you set this to -2, that means don't turn off auto-saving in this buffer
5611if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5612you probably should set this to -2 in that buffer. */);
1ab256cb 5613
4b4deea2 5614 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
7ee72033 5615 Qnil,
7614d762 5616 doc: /* Non-nil enables selective display.
a66f285a
JB
5617An integer N as value means display only lines
5618that start with less than N columns of space.
7614d762
RS
5619A value of t means that the character ^M makes itself and
5620all the rest of the line invisible; also, when saving the buffer
5621in a file, save the ^M as a newline. */);
1ab256cb
RM
5622
5623#ifndef old
5624 DEFVAR_PER_BUFFER ("selective-display-ellipses",
4b4deea2 5625 &BVAR (current_buffer, selective_display_ellipses),
7ee72033 5626 Qnil,
3f676284 5627 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
1ab256cb
RM
5628#endif
5629
4b4deea2 5630 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
efc7e75f 5631 doc: /* Non-nil if self-insertion should replace existing text.
018ba359
PJ
5632The value should be one of `overwrite-mode-textual',
5633`overwrite-mode-binary', or nil.
5634If it is `overwrite-mode-textual', self-insertion still
5635inserts at the end of a line, and inserts when point is before a tab,
5636until the tab is filled in.
5637If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5638
4b4deea2 5639 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
7ee72033 5640 Qnil,
efc7e75f 5641 doc: /* Display table that controls display of the contents of current buffer.
018ba359
PJ
5642
5643If this variable is nil, the value of `standard-display-table' is used.
5644Each window can have its own, overriding display table, see
5645`set-window-display-table' and `window-display-table'.
5646
5647The display table is a char-table created with `make-display-table'.
5648A char-table is an array indexed by character codes. Normal array
5649primitives `aref' and `aset' can be used to access elements of a char-table.
5650
5651Each of the char-table elements control how to display the corresponding
5652text character: the element at index C in the table says how to display
5653the character whose code is C. Each element should be a vector of
426a9163
JB
5654characters or nil. The value nil means display the character in the
5655default fashion; otherwise, the characters from the vector are delivered
5656to the screen instead of the original character.
018ba359 5657
5fd11dc8 5658For example, (aset buffer-display-table ?X [?Y]) tells Emacs
adbb3b05 5659to display a capital Y instead of each X character.
018ba359
PJ
5660
5661In addition, a char-table has six extra slots to control the display of:
5662
5663 the end of a truncated screen line (extra-slot 0, a single character);
5664 the end of a continued line (extra-slot 1, a single character);
5665 the escape character used to display character codes in octal
5666 (extra-slot 2, a single character);
5667 the character used as an arrow for control characters (extra-slot 3,
5668 a single character);
5669 the decoration indicating the presence of invisible lines (extra-slot 4,
5670 a vector of characters);
5671 the character used to draw the border between side-by-side windows
5672 (extra-slot 5, a single character).
5673
5674See also the functions `display-table-slot' and `set-display-table-slot'. */);
1ab256cb 5675
4b4deea2 5676 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
7ee72033 5677 Qnil,
efc7e75f 5678 doc: /* *Width of left marginal area for display of a buffer.
018ba359 5679A value of nil means no marginal area. */);
177c0ea7 5680
4b4deea2 5681 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
7ee72033 5682 Qnil,
efc7e75f 5683 doc: /* *Width of right marginal area for display of a buffer.
018ba359 5684A value of nil means no marginal area. */);
177c0ea7 5685
4b4deea2 5686 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
2ad8731a
KS
5687 Qnil,
5688 doc: /* *Width of this buffer's left fringe (in pixels).
5689A value of 0 means no left fringe is shown in this buffer's window.
5690A value of nil means to use the left fringe width from the window's frame. */);
5691
4b4deea2 5692 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
2ad8731a
KS
5693 Qnil,
5694 doc: /* *Width of this buffer's right fringe (in pixels).
5695A value of 0 means no right fringe is shown in this buffer's window.
5696A value of nil means to use the right fringe width from the window's frame. */);
5697
4b4deea2 5698 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
2ad8731a
KS
5699 Qnil,
5700 doc: /* *Non-nil means to display fringes outside display margins.
5701A value of nil means to display fringes between margins and buffer text. */);
5702
4b4deea2 5703 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
2ad8731a
KS
5704 Qnil,
5705 doc: /* *Width of this buffer's scroll bars in pixels.
5706A value of nil means to use the scroll bar width from the window's frame. */);
5707
4b4deea2 5708 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
2ad8731a
KS
5709 Qnil,
5710 doc: /* *Position of this buffer's vertical scroll bar.
7c6b2007 5711The value takes effect whenever you tell a window to display this buffer;
188577ce 5712for instance, with `set-window-buffer' or when `display-buffer' displays it.
7c6b2007 5713
fc2c8887
RS
5714A value of `left' or `right' means put the vertical scroll bar at that side
5715of the window; a value of nil means don't show any vertical scroll bars.
5716A value of t (the default) means do whatever the window's frame specifies. */);
2ad8731a 5717
0552666b 5718 DEFVAR_PER_BUFFER ("indicate-empty-lines",
4b4deea2 5719 &BVAR (current_buffer, indicate_empty_lines), Qnil,
efc7e75f 5720 doc: /* *Visually indicate empty lines after the buffer end.
018ba359
PJ
5721If non-nil, a bitmap is displayed in the left fringe of a window on
5722window-systems. */);
177c0ea7 5723
6b61353c 5724 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
4b4deea2 5725 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
6b61353c
KH
5726 doc: /* *Visually indicate buffer boundaries and scrolling.
5727If non-nil, the first and last line of the buffer are marked in the fringe
5728of a window on window-systems with angle bitmaps, or if the window can be
5729scrolled, the top and bottom line of the window are marked with up and down
5730arrow bitmaps.
b2229037
KS
5731
5732If value is a symbol `left' or `right', both angle and arrow bitmaps
79e3497d 5733are displayed in the left or right fringe, resp. Any other value
845a78b4 5734that doesn't look like an alist means display the angle bitmaps in
79e3497d 5735the left fringe but no arrows.
b2229037 5736
79e3497d
RS
5737You can exercise more precise control by using an alist as the
5738value. Each alist element (INDICATOR . POSITION) specifies
5739where to show one of the indicators. INDICATOR is one of `top',
b2229037
KS
5740`bottom', `up', `down', or t, which specifies the default position,
5741and POSITION is one of `left', `right', or nil, meaning do not show
5742this indicator.
5743
5744For example, ((top . left) (t . right)) places the top angle bitmap in
5745left fringe, the bottom angle bitmap in right fringe, and both arrow
6b61353c 5746bitmaps in right fringe. To show just the angle bitmaps in the left
b2229037 5747fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
6b61353c 5748
c6a46372 5749 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
4b4deea2 5750 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
c6a46372
KS
5751 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5752The value is an alist where each element (INDICATOR . BITMAPS)
5753specifies the fringe bitmaps used to display a specific logical
5754fringe indicator.
5755
5756INDICATOR specifies the logical indicator type which is one of the
5757following symbols: `truncation' , `continuation', `overlay-arrow',
14fb5704 5758`top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
c6a46372 5759
14fb5704 5760BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
c6a46372
KS
5761the actual bitmap shown in the left or right fringe for the logical
5762indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5763right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
14fb5704
JB
5764are used only for the `bottom' and `top-bottom' indicators when the
5765last (only) line has no final newline. BITMAPS may also be a single
c6a46372
KS
5766symbol which is used in both left and right fringes. */);
5767
5768 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
4b4deea2 5769 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
c6a46372
KS
5770 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5771The value is an alist where each element (CURSOR . BITMAP)
5772specifies the fringe bitmaps used to display a specific logical
5773cursor type in the fringe.
5774
5775CURSOR specifies the logical cursor type which is one of the following
5776symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5777one is used to show a hollow cursor on narrow lines display lines
5778where the normal hollow cursor will not fit.
5779
5780BITMAP is the corresponding fringe bitmap shown for the logical
5781cursor type. */);
5782
0552666b 5783 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
4b4deea2 5784 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
4e0692c1
RS
5785 doc: /* How far to scroll windows upward.
5786If you move point off the bottom, the window scrolls automatically.
426a9163 5787This variable controls how far it scrolls. The value nil, the default,
4e0692c1
RS
5788means scroll to center point. A fraction means scroll to put point
5789that fraction of the window's height from the bottom of the window.
d765e3a3
JB
5790When the value is 0.0, point goes at the bottom line, which in the
5791simple case that you moved off with C-f means scrolling just one line.
57921.0 means point goes at the top, so that in that simple case, the
5793window scrolls by a full window height. Meaningful values are
175e9712 5794between 0.0 and 1.0, inclusive. */);
177c0ea7 5795
0552666b 5796 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
4b4deea2 5797 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
4e0692c1
RS
5798 doc: /* How far to scroll windows downward.
5799If you move point off the top, the window scrolls automatically.
426a9163 5800This variable controls how far it scrolls. The value nil, the default,
4e0692c1
RS
5801means scroll to center point. A fraction means scroll to put point
5802that fraction of the window's height from the top of the window.
d765e3a3
JB
5803When the value is 0.0, point goes at the top line, which in the
5804simple case that you moved off with C-b means scrolling just one line.
58051.0 means point goes at the bottom, so that in that simple case, the
5806window scrolls by a full window height. Meaningful values are
175e9712 5807between 0.0 and 1.0, inclusive. */);
177c0ea7 5808
1ab256cb
RM
5809/*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5810 "Don't ask.");
5811*/
1ab256cb 5812
29208e82 5813 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
7ee72033 5814 doc: /* List of functions to call before each text change.
018ba359
PJ
5815Two arguments are passed to each function: the positions of
5816the beginning and end of the range of old text to be changed.
5817\(For an insertion, the beginning and end are at the same place.)
5818No information is given about the length of the text after the change.
5819
5820Buffer changes made while executing the `before-change-functions'
5821don't call any before-change or after-change functions.
7b2bf907 5822That's because `inhibit-modification-hooks' is temporarily set non-nil.
018ba359
PJ
5823
5824If an unhandled error happens in running these functions,
5825the variable's value remains nil. That prevents the error
5826from happening repeatedly and making Emacs nonfunctional. */);
5f079267
RS
5827 Vbefore_change_functions = Qnil;
5828
29208e82 5829 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
eacdfade 5830 doc: /* List of functions to call after each text change.
018ba359
PJ
5831Three arguments are passed to each function: the positions of
5832the beginning and end of the range of changed text,
5833and the length in bytes of the pre-change text replaced by that range.
5834\(For an insertion, the pre-change length is zero;
5835for a deletion, that length is the number of bytes deleted,
5836and the post-change beginning and end are at the same place.)
5837
5838Buffer changes made while executing the `after-change-functions'
5839don't call any before-change or after-change functions.
7b2bf907 5840That's because `inhibit-modification-hooks' is temporarily set non-nil.
018ba359
PJ
5841
5842If an unhandled error happens in running these functions,
5843the variable's value remains nil. That prevents the error
5844from happening repeatedly and making Emacs nonfunctional. */);
5f079267
RS
5845 Vafter_change_functions = Qnil;
5846
29208e82 5847 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
efc7e75f 5848 doc: /* A list of functions to call before changing a buffer which is unmodified.
018ba359 5849The functions are run using the `run-hooks' function. */);
dbc4e1c1 5850 Vfirst_change_hook = Qnil;
1ab256cb 5851
4b4deea2 5852 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
7ee72033 5853 doc: /* List of undo entries in current buffer.
018ba359
PJ
5854Recent changes come first; older changes follow newer.
5855
5856An entry (BEG . END) represents an insertion which begins at
5857position BEG and ends at position END.
5858
5859An entry (TEXT . POSITION) represents the deletion of the string TEXT
5860from (abs POSITION). If POSITION is positive, point was at the front
5861of the text being deleted; if negative, point was at the end.
5862
5863An entry (t HIGH . LOW) indicates that the buffer previously had
5864\"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5865of the visited file's modification time, as of that time. If the
5866modification time of the most recent save is different, this entry is
5867obsolete.
5868
5869An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5870was modified between BEG and END. PROPERTY is the property name,
5871and VALUE is the old value.
5872
7405f386
KS
5873An entry (apply FUN-NAME . ARGS) means undo the change with
5874\(apply FUN-NAME ARGS).
5875
5876An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5877in the active region. BEG and END is the range affected by this entry
5878and DELTA is the number of bytes added or deleted in that range by
5879this change.
c6c7dc03 5880
018ba359
PJ
5881An entry (MARKER . DISTANCE) indicates that the marker MARKER
5882was adjusted in position by the offset DISTANCE (an integer).
5883
5884An entry of the form POSITION indicates that point was at the buffer
5885location given by the integer. Undoing an entry of this form places
5886point at POSITION.
5887
b4c4f2f4
JB
5888Entries with value `nil' mark undo boundaries. The undo command treats
5889the changes between two undo boundaries as a single step to be undone.
018ba359
PJ
5890
5891If the value of the variable is t, undo information is not recorded. */);
5892
4b4deea2 5893 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
7ee72033 5894 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
018ba359 5895
4b4deea2 5896 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
7ee72033 5897 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
018ba359
PJ
5898
5899Normally, the line-motion functions work by scanning the buffer for
5629f29b
DK
5900newlines. Columnar operations (like `move-to-column' and
5901`compute-motion') also work by scanning the buffer, summing character
018ba359
PJ
5902widths as they go. This works well for ordinary text, but if the
5903buffer's lines are very long (say, more than 500 characters), these
5904motion functions will take longer to execute. Emacs may also take
5905longer to update the display.
5906
5629f29b 5907If `cache-long-line-scans' is non-nil, these motion functions cache the
018ba359
PJ
5908results of their scans, and consult the cache to avoid rescanning
5909regions of the buffer until the text is modified. The caches are most
5910beneficial when they prevent the most searching---that is, when the
5911buffer contains long lines and large regions of characters with the
5912same, fixed screen width.
5913
5629f29b 5914When `cache-long-line-scans' is non-nil, processing short lines will
018ba359
PJ
5915become slightly slower (because of the overhead of consulting the
5916cache), and the caches will use memory roughly proportional to the
5917number of newlines and characters whose screen width varies.
5918
5919The caches require no explicit maintenance; their accuracy is
5920maintained internally by the Emacs primitives. Enabling or disabling
5921the cache should not affect the behavior of any of the motion
5922functions; it should only affect their performance. */);
5923
4b4deea2 5924 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
7ee72033 5925 doc: /* Value of point before the last series of scroll operations, or nil. */);
018ba359 5926
4b4deea2 5927 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
7ee72033 5928 doc: /* List of formats to use when saving this buffer.
018ba359 5929Formats are defined by `format-alist'. This variable is
a9b9a780 5930set when a file is visited. */);
be9aafdd 5931
71ed49fa 5932 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
4b4deea2 5933 &BVAR (current_buffer, auto_save_file_format), Qnil,
71ed49fa
LT
5934 doc: /* *Format in which to write auto-save files.
5935Should be a list of symbols naming formats that are defined in `format-alist'.
5936If it is t, which is the default, auto-save files are written in the
5937same format as a regular save would use. */);
5938
3cb719bd 5939 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
4b4deea2 5940 &BVAR (current_buffer, invisibility_spec), Qnil,
7ee72033 5941 doc: /* Invisibility spec of this buffer.
018ba359
PJ
5942The default is t, which means that text is invisible
5943if it has a non-nil `invisible' property.
5944If the value is a list, a text character is invisible if its `invisible'
b49dd850 5945property is an element in that list (or is a list with members in common).
018ba359
PJ
5946If an element is a cons cell of the form (PROP . ELLIPSIS),
5947then characters with property value PROP are invisible,
5948and they have an ellipsis as well if ELLIPSIS is non-nil. */);
3cb719bd 5949
7962a441 5950 DEFVAR_PER_BUFFER ("buffer-display-count",
4b4deea2 5951 &BVAR (current_buffer, display_count), Qnil,
7ee72033 5952 doc: /* A number incremented each time this buffer is displayed in a window.
018ba359 5953The function `set-window-buffer' increments it. */);
3fd364db
RS
5954
5955 DEFVAR_PER_BUFFER ("buffer-display-time",
4b4deea2 5956 &BVAR (current_buffer, display_time), Qnil,
7ee72033 5957 doc: /* Time stamp updated each time this buffer is displayed in a window.
018ba359
PJ
5958The function `set-window-buffer' updates this variable
5959to the value obtained by calling `current-time'.
5960If the buffer has never been shown in a window, the value is nil. */);
5961
29208e82 5962 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
9d794026
GM
5963 doc: /* Non-nil if Transient Mark mode is enabled.
5964See the command `transient-mark-mode' for a description of this minor mode.
5965
5966Non-nil also enables highlighting of the region whenever the mark is active.
5967The variable `highlight-nonselected-windows' controls whether to highlight
5968all windows or just the selected window.
5969
f49d1f52 5970Lisp programs may give this variable certain special values:
9d794026 5971
f49d1f52
SM
5972- A value of `lambda' enables Transient Mark mode temporarily.
5973 It is disabled again after any subsequent action that would
5974 normally deactivate the mark (e.g. buffer modification).
5975
5976- A value of (only . OLDVAL) enables Transient Mark mode
5977 temporarily. After any subsequent point motion command that is
5978 not shift-translated, or any other action that would normally
5979 deactivate the mark (e.g. buffer modification), the value of
5980 `transient-mark-mode' is set to OLDVAL. */);
c48f61ef
RS
5981 Vtransient_mark_mode = Qnil;
5982
29208e82 5983 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
7ee72033 5984 doc: /* *Non-nil means disregard read-only status of buffers or characters.
018ba359
PJ
5985If the value is t, disregard `buffer-read-only' and all `read-only'
5986text properties. If the value is a list, disregard `buffer-read-only'
5987and disregard a `read-only' text property if the property value
5988is a member of the list. */);
a96b68f1
RS
5989 Vinhibit_read_only = Qnil;
5990
4b4deea2 5991 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
f6e22881 5992 doc: /* Cursor to use when this buffer is in the selected window.
018ba359
PJ
5993Values are interpreted as follows:
5994
b8dc613f
JB
5995 t use the cursor specified for the frame
5996 nil don't display a cursor
5997 box display a filled box cursor
5998 hollow display a hollow box cursor
5999 bar display a vertical bar cursor with default width
6000 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6001 hbar display a horizontal bar cursor with default height
b4234f4c 6002 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
b8dc613f 6003 ANYTHING ELSE display a hollow box cursor
cd8d5236 6004
e08b1705
MR
6005When the buffer is displayed in a non-selected window, the
6006cursor's appearance is instead controlled by the variable
6007`cursor-in-non-selected-windows'. */);
bb2ec976 6008
a3bbced0 6009 DEFVAR_PER_BUFFER ("line-spacing",
4b4deea2 6010 &BVAR (current_buffer, extra_line_spacing), Qnil,
7ee72033 6011 doc: /* Additional space to put between lines when displaying a buffer.
3ba010e5
EZ
6012The space is measured in pixels, and put below lines on graphic displays,
6013see `display-graphic-p'.
60ebfdf3 6014If value is a floating point number, it specifies the spacing relative
fc961256 6015to the default frame line height. A value of nil means add no extra space. */);
a3bbced0 6016
0124c5bd 6017 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
4b4deea2 6018 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
66c6abf0
GM
6019 doc: /* *Non-nil means show a cursor in non-selected windows.
6020If nil, only shows a cursor in the selected window.
6021If t, displays a cursor related to the usual cursor type
6022\(a solid box becomes hollow, a bar becomes a narrower bar).
6023You can also specify the cursor type as in the `cursor-type' variable.
6024Use Custom to set this variable and update the display." */);
0124c5bd 6025
29208e82 6026 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
f6e22881
JB
6027 doc: /* List of functions called with no args to query before killing a buffer.
6028The buffer being killed will be current while the functions are running.
6029If any of them returns nil, the buffer is not killed. */);
dcdffbf6
RS
6030 Vkill_buffer_query_functions = Qnil;
6031
29208e82 6032 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
43ed3b8d
CY
6033 doc: /* Normal hook run before changing the major mode of a buffer.
6034The function `kill-all-local-variables' runs this before doing anything else. */);
6035 Vchange_major_mode_hook = Qnil;
cd3520a4 6036 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
43ed3b8d 6037
9397e56f
MR
6038 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6039 doc: /* Hook run when the buffer list changes.
6040Functions running this hook are `get-buffer-create',
6041`make-indirect-buffer', `rename-buffer', `kill-buffer',
6042`record-buffer' and `unrecord-buffer'. */);
6043 Vbuffer_list_update_hook = Qnil;
cd3520a4 6044 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
9397e56f 6045
0dc88e60 6046 defsubr (&Sbuffer_live_p);
1ab256cb
RM
6047 defsubr (&Sbuffer_list);
6048 defsubr (&Sget_buffer);
6049 defsubr (&Sget_file_buffer);
6050 defsubr (&Sget_buffer_create);
336cd056 6051 defsubr (&Smake_indirect_buffer);
01050cb5 6052 defsubr (&Sgenerate_new_buffer_name);
1ab256cb
RM
6053 defsubr (&Sbuffer_name);
6054/*defsubr (&Sbuffer_number);*/
6055 defsubr (&Sbuffer_file_name);
336cd056 6056 defsubr (&Sbuffer_base_buffer);
79aa712d 6057 defsubr (&Sbuffer_local_value);
1ab256cb
RM
6058 defsubr (&Sbuffer_local_variables);
6059 defsubr (&Sbuffer_modified_p);
6060 defsubr (&Sset_buffer_modified_p);
6061 defsubr (&Sbuffer_modified_tick);
3e145152 6062 defsubr (&Sbuffer_chars_modified_tick);
1ab256cb
RM
6063 defsubr (&Srename_buffer);
6064 defsubr (&Sother_buffer);
1ab256cb
RM
6065 defsubr (&Sbuffer_enable_undo);
6066 defsubr (&Skill_buffer);
9397e56f
MR
6067 defsubr (&Srecord_buffer);
6068 defsubr (&Sunrecord_buffer);
a9ee7a59 6069 defsubr (&Sset_buffer_major_mode);
1ab256cb
RM
6070 defsubr (&Scurrent_buffer);
6071 defsubr (&Sset_buffer);
6072 defsubr (&Sbarf_if_buffer_read_only);
3ac81adb 6073 defsubr (&Serase_buffer);
13cda5f9 6074 defsubr (&Sbuffer_swap_text);
3ac81adb 6075 defsubr (&Sset_buffer_multibyte);
1ab256cb 6076 defsubr (&Skill_all_local_variables);
2eec3b4e 6077
52f8ec73 6078 defsubr (&Soverlayp);
2eec3b4e
RS
6079 defsubr (&Smake_overlay);
6080 defsubr (&Sdelete_overlay);
6081 defsubr (&Smove_overlay);
8ebafa8d
JB
6082 defsubr (&Soverlay_start);
6083 defsubr (&Soverlay_end);
6084 defsubr (&Soverlay_buffer);
6085 defsubr (&Soverlay_properties);
2eec3b4e 6086 defsubr (&Soverlays_at);
74514898 6087 defsubr (&Soverlays_in);
2eec3b4e 6088 defsubr (&Snext_overlay_change);
239c932b 6089 defsubr (&Sprevious_overlay_change);
2eec3b4e
RS
6090 defsubr (&Soverlay_recenter);
6091 defsubr (&Soverlay_lists);
6092 defsubr (&Soverlay_get);
6093 defsubr (&Soverlay_put);
a8c21b48 6094 defsubr (&Srestore_buffer_modified_p);
1ab256cb
RM
6095}
6096
dfcf069d 6097void
d3da34e0 6098keys_of_buffer (void)
1ab256cb
RM
6099{
6100 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6101 initial_define_key (control_x_map, 'k', "kill-buffer");
4158c17d
RM
6102
6103 /* This must not be in syms_of_buffer, because Qdisabled is not
6104 initialized when that function gets called. */
d67b4f80 6105 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);
1ab256cb 6106}