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