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