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