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