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