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