(syms_of_eval): Doc fix.
[bpt/emacs.git] / src / buffer.c
CommitLineData
1ab256cb 1/* Buffer manipulation primitives for GNU Emacs.
99a8b2d2 2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995, 1997
c922bc55 3 Free Software Foundation, Inc.
1ab256cb
RM
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
c922bc55 9the Free Software Foundation; either version 2, or (at your option)
1ab256cb
RM
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
1ab256cb
RM
21
22
2381d133
JB
23#include <sys/types.h>
24#include <sys/stat.h>
1ab256cb
RM
25#include <sys/param.h>
26
27#ifndef MAXPATHLEN
28/* in 4.1, param.h fails to define this. */
29#define MAXPATHLEN 1024
30#endif /* not MAXPATHLEN */
31
18160b98 32#include <config.h>
1ab256cb 33#include "lisp.h"
21cf4cf8 34#include "intervals.h"
1ab256cb
RM
35#include "window.h"
36#include "commands.h"
37#include "buffer.h"
3b06f880 38#include "charset.h"
28e969dd 39#include "region-cache.h"
1ab256cb 40#include "indent.h"
d014bf88 41#include "blockinput.h"
08460cd4 42#include "frame.h"
1ab256cb
RM
43
44struct buffer *current_buffer; /* the current buffer */
45
46/* First buffer in chain of all buffers (in reverse order of creation).
47 Threaded through ->next. */
48
49struct buffer *all_buffers;
50
51/* This structure holds the default values of the buffer-local variables
52 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
53 The default value occupies the same slot in this structure
54 as an individual buffer's value occupies in that buffer.
55 Setting the default value also goes through the alist of buffers
56 and stores into each buffer that does not say it has a local value. */
57
58struct buffer buffer_defaults;
59
60/* A Lisp_Object pointer to the above, used for staticpro */
61
62static Lisp_Object Vbuffer_defaults;
63
64/* This structure marks which slots in a buffer have corresponding
65 default values in buffer_defaults.
66 Each such slot has a nonzero value in this structure.
67 The value has only one nonzero bit.
68
69 When a buffer has its own local value for a slot,
70 the bit for that slot (found in the same slot in this structure)
71 is turned on in the buffer's local_var_flags slot.
72
73 If a slot in this structure is -1, then even though there may
74 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
75 and the corresponding slot in buffer_defaults is not used.
76
77 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
78 but there is a default value which is copied into each buffer.
79
80 If a slot in this structure is negative, then even though there may
81 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
82 and the corresponding slot in buffer_defaults is not used.
83
84 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
85 zero, that is a bug */
86
87struct buffer buffer_local_flags;
88
89/* This structure holds the names of symbols whose values may be
90 buffer-local. It is indexed and accessed in the same way as the above. */
91
92struct buffer buffer_local_symbols;
93/* A Lisp_Object pointer to the above, used for staticpro */
94static Lisp_Object Vbuffer_local_symbols;
95
0fa3ba92
JB
96/* This structure holds the required types for the values in the
97 buffer-local slots. If a slot contains Qnil, then the
98 corresponding buffer slot may contain a value of any type. If a
99 slot contains an integer, then prospective values' tags must be
100 equal to that integer. When a tag does not match, the function
101 buffer_slot_type_mismatch will signal an error. */
102struct buffer buffer_local_types;
103
13de9290
RS
104/* Flags indicating which built-in buffer-local variables
105 are permanent locals. */
106static int buffer_permanent_local_flags;
107
1ab256cb 108Lisp_Object Fset_buffer ();
01050cb5 109void set_buffer_internal ();
c7aa5005 110void set_buffer_internal_1 ();
173f2a64 111static void call_overlay_mod_hooks ();
2f3f993b 112static void swap_out_buffer_local_variables ();
13de9290 113static void reset_buffer_local_variables ();
1ab256cb
RM
114
115/* Alist of all buffer names vs the buffers. */
116/* This used to be a variable, but is no longer,
117 to prevent lossage due to user rplac'ing this alist or its elements. */
118Lisp_Object Vbuffer_alist;
119
120/* Functions to call before and after each text change. */
121Lisp_Object Vbefore_change_function;
122Lisp_Object Vafter_change_function;
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;
136
dbc4e1c1
JB
137/* List of functions to call before changing an unmodified buffer. */
138Lisp_Object Vfirst_change_hook;
22378665 139
dbc4e1c1 140Lisp_Object Qfirst_change_hook;
22378665
RS
141Lisp_Object Qbefore_change_functions;
142Lisp_Object Qafter_change_functions;
1ab256cb
RM
143
144Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
145
146Lisp_Object Qprotected_field;
147
148Lisp_Object QSFundamental; /* A string "Fundamental" */
149
150Lisp_Object Qkill_buffer_hook;
151
5fe0b67e
RS
152Lisp_Object Qget_file_buffer;
153
52f8ec73
JB
154Lisp_Object Qoverlayp;
155
bbbe9545 156Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
5985d248 157
294d215f
RS
158Lisp_Object Qmodification_hooks;
159Lisp_Object Qinsert_in_front_hooks;
160Lisp_Object Qinsert_behind_hooks;
161
1ab256cb
RM
162/* For debugging; temporary. See set_buffer_internal. */
163/* Lisp_Object Qlisp_mode, Vcheck_symbol; */
164
165nsberror (spec)
166 Lisp_Object spec;
167{
a7a60ce9 168 if (STRINGP (spec))
1ab256cb
RM
169 error ("No buffer named %s", XSTRING (spec)->data);
170 error ("Invalid buffer argument");
171}
172\f
0dc88e60
RS
173DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
174 "Return non-nil if OBJECT is a buffer which has not been killed.\n\
175Value is nil if OBJECT is not a buffer or if it has been killed.")
176 (object)
177 Lisp_Object object;
178{
179 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
180 ? Qt : Qnil);
181}
182
08460cd4
RS
183DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
184 "Return a list of all existing live buffers.\n\
185If the optional arg FRAME is a frame, we return that frame's buffer list.")
186 (frame)
187 Lisp_Object frame;
1ab256cb 188{
08460cd4
RS
189 Lisp_Object framelist, general;
190 general = Fmapcar (Qcdr, Vbuffer_alist);
191
192 if (FRAMEP (frame))
193 {
194 Lisp_Object tail;
195
196 CHECK_FRAME (frame, 1);
197
198 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
199
200 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
201 tail = framelist;
202 while (! NILP (tail))
203 {
204 general = Fdelq (XCONS (tail)->car, general);
205 tail = XCONS (tail)->cdr;
206 }
207 return nconc2 (framelist, general);
208 }
209
210 return general;
1ab256cb
RM
211}
212
04ae1b48
RS
213/* Like Fassoc, but use Fstring_equal to compare
214 (which ignores text properties),
215 and don't ever QUIT. */
216
217static Lisp_Object
218assoc_ignore_text_properties (key, list)
219 register Lisp_Object key;
220 Lisp_Object list;
221{
222 register Lisp_Object tail;
223 for (tail = list; !NILP (tail); tail = Fcdr (tail))
224 {
225 register Lisp_Object elt, tem;
226 elt = Fcar (tail);
227 tem = Fstring_equal (Fcar (elt), key);
228 if (!NILP (tem))
229 return elt;
230 }
231 return Qnil;
232}
233
1ab256cb
RM
234DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
235 "Return the buffer named NAME (a string).\n\
236If there is no live buffer named NAME, return nil.\n\
237NAME may also be a buffer; if so, the value is that buffer.")
238 (name)
239 register Lisp_Object name;
240{
a7a60ce9 241 if (BUFFERP (name))
1ab256cb
RM
242 return name;
243 CHECK_STRING (name, 0);
244
04ae1b48 245 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
1ab256cb
RM
246}
247
248DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
249 "Return the buffer visiting file FILENAME (a string).\n\
92194d02 250The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
11da5363
RS
251If there is no such live buffer, return nil.\n\
252See also `find-buffer-visiting'.")
1ab256cb
RM
253 (filename)
254 register Lisp_Object filename;
255{
256 register Lisp_Object tail, buf, tem;
5fe0b67e
RS
257 Lisp_Object handler;
258
1ab256cb
RM
259 CHECK_STRING (filename, 0);
260 filename = Fexpand_file_name (filename, Qnil);
261
5fe0b67e
RS
262 /* If the file name has special constructs in it,
263 call the corresponding file handler. */
a617e913 264 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
5fe0b67e
RS
265 if (!NILP (handler))
266 return call2 (handler, Qget_file_buffer, filename);
267
1ab256cb
RM
268 for (tail = Vbuffer_alist; CONSP (tail); tail = XCONS (tail)->cdr)
269 {
270 buf = Fcdr (XCONS (tail)->car);
a7a60ce9
KH
271 if (!BUFFERP (buf)) continue;
272 if (!STRINGP (XBUFFER (buf)->filename)) continue;
1ab256cb 273 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
265a9e55 274 if (!NILP (tem))
1ab256cb
RM
275 return buf;
276 }
277 return Qnil;
278}
279
52e01189
RS
280Lisp_Object
281get_truename_buffer (filename)
282 register Lisp_Object filename;
283{
284 register Lisp_Object tail, buf, tem;
285
286 for (tail = Vbuffer_alist; CONSP (tail); tail = XCONS (tail)->cdr)
287 {
288 buf = Fcdr (XCONS (tail)->car);
289 if (!BUFFERP (buf)) continue;
290 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
291 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
292 if (!NILP (tem))
293 return buf;
294 }
295 return Qnil;
296}
297
1ab256cb
RM
298/* Incremented for each buffer created, to assign the buffer number. */
299int buffer_count;
300
301DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
302 "Return the buffer named NAME, or create such a buffer and return it.\n\
303A new buffer is created if there is no live buffer named NAME.\n\
b44895bc 304If NAME starts with a space, the new buffer does not keep undo information.\n\
1ab256cb
RM
305If NAME is a buffer instead of a string, then it is the value returned.\n\
306The value is never nil.")
307 (name)
308 register Lisp_Object name;
309{
a9ee7a59 310 register Lisp_Object buf;
1ab256cb
RM
311 register struct buffer *b;
312
313 buf = Fget_buffer (name);
265a9e55 314 if (!NILP (buf))
1ab256cb
RM
315 return buf;
316
31cd83e9
KH
317 if (XSTRING (name)->size == 0)
318 error ("Empty string for buffer name is not allowed");
319
9ac0d9e0 320 b = (struct buffer *) xmalloc (sizeof (struct buffer));
1ab256cb 321
336cd056
RS
322 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
323
324 /* An ordinary buffer uses its own struct buffer_text. */
325 b->text = &b->own_text;
326 b->base_buffer = 0;
327
1ab256cb 328 BUF_GAP_SIZE (b) = 20;
9ac0d9e0 329 BLOCK_INPUT;
3b06f880
KH
330 /* We allocate extra 1-byte at the tail and keep it always '\0' for
331 anchoring a search. */
332 BUFFER_ALLOC (BUF_BEG_ADDR (b), (BUF_GAP_SIZE (b) + 1));
9ac0d9e0 333 UNBLOCK_INPUT;
1ab256cb 334 if (! BUF_BEG_ADDR (b))
81841847 335 buffer_memory_full ();
1ab256cb
RM
336
337 BUF_PT (b) = 1;
338 BUF_GPT (b) = 1;
339 BUF_BEGV (b) = 1;
340 BUF_ZV (b) = 1;
341 BUF_Z (b) = 1;
342 BUF_MODIFF (b) = 1;
2509d356 343 BUF_OVERLAY_MODIFF (b) = 1;
336cd056
RS
344 BUF_SAVE_MODIFF (b) = 1;
345 BUF_INTERVALS (b) = 0;
3b06f880 346 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
1ab256cb 347
28e969dd
JB
348 b->newline_cache = 0;
349 b->width_run_cache = 0;
350 b->width_table = Qnil;
351
1ab256cb
RM
352 /* Put this on the chain of all buffers including killed ones. */
353 b->next = all_buffers;
354 all_buffers = b;
355
336cd056
RS
356 /* An ordinary buffer normally doesn't need markers
357 to handle BEGV and ZV. */
358 b->pt_marker = Qnil;
359 b->begv_marker = Qnil;
360 b->zv_marker = Qnil;
04ae1b48
RS
361
362 name = Fcopy_sequence (name);
363 INITIALIZE_INTERVAL (XSTRING (name), NULL_INTERVAL);
1ab256cb 364 b->name = name;
04ae1b48 365
1ab256cb
RM
366 if (XSTRING (name)->data[0] != ' ')
367 b->undo_list = Qnil;
368 else
369 b->undo_list = Qt;
370
371 reset_buffer (b);
13de9290 372 reset_buffer_local_variables (b, 1);
1ab256cb
RM
373
374 /* Put this in the alist of all live buffers. */
67180c6a 375 XSETBUFFER (buf, b);
1ab256cb
RM
376 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
377
378 b->mark = Fmake_marker ();
336cd056
RS
379 BUF_MARKERS (b) = Qnil;
380 b->name = name;
381 return buf;
382}
383
a2428fa2 384DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer, 2, 2,
193c3837 385 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
a2428fa2
EN
386 "Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.\n\
387BASE-BUFFER should be an existing buffer (or buffer name).\n\
9e552710
RS
388NAME should be a string which is not the name of an existing buffer.")
389 (base_buffer, name)
390 register Lisp_Object base_buffer, name;
336cd056
RS
391{
392 register Lisp_Object buf;
393 register struct buffer *b;
394
395 buf = Fget_buffer (name);
396 if (!NILP (buf))
397 error ("Buffer name `%s' is in use", XSTRING (name)->data);
398
399 base_buffer = Fget_buffer (base_buffer);
400 if (NILP (base_buffer))
401 error ("No such buffer: `%s'",
402 XSTRING (XBUFFER (base_buffer)->name)->data);
403
404 if (XSTRING (name)->size == 0)
405 error ("Empty string for buffer name is not allowed");
406
407 b = (struct buffer *) xmalloc (sizeof (struct buffer));
408
409 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
410
411 if (XBUFFER (base_buffer)->base_buffer)
412 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
413 else
414 b->base_buffer = XBUFFER (base_buffer);
415
416 /* Use the base buffer's text object. */
417 b->text = b->base_buffer->text;
418
419 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
420 BUF_ZV (b) = BUF_ZV (b->base_buffer);
421 BUF_PT (b) = BUF_PT (b->base_buffer);
422
423 b->newline_cache = 0;
424 b->width_run_cache = 0;
425 b->width_table = Qnil;
426
427 /* Put this on the chain of all buffers including killed ones. */
428 b->next = all_buffers;
429 all_buffers = b;
430
431 name = Fcopy_sequence (name);
432 INITIALIZE_INTERVAL (XSTRING (name), NULL_INTERVAL);
433 b->name = name;
434
435 reset_buffer (b);
13de9290 436 reset_buffer_local_variables (b, 1);
336cd056
RS
437
438 /* Put this in the alist of all live buffers. */
439 XSETBUFFER (buf, b);
440 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
441
442 b->mark = Fmake_marker ();
1ab256cb 443 b->name = name;
336cd056
RS
444
445 /* Make sure the base buffer has markers for its narrowing. */
446 if (NILP (b->base_buffer->pt_marker))
447 {
448 b->base_buffer->pt_marker = Fmake_marker ();
449 Fset_marker (b->base_buffer->pt_marker,
450 make_number (BUF_PT (b->base_buffer)), base_buffer);
451 }
452 if (NILP (b->base_buffer->begv_marker))
453 {
454 b->base_buffer->begv_marker = Fmake_marker ();
455 Fset_marker (b->base_buffer->begv_marker,
456 make_number (BUF_BEGV (b->base_buffer)), base_buffer);
457 }
458 if (NILP (b->base_buffer->zv_marker))
459 {
460 b->base_buffer->zv_marker = Fmake_marker ();
461 Fset_marker (b->base_buffer->zv_marker,
462 make_number (BUF_ZV (b->base_buffer)), base_buffer);
26d84681 463 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
336cd056
RS
464 }
465
466 /* Give the indirect buffer markers for its narrowing. */
ea064aa0
RS
467 b->pt_marker = Fmake_marker ();
468 Fset_marker (b->pt_marker, make_number (BUF_PT (b)), buf);
469 b->begv_marker = Fmake_marker ();
470 Fset_marker (b->begv_marker, make_number (BUF_BEGV (b)), buf);
471 b->zv_marker = Fmake_marker ();
472 Fset_marker (b->zv_marker, make_number (BUF_ZV (b)), buf);
473
26d84681 474 XMARKER (b->zv_marker)->insertion_type = 1;
336cd056 475
a9ee7a59 476 return buf;
1ab256cb
RM
477}
478
bcd40520
RS
479/* Reinitialize everything about a buffer except its name and contents
480 and local variables. */
1ab256cb
RM
481
482void
483reset_buffer (b)
484 register struct buffer *b;
485{
486 b->filename = Qnil;
f6ed2e84 487 b->file_truename = Qnil;
1ab256cb
RM
488 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
489 b->modtime = 0;
8d7a4592 490 XSETFASTINT (b->save_length, 0);
1ab256cb 491 b->last_window_start = 1;
8b264726
RS
492 /* It is more conservative to start out "changed" than "unchanged". */
493 b->clip_changed = 1;
1ab256cb
RM
494 b->backed_up = Qnil;
495 b->auto_save_modified = 0;
84f6bcba 496 b->auto_save_failure_time = -1;
1ab256cb
RM
497 b->auto_save_file_name = Qnil;
498 b->read_only = Qnil;
2eec3b4e
RS
499 b->overlays_before = Qnil;
500 b->overlays_after = Qnil;
8d7a4592 501 XSETFASTINT (b->overlay_center, 1);
dfda7a7f 502 b->mark_active = Qnil;
943e065b 503 b->point_before_scroll = Qnil;
be9aafdd 504 b->file_format = Qnil;
0dc6f165 505 b->last_selected_window = Qnil;
7962a441 506 XSETINT (b->display_count, 0);
fb2030e3
RS
507 b->extra2 = Qnil;
508 b->extra3 = Qnil;
1ab256cb
RM
509}
510
bcd40520
RS
511/* Reset buffer B's local variables info.
512 Don't use this on a buffer that has already been in use;
513 it does not treat permanent locals consistently.
13de9290
RS
514 Instead, use Fkill_all_local_variables.
515
516 If PERMANENT_TOO is 1, then we reset permanent built-in
517 buffer-local variables. If PERMANENT_TOO is 0,
518 we preserve those. */
bcd40520 519
13de9290
RS
520static void
521reset_buffer_local_variables (b, permanent_too)
1ab256cb 522 register struct buffer *b;
13de9290 523 int permanent_too;
1ab256cb
RM
524{
525 register int offset;
13de9290
RS
526 int dont_reset;
527
528 /* Decide which built-in local variables to reset. */
529 if (permanent_too)
530 dont_reset = 0;
531 else
532 dont_reset = buffer_permanent_local_flags;
1ab256cb
RM
533
534 /* Reset the major mode to Fundamental, together with all the
535 things that depend on the major mode.
536 default-major-mode is handled at a higher level.
537 We ignore it here. */
538 b->major_mode = Qfundamental_mode;
539 b->keymap = Qnil;
540 b->abbrev_table = Vfundamental_mode_abbrev_table;
541 b->mode_name = QSFundamental;
542 b->minor_modes = Qnil;
3446af9c
RS
543
544 /* If the standard case table has been altered and invalidated,
545 fix up its insides first. */
546 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
547 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
548 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
549 Fset_standard_case_table (Vascii_downcase_table);
550
1ab256cb 551 b->downcase_table = Vascii_downcase_table;
1e9b6335
RS
552 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
553 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
554 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
3cb719bd 555 b->invisibility_spec = Qt;
2e716096
RS
556#ifndef DOS_NT
557 b->buffer_file_type = Qnil;
558#endif
3cb719bd 559
1ab256cb
RM
560#if 0
561 b->sort_table = XSTRING (Vascii_sort_table);
562 b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
563#endif /* 0 */
564
13de9290 565 /* Reset all (or most) per-buffer variables to their defaults. */
1ab256cb 566 b->local_var_alist = Qnil;
13de9290 567 b->local_var_flags &= dont_reset;
1ab256cb
RM
568
569 /* For each slot that has a default value,
570 copy that into the slot. */
571
572 for (offset = (char *)&buffer_local_flags.name - (char *)&buffer_local_flags;
573 offset < sizeof (struct buffer);
4d2f1389 574 offset += sizeof (Lisp_Object)) /* sizeof EMACS_INT == sizeof Lisp_Object */
aab80822
KH
575 {
576 int flag = XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_flags));
13de9290
RS
577 if ((flag > 0
578 /* Don't reset a permanent local. */
579 && ! (dont_reset & flag))
580 || flag == -2)
581 *(Lisp_Object *)(offset + (char *)b)
582 = *(Lisp_Object *)(offset + (char *)&buffer_defaults);
aab80822 583 }
1ab256cb
RM
584}
585
01050cb5
RM
586/* We split this away from generate-new-buffer, because rename-buffer
587 and set-visited-file-name ought to be able to use this to really
588 rename the buffer properly. */
589
590DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
c273e647 591 1, 2, 0,
01050cb5
RM
592 "Return a string that is the name of no existing buffer based on NAME.\n\
593If there is no live buffer named NAME, then return NAME.\n\
1ab256cb 594Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
c273e647 595until an unused name is found, and then return that name.\n\
03bdd54c 596Optional second argument IGNORE specifies a name that is okay to use\n\
c273e647 597\(if it is in the sequence to be tried)\n\
e8b3a22d 598even if a buffer with that name exists.")
c273e647
RS
599 (name, ignore)
600 register Lisp_Object name, ignore;
1ab256cb
RM
601{
602 register Lisp_Object gentemp, tem;
603 int count;
604 char number[10];
605
606 CHECK_STRING (name, 0);
607
608 tem = Fget_buffer (name);
265a9e55 609 if (NILP (tem))
01050cb5 610 return name;
1ab256cb
RM
611
612 count = 1;
613 while (1)
614 {
615 sprintf (number, "<%d>", ++count);
616 gentemp = concat2 (name, build_string (number));
638e4fc3 617 tem = Fstring_equal (gentemp, ignore);
c273e647
RS
618 if (!NILP (tem))
619 return gentemp;
1ab256cb 620 tem = Fget_buffer (gentemp);
265a9e55 621 if (NILP (tem))
01050cb5 622 return gentemp;
1ab256cb
RM
623 }
624}
625
626\f
627DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
628 "Return the name of BUFFER, as a string.\n\
01050cb5 629With no argument or nil as argument, return the name of the current buffer.")
1ab256cb
RM
630 (buffer)
631 register Lisp_Object buffer;
632{
265a9e55 633 if (NILP (buffer))
1ab256cb
RM
634 return current_buffer->name;
635 CHECK_BUFFER (buffer, 0);
636 return XBUFFER (buffer)->name;
637}
638
639DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
640 "Return name of file BUFFER is visiting, or nil if none.\n\
641No argument or nil as argument means use the current buffer.")
642 (buffer)
643 register Lisp_Object buffer;
644{
265a9e55 645 if (NILP (buffer))
1ab256cb
RM
646 return current_buffer->filename;
647 CHECK_BUFFER (buffer, 0);
648 return XBUFFER (buffer)->filename;
649}
650
336cd056
RS
651DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
652 0, 1, 0,
653 "Return the base buffer of indirect buffer BUFFER.\n\
654If BUFFER is not indirect, return nil.")
655 (buffer)
656 register Lisp_Object buffer;
657{
658 struct buffer *base;
659 Lisp_Object base_buffer;
660
661 if (NILP (buffer))
662 base = current_buffer->base_buffer;
663 else
664 {
665 CHECK_BUFFER (buffer, 0);
666 base = XBUFFER (buffer)->base_buffer;
667 }
668
669 if (! base)
670 return Qnil;
671 XSETBUFFER (base_buffer, base);
672 return base_buffer;
673}
674
1ab256cb
RM
675DEFUN ("buffer-local-variables", Fbuffer_local_variables,
676 Sbuffer_local_variables, 0, 1, 0,
677 "Return an alist of variables that are buffer-local in BUFFER.\n\
553defa4
RS
678Most elements look like (SYMBOL . VALUE), describing one variable.\n\
679For a symbol that is locally unbound, just the symbol appears in the value.\n\
1ab256cb
RM
680Note that storing new VALUEs in these elements doesn't change the variables.\n\
681No argument or nil as argument means use current buffer as BUFFER.")
682 (buffer)
683 register Lisp_Object buffer;
684{
685 register struct buffer *buf;
553defa4 686 register Lisp_Object result;
1ab256cb 687
265a9e55 688 if (NILP (buffer))
1ab256cb
RM
689 buf = current_buffer;
690 else
691 {
692 CHECK_BUFFER (buffer, 0);
693 buf = XBUFFER (buffer);
694 }
695
553defa4
RS
696 result = Qnil;
697
1ab256cb 698 {
553defa4
RS
699 register Lisp_Object tail;
700 for (tail = buf->local_var_alist; CONSP (tail); tail = XCONS (tail)->cdr)
1ab256cb 701 {
553defa4
RS
702 Lisp_Object val, elt;
703
704 elt = XCONS (tail)->car;
705
e0585c64
RS
706 /* Reference each variable in the alist in buf.
707 If inquiring about the current buffer, this gets the current values,
708 so store them into the alist so the alist is up to date.
709 If inquiring about some other buffer, this swaps out any values
710 for that buffer, making the alist up to date automatically. */
711 val = find_symbol_value (XCONS (elt)->car);
712 /* Use the current buffer value only if buf is the current buffer. */
713 if (buf != current_buffer)
553defa4
RS
714 val = XCONS (elt)->cdr;
715
716 /* If symbol is unbound, put just the symbol in the list. */
717 if (EQ (val, Qunbound))
718 result = Fcons (XCONS (elt)->car, result);
719 /* Otherwise, put (symbol . value) in the list. */
720 else
721 result = Fcons (Fcons (XCONS (elt)->car, val), result);
1ab256cb
RM
722 }
723 }
724
1ab256cb
RM
725 /* Add on all the variables stored in special slots. */
726 {
727 register int offset, mask;
728
729 for (offset = (char *)&buffer_local_symbols.name - (char *)&buffer_local_symbols;
730 offset < sizeof (struct buffer);
4d2f1389 731 offset += (sizeof (EMACS_INT))) /* sizeof EMACS_INT == sizeof Lisp_Object */
1ab256cb 732 {
aab80822 733 mask = XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_flags));
1ab256cb 734 if (mask == -1 || (buf->local_var_flags & mask))
aab80822
KH
735 if (SYMBOLP (*(Lisp_Object *)(offset
736 + (char *)&buffer_local_symbols)))
737 result = Fcons (Fcons (*((Lisp_Object *)
738 (offset + (char *)&buffer_local_symbols)),
553defa4
RS
739 *(Lisp_Object *)(offset + (char *)buf)),
740 result);
1ab256cb
RM
741 }
742 }
553defa4
RS
743
744 return result;
1ab256cb
RM
745}
746
747\f
748DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
749 0, 1, 0,
750 "Return t if BUFFER was modified since its file was last read or saved.\n\
751No argument or nil as argument means use current buffer as BUFFER.")
752 (buffer)
753 register Lisp_Object buffer;
754{
755 register struct buffer *buf;
265a9e55 756 if (NILP (buffer))
1ab256cb
RM
757 buf = current_buffer;
758 else
759 {
760 CHECK_BUFFER (buffer, 0);
761 buf = XBUFFER (buffer);
762 }
763
336cd056 764 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1ab256cb
RM
765}
766
767DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
768 1, 1, 0,
769 "Mark current buffer as modified or unmodified according to FLAG.\n\
770A non-nil FLAG means mark the buffer modified.")
771 (flag)
772 register Lisp_Object flag;
773{
774 register int already;
775 register Lisp_Object fn;
776
777#ifdef CLASH_DETECTION
778 /* If buffer becoming modified, lock the file.
779 If buffer becoming unmodified, unlock the file. */
780
60f4dd23 781 fn = current_buffer->file_truename;
265a9e55 782 if (!NILP (fn))
1ab256cb 783 {
336cd056 784 already = SAVE_MODIFF < MODIFF;
265a9e55 785 if (!already && !NILP (flag))
1ab256cb 786 lock_file (fn);
265a9e55 787 else if (already && NILP (flag))
1ab256cb
RM
788 unlock_file (fn);
789 }
790#endif /* CLASH_DETECTION */
791
336cd056 792 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1ab256cb
RM
793 update_mode_lines++;
794 return flag;
795}
796
797DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
798 0, 1, 0,
799 "Return BUFFER's tick counter, incremented for each change in text.\n\
800Each buffer has a tick counter which is incremented each time the text in\n\
801that buffer is changed. It wraps around occasionally.\n\
802No argument or nil as argument means use current buffer as BUFFER.")
803 (buffer)
804 register Lisp_Object buffer;
805{
806 register struct buffer *buf;
265a9e55 807 if (NILP (buffer))
1ab256cb
RM
808 buf = current_buffer;
809 else
810 {
811 CHECK_BUFFER (buffer, 0);
812 buf = XBUFFER (buffer);
813 }
814
815 return make_number (BUF_MODIFF (buf));
816}
817\f
01050cb5 818DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
4c7e5f09 819 "sRename buffer (to new name): \nP",
1ab256cb 820 "Change current buffer's name to NEWNAME (a string).\n\
3bd779aa 821If second arg UNIQUE is nil or omitted, it is an error if a\n\
01050cb5 822buffer named NEWNAME already exists.\n\
3bd779aa 823If UNIQUE is non-nil, come up with a new name using\n\
01050cb5 824`generate-new-buffer-name'.\n\
3bd779aa
RS
825Interactively, you can set UNIQUE with a prefix argument.\n\
826We return the name we actually gave the buffer.\n\
1ab256cb 827This does not change the name of the visited file (if any).")
489c043a
RS
828 (newname, unique)
829 register Lisp_Object newname, unique;
1ab256cb
RM
830{
831 register Lisp_Object tem, buf;
832
489c043a 833 CHECK_STRING (newname, 0);
d59698c4 834
489c043a 835 if (XSTRING (newname)->size == 0)
d59698c4
RS
836 error ("Empty string is invalid as a buffer name");
837
489c043a 838 tem = Fget_buffer (newname);
c059b5ea
RM
839 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
840 the buffer automatically so you can create another with the original name.
841 It makes UNIQUE equivalent to
489c043a 842 (rename-buffer (generate-new-buffer-name NEWNAME)). */
c059b5ea 843 if (NILP (unique) && XBUFFER (tem) == current_buffer)
fb5eba9c 844 return current_buffer->name;
265a9e55 845 if (!NILP (tem))
01050cb5 846 {
3bd779aa 847 if (!NILP (unique))
489c043a 848 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
01050cb5 849 else
489c043a 850 error ("Buffer name `%s' is in use", XSTRING (newname)->data);
01050cb5 851 }
1ab256cb 852
489c043a 853 current_buffer->name = newname;
76f590d7
JB
854
855 /* Catch redisplay's attention. Unless we do this, the mode lines for
856 any windows displaying current_buffer will stay unchanged. */
857 update_mode_lines++;
858
67180c6a 859 XSETBUFFER (buf, current_buffer);
489c043a 860 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
cf058e49
KH
861 if (NILP (current_buffer->filename)
862 && !NILP (current_buffer->auto_save_file_name))
1ab256cb 863 call0 (intern ("rename-auto-save-file"));
fb5eba9c
RS
864 /* Refetch since that last call may have done GC. */
865 return current_buffer->name;
1ab256cb
RM
866}
867
a0ebb746 868DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 2, 0,
1ab256cb 869 "Return most recently selected buffer other than BUFFER.\n\
a0ebb746
JB
870Buffers not visible in windows are preferred to visible buffers,\n\
871unless optional second argument VISIBLE-OK is non-nil.\n\
1ab256cb
RM
872If no other buffer exists, the buffer `*scratch*' is returned.\n\
873If BUFFER is omitted or nil, some interesting buffer is returned.")
a0ebb746
JB
874 (buffer, visible_ok)
875 register Lisp_Object buffer, visible_ok;
1ab256cb 876{
89132f25 877 Lisp_Object Fset_buffer_major_mode ();
7962a441 878 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1ab256cb
RM
879 notsogood = Qnil;
880
7962a441
RS
881 tail = Vbuffer_alist;
882 pred = frame_buffer_predicate ();
883
884 /* Consider buffers that have been seen in the selected frame
885 before other buffers. */
886
887 tem = frame_buffer_list ();
888 add_ons = Qnil;
889 while (CONSP (tem))
890 {
891 if (BUFFERP (XCONS (tem)->car))
892 add_ons = Fcons (Fcons (Qnil, XCONS (tem)->car), add_ons);
893 tem = XCONS (tem)->cdr;
894 }
895 tail = nconc2 (Fnreverse (add_ons), tail);
896
897 for (; !NILP (tail); tail = Fcdr (tail))
1ab256cb
RM
898 {
899 buf = Fcdr (Fcar (tail));
900 if (EQ (buf, buffer))
901 continue;
902 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
903 continue;
04ae1b48
RS
904 /* If the selected frame has a buffer_predicate,
905 disregard buffers that don't fit the predicate. */
7962a441 906 if (!NILP (pred))
04ae1b48 907 {
7962a441 908 tem = call1 (pred, buf);
04ae1b48
RS
909 if (NILP (tem))
910 continue;
911 }
04ae1b48 912
a0ebb746 913 if (NILP (visible_ok))
db732e5a 914 tem = Fget_buffer_window (buf, Qt);
a0ebb746
JB
915 else
916 tem = Qnil;
265a9e55 917 if (NILP (tem))
1ab256cb 918 return buf;
265a9e55 919 if (NILP (notsogood))
1ab256cb
RM
920 notsogood = buf;
921 }
265a9e55 922 if (!NILP (notsogood))
1ab256cb 923 return notsogood;
89132f25
KH
924 buf = Fget_buffer_create (build_string ("*scratch*"));
925 Fset_buffer_major_mode (buf);
926 return buf;
1ab256cb
RM
927}
928\f
316784fb
KH
929DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
930 0, 1, "",
5b8bcf48
RS
931 "Make BUFFER stop keeping undo information.\n\
932No argument or nil as argument means do this for the current buffer.")
ffd56f97
JB
933 (buffer)
934 register Lisp_Object buffer;
1ab256cb 935{
ffd56f97
JB
936 Lisp_Object real_buffer;
937
938 if (NILP (buffer))
67180c6a 939 XSETBUFFER (real_buffer, current_buffer);
ffd56f97
JB
940 else
941 {
942 real_buffer = Fget_buffer (buffer);
943 if (NILP (real_buffer))
944 nsberror (buffer);
945 }
946
947 XBUFFER (real_buffer)->undo_list = Qt;
948
1ab256cb
RM
949 return Qnil;
950}
951
952DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
953 0, 1, "",
954 "Start keeping undo information for buffer BUFFER.\n\
955No argument or nil as argument means do this for the current buffer.")
ffd56f97
JB
956 (buffer)
957 register Lisp_Object buffer;
1ab256cb 958{
ffd56f97 959 Lisp_Object real_buffer;
1ab256cb 960
ffd56f97 961 if (NILP (buffer))
67180c6a 962 XSETBUFFER (real_buffer, current_buffer);
1ab256cb
RM
963 else
964 {
ffd56f97
JB
965 real_buffer = Fget_buffer (buffer);
966 if (NILP (real_buffer))
967 nsberror (buffer);
1ab256cb
RM
968 }
969
ffd56f97
JB
970 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
971 XBUFFER (real_buffer)->undo_list = Qnil;
1ab256cb
RM
972
973 return Qnil;
974}
975
976/*
977 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
978Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
979The buffer being killed will be current while the hook is running.\n\
980See `kill-buffer'."
981 */
982DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
983 "Kill the buffer BUFFER.\n\
984The argument may be a buffer or may be the name of a buffer.\n\
985An argument of nil means kill the current buffer.\n\n\
986Value is t if the buffer is actually killed, nil if user says no.\n\n\
987The value of `kill-buffer-hook' (which may be local to that buffer),\n\
988if not void, is a list of functions to be called, with no arguments,\n\
989before the buffer is actually killed. The buffer to be killed is current\n\
990when the hook functions are called.\n\n\
991Any processes that have this buffer as the `process-buffer' are killed\n\
b64d7442 992with SIGHUP.")
a25f13ae
KH
993 (buffer)
994 Lisp_Object buffer;
1ab256cb
RM
995{
996 Lisp_Object buf;
997 register struct buffer *b;
998 register Lisp_Object tem;
999 register struct Lisp_Marker *m;
1000 struct gcpro gcpro1, gcpro2;
1001
a25f13ae 1002 if (NILP (buffer))
1ab256cb
RM
1003 buf = Fcurrent_buffer ();
1004 else
a25f13ae 1005 buf = Fget_buffer (buffer);
265a9e55 1006 if (NILP (buf))
a25f13ae 1007 nsberror (buffer);
1ab256cb
RM
1008
1009 b = XBUFFER (buf);
1010
4a4a9db5
KH
1011 /* Avoid trouble for buffer already dead. */
1012 if (NILP (b->name))
1013 return Qnil;
1014
1ab256cb 1015 /* Query if the buffer is still modified. */
265a9e55 1016 if (INTERACTIVE && !NILP (b->filename)
336cd056 1017 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1ab256cb 1018 {
a25f13ae 1019 GCPRO1 (buf);
1ab256cb
RM
1020 tem = do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
1021 XSTRING (b->name)->data));
1022 UNGCPRO;
265a9e55 1023 if (NILP (tem))
1ab256cb
RM
1024 return Qnil;
1025 }
1026
dcdffbf6 1027 /* Run hooks with the buffer to be killed the current buffer. */
1ab256cb
RM
1028 {
1029 register Lisp_Object val;
1030 int count = specpdl_ptr - specpdl;
dcdffbf6 1031 Lisp_Object list;
1ab256cb
RM
1032
1033 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1034 set_buffer_internal (b);
dcdffbf6
RS
1035
1036 /* First run the query functions; if any query is answered no,
1037 don't kill the buffer. */
1038 for (list = Vkill_buffer_query_functions; !NILP (list); list = Fcdr (list))
1039 {
1040 tem = call0 (Fcar (list));
1041 if (NILP (tem))
1042 return unbind_to (count, Qnil);
1043 }
1044
1045 /* Then run the hooks. */
fd186f07
RS
1046 if (!NILP (Vrun_hooks))
1047 call1 (Vrun_hooks, Qkill_buffer_hook);
1ab256cb
RM
1048 unbind_to (count, Qnil);
1049 }
1050
1051 /* We have no more questions to ask. Verify that it is valid
1052 to kill the buffer. This must be done after the questions
1053 since anything can happen within do_yes_or_no_p. */
1054
1055 /* Don't kill the minibuffer now current. */
1056 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1057 return Qnil;
1058
265a9e55 1059 if (NILP (b->name))
1ab256cb
RM
1060 return Qnil;
1061
336cd056
RS
1062 /* When we kill a base buffer, kill all its indirect buffers.
1063 We do it at this stage so nothing terrible happens if they
1064 ask questions or their hooks get errors. */
1065 if (! b->base_buffer)
1066 {
1067 struct buffer *other;
1068
1069 GCPRO1 (buf);
1070
1071 for (other = all_buffers; other; other = other->next)
4a4a9db5
KH
1072 /* all_buffers contains dead buffers too;
1073 don't re-kill them. */
1074 if (other->base_buffer == b && !NILP (other->name))
336cd056
RS
1075 {
1076 Lisp_Object buf;
1077 XSETBUFFER (buf, other);
1078 Fkill_buffer (buf);
1079 }
1080
1081 UNGCPRO;
1082 }
1083
1ab256cb
RM
1084 /* Make this buffer not be current.
1085 In the process, notice if this is the sole visible buffer
1086 and give up if so. */
1087 if (b == current_buffer)
1088 {
172a9c1f 1089 tem = Fother_buffer (buf, Qnil);
1ab256cb
RM
1090 Fset_buffer (tem);
1091 if (b == current_buffer)
1092 return Qnil;
1093 }
1094
1095 /* Now there is no question: we can kill the buffer. */
1096
1097#ifdef CLASH_DETECTION
1098 /* Unlock this buffer's file, if it is locked. */
1099 unlock_buffer (b);
1100#endif /* CLASH_DETECTION */
1101
1ab256cb 1102 kill_buffer_processes (buf);
1ab256cb
RM
1103
1104 tem = Vinhibit_quit;
1105 Vinhibit_quit = Qt;
00550f94 1106 replace_buffer_in_all_windows (buf);
b26dd9cb 1107 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
7962a441 1108 frames_discard_buffer (buf);
1ab256cb
RM
1109 Vinhibit_quit = tem;
1110
9b59d6d0 1111 /* Delete any auto-save file, if we saved it in this session. */
a7a60ce9 1112 if (STRINGP (b->auto_save_file_name)
e95a0b39
RS
1113 && b->auto_save_modified != 0
1114 && SAVE_MODIFF < b->auto_save_modified)
1ab256cb
RM
1115 {
1116 Lisp_Object tem;
1117 tem = Fsymbol_value (intern ("delete-auto-save-files"));
265a9e55 1118 if (! NILP (tem))
cbb6a418 1119 internal_delete_file (b->auto_save_file_name);
1ab256cb
RM
1120 }
1121
4a4a9db5
KH
1122 if (b->base_buffer)
1123 {
1124 /* Unchain all markers that belong to this indirect buffer.
1125 Don't unchain the markers that belong to the base buffer
1126 or its other indirect buffers. */
1127 for (tem = BUF_MARKERS (b); !NILP (tem); )
1128 {
1129 Lisp_Object next;
1130 m = XMARKER (tem);
1131 next = m->chain;
1132 if (m->buffer == b)
1133 unchain_marker (tem);
1134 tem = next;
1135 }
1136 }
1137 else
1ab256cb 1138 {
4a4a9db5 1139 /* Unchain all markers of this buffer and its indirect buffers.
336cd056 1140 and leave them pointing nowhere. */
4a4a9db5 1141 for (tem = BUF_MARKERS (b); !NILP (tem); )
336cd056
RS
1142 {
1143 m = XMARKER (tem);
1144 m->buffer = 0;
1145 tem = m->chain;
1146 m->chain = Qnil;
1147 }
1148 BUF_MARKERS (b) = Qnil;
1ab256cb 1149
336cd056
RS
1150#ifdef USE_TEXT_PROPERTIES
1151 BUF_INTERVALS (b) = NULL_INTERVAL;
1152#endif
1153
1154 /* Perhaps we should explicitly free the interval tree here... */
1155 }
33f7013e 1156
2f3f993b
RS
1157 /* Reset the local variables, so that this buffer's local values
1158 won't be protected from GC. They would be protected
1159 if they happened to remain encached in their symbols.
1160 This gets rid of them for certain. */
1161 swap_out_buffer_local_variables (b);
13de9290 1162 reset_buffer_local_variables (b, 1);
2f3f993b 1163
1ab256cb 1164 b->name = Qnil;
336cd056 1165
9ac0d9e0 1166 BLOCK_INPUT;
336cd056
RS
1167 if (! b->base_buffer)
1168 BUFFER_FREE (BUF_BEG_ADDR (b));
1169
28e969dd
JB
1170 if (b->newline_cache)
1171 {
1172 free_region_cache (b->newline_cache);
1173 b->newline_cache = 0;
1174 }
1175 if (b->width_run_cache)
1176 {
1177 free_region_cache (b->width_run_cache);
1178 b->width_run_cache = 0;
1179 }
1180 b->width_table = Qnil;
9ac0d9e0 1181 UNBLOCK_INPUT;
1ab256cb
RM
1182 b->undo_list = Qnil;
1183
1184 return Qt;
1185}
1186\f
36a8c287
JB
1187/* Move the assoc for buffer BUF to the front of buffer-alist. Since
1188 we do this each time BUF is selected visibly, the more recently
1189 selected buffers are always closer to the front of the list. This
1190 means that other_buffer is more likely to choose a relevant buffer. */
1ab256cb
RM
1191
1192record_buffer (buf)
1193 Lisp_Object buf;
1194{
1195 register Lisp_Object link, prev;
1196
1197 prev = Qnil;
1198 for (link = Vbuffer_alist; CONSP (link); link = XCONS (link)->cdr)
1199 {
1200 if (EQ (XCONS (XCONS (link)->car)->cdr, buf))
1201 break;
1202 prev = link;
1203 }
1204
36a8c287
JB
1205 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1206 we cannot use Fdelq itself here because it allows quitting. */
1ab256cb 1207
265a9e55 1208 if (NILP (prev))
1ab256cb
RM
1209 Vbuffer_alist = XCONS (Vbuffer_alist)->cdr;
1210 else
1211 XCONS (prev)->cdr = XCONS (XCONS (prev)->cdr)->cdr;
1212
7962a441 1213 XCONS (link)->cdr = Vbuffer_alist;
1ab256cb 1214 Vbuffer_alist = link;
7962a441
RS
1215
1216 /* Now move this buffer to the front of frame_buffer_list also. */
1217
1218 prev = Qnil;
1219 for (link = frame_buffer_list (); CONSP (link); link = XCONS (link)->cdr)
1220 {
1221 if (EQ (XCONS (link)->car, buf))
1222 break;
1223 prev = link;
1224 }
1225
1226 /* Effectively do delq. */
1227
1228 if (CONSP (link))
1229 {
1230 if (NILP (prev))
1231 set_frame_buffer_list (XCONS (frame_buffer_list ())->cdr);
1232 else
1233 XCONS (prev)->cdr = XCONS (XCONS (prev)->cdr)->cdr;
1234
1235 XCONS (link)->cdr = frame_buffer_list ();
1236 set_frame_buffer_list (link);
1237 }
1238 else
1239 set_frame_buffer_list (Fcons (buf, frame_buffer_list ()));
1ab256cb
RM
1240}
1241
a9ee7a59
KH
1242DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1243 "Set an appropriate major mode for BUFFER, according to `default-major-mode'.\n\
1244Use this function before selecting the buffer, since it may need to inspect\n\
1245the current buffer's major mode.")
a2428fa2
EN
1246 (buffer)
1247 Lisp_Object buffer;
a9ee7a59
KH
1248{
1249 int count;
1250 Lisp_Object function;
1251
1252 function = buffer_defaults.major_mode;
1253 if (NILP (function) && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1254 function = current_buffer->major_mode;
1255
1256 if (NILP (function) || EQ (function, Qfundamental_mode))
1257 return Qnil;
1258
1259 count = specpdl_ptr - specpdl;
1260
1261 /* To select a nonfundamental mode,
1262 select the buffer temporarily and then call the mode function. */
1263
1264 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1265
a2428fa2 1266 Fset_buffer (buffer);
a9ee7a59
KH
1267 call0 (function);
1268
1269 return unbind_to (count, Qnil);
1270}
1271
1ab256cb
RM
1272DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1273 "Select buffer BUFFER in the current window.\n\
1274BUFFER may be a buffer or a buffer name.\n\
1275Optional second arg NORECORD non-nil means\n\
1276do not put this buffer at the front of the list of recently selected ones.\n\
1277\n\
1278WARNING: This is NOT the way to work on another buffer temporarily\n\
1279within a Lisp program! Use `set-buffer' instead. That avoids messing with\n\
1280the window-buffer correspondences.")
a25f13ae
KH
1281 (buffer, norecord)
1282 Lisp_Object buffer, norecord;
1ab256cb
RM
1283{
1284 register Lisp_Object buf;
1285 Lisp_Object tem;
1286
1287 if (EQ (minibuf_window, selected_window))
1288 error ("Cannot switch buffers in minibuffer window");
1289 tem = Fwindow_dedicated_p (selected_window);
265a9e55 1290 if (!NILP (tem))
1ab256cb
RM
1291 error ("Cannot switch buffers in a dedicated window");
1292
a25f13ae 1293 if (NILP (buffer))
172a9c1f 1294 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
1ab256cb 1295 else
a9ee7a59 1296 {
a25f13ae 1297 buf = Fget_buffer (buffer);
a9ee7a59
KH
1298 if (NILP (buf))
1299 {
a25f13ae 1300 buf = Fget_buffer_create (buffer);
a9ee7a59
KH
1301 Fset_buffer_major_mode (buf);
1302 }
1303 }
1ab256cb 1304 Fset_buffer (buf);
265a9e55 1305 if (NILP (norecord))
1ab256cb
RM
1306 record_buffer (buf);
1307
1308 Fset_window_buffer (EQ (selected_window, minibuf_window)
5fcd022d
JB
1309 ? Fnext_window (minibuf_window, Qnil, Qnil)
1310 : selected_window,
1ab256cb
RM
1311 buf);
1312
cd0c235a 1313 return buf;
1ab256cb
RM
1314}
1315
cd0c235a 1316DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1ab256cb
RM
1317 "Select buffer BUFFER in some window, preferably a different one.\n\
1318If BUFFER is nil, then some other buffer is chosen.\n\
1319If `pop-up-windows' is non-nil, windows can be split to do this.\n\
1320If optional second arg OTHER-WINDOW is non-nil, insist on finding another\n\
405615e5
RS
1321window even if BUFFER is already visible in the selected window.\n\
1322This uses the function `display-buffer' as a subroutine; see the documentation\n\
6d12711f
RS
1323of `display-buffer' for additional customization information.\n\
1324\n\
1325Optional third arg NORECORD non-nil means\n\
1326do not put this buffer at the front of the list of recently selected ones.")
1327 (buffer, other_window, norecord)
1328 Lisp_Object buffer, other_window, norecord;
1ab256cb
RM
1329{
1330 register Lisp_Object buf;
a25f13ae 1331 if (NILP (buffer))
172a9c1f 1332 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
1ab256cb 1333 else
7c2087ee 1334 {
a25f13ae 1335 buf = Fget_buffer (buffer);
7c2087ee
RS
1336 if (NILP (buf))
1337 {
a25f13ae 1338 buf = Fget_buffer_create (buffer);
7c2087ee
RS
1339 Fset_buffer_major_mode (buf);
1340 }
1341 }
1ab256cb 1342 Fset_buffer (buf);
6d12711f
RS
1343 if (NILP (norecord))
1344 record_buffer (buf);
a2428fa2 1345 Fselect_window (Fdisplay_buffer (buf, other_window));
e8b3a22d 1346 return buf;
1ab256cb
RM
1347}
1348
1349DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1350 "Return the current buffer as a Lisp object.")
1351 ()
1352{
1353 register Lisp_Object buf;
67180c6a 1354 XSETBUFFER (buf, current_buffer);
1ab256cb
RM
1355 return buf;
1356}
1357\f
c7aa5005 1358/* Set the current buffer to B. */
1ab256cb
RM
1359
1360void
1361set_buffer_internal (b)
1362 register struct buffer *b;
1363{
1364 register struct buffer *old_buf;
1365 register Lisp_Object tail, valcontents;
a7a60ce9 1366 Lisp_Object tem;
1ab256cb
RM
1367
1368 if (current_buffer == b)
1369 return;
1370
1371 windows_or_buffers_changed = 1;
c7aa5005
KH
1372 set_buffer_internal_1 (b);
1373}
1374
1375/* Set the current buffer to B, and do not set windows_or_buffers_changed.
1376 This is used by redisplay. */
1377
1378void
1379set_buffer_internal_1 (b)
1380 register struct buffer *b;
1381{
1382 register struct buffer *old_buf;
1383 register Lisp_Object tail, valcontents;
1384 Lisp_Object tem;
1385
1386 if (current_buffer == b)
1387 return;
1388
1ab256cb
RM
1389 old_buf = current_buffer;
1390 current_buffer = b;
1391 last_known_column_point = -1; /* invalidate indentation cache */
1392
336cd056
RS
1393 if (old_buf)
1394 {
1395 /* Put the undo list back in the base buffer, so that it appears
1396 that an indirect buffer shares the undo list of its base. */
1397 if (old_buf->base_buffer)
1398 old_buf->base_buffer->undo_list = old_buf->undo_list;
1399
1400 /* If the old current buffer has markers to record PT, BEGV and ZV
1401 when it is not current, update them now. */
1402 if (! NILP (old_buf->pt_marker))
1403 {
1404 Lisp_Object obuf;
1405 XSETBUFFER (obuf, old_buf);
2c99f3ea
RS
1406 Fset_marker (old_buf->pt_marker, make_number (BUF_PT (old_buf)),
1407 obuf);
336cd056
RS
1408 }
1409 if (! NILP (old_buf->begv_marker))
1410 {
1411 Lisp_Object obuf;
1412 XSETBUFFER (obuf, old_buf);
2c99f3ea
RS
1413 Fset_marker (old_buf->begv_marker, make_number (BUF_BEGV (old_buf)),
1414 obuf);
336cd056
RS
1415 }
1416 if (! NILP (old_buf->zv_marker))
1417 {
1418 Lisp_Object obuf;
1419 XSETBUFFER (obuf, old_buf);
2c99f3ea
RS
1420 Fset_marker (old_buf->zv_marker, make_number (BUF_ZV (old_buf)),
1421 obuf);
336cd056
RS
1422 }
1423 }
1424
1425 /* Get the undo list from the base buffer, so that it appears
1426 that an indirect buffer shares the undo list of its base. */
1427 if (b->base_buffer)
1428 b->undo_list = b->base_buffer->undo_list;
1429
1430 /* If the new current buffer has markers to record PT, BEGV and ZV
1431 when it is not current, fetch them now. */
1432 if (! NILP (b->pt_marker))
1433 BUF_PT (b) = marker_position (b->pt_marker);
1434 if (! NILP (b->begv_marker))
1435 BUF_BEGV (b) = marker_position (b->begv_marker);
1436 if (! NILP (b->zv_marker))
1437 BUF_ZV (b) = marker_position (b->zv_marker);
1438
1ab256cb
RM
1439 /* Look down buffer's list of local Lisp variables
1440 to find and update any that forward into C variables. */
1441
265a9e55 1442 for (tail = b->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
1ab256cb
RM
1443 {
1444 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
a7a60ce9
KH
1445 if ((BUFFER_LOCAL_VALUEP (valcontents)
1446 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
fdc6e516 1447 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->car,
a7a60ce9 1448 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1ab256cb
RM
1449 /* Just reference the variable
1450 to cause it to become set for this buffer. */
1451 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
1452 }
1453
1454 /* Do the same with any others that were local to the previous buffer */
1455
1456 if (old_buf)
265a9e55 1457 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
1ab256cb
RM
1458 {
1459 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
a7a60ce9
KH
1460 if ((BUFFER_LOCAL_VALUEP (valcontents)
1461 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
fdc6e516 1462 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->car,
a7a60ce9 1463 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1ab256cb
RM
1464 /* Just reference the variable
1465 to cause it to become set for this buffer. */
1466 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
1467 }
1468}
1469
336cd056 1470/* Switch to buffer B temporarily for redisplay purposes.
bbbe9545 1471 This avoids certain things that don't need to be done within redisplay. */
336cd056
RS
1472
1473void
1474set_buffer_temp (b)
1475 struct buffer *b;
1476{
1477 register struct buffer *old_buf;
1478
1479 if (current_buffer == b)
1480 return;
1481
1482 old_buf = current_buffer;
1483 current_buffer = b;
1484
1485 if (old_buf)
1486 {
1487 /* If the old current buffer has markers to record PT, BEGV and ZV
1488 when it is not current, update them now. */
1489 if (! NILP (old_buf->pt_marker))
1490 {
1491 Lisp_Object obuf;
1492 XSETBUFFER (obuf, old_buf);
2c99f3ea
RS
1493 Fset_marker (old_buf->pt_marker, make_number (BUF_PT (old_buf)),
1494 obuf);
336cd056
RS
1495 }
1496 if (! NILP (old_buf->begv_marker))
1497 {
1498 Lisp_Object obuf;
1499 XSETBUFFER (obuf, old_buf);
2c99f3ea
RS
1500 Fset_marker (old_buf->begv_marker, make_number (BUF_BEGV (old_buf)),
1501 obuf);
336cd056
RS
1502 }
1503 if (! NILP (old_buf->zv_marker))
1504 {
1505 Lisp_Object obuf;
1506 XSETBUFFER (obuf, old_buf);
2c99f3ea
RS
1507 Fset_marker (old_buf->zv_marker, make_number (BUF_ZV (old_buf)),
1508 obuf);
336cd056
RS
1509 }
1510 }
1511
1512 /* If the new current buffer has markers to record PT, BEGV and ZV
1513 when it is not current, fetch them now. */
1514 if (! NILP (b->pt_marker))
1515 BUF_PT (b) = marker_position (b->pt_marker);
1516 if (! NILP (b->begv_marker))
1517 BUF_BEGV (b) = marker_position (b->begv_marker);
1518 if (! NILP (b->zv_marker))
1519 BUF_ZV (b) = marker_position (b->zv_marker);
1520}
1521
1ab256cb
RM
1522DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1523 "Make the buffer BUFFER current for editing operations.\n\
1524BUFFER may be a buffer or the name of an existing buffer.\n\
1525See also `save-excursion' when you want to make a buffer current temporarily.\n\
1526This function does not display the buffer, so its effect ends\n\
1527when the current command terminates.\n\
1528Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.")
a25f13ae
KH
1529 (buffer)
1530 register Lisp_Object buffer;
1ab256cb 1531{
a25f13ae
KH
1532 register Lisp_Object buf;
1533 buf = Fget_buffer (buffer);
1534 if (NILP (buf))
1535 nsberror (buffer);
1536 if (NILP (XBUFFER (buf)->name))
1ab256cb 1537 error ("Selecting deleted buffer");
a25f13ae
KH
1538 set_buffer_internal (XBUFFER (buf));
1539 return buf;
1ab256cb
RM
1540}
1541\f
1542DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1543 Sbarf_if_buffer_read_only, 0, 0, 0,
1544 "Signal a `buffer-read-only' error if the current buffer is read-only.")
1545 ()
1546{
a96b68f1
RS
1547 if (!NILP (current_buffer->read_only)
1548 && NILP (Vinhibit_read_only))
1ab256cb
RM
1549 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1550 return Qnil;
1551}
1552
1553DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1554 "Put BUFFER at the end of the list of all buffers.\n\
1555There it is the least likely candidate for `other-buffer' to return;\n\
528415e7 1556thus, the least likely buffer for \\[switch-to-buffer] to select by default.\n\
a5611885
JB
1557If BUFFER is nil or omitted, bury the current buffer.\n\
1558Also, if BUFFER is nil or omitted, remove the current buffer from the\n\
1559selected window if it is displayed there.")
a2428fa2
EN
1560 (buffer)
1561 register Lisp_Object buffer;
1ab256cb 1562{
b271272a 1563 /* Figure out what buffer we're going to bury. */
a2428fa2 1564 if (NILP (buffer))
a5611885 1565 {
a2428fa2 1566 XSETBUFFER (buffer, current_buffer);
0a63b212
RS
1567
1568 /* If we're burying the current buffer, unshow it. */
1569 Fswitch_to_buffer (Fother_buffer (buffer, Qnil), Qnil);
a5611885 1570 }
1ab256cb
RM
1571 else
1572 {
1573 Lisp_Object buf1;
1574
a2428fa2 1575 buf1 = Fget_buffer (buffer);
265a9e55 1576 if (NILP (buf1))
a2428fa2
EN
1577 nsberror (buffer);
1578 buffer = buf1;
b271272a
JB
1579 }
1580
a2428fa2 1581 /* Move buffer to the end of the buffer list. */
b271272a
JB
1582 {
1583 register Lisp_Object aelt, link;
1584
a2428fa2 1585 aelt = Frassq (buffer, Vbuffer_alist);
b271272a
JB
1586 link = Fmemq (aelt, Vbuffer_alist);
1587 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1588 XCONS (link)->cdr = Qnil;
1589 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1590 }
1ab256cb 1591
dcb26650 1592 frames_bury_buffer (buffer);
dec989eb 1593
1ab256cb
RM
1594 return Qnil;
1595}
1596\f
c922bc55 1597DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1ab256cb 1598 "Delete the entire contents of the current buffer.\n\
2950a20e 1599Any narrowing restriction in effect (see `narrow-to-region') is removed,\n\
1ab256cb
RM
1600so the buffer is truly empty after this.")
1601 ()
1602{
1603 Fwiden ();
1604 del_range (BEG, Z);
1605 current_buffer->last_window_start = 1;
1606 /* Prevent warnings, or suspension of auto saving, that would happen
1607 if future size is less than past size. Use of erase-buffer
1608 implies that the future text is not really related to the past text. */
8d7a4592 1609 XSETFASTINT (current_buffer->save_length, 0);
1ab256cb
RM
1610 return Qnil;
1611}
1612
1613validate_region (b, e)
1614 register Lisp_Object *b, *e;
1615{
1ab256cb
RM
1616 CHECK_NUMBER_COERCE_MARKER (*b, 0);
1617 CHECK_NUMBER_COERCE_MARKER (*e, 1);
1618
1619 if (XINT (*b) > XINT (*e))
1620 {
03192067
KH
1621 Lisp_Object tem;
1622 tem = *b; *b = *e; *e = tem;
1ab256cb
RM
1623 }
1624
1625 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1626 && XINT (*e) <= ZV))
1627 args_out_of_range (*b, *e);
1628}
1629\f
1ab256cb
RM
1630DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
1631 0, 0, 0,
1632 "Switch to Fundamental mode by killing current buffer's local variables.\n\
1633Most local variable bindings are eliminated so that the default values\n\
1634become effective once more. Also, the syntax table is set from\n\
1635`standard-syntax-table', the local keymap is set to nil,\n\
1636and the abbrev table from `fundamental-mode-abbrev-table'.\n\
1637This function also forces redisplay of the mode line.\n\
1638\n\
1639Every function to select a new major mode starts by\n\
1640calling this function.\n\n\
1641As a special exception, local variables whose names have\n\
c5a15222
RS
1642a non-nil `permanent-local' property are not eliminated by this function.\n\
1643\n\
1644The first thing this function does is run\n\
1645the normal hook `change-major-mode-hook'.")
1ab256cb
RM
1646 ()
1647{
1648 register Lisp_Object alist, sym, tem;
1649 Lisp_Object oalist;
7410477a 1650
fd186f07
RS
1651 if (!NILP (Vrun_hooks))
1652 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
1ab256cb
RM
1653 oalist = current_buffer->local_var_alist;
1654
2f3f993b
RS
1655 /* Make sure none of the bindings in oalist
1656 remain swapped in, in their symbols. */
1ab256cb 1657
2f3f993b 1658 swap_out_buffer_local_variables (current_buffer);
1ab256cb
RM
1659
1660 /* Actually eliminate all local bindings of this buffer. */
1661
13de9290 1662 reset_buffer_local_variables (current_buffer, 0);
1ab256cb
RM
1663
1664 /* Redisplay mode lines; we are changing major mode. */
1665
1666 update_mode_lines++;
1667
1668 /* Any which are supposed to be permanent,
1669 make local again, with the same values they had. */
1670
265a9e55 1671 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1ab256cb
RM
1672 {
1673 sym = XCONS (XCONS (alist)->car)->car;
1674 tem = Fget (sym, Qpermanent_local);
265a9e55 1675 if (! NILP (tem))
01050cb5
RM
1676 {
1677 Fmake_local_variable (sym);
1678 Fset (sym, XCONS (XCONS (alist)->car)->cdr);
1679 }
1ab256cb
RM
1680 }
1681
1682 /* Force mode-line redisplay. Useful here because all major mode
1683 commands call this function. */
1684 update_mode_lines++;
1685
1686 return Qnil;
1687}
2f3f993b
RS
1688
1689/* Make sure no local variables remain set up with buffer B
1690 for their current values. */
1691
1692static void
1693swap_out_buffer_local_variables (b)
1694 struct buffer *b;
1695{
1696 Lisp_Object oalist, alist, sym, tem, buffer;
1697
1698 XSETBUFFER (buffer, b);
1699 oalist = b->local_var_alist;
1700
1701 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1702 {
1703 sym = XCONS (XCONS (alist)->car)->car;
1704
1705 /* Need not do anything if some other buffer's binding is now encached. */
1706 tem = XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->cdr)->car;
1707 if (XBUFFER (tem) == current_buffer)
1708 {
1709 /* Symbol is set up for this buffer's old local value.
1710 Set it up for the current buffer with the default value. */
1711
1712 tem = XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->cdr)->cdr;
1713 /* Store the symbol's current value into the alist entry
1714 it is currently set up for. This is so that, if the
1715 local is marked permanent, and we make it local again
1716 later in Fkill_all_local_variables, we don't lose the value. */
1717 XCONS (XCONS (tem)->car)->cdr
1718 = do_symval_forwarding (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->car);
1719 /* Switch to the symbol's default-value alist entry. */
1720 XCONS (tem)->car = tem;
1721 /* Mark it as current for buffer B. */
1722 XCONS (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->cdr)->car
1723 = buffer;
1724 /* Store the current value into any forwarding in the symbol. */
1725 store_symval_forwarding (sym, XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->car,
1726 XCONS (tem)->cdr);
1727 }
1728 }
1729}
1ab256cb 1730\f
2eec3b4e
RS
1731/* Find all the overlays in the current buffer that contain position POS.
1732 Return the number found, and store them in a vector in *VEC_PTR.
1733 Store in *LEN_PTR the size allocated for the vector.
52f8ec73
JB
1734 Store in *NEXT_PTR the next position after POS where an overlay starts,
1735 or ZV if there are no more overlays.
bbbe9545 1736 Store in *PREV_PTR the previous position before POS where an overlay ends,
239c932b
RS
1737 or BEGV if there are no previous overlays.
1738 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2eec3b4e
RS
1739
1740 *VEC_PTR and *LEN_PTR should contain a valid vector and size
61d54cd5
RS
1741 when this function is called.
1742
1743 If EXTEND is non-zero, we make the vector bigger if necessary.
1744 If EXTEND is zero, we never extend the vector,
1745 and we store only as many overlays as will fit.
1746 But we still return the total number of overlays. */
2eec3b4e
RS
1747
1748int
239c932b 1749overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2eec3b4e 1750 int pos;
61d54cd5 1751 int extend;
2eec3b4e
RS
1752 Lisp_Object **vec_ptr;
1753 int *len_ptr;
1754 int *next_ptr;
239c932b 1755 int *prev_ptr;
1ab256cb 1756{
2eec3b4e
RS
1757 Lisp_Object tail, overlay, start, end, result;
1758 int idx = 0;
1759 int len = *len_ptr;
1760 Lisp_Object *vec = *vec_ptr;
1761 int next = ZV;
239c932b 1762 int prev = BEGV;
61d54cd5
RS
1763 int inhibit_storing = 0;
1764
2eec3b4e 1765 for (tail = current_buffer->overlays_before;
8fc0589a 1766 GC_CONSP (tail);
2eec3b4e
RS
1767 tail = XCONS (tail)->cdr)
1768 {
239c932b 1769 int startpos, endpos;
52f8ec73 1770
2eec3b4e 1771 overlay = XCONS (tail)->car;
1ab256cb 1772
2eec3b4e
RS
1773 start = OVERLAY_START (overlay);
1774 end = OVERLAY_END (overlay);
239c932b
RS
1775 endpos = OVERLAY_POSITION (end);
1776 if (endpos < pos)
1777 {
1778 if (prev < endpos)
1779 prev = endpos;
1780 break;
1781 }
1782 if (endpos == pos)
1783 continue;
2eec3b4e
RS
1784 startpos = OVERLAY_POSITION (start);
1785 if (startpos <= pos)
1786 {
1787 if (idx == len)
1788 {
61d54cd5
RS
1789 /* The supplied vector is full.
1790 Either make it bigger, or don't store any more in it. */
1791 if (extend)
1792 {
1793 *len_ptr = len *= 2;
1794 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1795 *vec_ptr = vec;
1796 }
1797 else
1798 inhibit_storing = 1;
2eec3b4e 1799 }
61d54cd5
RS
1800
1801 if (!inhibit_storing)
1802 vec[idx] = overlay;
1803 /* Keep counting overlays even if we can't return them all. */
1804 idx++;
2eec3b4e
RS
1805 }
1806 else if (startpos < next)
1807 next = startpos;
1808 }
1809
1810 for (tail = current_buffer->overlays_after;
8fc0589a 1811 GC_CONSP (tail);
2eec3b4e 1812 tail = XCONS (tail)->cdr)
1ab256cb 1813 {
239c932b 1814 int startpos, endpos;
52f8ec73 1815
2eec3b4e 1816 overlay = XCONS (tail)->car;
2eec3b4e
RS
1817
1818 start = OVERLAY_START (overlay);
1819 end = OVERLAY_END (overlay);
1820 startpos = OVERLAY_POSITION (start);
52f8ec73 1821 if (pos < startpos)
2eec3b4e
RS
1822 {
1823 if (startpos < next)
1824 next = startpos;
1825 break;
1826 }
239c932b
RS
1827 endpos = OVERLAY_POSITION (end);
1828 if (pos < endpos)
2eec3b4e
RS
1829 {
1830 if (idx == len)
1831 {
61d54cd5
RS
1832 if (extend)
1833 {
1834 *len_ptr = len *= 2;
1835 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1836 *vec_ptr = vec;
1837 }
1838 else
1839 inhibit_storing = 1;
2eec3b4e 1840 }
61d54cd5
RS
1841
1842 if (!inhibit_storing)
1843 vec[idx] = overlay;
1844 idx++;
2eec3b4e 1845 }
239c932b
RS
1846 else if (endpos < pos && endpos > prev)
1847 prev = endpos;
1ab256cb
RM
1848 }
1849
239c932b
RS
1850 if (next_ptr)
1851 *next_ptr = next;
1852 if (prev_ptr)
1853 *prev_ptr = prev;
2eec3b4e
RS
1854 return idx;
1855}
74514898
RS
1856\f
1857/* Find all the overlays in the current buffer that overlap the range BEG-END
2a3eeee7
RS
1858 or are empty at BEG.
1859
74514898
RS
1860 Return the number found, and store them in a vector in *VEC_PTR.
1861 Store in *LEN_PTR the size allocated for the vector.
1862 Store in *NEXT_PTR the next position after POS where an overlay starts,
1863 or ZV if there are no more overlays.
1864 Store in *PREV_PTR the previous position before POS where an overlay ends,
1865 or BEGV if there are no previous overlays.
1866 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
1867
1868 *VEC_PTR and *LEN_PTR should contain a valid vector and size
1869 when this function is called.
1870
1871 If EXTEND is non-zero, we make the vector bigger if necessary.
1872 If EXTEND is zero, we never extend the vector,
1873 and we store only as many overlays as will fit.
1874 But we still return the total number of overlays. */
1875
1876int
1877overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
1878 int beg, end;
1879 int extend;
1880 Lisp_Object **vec_ptr;
1881 int *len_ptr;
1882 int *next_ptr;
1883 int *prev_ptr;
1884{
1885 Lisp_Object tail, overlay, ostart, oend, result;
1886 int idx = 0;
1887 int len = *len_ptr;
1888 Lisp_Object *vec = *vec_ptr;
1889 int next = ZV;
1890 int prev = BEGV;
1891 int inhibit_storing = 0;
1892
1893 for (tail = current_buffer->overlays_before;
1894 GC_CONSP (tail);
1895 tail = XCONS (tail)->cdr)
1896 {
1897 int startpos, endpos;
1898
1899 overlay = XCONS (tail)->car;
1900
1901 ostart = OVERLAY_START (overlay);
1902 oend = OVERLAY_END (overlay);
1903 endpos = OVERLAY_POSITION (oend);
1904 if (endpos < beg)
1905 {
1906 if (prev < endpos)
1907 prev = endpos;
1908 break;
1909 }
1910 startpos = OVERLAY_POSITION (ostart);
1911 /* Count an interval if it either overlaps the range
2a3eeee7 1912 or is empty at the start of the range. */
74514898 1913 if ((beg < endpos && startpos < end)
2a3eeee7 1914 || (startpos == endpos && beg == endpos))
74514898
RS
1915 {
1916 if (idx == len)
1917 {
1918 /* The supplied vector is full.
1919 Either make it bigger, or don't store any more in it. */
1920 if (extend)
1921 {
1922 *len_ptr = len *= 2;
1923 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1924 *vec_ptr = vec;
1925 }
1926 else
1927 inhibit_storing = 1;
1928 }
1929
1930 if (!inhibit_storing)
1931 vec[idx] = overlay;
1932 /* Keep counting overlays even if we can't return them all. */
1933 idx++;
1934 }
1935 else if (startpos < next)
1936 next = startpos;
1937 }
1938
1939 for (tail = current_buffer->overlays_after;
1940 GC_CONSP (tail);
1941 tail = XCONS (tail)->cdr)
1942 {
1943 int startpos, endpos;
1944
1945 overlay = XCONS (tail)->car;
1946
1947 ostart = OVERLAY_START (overlay);
1948 oend = OVERLAY_END (overlay);
1949 startpos = OVERLAY_POSITION (ostart);
1950 if (end < startpos)
1951 {
1952 if (startpos < next)
1953 next = startpos;
1954 break;
1955 }
1956 endpos = OVERLAY_POSITION (oend);
2a3eeee7
RS
1957 /* Count an interval if it either overlaps the range
1958 or is empty at the start of the range. */
74514898 1959 if ((beg < endpos && startpos < end)
2a3eeee7 1960 || (startpos == endpos && beg == endpos))
74514898
RS
1961 {
1962 if (idx == len)
1963 {
1964 if (extend)
1965 {
1966 *len_ptr = len *= 2;
1967 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1968 *vec_ptr = vec;
1969 }
1970 else
1971 inhibit_storing = 1;
1972 }
1973
1974 if (!inhibit_storing)
1975 vec[idx] = overlay;
1976 idx++;
1977 }
1978 else if (endpos < beg && endpos > prev)
1979 prev = endpos;
1980 }
fc04fa47 1981
74514898
RS
1982 if (next_ptr)
1983 *next_ptr = next;
1984 if (prev_ptr)
1985 *prev_ptr = prev;
1986 return idx;
1987}
1988\f
fc04fa47
KH
1989/* Fast function to just test if we're at an overlay boundary. */
1990int
1991overlay_touches_p (pos)
1992 int pos;
1993{
1994 Lisp_Object tail, overlay;
1995
1996 for (tail = current_buffer->overlays_before; GC_CONSP (tail);
1997 tail = XCONS (tail)->cdr)
1998 {
1999 int endpos;
2000
2001 overlay = XCONS (tail)->car;
2002 if (!GC_OVERLAYP (overlay))
2003 abort ();
2004
2005 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2006 if (endpos < pos)
2007 break;
2008 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2009 return 1;
2010 }
2011
2012 for (tail = current_buffer->overlays_after; GC_CONSP (tail);
2013 tail = XCONS (tail)->cdr)
2014 {
2015 int startpos;
2016
2017 overlay = XCONS (tail)->car;
2018 if (!GC_OVERLAYP (overlay))
2019 abort ();
2020
2021 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2022 if (pos < startpos)
2023 break;
2024 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2025 return 1;
2026 }
2027 return 0;
2028}
2eec3b4e 2029\f
5985d248
KH
2030struct sortvec
2031{
2032 Lisp_Object overlay;
2033 int beg, end;
2034 int priority;
2035};
2036
2037static int
2038compare_overlays (s1, s2)
2039 struct sortvec *s1, *s2;
2040{
2041 if (s1->priority != s2->priority)
2042 return s1->priority - s2->priority;
2043 if (s1->beg != s2->beg)
2044 return s1->beg - s2->beg;
2045 if (s1->end != s2->end)
2046 return s2->end - s1->end;
2047 return 0;
2048}
2049
2050/* Sort an array of overlays by priority. The array is modified in place.
2051 The return value is the new size; this may be smaller than the original
2052 size if some of the overlays were invalid or were window-specific. */
2053int
2054sort_overlays (overlay_vec, noverlays, w)
2055 Lisp_Object *overlay_vec;
2056 int noverlays;
2057 struct window *w;
2058{
2059 int i, j;
2060 struct sortvec *sortvec;
2061 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2062
2063 /* Put the valid and relevant overlays into sortvec. */
2064
2065 for (i = 0, j = 0; i < noverlays; i++)
2066 {
0fa767e7 2067 Lisp_Object tem;
c99fc30f 2068 Lisp_Object overlay;
5985d248 2069
c99fc30f 2070 overlay = overlay_vec[i];
5985d248
KH
2071 if (OVERLAY_VALID (overlay)
2072 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2073 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2074 {
0fa767e7
KH
2075 /* If we're interested in a specific window, then ignore
2076 overlays that are limited to some other window. */
2077 if (w)
5985d248 2078 {
0fa767e7
KH
2079 Lisp_Object window;
2080
2081 window = Foverlay_get (overlay, Qwindow);
a7a60ce9 2082 if (WINDOWP (window) && XWINDOW (window) != w)
0fa767e7 2083 continue;
5985d248 2084 }
0fa767e7
KH
2085
2086 /* This overlay is good and counts: put it into sortvec. */
2087 sortvec[j].overlay = overlay;
2088 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2089 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2090 tem = Foverlay_get (overlay, Qpriority);
2091 if (INTEGERP (tem))
2092 sortvec[j].priority = XINT (tem);
2093 else
2094 sortvec[j].priority = 0;
2095 j++;
5985d248
KH
2096 }
2097 }
2098 noverlays = j;
2099
2100 /* Sort the overlays into the proper order: increasing priority. */
2101
2102 if (noverlays > 1)
2103 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2104
2105 for (i = 0; i < noverlays; i++)
2106 overlay_vec[i] = sortvec[i].overlay;
2107 return (noverlays);
2108}
2109\f
bbbe9545
KH
2110struct sortstr
2111{
cb26008f 2112 Lisp_Object string, string2;
bbbe9545
KH
2113 int size;
2114 int priority;
2115};
2116
e8185fa8
KH
2117struct sortstrlist
2118{
2119 struct sortstr *buf; /* An array that expands as needed; never freed. */
2120 int size; /* Allocated length of that array. */
2121 int used; /* How much of the array is currently in use. */
2122 int bytes; /* Total length of the strings in buf. */
2123};
2124
2125/* Buffers for storing information about the overlays touching a given
2126 position. These could be automatic variables in overlay_strings, but
2127 it's more efficient to hold onto the memory instead of repeatedly
2128 allocating and freeing it. */
2129static struct sortstrlist overlay_heads, overlay_tails;
9492daf2 2130static unsigned char *overlay_str_buf;
e8185fa8
KH
2131
2132/* Allocated length of overlay_str_buf. */
2133static int overlay_str_len;
2134
bbbe9545
KH
2135/* A comparison function suitable for passing to qsort. */
2136static int
2137cmp_for_strings (as1, as2)
2138 char *as1, *as2;
2139{
2140 struct sortstr *s1 = (struct sortstr *)as1;
2141 struct sortstr *s2 = (struct sortstr *)as2;
2142 if (s1->size != s2->size)
2143 return s2->size - s1->size;
2144 if (s1->priority != s2->priority)
2145 return s1->priority - s2->priority;
2146 return 0;
2147}
2148
e8185fa8 2149static void
cb26008f 2150record_overlay_string (ssl, str, str2, pri, size)
e8185fa8 2151 struct sortstrlist *ssl;
cb26008f 2152 Lisp_Object str, str2, pri;
e8185fa8
KH
2153 int size;
2154{
2155 if (ssl->used == ssl->size)
2156 {
2157 if (ssl->buf)
2158 ssl->size *= 2;
2159 else
2160 ssl->size = 5;
2161 ssl->buf = ((struct sortstr *)
2162 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2163 }
2164 ssl->buf[ssl->used].string = str;
cb26008f 2165 ssl->buf[ssl->used].string2 = str2;
e8185fa8
KH
2166 ssl->buf[ssl->used].size = size;
2167 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2168 ssl->used++;
2169 ssl->bytes += XSTRING (str)->size;
cb26008f
KH
2170 if (STRINGP (str2))
2171 ssl->bytes += XSTRING (str2)->size;
e8185fa8 2172}
bbbe9545
KH
2173
2174/* Return the concatenation of the strings associated with overlays that
2175 begin or end at POS, ignoring overlays that are specific to a window
2176 other than W. The strings are concatenated in the appropriate order:
2177 shorter overlays nest inside longer ones, and higher priority inside
cb26008f
KH
2178 lower. Normally all of the after-strings come first, but zero-sized
2179 overlays have their after-strings ride along with the before-strings
2180 because it would look strange to print them inside-out.
2181
2182 Returns the string length, and stores the contents indirectly through
2183 PSTR, if that variable is non-null. The string may be overwritten by
2184 subsequent calls. */
6b5d3b89 2185
bbbe9545
KH
2186int
2187overlay_strings (pos, w, pstr)
2188 int pos;
2189 struct window *w;
6b5d3b89 2190 unsigned char **pstr;
bbbe9545 2191{
e8185fa8 2192 Lisp_Object ov, overlay, window, str;
bbbe9545
KH
2193 int startpos, endpos;
2194
e8185fa8
KH
2195 overlay_heads.used = overlay_heads.bytes = 0;
2196 overlay_tails.used = overlay_tails.bytes = 0;
bbbe9545
KH
2197 for (ov = current_buffer->overlays_before; CONSP (ov); ov = XCONS (ov)->cdr)
2198 {
2199 overlay = XCONS (ov)->car;
2200 if (!OVERLAYP (overlay))
2201 abort ();
2202
2203 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2204 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2205 if (endpos < pos)
2206 break;
2207 if (endpos != pos && startpos != pos)
2208 continue;
2209 window = Foverlay_get (overlay, Qwindow);
2210 if (WINDOWP (window) && XWINDOW (window) != w)
2211 continue;
e8185fa8
KH
2212 if (startpos == pos
2213 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2214 record_overlay_string (&overlay_heads, str,
cb26008f
KH
2215 (startpos == endpos
2216 ? Foverlay_get (overlay, Qafter_string)
2217 : Qnil),
2218 Foverlay_get (overlay, Qpriority),
2219 endpos - startpos);
2220 else if (endpos == pos
2221 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2222 record_overlay_string (&overlay_tails, str, Qnil,
e8185fa8
KH
2223 Foverlay_get (overlay, Qpriority),
2224 endpos - startpos);
bbbe9545
KH
2225 }
2226 for (ov = current_buffer->overlays_after; CONSP (ov); ov = XCONS (ov)->cdr)
2227 {
2228 overlay = XCONS (ov)->car;
2229 if (!OVERLAYP (overlay))
2230 abort ();
2231
2232 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2233 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2234 if (startpos > pos)
2235 break;
e8185fa8
KH
2236 if (endpos != pos && startpos != pos)
2237 continue;
2238 window = Foverlay_get (overlay, Qwindow);
2239 if (WINDOWP (window) && XWINDOW (window) != w)
2240 continue;
e8185fa8
KH
2241 if (startpos == pos
2242 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2243 record_overlay_string (&overlay_heads, str,
cb26008f
KH
2244 (startpos == endpos
2245 ? Foverlay_get (overlay, Qafter_string)
2246 : Qnil),
2247 Foverlay_get (overlay, Qpriority),
2248 endpos - startpos);
2249 else if (endpos == pos
2250 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2251 record_overlay_string (&overlay_tails, str, Qnil,
e8185fa8
KH
2252 Foverlay_get (overlay, Qpriority),
2253 endpos - startpos);
bbbe9545 2254 }
e8185fa8
KH
2255 if (overlay_tails.used > 1)
2256 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
2257 cmp_for_strings);
2258 if (overlay_heads.used > 1)
2259 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
2260 cmp_for_strings);
2261 if (overlay_heads.bytes || overlay_tails.bytes)
bbbe9545 2262 {
e8185fa8 2263 Lisp_Object tem;
bbbe9545 2264 int i;
9f4d7cde 2265 unsigned char *p;
e8185fa8 2266 int total = overlay_heads.bytes + overlay_tails.bytes;
bbbe9545
KH
2267
2268 if (total > overlay_str_len)
9f4d7cde
RS
2269 {
2270 overlay_str_len = total;
2271 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
2272 total);
2273 }
bbbe9545 2274 p = overlay_str_buf;
e8185fa8 2275 for (i = overlay_tails.used; --i >= 0;)
bbbe9545 2276 {
e8185fa8 2277 tem = overlay_tails.buf[i].string;
bbbe9545
KH
2278 bcopy (XSTRING (tem)->data, p, XSTRING (tem)->size);
2279 p += XSTRING (tem)->size;
2280 }
e8185fa8 2281 for (i = 0; i < overlay_heads.used; ++i)
bbbe9545 2282 {
e8185fa8 2283 tem = overlay_heads.buf[i].string;
bbbe9545
KH
2284 bcopy (XSTRING (tem)->data, p, XSTRING (tem)->size);
2285 p += XSTRING (tem)->size;
cb26008f
KH
2286 tem = overlay_heads.buf[i].string2;
2287 if (STRINGP (tem))
2288 {
2289 bcopy (XSTRING (tem)->data, p, XSTRING (tem)->size);
2290 p += XSTRING (tem)->size;
2291 }
bbbe9545 2292 }
cb26008f
KH
2293 if (p != overlay_str_buf + total)
2294 abort ();
bbbe9545
KH
2295 if (pstr)
2296 *pstr = overlay_str_buf;
e8185fa8 2297 return total;
bbbe9545 2298 }
e8185fa8 2299 return 0;
bbbe9545
KH
2300}
2301\f
5c4f68f1 2302/* Shift overlays in BUF's overlay lists, to center the lists at POS. */
1ab256cb 2303
2eec3b4e 2304void
5c4f68f1
JB
2305recenter_overlay_lists (buf, pos)
2306 struct buffer *buf;
2eec3b4e
RS
2307 int pos;
2308{
2309 Lisp_Object overlay, tail, next, prev, beg, end;
2310
2311 /* See if anything in overlays_before should move to overlays_after. */
2312
2313 /* We don't strictly need prev in this loop; it should always be nil.
2314 But we use it for symmetry and in case that should cease to be true
2315 with some future change. */
2316 prev = Qnil;
5c4f68f1 2317 for (tail = buf->overlays_before;
2eec3b4e
RS
2318 CONSP (tail);
2319 prev = tail, tail = next)
1ab256cb 2320 {
2eec3b4e
RS
2321 next = XCONS (tail)->cdr;
2322 overlay = XCONS (tail)->car;
2323
2324 /* If the overlay is not valid, get rid of it. */
2325 if (!OVERLAY_VALID (overlay))
52f8ec73
JB
2326#if 1
2327 abort ();
2328#else
2eec3b4e
RS
2329 {
2330 /* Splice the cons cell TAIL out of overlays_before. */
2331 if (!NILP (prev))
2332 XCONS (prev)->cdr = next;
2333 else
5c4f68f1 2334 buf->overlays_before = next;
2eec3b4e
RS
2335 tail = prev;
2336 continue;
2337 }
52f8ec73 2338#endif
1ab256cb 2339
2eec3b4e
RS
2340 beg = OVERLAY_START (overlay);
2341 end = OVERLAY_END (overlay);
1ab256cb 2342
2eec3b4e 2343 if (OVERLAY_POSITION (end) > pos)
1ab256cb 2344 {
2eec3b4e
RS
2345 /* OVERLAY needs to be moved. */
2346 int where = OVERLAY_POSITION (beg);
2347 Lisp_Object other, other_prev;
2348
2349 /* Splice the cons cell TAIL out of overlays_before. */
2350 if (!NILP (prev))
2351 XCONS (prev)->cdr = next;
2352 else
5c4f68f1 2353 buf->overlays_before = next;
2eec3b4e
RS
2354
2355 /* Search thru overlays_after for where to put it. */
2356 other_prev = Qnil;
5c4f68f1 2357 for (other = buf->overlays_after;
2eec3b4e
RS
2358 CONSP (other);
2359 other_prev = other, other = XCONS (other)->cdr)
1ab256cb 2360 {
2eec3b4e
RS
2361 Lisp_Object otherbeg, otheroverlay, follower;
2362 int win;
2363
2364 otheroverlay = XCONS (other)->car;
2365 if (! OVERLAY_VALID (otheroverlay))
52f8ec73 2366 abort ();
2eec3b4e
RS
2367
2368 otherbeg = OVERLAY_START (otheroverlay);
2369 if (OVERLAY_POSITION (otherbeg) >= where)
2370 break;
1ab256cb 2371 }
2eec3b4e
RS
2372
2373 /* Add TAIL to overlays_after before OTHER. */
2374 XCONS (tail)->cdr = other;
2375 if (!NILP (other_prev))
2376 XCONS (other_prev)->cdr = tail;
1ab256cb 2377 else
5c4f68f1 2378 buf->overlays_after = tail;
2eec3b4e 2379 tail = prev;
1ab256cb 2380 }
2eec3b4e
RS
2381 else
2382 /* We've reached the things that should stay in overlays_before.
2383 All the rest of overlays_before must end even earlier,
2384 so stop now. */
2385 break;
2386 }
2387
2388 /* See if anything in overlays_after should be in overlays_before. */
2389 prev = Qnil;
5c4f68f1 2390 for (tail = buf->overlays_after;
2eec3b4e
RS
2391 CONSP (tail);
2392 prev = tail, tail = next)
2393 {
2394 next = XCONS (tail)->cdr;
2395 overlay = XCONS (tail)->car;
2396
2397 /* If the overlay is not valid, get rid of it. */
2398 if (!OVERLAY_VALID (overlay))
52f8ec73
JB
2399#if 1
2400 abort ();
2401#else
2eec3b4e
RS
2402 {
2403 /* Splice the cons cell TAIL out of overlays_after. */
2404 if (!NILP (prev))
2405 XCONS (prev)->cdr = next;
2406 else
5c4f68f1 2407 buf->overlays_after = next;
2eec3b4e
RS
2408 tail = prev;
2409 continue;
2410 }
52f8ec73 2411#endif
2eec3b4e
RS
2412
2413 beg = OVERLAY_START (overlay);
2414 end = OVERLAY_END (overlay);
2415
2416 /* Stop looking, when we know that nothing further
2417 can possibly end before POS. */
2418 if (OVERLAY_POSITION (beg) > pos)
2419 break;
2420
2421 if (OVERLAY_POSITION (end) <= pos)
2422 {
2423 /* OVERLAY needs to be moved. */
2424 int where = OVERLAY_POSITION (end);
2425 Lisp_Object other, other_prev;
2426
2427 /* Splice the cons cell TAIL out of overlays_after. */
2428 if (!NILP (prev))
2429 XCONS (prev)->cdr = next;
2430 else
5c4f68f1 2431 buf->overlays_after = next;
2eec3b4e
RS
2432
2433 /* Search thru overlays_before for where to put it. */
2434 other_prev = Qnil;
5c4f68f1 2435 for (other = buf->overlays_before;
2eec3b4e
RS
2436 CONSP (other);
2437 other_prev = other, other = XCONS (other)->cdr)
2438 {
2439 Lisp_Object otherend, otheroverlay;
2440 int win;
2441
2442 otheroverlay = XCONS (other)->car;
2443 if (! OVERLAY_VALID (otheroverlay))
52f8ec73 2444 abort ();
2eec3b4e
RS
2445
2446 otherend = OVERLAY_END (otheroverlay);
2447 if (OVERLAY_POSITION (otherend) <= where)
2448 break;
2449 }
2450
2451 /* Add TAIL to overlays_before before OTHER. */
2452 XCONS (tail)->cdr = other;
2453 if (!NILP (other_prev))
2454 XCONS (other_prev)->cdr = tail;
2455 else
5c4f68f1 2456 buf->overlays_before = tail;
2eec3b4e
RS
2457 tail = prev;
2458 }
2459 }
2460
8d7a4592 2461 XSETFASTINT (buf->overlay_center, pos);
2eec3b4e 2462}
2b1bdf65 2463
423cdb46
KH
2464void
2465adjust_overlays_for_insert (pos, length)
2466 int pos;
2467 int length;
2468{
2469 /* After an insertion, the lists are still sorted properly,
2470 but we may need to update the value of the overlay center. */
2471 if (XFASTINT (current_buffer->overlay_center) >= pos)
2472 XSETFASTINT (current_buffer->overlay_center,
2473 XFASTINT (current_buffer->overlay_center) + length);
2474}
2475
2476void
2477adjust_overlays_for_delete (pos, length)
2478 int pos;
2479 int length;
2480{
2481 if (XFASTINT (current_buffer->overlay_center) < pos)
2482 /* The deletion was to our right. No change needed; the before- and
2483 after-lists are still consistent. */
2484 ;
2485 else if (XFASTINT (current_buffer->overlay_center) > pos + length)
2486 /* The deletion was to our left. We need to adjust the center value
2487 to account for the change in position, but the lists are consistent
2488 given the new value. */
2489 XSETFASTINT (current_buffer->overlay_center,
2490 XFASTINT (current_buffer->overlay_center) - length);
2491 else
2492 /* We're right in the middle. There might be things on the after-list
2493 that now belong on the before-list. Recentering will move them,
2494 and also update the center point. */
2495 recenter_overlay_lists (current_buffer, pos);
2496}
2497
2b1bdf65
KH
2498/* Fix up overlays that were garbled as a result of permuting markers
2499 in the range START through END. Any overlay with at least one
2500 endpoint in this range will need to be unlinked from the overlay
2501 list and reinserted in its proper place.
2502 Such an overlay might even have negative size at this point.
2503 If so, we'll reverse the endpoints. Can you think of anything
2504 better to do in this situation? */
2505void
2506fix_overlays_in_range (start, end)
2507 register int start, end;
2508{
2509 Lisp_Object tem, overlay;
2510 Lisp_Object before_list, after_list;
2511 Lisp_Object *ptail, *pbefore = &before_list, *pafter = &after_list;
2512 int startpos, endpos;
2513
2514 /* This algorithm shifts links around instead of consing and GCing.
2515 The loop invariant is that before_list (resp. after_list) is a
2516 well-formed list except that its last element, the one that
2517 *pbefore (resp. *pafter) points to, is still uninitialized.
2518 So it's not a bug that before_list isn't initialized, although
2519 it may look strange. */
2520 for (ptail = &current_buffer->overlays_before; CONSP (*ptail);)
2521 {
2522 overlay = XCONS (*ptail)->car;
2523 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2524 if (endpos < start)
2525 break;
2526 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2527 if (endpos < end
2528 || (startpos >= start && startpos < end))
2529 {
2530 /* If the overlay is backwards, fix that now. */
2531 if (startpos > endpos)
2532 {
2533 int tem;
2c99f3ea
RS
2534 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
2535 Qnil);
2536 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
2537 Qnil);
2b1bdf65
KH
2538 tem = startpos; startpos = endpos; endpos = tem;
2539 }
2540 /* Add it to the end of the wrong list. Later on,
2541 recenter_overlay_lists will move it to the right place. */
2542 if (endpos < XINT (current_buffer->overlay_center))
2543 {
2544 *pafter = *ptail;
2545 pafter = &XCONS (*ptail)->cdr;
2546 }
2547 else
2548 {
2549 *pbefore = *ptail;
2550 pbefore = &XCONS (*ptail)->cdr;
2551 }
2552 *ptail = XCONS (*ptail)->cdr;
2553 }
2554 else
2555 ptail = &XCONS (*ptail)->cdr;
2556 }
2557 for (ptail = &current_buffer->overlays_after; CONSP (*ptail);)
2558 {
2559 overlay = XCONS (*ptail)->car;
2560 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2561 if (startpos >= end)
2562 break;
2563 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2564 if (startpos >= start
2565 || (endpos >= start && endpos < end))
2566 {
2567 if (startpos > endpos)
2568 {
2569 int tem;
2c99f3ea
RS
2570 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
2571 Qnil);
2572 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
2573 Qnil);
2b1bdf65
KH
2574 tem = startpos; startpos = endpos; endpos = tem;
2575 }
2576 if (endpos < XINT (current_buffer->overlay_center))
2577 {
2578 *pafter = *ptail;
2579 pafter = &XCONS (*ptail)->cdr;
2580 }
2581 else
2582 {
2583 *pbefore = *ptail;
2584 pbefore = &XCONS (*ptail)->cdr;
2585 }
2586 *ptail = XCONS (*ptail)->cdr;
2587 }
2588 else
2589 ptail = &XCONS (*ptail)->cdr;
2590 }
2591
2592 /* Splice the constructed (wrong) lists into the buffer's lists,
2593 and let the recenter function make it sane again. */
2594 *pbefore = current_buffer->overlays_before;
2595 current_buffer->overlays_before = before_list;
2596 recenter_overlay_lists (current_buffer,
2597 XINT (current_buffer->overlay_center));
2598
2599 *pafter = current_buffer->overlays_after;
2600 current_buffer->overlays_after = after_list;
2601 recenter_overlay_lists (current_buffer,
2602 XINT (current_buffer->overlay_center));
2603}
3b06f880
KH
2604
2605/* We have two types of overlay: the one whose ending marker is
2606 after-insertion-marker (this is the usual case) and the one whose
2607 ending marker is before-insertion-marker. When `overlays_before'
2608 contains overlays of the latter type and the former type in this
2609 order and both overlays end at inserting position, inserting a text
2610 increases only the ending marker of the latter type, which results
2611 in incorrect ordering of `overlays_before'.
2612
2613 This function fixes ordering of overlays in the slot
2614 `overlays_before' of the buffer *BP. Before the insertion, `point'
2615 was at PREV, and now is at POS. */
2616
2617fix_overlays_before (bp, prev, pos)
2618 struct buffer *bp;
2619 int prev, pos;
2620{
2621 Lisp_Object *tailp = &bp->overlays_before;
2622 Lisp_Object *right_place;
2623 int end;
2624
2625 /* After the insertion, the several overlays may be in incorrect
2626 order. The possibility is that, in the list `overlays_before',
2627 an overlay which ends at POS appears after an overlay which ends
2628 at PREV. Since POS is greater than PREV, we must fix the
2629 ordering of these overlays, by moving overlays ends at POS before
2630 the overlays ends at PREV. */
2631
2632 /* At first, find a place where disordered overlays should be linked
2633 in. It is where an overlay which end before POS exists. (i.e. an
2634 overlay whose ending marker is after-insertion-marker if disorder
2635 exists). */
2636 while (!NILP (*tailp)
2637 && ((end = OVERLAY_POSITION (OVERLAY_END (XCONS (*tailp)->car)))
2638 >= pos))
2639 tailp = &XCONS (*tailp)->cdr;
2640
2641 /* If we don't find such an overlay,
2642 or the found one ends before PREV,
2643 or the found one is the last one in the list,
2644 we don't have to fix anything. */
2645 if (NILP (*tailp)
2646 || end < prev
2647 || NILP (XCONS (*tailp)->cdr))
2648 return;
2649
2650 right_place = tailp;
2651 tailp = &XCONS (*tailp)->cdr;
2652
2653 /* Now, end position of overlays in the list *TAILP should be before
2654 or equal to PREV. In the loop, an overlay which ends at POS is
2655 moved ahead to the place pointed by RIGHT_PLACE. If we found an
2656 overlay which ends before PREV, the remaining overlays are in
2657 correct order. */
2658 while (!NILP (*tailp))
2659 {
2660 end = OVERLAY_POSITION (OVERLAY_END (XCONS (*tailp)->car));
2661
2662 if (end == pos)
2663 { /* This overlay is disordered. */
2664 Lisp_Object found = *tailp;
2665
2666 /* Unlink the found overlay. */
2667 *tailp = XCONS (found)->cdr;
2668 /* Move an overlay at RIGHT_PLACE to the next of the found one. */
2669 XCONS (found)->cdr = *right_place;
2670 /* Link it into the right place. */
2671 *right_place = found;
2672 }
2673 else if (end == prev)
2674 tailp = &XCONS (*tailp)->cdr;
2675 else /* No more disordered overlay. */
2676 break;
2677 }
2678}
2eec3b4e 2679\f
52f8ec73
JB
2680DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
2681 "Return t if OBJECT is an overlay.")
2682 (object)
2683 Lisp_Object object;
2684{
2685 return (OVERLAYP (object) ? Qt : Qnil);
2686}
2687
acac2700 2688DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
5c4f68f1
JB
2689 "Create a new overlay with range BEG to END in BUFFER.\n\
2690If omitted, BUFFER defaults to the current buffer.\n\
acac2700
RS
2691BEG and END may be integers or markers.\n\
2692The fourth arg FRONT-ADVANCE, if non-nil, makes the\n\
2693front delimiter advance when text is inserted there.\n\
2694The fifth arg REAR-ADVANCE, if non-nil, makes the\n\
2695rear delimiter advance when text is inserted there.")
2696 (beg, end, buffer, front_advance, rear_advance)
5c4f68f1 2697 Lisp_Object beg, end, buffer;
acac2700 2698 Lisp_Object front_advance, rear_advance;
2eec3b4e
RS
2699{
2700 Lisp_Object overlay;
5c4f68f1 2701 struct buffer *b;
2eec3b4e 2702
5c4f68f1 2703 if (NILP (buffer))
67180c6a 2704 XSETBUFFER (buffer, current_buffer);
883047b9
JB
2705 else
2706 CHECK_BUFFER (buffer, 2);
2707 if (MARKERP (beg)
2708 && ! EQ (Fmarker_buffer (beg), buffer))
2709 error ("Marker points into wrong buffer");
2710 if (MARKERP (end)
2711 && ! EQ (Fmarker_buffer (end), buffer))
2712 error ("Marker points into wrong buffer");
2eec3b4e 2713
883047b9
JB
2714 CHECK_NUMBER_COERCE_MARKER (beg, 1);
2715 CHECK_NUMBER_COERCE_MARKER (end, 1);
5c4f68f1 2716
883047b9 2717 if (XINT (beg) > XINT (end))
5c4f68f1 2718 {
c99fc30f
KH
2719 Lisp_Object temp;
2720 temp = beg; beg = end; end = temp;
5c4f68f1 2721 }
883047b9
JB
2722
2723 b = XBUFFER (buffer);
2724
2725 beg = Fset_marker (Fmake_marker (), beg, buffer);
2726 end = Fset_marker (Fmake_marker (), end, buffer);
5c4f68f1 2727
acac2700
RS
2728 if (!NILP (front_advance))
2729 XMARKER (beg)->insertion_type = 1;
2730 if (!NILP (rear_advance))
2731 XMARKER (end)->insertion_type = 1;
597dd755 2732
48e2e3ba 2733 overlay = allocate_misc ();
89ca3e1b 2734 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
48e2e3ba
KH
2735 XOVERLAY (overlay)->start = beg;
2736 XOVERLAY (overlay)->end = end;
2737 XOVERLAY (overlay)->plist = Qnil;
2eec3b4e
RS
2738
2739 /* Put the new overlay on the wrong list. */
2740 end = OVERLAY_END (overlay);
5c4f68f1
JB
2741 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
2742 b->overlays_after = Fcons (overlay, b->overlays_after);
2eec3b4e 2743 else
5c4f68f1 2744 b->overlays_before = Fcons (overlay, b->overlays_before);
2eec3b4e
RS
2745
2746 /* This puts it in the right list, and in the right order. */
5c4f68f1 2747 recenter_overlay_lists (b, XINT (b->overlay_center));
2eec3b4e 2748
b61982dd
JB
2749 /* We don't need to redisplay the region covered by the overlay, because
2750 the overlay has no properties at the moment. */
2751
2eec3b4e
RS
2752 return overlay;
2753}
876aa27c
RS
2754\f
2755/* Mark a section of BUF as needing redisplay because of overlays changes. */
2756
2757static void
2758modify_overlay (buf, start, end)
2759 struct buffer *buf;
2760 int start, end;
2761{
2762 if (start == end)
2763 return;
2764
2765 if (start > end)
2766 {
2767 int temp = start;
2768 start = end; end = temp;
2769 }
2770
2771 /* If this is a buffer not in the selected window,
2772 we must do other windows. */
2773 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
2774 windows_or_buffers_changed = 1;
2775 /* If it's not current, we can't use beg_unchanged, end_unchanged for it. */
2776 else if (buf != current_buffer)
2777 windows_or_buffers_changed = 1;
2778 /* If multiple windows show this buffer, we must do other windows. */
2779 else if (buffer_shared > 1)
2780 windows_or_buffers_changed = 1;
2781 else
2782 {
2783 if (unchanged_modified == MODIFF
2784 && overlay_unchanged_modified == OVERLAY_MODIFF)
2785 {
2786 beg_unchanged = start - BEG;
2787 end_unchanged = Z - end;
2788 }
2789 else
2790 {
2791 if (Z - end < end_unchanged)
2792 end_unchanged = Z - end;
2793 if (start - BEG < beg_unchanged)
2794 beg_unchanged = start - BEG;
2795 }
2796 }
2797
2798 ++OVERLAY_MODIFF;
2799}
2eec3b4e 2800
876aa27c 2801\f\f
2e34157c
RS
2802Lisp_Object Fdelete_overlay ();
2803
5c4f68f1
JB
2804DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
2805 "Set the endpoints of OVERLAY to BEG and END in BUFFER.\n\
3ece337a
JB
2806If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.\n\
2807If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current\n\
2808buffer.")
5c4f68f1
JB
2809 (overlay, beg, end, buffer)
2810 Lisp_Object overlay, beg, end, buffer;
2eec3b4e 2811{
0a4469c9
RS
2812 struct buffer *b, *ob;
2813 Lisp_Object obuffer;
2814 int count = specpdl_ptr - specpdl;
5c4f68f1 2815
52f8ec73 2816 CHECK_OVERLAY (overlay, 0);
5c4f68f1
JB
2817 if (NILP (buffer))
2818 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3ece337a 2819 if (NILP (buffer))
67180c6a 2820 XSETBUFFER (buffer, current_buffer);
5c4f68f1 2821 CHECK_BUFFER (buffer, 3);
883047b9
JB
2822
2823 if (MARKERP (beg)
2824 && ! EQ (Fmarker_buffer (beg), buffer))
2825 error ("Marker points into wrong buffer");
2826 if (MARKERP (end)
2827 && ! EQ (Fmarker_buffer (end), buffer))
2828 error ("Marker points into wrong buffer");
2829
b61982dd
JB
2830 CHECK_NUMBER_COERCE_MARKER (beg, 1);
2831 CHECK_NUMBER_COERCE_MARKER (end, 1);
2832
9d7608b7
KH
2833 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
2834 return Fdelete_overlay (overlay);
0a4469c9 2835
b61982dd
JB
2836 if (XINT (beg) > XINT (end))
2837 {
c99fc30f
KH
2838 Lisp_Object temp;
2839 temp = beg; beg = end; end = temp;
b61982dd
JB
2840 }
2841
9d7608b7
KH
2842 specbind (Qinhibit_quit, Qt);
2843
0a4469c9 2844 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
5c4f68f1 2845 b = XBUFFER (buffer);
0a4469c9 2846 ob = XBUFFER (obuffer);
2eec3b4e 2847
c82ed728 2848 /* If the overlay has changed buffers, do a thorough redisplay. */
0a4469c9 2849 if (!EQ (buffer, obuffer))
50760c4a
RS
2850 {
2851 /* Redisplay where the overlay was. */
2852 if (!NILP (obuffer))
2853 {
2e34157c
RS
2854 int o_beg;
2855 int o_end;
50760c4a 2856
80509f2f
RS
2857 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2858 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
50760c4a 2859
2e34157c 2860 modify_overlay (ob, o_beg, o_end);
50760c4a
RS
2861 }
2862
2863 /* Redisplay where the overlay is going to be. */
876aa27c 2864 modify_overlay (b, XINT (beg), XINT (end));
50760c4a 2865 }
c82ed728
JB
2866 else
2867 /* Redisplay the area the overlay has just left, or just enclosed. */
2868 {
2e34157c 2869 int o_beg, o_end;
c82ed728
JB
2870 int change_beg, change_end;
2871
80509f2f
RS
2872 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2873 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
c82ed728 2874
2e34157c
RS
2875 if (o_beg == XINT (beg))
2876 modify_overlay (b, o_end, XINT (end));
2877 else if (o_end == XINT (end))
2878 modify_overlay (b, o_beg, XINT (beg));
c82ed728
JB
2879 else
2880 {
2e34157c
RS
2881 if (XINT (beg) < o_beg) o_beg = XINT (beg);
2882 if (XINT (end) > o_end) o_end = XINT (end);
2883 modify_overlay (b, o_beg, o_end);
c82ed728
JB
2884 }
2885 }
b61982dd 2886
0a4469c9
RS
2887 if (!NILP (obuffer))
2888 {
2889 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
2890 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
2891 }
5c4f68f1
JB
2892
2893 Fset_marker (OVERLAY_START (overlay), beg, buffer);
2894 Fset_marker (OVERLAY_END (overlay), end, buffer);
2eec3b4e
RS
2895
2896 /* Put the overlay on the wrong list. */
2897 end = OVERLAY_END (overlay);
5c4f68f1
JB
2898 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
2899 b->overlays_after = Fcons (overlay, b->overlays_after);
2eec3b4e 2900 else
5c4f68f1 2901 b->overlays_before = Fcons (overlay, b->overlays_before);
2eec3b4e
RS
2902
2903 /* This puts it in the right list, and in the right order. */
5c4f68f1 2904 recenter_overlay_lists (b, XINT (b->overlay_center));
2eec3b4e 2905
0a4469c9 2906 return unbind_to (count, overlay);
2eec3b4e
RS
2907}
2908
2909DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
5c4f68f1 2910 "Delete the overlay OVERLAY from its buffer.")
2eec3b4e 2911 (overlay)
5c4f68f1 2912 Lisp_Object overlay;
2eec3b4e 2913{
0a4469c9 2914 Lisp_Object buffer;
5c4f68f1 2915 struct buffer *b;
0a4469c9 2916 int count = specpdl_ptr - specpdl;
5c4f68f1 2917
52f8ec73
JB
2918 CHECK_OVERLAY (overlay, 0);
2919
0a4469c9
RS
2920 buffer = Fmarker_buffer (OVERLAY_START (overlay));
2921 if (NILP (buffer))
2922 return Qnil;
2923
2924 b = XBUFFER (buffer);
2925
2926 specbind (Qinhibit_quit, Qt);
5c4f68f1
JB
2927
2928 b->overlays_before = Fdelq (overlay, b->overlays_before);
2929 b->overlays_after = Fdelq (overlay, b->overlays_after);
2930
876aa27c 2931 modify_overlay (b,
a927f5c9
RS
2932 marker_position (OVERLAY_START (overlay)),
2933 marker_position (OVERLAY_END (overlay)));
b61982dd 2934
3ece337a
JB
2935 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
2936 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
2937
0a4469c9 2938 return unbind_to (count, Qnil);
2eec3b4e
RS
2939}
2940\f
8ebafa8d
JB
2941/* Overlay dissection functions. */
2942
2943DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
2944 "Return the position at which OVERLAY starts.")
2945 (overlay)
2946 Lisp_Object overlay;
2947{
2948 CHECK_OVERLAY (overlay, 0);
2949
2950 return (Fmarker_position (OVERLAY_START (overlay)));
2951}
2952
2953DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
2954 "Return the position at which OVERLAY ends.")
2955 (overlay)
2956 Lisp_Object overlay;
2957{
2958 CHECK_OVERLAY (overlay, 0);
2959
2960 return (Fmarker_position (OVERLAY_END (overlay)));
2961}
2962
2963DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
2964 "Return the buffer OVERLAY belongs to.")
2965 (overlay)
2966 Lisp_Object overlay;
2967{
2968 CHECK_OVERLAY (overlay, 0);
2969
2970 return Fmarker_buffer (OVERLAY_START (overlay));
2971}
2972
2973DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
2974 "Return a list of the properties on OVERLAY.\n\
2975This is a copy of OVERLAY's plist; modifying its conses has no effect on\n\
2976OVERLAY.")
2977 (overlay)
2978 Lisp_Object overlay;
2979{
2980 CHECK_OVERLAY (overlay, 0);
2981
48e2e3ba 2982 return Fcopy_sequence (XOVERLAY (overlay)->plist);
8ebafa8d
JB
2983}
2984
2985\f
2eec3b4e 2986DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
eb8c3be9 2987 "Return a list of the overlays that contain position POS.")
2eec3b4e
RS
2988 (pos)
2989 Lisp_Object pos;
2990{
2991 int noverlays;
2eec3b4e
RS
2992 Lisp_Object *overlay_vec;
2993 int len;
2994 Lisp_Object result;
2995
2996 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2997
2998 len = 10;
2999 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3000
3001 /* Put all the overlays we want in a vector in overlay_vec.
3002 Store the length in len. */
2a77a7d7
RS
3003 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3004 (int *) 0, (int *) 0);
2eec3b4e
RS
3005
3006 /* Make a list of them all. */
3007 result = Flist (noverlays, overlay_vec);
3008
9ac0d9e0 3009 xfree (overlay_vec);
2eec3b4e
RS
3010 return result;
3011}
3012
74514898 3013DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
2a3eeee7
RS
3014 "Return a list of the overlays that overlap the region BEG ... END.\n\
3015Overlap means that at least one character is contained within the overlay\n\
3016and also contained within the specified region.\n\
3017Empty overlays are included in the result if they are located at BEG\n\
3018or between BEG and END.")
74514898
RS
3019 (beg, end)
3020 Lisp_Object beg, end;
3021{
3022 int noverlays;
3023 Lisp_Object *overlay_vec;
3024 int len;
3025 Lisp_Object result;
3026
3027 CHECK_NUMBER_COERCE_MARKER (beg, 0);
3028 CHECK_NUMBER_COERCE_MARKER (end, 0);
3029
3030 len = 10;
3031 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3032
3033 /* Put all the overlays we want in a vector in overlay_vec.
3034 Store the length in len. */
3035 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3036 (int *) 0, (int *) 0);
3037
3038 /* Make a list of them all. */
3039 result = Flist (noverlays, overlay_vec);
3040
3041 xfree (overlay_vec);
3042 return result;
3043}
3044
2eec3b4e
RS
3045DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3046 1, 1, 0,
bbe20e81
KH
3047 "Return the next position after POS where an overlay starts or ends.\n\
3048If there are no more overlay boundaries after POS, return (point-max).")
2eec3b4e
RS
3049 (pos)
3050 Lisp_Object pos;
3051{
3052 int noverlays;
3053 int endpos;
3054 Lisp_Object *overlay_vec;
3055 int len;
2eec3b4e
RS
3056 int i;
3057
3058 CHECK_NUMBER_COERCE_MARKER (pos, 0);
3059
3060 len = 10;
3061 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3062
3063 /* Put all the overlays we want in a vector in overlay_vec.
3064 Store the length in len.
3065 endpos gets the position where the next overlay starts. */
2a77a7d7
RS
3066 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3067 &endpos, (int *) 0);
2eec3b4e
RS
3068
3069 /* If any of these overlays ends before endpos,
3070 use its ending point instead. */
3071 for (i = 0; i < noverlays; i++)
3072 {
3073 Lisp_Object oend;
3074 int oendpos;
3075
3076 oend = OVERLAY_END (overlay_vec[i]);
3077 oendpos = OVERLAY_POSITION (oend);
3078 if (oendpos < endpos)
3079 endpos = oendpos;
1ab256cb
RM
3080 }
3081
9ac0d9e0 3082 xfree (overlay_vec);
2eec3b4e
RS
3083 return make_number (endpos);
3084}
239c932b
RS
3085
3086DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3087 Sprevious_overlay_change, 1, 1, 0,
3088 "Return the previous position before POS where an overlay starts or ends.\n\
624bbdc4 3089If there are no more overlay boundaries before POS, return (point-min).")
239c932b
RS
3090 (pos)
3091 Lisp_Object pos;
3092{
3093 int noverlays;
3094 int prevpos;
3095 Lisp_Object *overlay_vec;
3096 int len;
3097 int i;
624bbdc4 3098 Lisp_Object tail;
239c932b
RS
3099
3100 CHECK_NUMBER_COERCE_MARKER (pos, 0);
3101
3102 len = 10;
3103 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3104
624bbdc4
RS
3105 /* At beginning of buffer, we know the answer;
3106 avoid bug subtracting 1 below. */
3107 if (XINT (pos) == BEGV)
3108 return pos;
3109
239c932b
RS
3110 /* Put all the overlays we want in a vector in overlay_vec.
3111 Store the length in len.
3112 prevpos gets the position of an overlay end. */
2a77a7d7
RS
3113 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3114 (int *) 0, &prevpos);
239c932b 3115
624bbdc4 3116 /* If any of these overlays starts after prevpos,
239c932b
RS
3117 maybe use its starting point instead. */
3118 for (i = 0; i < noverlays; i++)
3119 {
3120 Lisp_Object ostart;
3121 int ostartpos;
3122
3123 ostart = OVERLAY_START (overlay_vec[i]);
3124 ostartpos = OVERLAY_POSITION (ostart);
3125 if (ostartpos > prevpos && ostartpos < XINT (pos))
3126 prevpos = ostartpos;
3127 }
3128
624bbdc4
RS
3129 /* If any overlay ends at pos, consider its starting point too. */
3130 for (tail = current_buffer->overlays_before;
3131 GC_CONSP (tail);
3132 tail = XCONS (tail)->cdr)
3133 {
3134 Lisp_Object overlay, ostart;
3135 int ostartpos;
3136
3137 overlay = XCONS (tail)->car;
3138
3139 ostart = OVERLAY_START (overlay);
3140 ostartpos = OVERLAY_POSITION (ostart);
3141 if (ostartpos > prevpos && ostartpos < XINT (pos))
3142 prevpos = ostartpos;
3143 }
3144
239c932b
RS
3145 xfree (overlay_vec);
3146 return make_number (prevpos);
3147}
2eec3b4e
RS
3148\f
3149/* These functions are for debugging overlays. */
3150
3151DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3152 "Return a pair of lists giving all the overlays of the current buffer.\n\
3153The car has all the overlays before the overlay center;\n\
bbe20e81 3154the cdr has all the overlays after the overlay center.\n\
2eec3b4e
RS
3155Recentering overlays moves overlays between these lists.\n\
3156The lists you get are copies, so that changing them has no effect.\n\
3157However, the overlays you get are the real objects that the buffer uses.")
3158 ()
3159{
3160 Lisp_Object before, after;
3161 before = current_buffer->overlays_before;
3162 if (CONSP (before))
3163 before = Fcopy_sequence (before);
3164 after = current_buffer->overlays_after;
3165 if (CONSP (after))
3166 after = Fcopy_sequence (after);
3167
3168 return Fcons (before, after);
3169}
3170
3171DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
3172 "Recenter the overlays of the current buffer around position POS.")
3173 (pos)
3174 Lisp_Object pos;
3175{
3176 CHECK_NUMBER_COERCE_MARKER (pos, 0);
3177
5c4f68f1 3178 recenter_overlay_lists (current_buffer, XINT (pos));
2eec3b4e
RS
3179 return Qnil;
3180}
3181\f
3182DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
a2428fa2 3183 "Get the property of overlay OVERLAY with property name PROP.")
2eec3b4e
RS
3184 (overlay, prop)
3185 Lisp_Object overlay, prop;
3186{
cab4777e 3187 Lisp_Object plist, fallback;
52f8ec73
JB
3188
3189 CHECK_OVERLAY (overlay, 0);
3190
cab4777e
RS
3191 fallback = Qnil;
3192
48e2e3ba 3193 for (plist = XOVERLAY (overlay)->plist;
2eec3b4e
RS
3194 CONSP (plist) && CONSP (XCONS (plist)->cdr);
3195 plist = XCONS (XCONS (plist)->cdr)->cdr)
3196 {
3197 if (EQ (XCONS (plist)->car, prop))
3198 return XCONS (XCONS (plist)->cdr)->car;
cab4777e
RS
3199 else if (EQ (XCONS (plist)->car, Qcategory))
3200 {
3201 Lisp_Object tem;
3202 tem = Fcar (Fcdr (plist));
3203 if (SYMBOLP (tem))
3204 fallback = Fget (tem, prop);
3205 }
2eec3b4e 3206 }
52f8ec73 3207
cab4777e 3208 return fallback;
2eec3b4e
RS
3209}
3210
3211DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
3212 "Set one property of overlay OVERLAY: give property PROP value VALUE.")
3213 (overlay, prop, value)
3214 Lisp_Object overlay, prop, value;
3215{
48e2e3ba 3216 Lisp_Object tail, buffer;
9d7608b7 3217 int changed;
2eec3b4e 3218
52f8ec73 3219 CHECK_OVERLAY (overlay, 0);
b61982dd 3220
274a9425
RS
3221 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3222
48e2e3ba 3223 for (tail = XOVERLAY (overlay)->plist;
2eec3b4e
RS
3224 CONSP (tail) && CONSP (XCONS (tail)->cdr);
3225 tail = XCONS (XCONS (tail)->cdr)->cdr)
274a9425
RS
3226 if (EQ (XCONS (tail)->car, prop))
3227 {
9d7608b7
KH
3228 changed = !EQ (XCONS (XCONS (tail)->cdr)->car, value);
3229 XCONS (XCONS (tail)->cdr)->car = value;
3230 goto found;
274a9425 3231 }
9d7608b7
KH
3232 /* It wasn't in the list, so add it to the front. */
3233 changed = !NILP (value);
48e2e3ba
KH
3234 XOVERLAY (overlay)->plist
3235 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
9d7608b7
KH
3236 found:
3237 if (! NILP (buffer))
3238 {
3239 if (changed)
876aa27c 3240 modify_overlay (XBUFFER (buffer),
9d7608b7
KH
3241 marker_position (OVERLAY_START (overlay)),
3242 marker_position (OVERLAY_END (overlay)));
3243 if (EQ (prop, Qevaporate) && ! NILP (value)
3244 && (OVERLAY_POSITION (OVERLAY_START (overlay))
3245 == OVERLAY_POSITION (OVERLAY_END (overlay))))
3246 Fdelete_overlay (overlay);
3247 }
2eec3b4e 3248 return value;
1ab256cb
RM
3249}
3250\f
9115729e
KH
3251/* Subroutine of report_overlay_modification. */
3252
3253/* Lisp vector holding overlay hook functions to call.
3254 Vector elements come in pairs.
3255 Each even-index element is a list of hook functions.
3256 The following odd-index element is the overlay they came from.
3257
3258 Before the buffer change, we fill in this vector
3259 as we call overlay hook functions.
3260 After the buffer change, we get the functions to call from this vector.
3261 This way we always call the same functions before and after the change. */
3262static Lisp_Object last_overlay_modification_hooks;
3263
3264/* Number of elements actually used in last_overlay_modification_hooks. */
3265static int last_overlay_modification_hooks_used;
3266
3267/* Add one functionlist/overlay pair
3268 to the end of last_overlay_modification_hooks. */
3269
3270static void
3271add_overlay_mod_hooklist (functionlist, overlay)
3272 Lisp_Object functionlist, overlay;
3273{
3274 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
3275
3276 if (last_overlay_modification_hooks_used == oldsize)
3277 {
3278 Lisp_Object old;
3279 old = last_overlay_modification_hooks;
3280 last_overlay_modification_hooks
3281 = Fmake_vector (make_number (oldsize * 2), Qnil);
0b1f1b09
RS
3282 bcopy (XVECTOR (old)->contents,
3283 XVECTOR (last_overlay_modification_hooks)->contents,
9115729e
KH
3284 sizeof (Lisp_Object) * oldsize);
3285 }
3286 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = functionlist;
3287 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = overlay;
3288}
3289\f
173f2a64
RS
3290/* Run the modification-hooks of overlays that include
3291 any part of the text in START to END.
9115729e
KH
3292 If this change is an insertion, also
3293 run the insert-before-hooks of overlay starting at END,
930a9140
RS
3294 and the insert-after-hooks of overlay ending at START.
3295
3296 This is called both before and after the modification.
3297 AFTER is nonzero when we call after the modification.
3298
9115729e
KH
3299 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
3300 When AFTER is nonzero, they are the start position,
3301 the position after the inserted new text,
3302 and the length of deleted or replaced old text. */
173f2a64
RS
3303
3304void
930a9140 3305report_overlay_modification (start, end, after, arg1, arg2, arg3)
173f2a64 3306 Lisp_Object start, end;
930a9140
RS
3307 int after;
3308 Lisp_Object arg1, arg2, arg3;
173f2a64
RS
3309{
3310 Lisp_Object prop, overlay, tail;
9115729e
KH
3311 /* 1 if this change is an insertion. */
3312 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
55b48893 3313 int tail_copied;
930a9140 3314 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
55b48893
RS
3315
3316 overlay = Qnil;
3317 tail = Qnil;
930a9140 3318 GCPRO5 (overlay, tail, arg1, arg2, arg3);
173f2a64 3319
9115729e
KH
3320 if (after)
3321 {
3322 /* Call the functions recorded in last_overlay_modification_hooks
3323 rather than scanning the overlays again.
3324 First copy the vector contents, in case some of these hooks
3325 do subsequent modification of the buffer. */
3326 int size = last_overlay_modification_hooks_used;
3327 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
3328 int i;
3329
3330 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
3331 copy, size * sizeof (Lisp_Object));
3332 gcpro1.var = copy;
3333 gcpro1.nvars = size;
3334
3335 for (i = 0; i < size;)
3336 {
3337 Lisp_Object prop, overlay;
3338 prop = copy[i++];
3339 overlay = copy[i++];
3340 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3341 }
3342 UNGCPRO;
3343 return;
3344 }
3345
3346 /* We are being called before a change.
3347 Scan the overlays to find the functions to call. */
3348 last_overlay_modification_hooks_used = 0;
55b48893 3349 tail_copied = 0;
173f2a64
RS
3350 for (tail = current_buffer->overlays_before;
3351 CONSP (tail);
3352 tail = XCONS (tail)->cdr)
3353 {
3354 int startpos, endpos;
be8b1c6b 3355 Lisp_Object ostart, oend;
173f2a64
RS
3356
3357 overlay = XCONS (tail)->car;
3358
3359 ostart = OVERLAY_START (overlay);
3360 oend = OVERLAY_END (overlay);
3361 endpos = OVERLAY_POSITION (oend);
3362 if (XFASTINT (start) > endpos)
3363 break;
3364 startpos = OVERLAY_POSITION (ostart);
9115729e
KH
3365 if (insertion && (XFASTINT (start) == startpos
3366 || XFASTINT (end) == startpos))
173f2a64
RS
3367 {
3368 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
5fb5aa33
RS
3369 if (!NILP (prop))
3370 {
3371 /* Copy TAIL in case the hook recenters the overlay lists. */
55b48893
RS
3372 if (!tail_copied)
3373 tail = Fcopy_sequence (tail);
3374 tail_copied = 1;
930a9140 3375 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
5fb5aa33 3376 }
173f2a64 3377 }
9115729e
KH
3378 if (insertion && (XFASTINT (start) == endpos
3379 || XFASTINT (end) == endpos))
173f2a64
RS
3380 {
3381 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
5fb5aa33
RS
3382 if (!NILP (prop))
3383 {
55b48893
RS
3384 if (!tail_copied)
3385 tail = Fcopy_sequence (tail);
3386 tail_copied = 1;
930a9140 3387 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
5fb5aa33 3388 }
173f2a64 3389 }
3bd13e92
KH
3390 /* Test for intersecting intervals. This does the right thing
3391 for both insertion and deletion. */
3392 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
173f2a64
RS
3393 {
3394 prop = Foverlay_get (overlay, Qmodification_hooks);
5fb5aa33
RS
3395 if (!NILP (prop))
3396 {
55b48893
RS
3397 if (!tail_copied)
3398 tail = Fcopy_sequence (tail);
3399 tail_copied = 1;
930a9140 3400 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
5fb5aa33 3401 }
173f2a64
RS
3402 }
3403 }
3404
55b48893 3405 tail_copied = 0;
173f2a64
RS
3406 for (tail = current_buffer->overlays_after;
3407 CONSP (tail);
3408 tail = XCONS (tail)->cdr)
3409 {
3410 int startpos, endpos;
be8b1c6b 3411 Lisp_Object ostart, oend;
173f2a64
RS
3412
3413 overlay = XCONS (tail)->car;
3414
3415 ostart = OVERLAY_START (overlay);
3416 oend = OVERLAY_END (overlay);
3417 startpos = OVERLAY_POSITION (ostart);
cdf0b096 3418 endpos = OVERLAY_POSITION (oend);
173f2a64
RS
3419 if (XFASTINT (end) < startpos)
3420 break;
9115729e
KH
3421 if (insertion && (XFASTINT (start) == startpos
3422 || XFASTINT (end) == startpos))
173f2a64
RS
3423 {
3424 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
5fb5aa33
RS
3425 if (!NILP (prop))
3426 {
55b48893
RS
3427 if (!tail_copied)
3428 tail = Fcopy_sequence (tail);
3429 tail_copied = 1;
930a9140 3430 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
5fb5aa33 3431 }
173f2a64 3432 }
9115729e
KH
3433 if (insertion && (XFASTINT (start) == endpos
3434 || XFASTINT (end) == endpos))
173f2a64
RS
3435 {
3436 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
5fb5aa33
RS
3437 if (!NILP (prop))
3438 {
55b48893
RS
3439 if (!tail_copied)
3440 tail = Fcopy_sequence (tail);
3441 tail_copied = 1;
930a9140 3442 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
5fb5aa33 3443 }
173f2a64 3444 }
3bd13e92
KH
3445 /* Test for intersecting intervals. This does the right thing
3446 for both insertion and deletion. */
3447 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
173f2a64
RS
3448 {
3449 prop = Foverlay_get (overlay, Qmodification_hooks);
5fb5aa33
RS
3450 if (!NILP (prop))
3451 {
55b48893
RS
3452 if (!tail_copied)
3453 tail = Fcopy_sequence (tail);
3454 tail_copied = 1;
930a9140 3455 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
5fb5aa33 3456 }
173f2a64
RS
3457 }
3458 }
55b48893
RS
3459
3460 UNGCPRO;
173f2a64
RS
3461}
3462
3463static void
930a9140
RS
3464call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
3465 Lisp_Object list, overlay;
3466 int after;
3467 Lisp_Object arg1, arg2, arg3;
173f2a64 3468{
930a9140 3469 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9115729e 3470
930a9140 3471 GCPRO4 (list, arg1, arg2, arg3);
9115729e
KH
3472 if (! after)
3473 add_overlay_mod_hooklist (list, overlay);
3474
173f2a64
RS
3475 while (!NILP (list))
3476 {
930a9140
RS
3477 if (NILP (arg3))
3478 call4 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2);
3479 else
3480 call5 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
173f2a64
RS
3481 list = Fcdr (list);
3482 }
3483 UNGCPRO;
3484}
9d7608b7
KH
3485
3486/* Delete any zero-sized overlays at position POS, if the `evaporate'
3487 property is set. */
3488void
3489evaporate_overlays (pos)
3490 int pos;
3491{
3492 Lisp_Object tail, overlay, hit_list;
3493
3494 hit_list = Qnil;
3495 if (pos <= XFASTINT (current_buffer->overlay_center))
3496 for (tail = current_buffer->overlays_before; CONSP (tail);
3497 tail = XCONS (tail)->cdr)
3498 {
3499 int endpos;
3500 overlay = XCONS (tail)->car;
3501 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3502 if (endpos < pos)
3503 break;
3504 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
c3935f9d 3505 && ! NILP (Foverlay_get (overlay, Qevaporate)))
9d7608b7
KH
3506 hit_list = Fcons (overlay, hit_list);
3507 }
3508 else
3509 for (tail = current_buffer->overlays_after; CONSP (tail);
3510 tail = XCONS (tail)->cdr)
3511 {
3512 int startpos;
889bf329 3513 overlay = XCONS (tail)->car;
9d7608b7
KH
3514 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3515 if (startpos > pos)
3516 break;
3517 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
c3935f9d 3518 && ! NILP (Foverlay_get (overlay, Qevaporate)))
9d7608b7
KH
3519 hit_list = Fcons (overlay, hit_list);
3520 }
3521 for (; CONSP (hit_list); hit_list = XCONS (hit_list)->cdr)
3522 Fdelete_overlay (XCONS (hit_list)->car);
3523}
173f2a64 3524\f
54dfdeb0
KH
3525/* Somebody has tried to store a value with an unacceptable type
3526 into the buffer-local slot with offset OFFSET. */
0fa3ba92 3527void
54dfdeb0
KH
3528buffer_slot_type_mismatch (offset)
3529 int offset;
0fa3ba92 3530{
54dfdeb0 3531 Lisp_Object sym;
0fa3ba92 3532 char *type_name;
54dfdeb0 3533 sym = *(Lisp_Object *)(offset + (char *)&buffer_local_symbols);
0fa3ba92
JB
3534 switch (XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_types)))
3535 {
3536 case Lisp_Int: type_name = "integers"; break;
3537 case Lisp_String: type_name = "strings"; break;
0fa3ba92 3538 case Lisp_Symbol: type_name = "symbols"; break;
0fa3ba92
JB
3539 default:
3540 abort ();
3541 }
3542
3543 error ("only %s should be stored in the buffer-local variable %s",
54dfdeb0 3544 type_name, XSYMBOL (sym)->name->data);
0fa3ba92
JB
3545}
3546\f
1ab256cb
RM
3547init_buffer_once ()
3548{
3549 register Lisp_Object tem;
3550
13de9290
RS
3551 buffer_permanent_local_flags = 0;
3552
1ab256cb
RM
3553 /* Make sure all markable slots in buffer_defaults
3554 are initialized reasonably, so mark_buffer won't choke. */
3555 reset_buffer (&buffer_defaults);
13de9290 3556 reset_buffer_local_variables (&buffer_defaults, 1);
1ab256cb 3557 reset_buffer (&buffer_local_symbols);
13de9290 3558 reset_buffer_local_variables (&buffer_local_symbols, 1);
336cd056
RS
3559 /* Prevent GC from getting confused. */
3560 buffer_defaults.text = &buffer_defaults.own_text;
3561 buffer_local_symbols.text = &buffer_local_symbols.own_text;
3562#ifdef USE_TEXT_PROPERTIES
3563 BUF_INTERVALS (&buffer_defaults) = 0;
3564 BUF_INTERVALS (&buffer_local_symbols) = 0;
3565#endif
67180c6a
KH
3566 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
3567 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
1ab256cb
RM
3568
3569 /* Set up the default values of various buffer slots. */
3570 /* Must do these before making the first buffer! */
3571
3572 /* real setup is done in loaddefs.el */
3573 buffer_defaults.mode_line_format = build_string ("%-");
3574 buffer_defaults.abbrev_mode = Qnil;
3575 buffer_defaults.overwrite_mode = Qnil;
3576 buffer_defaults.case_fold_search = Qt;
3577 buffer_defaults.auto_fill_function = Qnil;
3578 buffer_defaults.selective_display = Qnil;
3579#ifndef old
3580 buffer_defaults.selective_display_ellipses = Qt;
3581#endif
3582 buffer_defaults.abbrev_table = Qnil;
3583 buffer_defaults.display_table = Qnil;
1ab256cb 3584 buffer_defaults.undo_list = Qnil;
c48f61ef 3585 buffer_defaults.mark_active = Qnil;
be9aafdd 3586 buffer_defaults.file_format = Qnil;
2eec3b4e
RS
3587 buffer_defaults.overlays_before = Qnil;
3588 buffer_defaults.overlays_after = Qnil;
bbbe9545 3589 XSETFASTINT (buffer_defaults.overlay_center, BEG);
1ab256cb 3590
8d7a4592 3591 XSETFASTINT (buffer_defaults.tab_width, 8);
1ab256cb
RM
3592 buffer_defaults.truncate_lines = Qnil;
3593 buffer_defaults.ctl_arrow = Qt;
3b06f880 3594 buffer_defaults.direction_reversed = Qnil;
1ab256cb 3595
f7975d07 3596#ifdef DOS_NT
0776cb1b 3597 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
54ad07d3 3598#endif
a1a17b61 3599 buffer_defaults.enable_multibyte_characters = Qt;
c71b5d9b 3600 buffer_defaults.buffer_file_coding_system = Qnil;
8d7a4592
KH
3601 XSETFASTINT (buffer_defaults.fill_column, 70);
3602 XSETFASTINT (buffer_defaults.left_margin, 0);
28e969dd 3603 buffer_defaults.cache_long_line_scans = Qnil;
f6ed2e84 3604 buffer_defaults.file_truename = Qnil;
7962a441 3605 XSETFASTINT (buffer_defaults.display_count, 0);
1ab256cb
RM
3606
3607 /* Assign the local-flags to the slots that have default values.
3608 The local flag is a bit that is used in the buffer
3609 to say that it has its own local value for the slot.
3610 The local flag bits are in the local_var_flags slot of the buffer. */
3611
3612 /* Nothing can work if this isn't true */
4d2f1389 3613 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
1ab256cb
RM
3614
3615 /* 0 means not a lisp var, -1 means always local, else mask */
3616 bzero (&buffer_local_flags, sizeof buffer_local_flags);
aab80822
KH
3617 XSETINT (buffer_local_flags.filename, -1);
3618 XSETINT (buffer_local_flags.directory, -1);
3619 XSETINT (buffer_local_flags.backed_up, -1);
3620 XSETINT (buffer_local_flags.save_length, -1);
3621 XSETINT (buffer_local_flags.auto_save_file_name, -1);
3622 XSETINT (buffer_local_flags.read_only, -1);
3623 XSETINT (buffer_local_flags.major_mode, -1);
3624 XSETINT (buffer_local_flags.mode_name, -1);
3625 XSETINT (buffer_local_flags.undo_list, -1);
3626 XSETINT (buffer_local_flags.mark_active, -1);
943e065b 3627 XSETINT (buffer_local_flags.point_before_scroll, -1);
f6ed2e84 3628 XSETINT (buffer_local_flags.file_truename, -1);
3cb719bd 3629 XSETINT (buffer_local_flags.invisibility_spec, -1);
55ac8536 3630 XSETINT (buffer_local_flags.file_format, -1);
7962a441 3631 XSETINT (buffer_local_flags.display_count, -1);
8d7a4592
KH
3632
3633 XSETFASTINT (buffer_local_flags.mode_line_format, 1);
3634 XSETFASTINT (buffer_local_flags.abbrev_mode, 2);
3635 XSETFASTINT (buffer_local_flags.overwrite_mode, 4);
3636 XSETFASTINT (buffer_local_flags.case_fold_search, 8);
3637 XSETFASTINT (buffer_local_flags.auto_fill_function, 0x10);
3638 XSETFASTINT (buffer_local_flags.selective_display, 0x20);
1ab256cb 3639#ifndef old
8d7a4592 3640 XSETFASTINT (buffer_local_flags.selective_display_ellipses, 0x40);
1ab256cb 3641#endif
8d7a4592
KH
3642 XSETFASTINT (buffer_local_flags.tab_width, 0x80);
3643 XSETFASTINT (buffer_local_flags.truncate_lines, 0x100);
3644 XSETFASTINT (buffer_local_flags.ctl_arrow, 0x200);
3645 XSETFASTINT (buffer_local_flags.fill_column, 0x400);
3646 XSETFASTINT (buffer_local_flags.left_margin, 0x800);
3647 XSETFASTINT (buffer_local_flags.abbrev_table, 0x1000);
3648 XSETFASTINT (buffer_local_flags.display_table, 0x2000);
f7975d07 3649#ifdef DOS_NT
8d7a4592 3650 XSETFASTINT (buffer_local_flags.buffer_file_type, 0x4000);
13de9290
RS
3651 /* Make this one a permanent local. */
3652 buffer_permanent_local_flags |= 0x4000;
54ad07d3 3653#endif
2e716096
RS
3654 XSETFASTINT (buffer_local_flags.syntax_table, 0x8000);
3655 XSETFASTINT (buffer_local_flags.cache_long_line_scans, 0x10000);
3b06f880
KH
3656 XSETFASTINT (buffer_local_flags.category_table, 0x20000);
3657 XSETFASTINT (buffer_local_flags.direction_reversed, 0x40000);
a1a17b61
KH
3658 XSETFASTINT (buffer_local_flags.enable_multibyte_characters, 0x80000);
3659 /* Make this one a permanent local. */
3660 buffer_permanent_local_flags |= 0x80000;
c71b5d9b
KH
3661 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, 0x100000);
3662 /* Make this one a permanent local. */
3663 buffer_permanent_local_flags |= 0x100000;
3664
1ab256cb
RM
3665 Vbuffer_alist = Qnil;
3666 current_buffer = 0;
3667 all_buffers = 0;
3668
3669 QSFundamental = build_string ("Fundamental");
3670
3671 Qfundamental_mode = intern ("fundamental-mode");
3672 buffer_defaults.major_mode = Qfundamental_mode;
3673
3674 Qmode_class = intern ("mode-class");
3675
3676 Qprotected_field = intern ("protected-field");
3677
3678 Qpermanent_local = intern ("permanent-local");
3679
3680 Qkill_buffer_hook = intern ("kill-buffer-hook");
3681
3682 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
000f8083 3683
1ab256cb
RM
3684 /* super-magic invisible buffer */
3685 Vbuffer_alist = Qnil;
3686
ffd56f97 3687 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
1ab256cb
RM
3688}
3689
3690init_buffer ()
3691{
3692 char buf[MAXPATHLEN+1];
2381d133
JB
3693 char *pwd;
3694 struct stat dotstat, pwdstat;
136351b7 3695 Lisp_Object temp;
f7975d07 3696 int rc;
1ab256cb
RM
3697
3698 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2381d133
JB
3699
3700 /* If PWD is accurate, use it instead of calling getwd. This is faster
3701 when PWD is right, and may avoid a fatal error. */
f7975d07 3702 if ((pwd = getenv ("PWD")) != 0 && IS_DIRECTORY_SEP (*pwd)
2381d133
JB
3703 && stat (pwd, &pwdstat) == 0
3704 && stat (".", &dotstat) == 0
3705 && dotstat.st_ino == pwdstat.st_ino
3706 && dotstat.st_dev == pwdstat.st_dev
3707 && strlen (pwd) < MAXPATHLEN)
3708 strcpy (buf, pwd);
3709 else if (getwd (buf) == 0)
cf1e6391 3710 fatal ("`getwd' failed: %s\n", buf);
1ab256cb
RM
3711
3712#ifndef VMS
3713 /* Maybe this should really use some standard subroutine
3714 whose definition is filename syntax dependent. */
f7975d07
RS
3715 rc = strlen (buf);
3716 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
3717 {
3718 buf[rc] = DIRECTORY_SEP;
3719 buf[rc + 1] = '\0';
3720 }
1ab256cb 3721#endif /* not VMS */
0995fa35 3722
1ab256cb 3723 current_buffer->directory = build_string (buf);
136351b7 3724
0995fa35
RS
3725 /* Add /: to the front of the name
3726 if it would otherwise be treated as magic. */
3727 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
3728 if (! NILP (temp))
3729 current_buffer->directory
3730 = concat2 (build_string ("/:"), current_buffer->directory);
3731
136351b7
RS
3732 temp = get_minibuffer (0);
3733 XBUFFER (temp)->directory = current_buffer->directory;
1ab256cb
RM
3734}
3735
3736/* initialize the buffer routines */
3737syms_of_buffer ()
3738{
188d4d11
RM
3739 extern Lisp_Object Qdisabled;
3740
9115729e
KH
3741 staticpro (&last_overlay_modification_hooks);
3742 last_overlay_modification_hooks
3743 = Fmake_vector (make_number (10), Qnil);
3744
1ab256cb
RM
3745 staticpro (&Vbuffer_defaults);
3746 staticpro (&Vbuffer_local_symbols);
3747 staticpro (&Qfundamental_mode);
3748 staticpro (&Qmode_class);
3749 staticpro (&QSFundamental);
3750 staticpro (&Vbuffer_alist);
3751 staticpro (&Qprotected_field);
3752 staticpro (&Qpermanent_local);
3753 staticpro (&Qkill_buffer_hook);
22378665 3754 Qoverlayp = intern ("overlayp");
52f8ec73 3755 staticpro (&Qoverlayp);
9d7608b7
KH
3756 Qevaporate = intern ("evaporate");
3757 staticpro (&Qevaporate);
294d215f 3758 Qmodification_hooks = intern ("modification-hooks");
22378665 3759 staticpro (&Qmodification_hooks);
294d215f 3760 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
22378665 3761 staticpro (&Qinsert_in_front_hooks);
294d215f 3762 Qinsert_behind_hooks = intern ("insert-behind-hooks");
22378665 3763 staticpro (&Qinsert_behind_hooks);
5fe0b67e 3764 Qget_file_buffer = intern ("get-file-buffer");
22378665 3765 staticpro (&Qget_file_buffer);
5985d248
KH
3766 Qpriority = intern ("priority");
3767 staticpro (&Qpriority);
3768 Qwindow = intern ("window");
3769 staticpro (&Qwindow);
bbbe9545
KH
3770 Qbefore_string = intern ("before-string");
3771 staticpro (&Qbefore_string);
3772 Qafter_string = intern ("after-string");
3773 staticpro (&Qafter_string);
22378665
RS
3774 Qfirst_change_hook = intern ("first-change-hook");
3775 staticpro (&Qfirst_change_hook);
3776 Qbefore_change_functions = intern ("before-change-functions");
3777 staticpro (&Qbefore_change_functions);
3778 Qafter_change_functions = intern ("after-change-functions");
3779 staticpro (&Qafter_change_functions);
1ab256cb
RM
3780
3781 Fput (Qprotected_field, Qerror_conditions,
3782 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
3783 Fput (Qprotected_field, Qerror_message,
3784 build_string ("Attempt to modify a protected field"));
3785
3786 /* All these use DEFVAR_LISP_NOPRO because the slots in
3787 buffer_defaults will all be marked via Vbuffer_defaults. */
3788
3789 DEFVAR_LISP_NOPRO ("default-mode-line-format",
3790 &buffer_defaults.mode_line_format,
3791 "Default value of `mode-line-format' for buffers that don't override it.\n\
3792This is the same as (default-value 'mode-line-format).");
3793
3794 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
3795 &buffer_defaults.abbrev_mode,
3796 "Default value of `abbrev-mode' for buffers that do not override it.\n\
3797This is the same as (default-value 'abbrev-mode).");
3798
3799 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
3800 &buffer_defaults.ctl_arrow,
3801 "Default value of `ctl-arrow' for buffers that do not override it.\n\
3802This is the same as (default-value 'ctl-arrow).");
3803
3b06f880
KH
3804 DEFVAR_LISP_NOPRO ("default-direction-reversed",
3805 &buffer_defaults.direction_reversed,
3806 "Default value of `direction_reversed' for buffers that do not override it.\n\
3807 This is the same as (default-value 'direction-reversed).");
3808
a1a17b61
KH
3809 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
3810 &buffer_defaults.enable_multibyte_characters,
3811 "Default value of `enable-multibyte-characters' for buffers not overriding it.\n\
3812 This is the same as (default-value 'enable-multibyte-characters).");
3813
c71b5d9b
KH
3814 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
3815 &buffer_defaults.buffer_file_coding_system,
3816 "Default value of `buffer-file-coding-system' for buffers not overriding it.\n\
3817 This is the same as (default-value 'buffer-file-coding-system).");
3818
1ab256cb
RM
3819 DEFVAR_LISP_NOPRO ("default-truncate-lines",
3820 &buffer_defaults.truncate_lines,
3821 "Default value of `truncate-lines' for buffers that do not override it.\n\
3822This is the same as (default-value 'truncate-lines).");
3823
3824 DEFVAR_LISP_NOPRO ("default-fill-column",
3825 &buffer_defaults.fill_column,
3826 "Default value of `fill-column' for buffers that do not override it.\n\
3827This is the same as (default-value 'fill-column).");
3828
3829 DEFVAR_LISP_NOPRO ("default-left-margin",
3830 &buffer_defaults.left_margin,
3831 "Default value of `left-margin' for buffers that do not override it.\n\
3832This is the same as (default-value 'left-margin).");
3833
3834 DEFVAR_LISP_NOPRO ("default-tab-width",
3835 &buffer_defaults.tab_width,
3836 "Default value of `tab-width' for buffers that do not override it.\n\
3837This is the same as (default-value 'tab-width).");
3838
3839 DEFVAR_LISP_NOPRO ("default-case-fold-search",
3840 &buffer_defaults.case_fold_search,
3841 "Default value of `case-fold-search' for buffers that don't override it.\n\
3842This is the same as (default-value 'case-fold-search).");
3843
f7975d07 3844#ifdef DOS_NT
54ad07d3
RS
3845 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
3846 &buffer_defaults.buffer_file_type,
3847 "Default file type for buffers that do not override it.\n\
3848This is the same as (default-value 'buffer-file-type).\n\
3849The file type is nil for text, t for binary.");
3850#endif
3851
0fa3ba92
JB
3852 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
3853 Qnil, 0);
1ab256cb
RM
3854
3855/* This doc string is too long for cpp; cpp dies if it isn't in a comment.
3856 But make-docfile finds it!
3857 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
bec44fd6 3858 Qnil,
1ab256cb
RM
3859 "Template for displaying mode line for current buffer.\n\
3860Each buffer has its own value of this variable.\n\
3861Value may be a string, a symbol or a list or cons cell.\n\
3862For a symbol, its value is used (but it is ignored if t or nil).\n\
3863 A string appearing directly as the value of a symbol is processed verbatim\n\
3864 in that the %-constructs below are not recognized.\n\
3865For a list whose car is a symbol, the symbol's value is taken,\n\
3866 and if that is non-nil, the cadr of the list is processed recursively.\n\
3867 Otherwise, the caddr of the list (if there is one) is processed.\n\
3868For a list whose car is a string or list, each element is processed\n\
3869 recursively and the results are effectively concatenated.\n\
3870For a list whose car is an integer, the cdr of the list is processed\n\
3871 and padded (if the number is positive) or truncated (if negative)\n\
3872 to the width specified by that number.\n\
3873A string is printed verbatim in the mode line except for %-constructs:\n\
3874 (%-constructs are allowed when the string is the entire mode-line-format\n\
3875 or when it is found in a cons-cell or a list)\n\
3876 %b -- print buffer name. %f -- print visited file name.\n\
c2ff34f7
RS
3877 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.\n\
3878 % means buffer is read-only and * means it is modified.\n\
3879 For a modified read-only buffer, %* gives % and %+ gives *.\n\
a97c374a 3880 %s -- print process status. %l -- print the current line number.\n\
07924294 3881 %c -- print the current column number (this makes editing slower).\n\
dd24e6a6 3882 %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
9d130ffc 3883 %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
dd24e6a6 3884 or print Bottom or All.\n\
1ab256cb 3885 %n -- print Narrow if appropriate.\n\
b77087c5 3886 %t -- print T if file is text, B if binary.\n\
1ab256cb
RM
3887 %[ -- print one [ for each recursive editing level. %] similar.\n\
3888 %% -- print %. %- -- print infinitely many dashes.\n\
3889Decimal digits after the % specify field width to which to pad.");
3890*/
3891
3892 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
3893 "*Major mode for new buffers. Defaults to `fundamental-mode'.\n\
3894nil here means use current buffer's major mode.");
3895
3896 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
0fa3ba92 3897 make_number (Lisp_Symbol),
1ab256cb
RM
3898 "Symbol for current buffer's major mode.");
3899
3900 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
0fa3ba92 3901 make_number (Lisp_String),
1ab256cb
RM
3902 "Pretty name of current buffer's major mode (a string).");
3903
0fa3ba92 3904 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
1ab256cb
RM
3905 "Non-nil turns on automatic expansion of abbrevs as they are inserted.\n\
3906Automatically becomes buffer-local when set in any fashion.");
3907
3908 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
0fa3ba92 3909 Qnil,
1ab256cb
RM
3910 "*Non-nil if searches should ignore case.\n\
3911Automatically becomes buffer-local when set in any fashion.");
3912
3913 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
0fa3ba92 3914 make_number (Lisp_Int),
1ab256cb
RM
3915 "*Column beyond which automatic line-wrapping should happen.\n\
3916Automatically becomes buffer-local when set in any fashion.");
3917
3918 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
0fa3ba92 3919 make_number (Lisp_Int),
1ab256cb
RM
3920 "*Column for the default indent-line-function to indent to.\n\
3921Linefeed indents to this column in Fundamental mode.\n\
3922Automatically becomes buffer-local when set in any fashion.");
3923
3924 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
0fa3ba92 3925 make_number (Lisp_Int),
1ab256cb
RM
3926 "*Distance between tab stops (for display of tab characters), in columns.\n\
3927Automatically becomes buffer-local when set in any fashion.");
3928
0fa3ba92 3929 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
1ab256cb 3930 "*Non-nil means display control chars with uparrow.\n\
6a99d31d 3931A value of nil means use backslash and octal digits.\n\
1ab256cb
RM
3932Automatically becomes buffer-local when set in any fashion.\n\
3933This variable does not apply to characters whose display is specified\n\
3934in the current display table (if there is one).");
3935
3b06f880
KH
3936 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
3937 &current_buffer->enable_multibyte_characters, Qnil,
c807f767 3938 "*Non-nil means the buffer contents are regarded as multi-byte form\n\
3b06f880
KH
3939of characters, not a binary code. This affects the display, file I/O,\n\
3940and behaviors of various editing commands.");
3941
c71b5d9b
KH
3942 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
3943 &current_buffer->buffer_file_coding_system, Qnil,
3944 "Coding system to be used for encoding the buffer contents on saving.\n\
3945If it is nil, the buffer is saved without any code conversion unless\n\
3946some coding system is specified in file-coding-system-alist\n\
3947for the buffer file.\n\
3948\n\
3949This variable is never applied to a way of decoding\n\
3950a file while reading it.");
3951
3b06f880
KH
3952 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
3953 Qnil,
3954 "*Non-nil means lines in the buffer are displayed right to left.");
3955
0fa3ba92 3956 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
1ab256cb
RM
3957 "*Non-nil means do not display continuation lines;\n\
3958give each line of text one screen line.\n\
3959Automatically becomes buffer-local when set in any fashion.\n\
3960\n\
3961Note that this is overridden by the variable\n\
3962`truncate-partial-width-windows' if that variable is non-nil\n\
502b9b64 3963and this buffer is not full-frame width.");
1ab256cb 3964
f7975d07 3965#ifdef DOS_NT
54ad07d3
RS
3966 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
3967 Qnil,
006d3d34
RS
3968 "Non-nil if the visited file is a binary file.\n\
3969This variable is meaningful on MS-DOG and Windows NT.\n\
3970On those systems, it is automatically local in every buffer.\n\
e0585c64 3971On other systems, this variable is normally always nil.");
54ad07d3
RS
3972#endif
3973
1ab256cb 3974 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
0fa3ba92 3975 make_number (Lisp_String),
1ab256cb
RM
3976 "Name of default directory of current buffer. Should end with slash.\n\
3977Each buffer has its own value of this variable.");
3978
3979 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
0fa3ba92 3980 Qnil,
1ab256cb 3981 "Function called (if non-nil) to perform auto-fill.\n\
54158e68 3982It is called after self-inserting a space or newline.\n\
1ab256cb 3983Each buffer has its own value of this variable.\n\
54158e68
KH
3984NOTE: This variable is not a hook;\n\
3985its value may not be a list of functions.");
1ab256cb
RM
3986
3987 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
0fa3ba92 3988 make_number (Lisp_String),
1ab256cb
RM
3989 "Name of file visited in current buffer, or nil if not visiting a file.\n\
3990Each buffer has its own value of this variable.");
3991
f6ed2e84
RS
3992 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
3993 make_number (Lisp_String),
bb4c204e 3994 "Abbreviated truename of file visited in current buffer, or nil if none.\n\
b1c03e64
RS
3995The truename of a file is calculated by `file-truename'\n\
3996and then abbreviated with `abbreviate-file-name'.\n\
f6ed2e84
RS
3997Each buffer has its own value of this variable.");
3998
1ab256cb 3999 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
3f5fcd47 4000 &current_buffer->auto_save_file_name,
0fa3ba92 4001 make_number (Lisp_String),
1ab256cb
RM
4002 "Name of file for auto-saving current buffer,\n\
4003or nil if buffer should not be auto-saved.\n\
4004Each buffer has its own value of this variable.");
4005
0fa3ba92 4006 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
1ab256cb
RM
4007 "Non-nil if this buffer is read-only.\n\
4008Each buffer has its own value of this variable.");
4009
0fa3ba92 4010 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
1ab256cb
RM
4011 "Non-nil if this buffer's file has been backed up.\n\
4012Backing up is done before the first time the file is saved.\n\
4013Each buffer has its own value of this variable.");
4014
4015 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
0fa3ba92 4016 make_number (Lisp_Int),
1ab256cb
RM
4017 "Length of current buffer when last read in, saved or auto-saved.\n\
40180 initially.\n\
4019Each buffer has its own value of this variable.");
4020
4021 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
0fa3ba92 4022 Qnil,
1ab256cb
RM
4023 "Non-nil enables selective display:\n\
4024Integer N as value means display only lines\n\
4025 that start with less than n columns of space.\n\
4026A value of t means, after a ^M, all the rest of the line is invisible.\n\
4027 Then ^M's in the file are written into files as newlines.\n\n\
4028Automatically becomes buffer-local when set in any fashion.");
4029
4030#ifndef old
4031 DEFVAR_PER_BUFFER ("selective-display-ellipses",
4032 &current_buffer->selective_display_ellipses,
0fa3ba92 4033 Qnil,
1ab256cb
RM
4034 "t means display ... on previous line when a line is invisible.\n\
4035Automatically becomes buffer-local when set in any fashion.");
4036#endif
4037
0fa3ba92 4038 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
1ab256cb 4039 "Non-nil if self-insertion should replace existing text.\n\
5e05d0a5
RS
4040The value should be one of `overwrite-mode-textual',\n\
4041`overwrite-mode-binary', or nil.\n\
4042If it is `overwrite-mode-textual', self-insertion still\n\
6bbb0d4a 4043inserts at the end of a line, and inserts when point is before a tab,\n\
2e94b813 4044until the tab is filled in.\n\
6bbb0d4a 4045If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.\n\
1ab256cb
RM
4046Automatically becomes buffer-local when set in any fashion.");
4047
54939090
RS
4048#if 0 /* The doc string is too long for some compilers,
4049 but make-docfile can find it in this comment. */
1ab256cb 4050 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5d305367 4051 Qnil,
1ab256cb
RM
4052 "Display table that controls display of the contents of current buffer.\n\
4053Automatically becomes buffer-local when set in any fashion.\n\
6fdc249f
EN
4054The display table is a char-table created with `make-display-table'.\n\
4055The ordinary char-table elements control how to display each possible text\n\
4056character. Each value should be a vector of characters or nil;\n\
1ab256cb 4057nil means display the character in the default fashion.\n\
6fdc249f
EN
4058There are six extra slots to control the display of\n\
4059 the end of a truncated screen line (extra-slot 0, a single character);\n\
4060 the end of a continued line (extra-slot 1, a single character);\n\
6158b3b0 4061 the escape character used to display character codes in octal\n\
6fdc249f
EN
4062 (extra-slot 2, a single character);\n\
4063 the character used as an arrow for control characters (extra-slot 3,\n\
6158b3b0 4064 a single character);\n\
6fdc249f 4065 the decoration indicating the presence of invisible lines (extra-slot 4,\n\
a45e35e1
JB
4066 a vector of characters);\n\
4067 the character used to draw the border between side-by-side windows\n\
6fdc249f
EN
4068 (extra-slot 5, a single character).\n\
4069See also the functions `display-table-slot' and `set-display-table-slot'.\n\
1ab256cb
RM
4070If this variable is nil, the value of `standard-display-table' is used.\n\
4071Each window can have its own, overriding display table.");
54939090
RS
4072#endif
4073 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
de15914a 4074 Qnil, 0);
1ab256cb 4075
1ab256cb
RM
4076/*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
4077 "Don't ask.");
4078*/
01050cb5 4079 DEFVAR_LISP ("before-change-function", &Vbefore_change_function,
f0724bcb 4080 "If non-nil, a function to call before each text change (obsolete).\n\
1ab256cb
RM
4081Two arguments are passed to the function: the positions of\n\
4082the beginning and end of the range of old text to be changed.\n\
4083\(For an insertion, the beginning and end are at the same place.)\n\
4084No information is given about the length of the text after the change.\n\
1ab256cb 4085\n\
5f079267 4086Buffer changes made while executing the `before-change-function'\n\
b86344d0
RS
4087don't call any before-change or after-change functions.\n\
4088That's because these variables are temporarily set to nil.\n\
4089As a result, a hook function cannot straightforwardly alter the value of\n\
4090these variables. See the Emacs Lisp manual for a way of\n\
f0724bcb
RS
4091accomplishing an equivalent result by using other variables.\n\n\
4092This variable is obsolete; use `before-change-functions' instead.");
1ab256cb
RM
4093 Vbefore_change_function = Qnil;
4094
4095 DEFVAR_LISP ("after-change-function", &Vafter_change_function,
f0724bcb 4096 "If non-nil, a Function to call after each text change (obsolete).\n\
1ab256cb
RM
4097Three arguments are passed to the function: the positions of\n\
4098the beginning and end of the range of changed text,\n\
4099and the length of the pre-change text replaced by that range.\n\
4100\(For an insertion, the pre-change length is zero;\n\
4101for a deletion, that length is the number of characters deleted,\n\
4102and the post-change beginning and end are at the same place.)\n\
4103\n\
5f079267 4104Buffer changes made while executing the `after-change-function'\n\
b86344d0
RS
4105don't call any before-change or after-change functions.\n\
4106That's because these variables are temporarily set to nil.\n\
4107As a result, a hook function cannot straightforwardly alter the value of\n\
4108these variables. See the Emacs Lisp manual for a way of\n\
f0724bcb
RS
4109accomplishing an equivalent result by using other variables.\n\n\
4110This variable is obsolete; use `after-change-functions' instead.");
1ab256cb
RM
4111 Vafter_change_function = Qnil;
4112
5f079267
RS
4113 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
4114 "List of functions to call before each text change.\n\
4115Two arguments are passed to each function: the positions of\n\
4116the beginning and end of the range of old text to be changed.\n\
4117\(For an insertion, the beginning and end are at the same place.)\n\
4118No information is given about the length of the text after the change.\n\
5f079267
RS
4119\n\
4120Buffer changes made while executing the `before-change-functions'\n\
b86344d0
RS
4121don't call any before-change or after-change functions.\n\
4122That's because these variables are temporarily set to nil.\n\
4123As a result, a hook function cannot straightforwardly alter the value of\n\
4124these variables. See the Emacs Lisp manual for a way of\n\
d59698c4 4125accomplishing an equivalent result by using other variables.");
5f079267
RS
4126 Vbefore_change_functions = Qnil;
4127
4128 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
4129 "List of function to call after each text change.\n\
4130Three arguments are passed to each function: the positions of\n\
4131the beginning and end of the range of changed text,\n\
4132and the length of the pre-change text replaced by that range.\n\
4133\(For an insertion, the pre-change length is zero;\n\
4134for a deletion, that length is the number of characters deleted,\n\
4135and the post-change beginning and end are at the same place.)\n\
4136\n\
4137Buffer changes made while executing the `after-change-functions'\n\
b86344d0
RS
4138don't call any before-change or after-change functions.\n\
4139That's because these variables are temporarily set to nil.\n\
4140As a result, a hook function cannot straightforwardly alter the value of\n\
4141these variables. See the Emacs Lisp manual for a way of\n\
d59698c4 4142accomplishing an equivalent result by using other variables.");
b86344d0 4143
5f079267
RS
4144 Vafter_change_functions = Qnil;
4145
dbc4e1c1
JB
4146 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
4147 "A list of functions to call before changing a buffer which is unmodified.\n\
4148The functions are run using the `run-hooks' function.");
4149 Vfirst_change_hook = Qnil;
1ab256cb 4150
54939090
RS
4151#if 0 /* The doc string is too long for some compilers,
4152 but make-docfile can find it in this comment. */
3f5fcd47 4153 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
1ab256cb
RM
4154 "List of undo entries in current buffer.\n\
4155Recent changes come first; older changes follow newer.\n\
4156\n\
630f4018
KH
4157An entry (BEG . END) represents an insertion which begins at\n\
4158position BEG and ends at position END.\n\
1ab256cb
RM
4159\n\
4160An entry (TEXT . POSITION) represents the deletion of the string TEXT\n\
4161from (abs POSITION). If POSITION is positive, point was at the front\n\
4162of the text being deleted; if negative, point was at the end.\n\
4163\n\
6c0df54a
RS
4164An entry (t HIGH . LOW) indicates that the buffer previously had\n\
4165\"unmodified\" status. HIGH and LOW are the high and low 16-bit portions\n\
4166of the visited file's modification time, as of that time. If the\n\
4167modification time of the most recent save is different, this entry is\n\
1ab256cb
RM
4168obsolete.\n\
4169\n\
6c0df54a
RS
4170An entry (nil PROPERTY VALUE BEG . END) indicates that a text property\n\
4171was modified between BEG and END. PROPERTY is the property name,\n\
4172and VALUE is the old value.\n\
483c1fd3 4173\n\
da1c183c
RS
4174An entry (MARKER . DISTANCE) indicates that the marker MARKER\n\
4175was adjusted in position by the offset DISTANCE (an integer).\n\
4176\n\
bec44fd6
JB
4177An entry of the form POSITION indicates that point was at the buffer\n\
4178location given by the integer. Undoing an entry of this form places\n\
4179point at POSITION.\n\
4180\n\
1ab256cb
RM
4181nil marks undo boundaries. The undo command treats the changes\n\
4182between two undo boundaries as a single step to be undone.\n\
4183\n\
bec44fd6 4184If the value of the variable is t, undo information is not recorded.");
54939090
RS
4185#endif
4186 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
de15914a 4187 0);
1ab256cb 4188
c48f61ef
RS
4189 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
4190 "Non-nil means the mark and region are currently active in this buffer.\n\
4191Automatically local in all buffers.");
4192
28e969dd 4193 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
f0c5b712
JB
4194 "Non-nil means that Emacs should use caches to handle long lines more quickly.\n\
4195This variable is buffer-local, in all buffers.\n\
28e969dd 4196\n\
f0c5b712
JB
4197Normally, the line-motion functions work by scanning the buffer for\n\
4198newlines. Columnar operations (like move-to-column and\n\
4199compute-motion) also work by scanning the buffer, summing character\n\
4200widths as they go. This works well for ordinary text, but if the\n\
28e969dd 4201buffer's lines are very long (say, more than 500 characters), these\n\
f0c5b712
JB
4202motion functions will take longer to execute. Emacs may also take\n\
4203longer to update the display.\n\
28e969dd 4204\n\
f0c5b712
JB
4205If cache-long-line-scans is non-nil, these motion functions cache the\n\
4206results of their scans, and consult the cache to avoid rescanning\n\
4207regions of the buffer until the text is modified. The caches are most\n\
4208beneficial when they prevent the most searching---that is, when the\n\
4209buffer contains long lines and large regions of characters with the\n\
4210same, fixed screen width.\n\
28e969dd 4211\n\
f0c5b712
JB
4212When cache-long-line-scans is non-nil, processing short lines will\n\
4213become slightly slower (because of the overhead of consulting the\n\
4214cache), and the caches will use memory roughly proportional to the\n\
4215number of newlines and characters whose screen width varies.\n\
4216\n\
4217The caches require no explicit maintenance; their accuracy is\n\
4218maintained internally by the Emacs primitives. Enabling or disabling\n\
4219the cache should not affect the behavior of any of the motion\n\
4220functions; it should only affect their performance.");
28e969dd 4221
943e065b
RS
4222 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
4223 "Value of point before the last series of scroll operations, or nil.");
4224
be9aafdd
BG
4225 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
4226 "List of formats to use when saving this buffer.\n\
4227Formats are defined by `format-alist'. This variable is\n\
4228set when a file is visited. Automatically local in all buffers.");
4229
3cb719bd
RS
4230 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
4231 &current_buffer->invisibility_spec, Qnil,
4232 "Invisibility spec of this buffer.\n\
4233The default is t, which means that text is invisible\n\
4234if it has a non-nil `invisible' property.\n\
4235If the value is a list, a text character is invisible if its `invisible'\n\
4236property is an element in that list.\n\
554216ad
KH
4237If an element is a cons cell of the form (PROP . ELLIPSIS),\n\
4238then characters with property value PROP are invisible,\n\
3cb719bd
RS
4239and they have an ellipsis as well if ELLIPSIS is non-nil.");
4240
7962a441
RS
4241 DEFVAR_PER_BUFFER ("buffer-display-count",
4242 &current_buffer->display_count, Qnil,
4243 "A number incremented each time the buffer is displayed in a window.");
4244
c48f61ef 4245 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
319c537c
RS
4246 "*Non-nil means deactivate the mark when the buffer contents change.\n\
4247Non-nil also enables highlighting of the region whenever the mark is active.\n\
4248The variable `highlight-nonselected-windows' controls whether to highlight\n\
4249all windows or just the selected window.");
c48f61ef
RS
4250 Vtransient_mark_mode = Qnil;
4251
0a4469c9 4252 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
a96b68f1
RS
4253 "*Non-nil means disregard read-only status of buffers or characters.\n\
4254If the value is t, disregard `buffer-read-only' and all `read-only'\n\
4255text properties. If the value is a list, disregard `buffer-read-only'\n\
4256and disregard a `read-only' text property if the property value\n\
4257is a member of the list.");
4258 Vinhibit_read_only = Qnil;
4259
dcdffbf6
RS
4260 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
4261 "List of functions called with no args to query before killing a buffer.");
4262 Vkill_buffer_query_functions = Qnil;
4263
0dc88e60 4264 defsubr (&Sbuffer_live_p);
1ab256cb
RM
4265 defsubr (&Sbuffer_list);
4266 defsubr (&Sget_buffer);
4267 defsubr (&Sget_file_buffer);
4268 defsubr (&Sget_buffer_create);
336cd056 4269 defsubr (&Smake_indirect_buffer);
01050cb5 4270 defsubr (&Sgenerate_new_buffer_name);
1ab256cb
RM
4271 defsubr (&Sbuffer_name);
4272/*defsubr (&Sbuffer_number);*/
4273 defsubr (&Sbuffer_file_name);
336cd056 4274 defsubr (&Sbuffer_base_buffer);
1ab256cb
RM
4275 defsubr (&Sbuffer_local_variables);
4276 defsubr (&Sbuffer_modified_p);
4277 defsubr (&Sset_buffer_modified_p);
4278 defsubr (&Sbuffer_modified_tick);
4279 defsubr (&Srename_buffer);
4280 defsubr (&Sother_buffer);
4281 defsubr (&Sbuffer_disable_undo);
4282 defsubr (&Sbuffer_enable_undo);
4283 defsubr (&Skill_buffer);
4284 defsubr (&Serase_buffer);
a9ee7a59 4285 defsubr (&Sset_buffer_major_mode);
1ab256cb
RM
4286 defsubr (&Sswitch_to_buffer);
4287 defsubr (&Spop_to_buffer);
4288 defsubr (&Scurrent_buffer);
4289 defsubr (&Sset_buffer);
4290 defsubr (&Sbarf_if_buffer_read_only);
4291 defsubr (&Sbury_buffer);
1ab256cb 4292 defsubr (&Skill_all_local_variables);
2eec3b4e 4293
52f8ec73 4294 defsubr (&Soverlayp);
2eec3b4e
RS
4295 defsubr (&Smake_overlay);
4296 defsubr (&Sdelete_overlay);
4297 defsubr (&Smove_overlay);
8ebafa8d
JB
4298 defsubr (&Soverlay_start);
4299 defsubr (&Soverlay_end);
4300 defsubr (&Soverlay_buffer);
4301 defsubr (&Soverlay_properties);
2eec3b4e 4302 defsubr (&Soverlays_at);
74514898 4303 defsubr (&Soverlays_in);
2eec3b4e 4304 defsubr (&Snext_overlay_change);
239c932b 4305 defsubr (&Sprevious_overlay_change);
2eec3b4e
RS
4306 defsubr (&Soverlay_recenter);
4307 defsubr (&Soverlay_lists);
4308 defsubr (&Soverlay_get);
4309 defsubr (&Soverlay_put);
1ab256cb
RM
4310}
4311
4312keys_of_buffer ()
4313{
4314 initial_define_key (control_x_map, 'b', "switch-to-buffer");
4315 initial_define_key (control_x_map, 'k', "kill-buffer");
4158c17d
RM
4316
4317 /* This must not be in syms_of_buffer, because Qdisabled is not
4318 initialized when that function gets called. */
4319 Fput (intern ("erase-buffer"), Qdisabled, Qt);
1ab256cb 4320}