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