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