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