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