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