Remove * characters from the front of variable docstrings.
[emacs.git] / src / buffer.c
blobca8d1ec5db36de1f3e0751d3fed03d1ec9293d45
1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/param.h>
25 #include <errno.h>
26 #include <stdio.h>
27 #include <setjmp.h>
28 #include <unistd.h>
30 #include <verify.h>
32 #include "lisp.h"
33 #include "intervals.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "buffer.h"
37 #include "character.h"
38 #include "region-cache.h"
39 #include "indent.h"
40 #include "blockinput.h"
41 #include "keyboard.h"
42 #include "keymap.h"
43 #include "frame.h"
45 struct buffer *current_buffer; /* the current buffer */
47 /* First buffer in chain of all buffers (in reverse order of creation).
48 Threaded through ->header.next.buffer. */
50 struct buffer *all_buffers;
52 /* This structure holds the default values of the buffer-local variables
53 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
54 The default value occupies the same slot in this structure
55 as an individual buffer's value occupies in that buffer.
56 Setting the default value also goes through the alist of buffers
57 and stores into each buffer that does not say it has a local value. */
59 DECL_ALIGN (struct buffer, buffer_defaults);
61 /* A Lisp_Object pointer to the above, used for staticpro */
63 static Lisp_Object Vbuffer_defaults;
65 /* This structure marks which slots in a buffer have corresponding
66 default values in buffer_defaults.
67 Each such slot has a nonzero value in this structure.
68 The value has only one nonzero bit.
70 When a buffer has its own local value for a slot,
71 the entry for that slot (found in the same slot in this structure)
72 is turned on in the buffer's local_flags array.
74 If a slot in this structure is -1, then even though there may
75 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
76 and the corresponding slot in buffer_defaults is not used.
78 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
79 zero, that is a bug */
81 struct buffer buffer_local_flags;
83 /* This structure holds the names of symbols whose values may be
84 buffer-local. It is indexed and accessed in the same way as the above. */
86 DECL_ALIGN (struct buffer, buffer_local_symbols);
88 /* A Lisp_Object pointer to the above, used for staticpro */
89 static Lisp_Object Vbuffer_local_symbols;
91 /* Return the symbol of the per-buffer variable at offset OFFSET in
92 the buffer structure. */
94 #define PER_BUFFER_SYMBOL(OFFSET) \
95 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
97 /* Maximum length of an overlay vector. */
98 #define OVERLAY_COUNT_MAX \
99 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
100 min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)))
102 /* Flags indicating which built-in buffer-local variables
103 are permanent locals. */
104 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
106 /* Number of per-buffer variables used. */
108 int last_per_buffer_idx;
110 static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
111 static Lisp_Object Fdelete_overlay (Lisp_Object);
112 static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
113 int after, Lisp_Object arg1,
114 Lisp_Object arg2, Lisp_Object arg3);
115 static void swap_out_buffer_local_variables (struct buffer *b);
116 static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
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. */
121 Lisp_Object Vbuffer_alist;
123 static Lisp_Object Qkill_buffer_query_functions;
125 /* Hook run before changing a major mode. */
126 static Lisp_Object Qchange_major_mode_hook;
128 Lisp_Object Qfirst_change_hook;
129 Lisp_Object Qbefore_change_functions;
130 Lisp_Object Qafter_change_functions;
132 static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
133 static Lisp_Object Qpermanent_local_hook;
135 static Lisp_Object Qprotected_field;
137 static Lisp_Object QSFundamental; /* A string "Fundamental" */
139 static Lisp_Object Qkill_buffer_hook;
140 static Lisp_Object Qbuffer_list_update_hook;
142 static Lisp_Object Qget_file_buffer;
144 static Lisp_Object Qoverlayp;
146 Lisp_Object Qpriority, Qbefore_string, Qafter_string;
148 static Lisp_Object Qevaporate;
150 Lisp_Object Qmodification_hooks;
151 Lisp_Object Qinsert_in_front_hooks;
152 Lisp_Object Qinsert_behind_hooks;
154 static void alloc_buffer_text (struct buffer *, ptrdiff_t);
155 static void free_buffer_text (struct buffer *b);
156 static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
157 static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
158 static Lisp_Object buffer_lisp_local_variables (struct buffer *);
160 /* For debugging; temporary. See set_buffer_internal. */
161 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
163 void
164 nsberror (Lisp_Object spec)
166 if (STRINGP (spec))
167 error ("No buffer named %s", SDATA (spec));
168 error ("Invalid buffer argument");
171 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
172 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
173 Value is nil if OBJECT is not a buffer or if it has been killed. */)
174 (Lisp_Object object)
176 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
177 ? Qt : Qnil);
180 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
181 doc: /* Return a list of all existing live buffers.
182 If the optional arg FRAME is a frame, we return the buffer list in the
183 proper order for that frame: the buffers show in FRAME come first,
184 followed by the rest of the buffers. */)
185 (Lisp_Object frame)
187 Lisp_Object general;
188 general = Fmapcar (Qcdr, Vbuffer_alist);
190 if (FRAMEP (frame))
192 Lisp_Object framelist, prevlist, tail;
193 Lisp_Object args[3];
195 CHECK_FRAME (frame);
196 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
197 prevlist = Fnreverse (Fcopy_sequence
198 (XFRAME (frame)->buried_buffer_list));
200 /* Remove from GENERAL any buffer that duplicates one in
201 FRAMELIST or PREVLIST. */
202 tail = framelist;
203 while (CONSP (tail))
205 general = Fdelq (XCAR (tail), general);
206 tail = XCDR (tail);
208 tail = prevlist;
209 while (CONSP (tail))
211 general = Fdelq (XCAR (tail), general);
212 tail = XCDR (tail);
215 args[0] = framelist;
216 args[1] = general;
217 args[2] = prevlist;
218 return Fnconc (3, args);
220 else
221 return general;
224 /* Like Fassoc, but use Fstring_equal to compare
225 (which ignores text properties),
226 and don't ever QUIT. */
228 static Lisp_Object
229 assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
231 register Lisp_Object tail;
232 for (tail = list; CONSP (tail); tail = XCDR (tail))
234 register Lisp_Object elt, tem;
235 elt = XCAR (tail);
236 tem = Fstring_equal (Fcar (elt), key);
237 if (!NILP (tem))
238 return elt;
240 return Qnil;
243 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
244 doc: /* Return the buffer named BUFFER-OR-NAME.
245 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
246 is a string and there is no buffer with that name, return nil. If
247 BUFFER-OR-NAME is a buffer, return it as given. */)
248 (register Lisp_Object buffer_or_name)
250 if (BUFFERP (buffer_or_name))
251 return buffer_or_name;
252 CHECK_STRING (buffer_or_name);
254 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
257 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
258 doc: /* Return the buffer visiting file FILENAME (a string).
259 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
260 If there is no such live buffer, return nil.
261 See also `find-buffer-visiting'. */)
262 (register Lisp_Object filename)
264 register Lisp_Object tail, buf, tem;
265 Lisp_Object handler;
267 CHECK_STRING (filename);
268 filename = Fexpand_file_name (filename, Qnil);
270 /* If the file name has special constructs in it,
271 call the corresponding file handler. */
272 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
273 if (!NILP (handler))
275 Lisp_Object handled_buf = call2 (handler, Qget_file_buffer,
276 filename);
277 return BUFFERP (handled_buf) ? handled_buf : Qnil;
280 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
282 buf = Fcdr (XCAR (tail));
283 if (!BUFFERP (buf)) continue;
284 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
285 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
286 if (!NILP (tem))
287 return buf;
289 return Qnil;
292 Lisp_Object
293 get_truename_buffer (register Lisp_Object filename)
295 register Lisp_Object tail, buf, tem;
297 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
299 buf = Fcdr (XCAR (tail));
300 if (!BUFFERP (buf)) continue;
301 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
302 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
303 if (!NILP (tem))
304 return buf;
306 return Qnil;
309 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
310 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
311 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
312 return that buffer. If no such buffer exists, create a new buffer with
313 that name and return it. If BUFFER-OR-NAME starts with a space, the new
314 buffer does not keep undo information.
316 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
317 even if it is dead. The return value is never nil. */)
318 (register Lisp_Object buffer_or_name)
320 register Lisp_Object buffer, name;
321 register struct buffer *b;
323 buffer = Fget_buffer (buffer_or_name);
324 if (!NILP (buffer))
325 return buffer;
327 if (SCHARS (buffer_or_name) == 0)
328 error ("Empty string for buffer name is not allowed");
330 b = allocate_buffer ();
332 /* An ordinary buffer uses its own struct buffer_text. */
333 b->text = &b->own_text;
334 b->base_buffer = 0;
336 BUF_GAP_SIZE (b) = 20;
337 BLOCK_INPUT;
338 /* We allocate extra 1-byte at the tail and keep it always '\0' for
339 anchoring a search. */
340 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
341 UNBLOCK_INPUT;
342 if (! BUF_BEG_ADDR (b))
343 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
345 b->pt = BEG;
346 b->begv = BEG;
347 b->zv = BEG;
348 b->pt_byte = BEG_BYTE;
349 b->begv_byte = BEG_BYTE;
350 b->zv_byte = BEG_BYTE;
352 BUF_GPT (b) = BEG;
353 BUF_GPT_BYTE (b) = BEG_BYTE;
355 BUF_Z (b) = BEG;
356 BUF_Z_BYTE (b) = BEG_BYTE;
357 BUF_MODIFF (b) = 1;
358 BUF_CHARS_MODIFF (b) = 1;
359 BUF_OVERLAY_MODIFF (b) = 1;
360 BUF_SAVE_MODIFF (b) = 1;
361 BUF_INTERVALS (b) = 0;
362 BUF_UNCHANGED_MODIFIED (b) = 1;
363 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
364 BUF_END_UNCHANGED (b) = 0;
365 BUF_BEG_UNCHANGED (b) = 0;
366 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
367 b->text->inhibit_shrinking = 0;
369 b->newline_cache = 0;
370 b->width_run_cache = 0;
371 BVAR (b, width_table) = Qnil;
372 b->prevent_redisplay_optimizations_p = 1;
374 /* Put this on the chain of all buffers including killed ones. */
375 b->header.next.buffer = all_buffers;
376 all_buffers = b;
378 /* An ordinary buffer normally doesn't need markers
379 to handle BEGV and ZV. */
380 BVAR (b, pt_marker) = Qnil;
381 BVAR (b, begv_marker) = Qnil;
382 BVAR (b, zv_marker) = Qnil;
384 name = Fcopy_sequence (buffer_or_name);
385 STRING_SET_INTERVALS (name, NULL_INTERVAL);
386 BVAR (b, name) = name;
388 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
390 reset_buffer (b);
391 reset_buffer_local_variables (b, 1);
393 BVAR (b, mark) = Fmake_marker ();
394 BUF_MARKERS (b) = NULL;
395 BVAR (b, name) = name;
397 /* Put this in the alist of all live buffers. */
398 XSETBUFFER (buffer, b);
399 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
400 /* And run buffer-list-update-hook. */
401 if (!NILP (Vrun_hooks))
402 call1 (Vrun_hooks, Qbuffer_list_update_hook);
404 return buffer;
408 /* Return a list of overlays which is a copy of the overlay list
409 LIST, but for buffer B. */
411 static struct Lisp_Overlay *
412 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
414 Lisp_Object buffer;
415 struct Lisp_Overlay *result = NULL, *tail = NULL;
417 XSETBUFFER (buffer, b);
419 for (; list; list = list->next)
421 Lisp_Object overlay, start, end, old_overlay;
422 EMACS_INT charpos;
424 XSETMISC (old_overlay, list);
425 charpos = marker_position (OVERLAY_START (old_overlay));
426 start = Fmake_marker ();
427 Fset_marker (start, make_number (charpos), buffer);
428 XMARKER (start)->insertion_type
429 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
431 charpos = marker_position (OVERLAY_END (old_overlay));
432 end = Fmake_marker ();
433 Fset_marker (end, make_number (charpos), buffer);
434 XMARKER (end)->insertion_type
435 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
437 overlay = allocate_misc ();
438 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
439 OVERLAY_START (overlay) = start;
440 OVERLAY_END (overlay) = end;
441 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
442 XOVERLAY (overlay)->next = NULL;
444 if (tail)
445 tail = tail->next = XOVERLAY (overlay);
446 else
447 result = tail = XOVERLAY (overlay);
450 return result;
454 /* Clone per-buffer values of buffer FROM.
456 Buffer TO gets the same per-buffer values as FROM, with the
457 following exceptions: (1) TO's name is left untouched, (2) markers
458 are copied and made to refer to TO, and (3) overlay lists are
459 copied. */
461 static void
462 clone_per_buffer_values (struct buffer *from, struct buffer *to)
464 Lisp_Object to_buffer;
465 int offset;
467 XSETBUFFER (to_buffer, to);
469 /* buffer-local Lisp variables start at `undo_list',
470 tho only the ones from `name' on are GC'd normally. */
471 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
472 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
473 offset += sizeof (Lisp_Object))
475 Lisp_Object obj;
477 /* Don't touch the `name' which should be unique for every buffer. */
478 if (offset == PER_BUFFER_VAR_OFFSET (name))
479 continue;
481 obj = PER_BUFFER_VALUE (from, offset);
482 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
484 struct Lisp_Marker *m = XMARKER (obj);
485 obj = Fmake_marker ();
486 XMARKER (obj)->insertion_type = m->insertion_type;
487 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
490 PER_BUFFER_VALUE (to, offset) = obj;
493 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
495 to->overlays_before = copy_overlays (to, from->overlays_before);
496 to->overlays_after = copy_overlays (to, from->overlays_after);
498 /* Get (a copy of) the alist of Lisp-level local variables of FROM
499 and install that in TO. */
500 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
504 /* If buffer B has markers to record PT, BEGV and ZV when it is not
505 current, update these markers. */
507 static void
508 record_buffer_markers (struct buffer *b)
510 if (! NILP (BVAR (b, pt_marker)))
512 Lisp_Object buffer;
514 eassert (!NILP (BVAR (b, begv_marker)));
515 eassert (!NILP (BVAR (b, zv_marker)));
517 XSETBUFFER (buffer, b);
518 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
519 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
520 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
525 /* If buffer B has markers to record PT, BEGV and ZV when it is not
526 current, fetch these values into B->begv etc. */
528 static void
529 fetch_buffer_markers (struct buffer *b)
531 if (! NILP (BVAR (b, pt_marker)))
533 Lisp_Object m;
535 eassert (!NILP (BVAR (b, begv_marker)));
536 eassert (!NILP (BVAR (b, zv_marker)));
538 m = BVAR (b, pt_marker);
539 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
541 m = BVAR (b, begv_marker);
542 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
544 m = BVAR (b, zv_marker);
545 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
550 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
551 2, 3,
552 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
553 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
554 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
555 NAME should be a string which is not the name of an existing buffer.
556 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
557 such as major and minor modes, in the indirect buffer.
558 CLONE nil means the indirect buffer's state is reset to default values. */)
559 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
561 Lisp_Object buf, tem;
562 struct buffer *b;
564 CHECK_STRING (name);
565 buf = Fget_buffer (name);
566 if (!NILP (buf))
567 error ("Buffer name `%s' is in use", SDATA (name));
569 tem = base_buffer;
570 base_buffer = Fget_buffer (base_buffer);
571 if (NILP (base_buffer))
572 error ("No such buffer: `%s'", SDATA (tem));
573 if (NILP (BVAR (XBUFFER (base_buffer), name)))
574 error ("Base buffer has been killed");
576 if (SCHARS (name) == 0)
577 error ("Empty string for buffer name is not allowed");
579 b = allocate_buffer ();
581 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
582 ? XBUFFER (base_buffer)->base_buffer
583 : XBUFFER (base_buffer));
585 /* Use the base buffer's text object. */
586 b->text = b->base_buffer->text;
588 b->pt = b->base_buffer->pt;
589 b->begv = b->base_buffer->begv;
590 b->zv = b->base_buffer->zv;
591 b->pt_byte = b->base_buffer->pt_byte;
592 b->begv_byte = b->base_buffer->begv_byte;
593 b->zv_byte = b->base_buffer->zv_byte;
595 b->newline_cache = 0;
596 b->width_run_cache = 0;
597 BVAR (b, width_table) = Qnil;
599 /* Put this on the chain of all buffers including killed ones. */
600 b->header.next.buffer = all_buffers;
601 all_buffers = b;
603 name = Fcopy_sequence (name);
604 STRING_SET_INTERVALS (name, NULL_INTERVAL);
605 BVAR (b, name) = name;
607 reset_buffer (b);
608 reset_buffer_local_variables (b, 1);
610 /* Put this in the alist of all live buffers. */
611 XSETBUFFER (buf, b);
612 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
614 BVAR (b, mark) = Fmake_marker ();
615 BVAR (b, name) = name;
617 /* The multibyte status belongs to the base buffer. */
618 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
620 /* Make sure the base buffer has markers for its narrowing. */
621 if (NILP (BVAR (b->base_buffer, pt_marker)))
623 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
624 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
626 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
627 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
628 b->base_buffer->pt,
629 b->base_buffer->pt_byte);
631 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
632 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
633 b->base_buffer->begv,
634 b->base_buffer->begv_byte);
636 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
637 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
638 b->base_buffer->zv,
639 b->base_buffer->zv_byte);
640 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
643 if (NILP (clone))
645 /* Give the indirect buffer markers for its narrowing. */
646 BVAR (b, pt_marker) = Fmake_marker ();
647 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
648 BVAR (b, begv_marker) = Fmake_marker ();
649 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
650 BVAR (b, zv_marker) = Fmake_marker ();
651 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
652 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
654 else
656 struct buffer *old_b = current_buffer;
658 clone_per_buffer_values (b->base_buffer, b);
659 BVAR (b, filename) = Qnil;
660 BVAR (b, file_truename) = Qnil;
661 BVAR (b, display_count) = make_number (0);
662 BVAR (b, backed_up) = Qnil;
663 BVAR (b, auto_save_file_name) = Qnil;
664 set_buffer_internal_1 (b);
665 Fset (intern ("buffer-save-without-query"), Qnil);
666 Fset (intern ("buffer-file-number"), Qnil);
667 Fset (intern ("buffer-stale-function"), Qnil);
668 set_buffer_internal_1 (old_b);
671 /* Run buffer-list-update-hook. */
672 if (!NILP (Vrun_hooks))
673 call1 (Vrun_hooks, Qbuffer_list_update_hook);
675 return buf;
678 void
679 delete_all_overlays (struct buffer *b)
681 Lisp_Object overlay;
683 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
684 have to empty the list, otherwise we end up with overlays that
685 think they belong to this buffer while the buffer doesn't know about
686 them any more. */
687 while (b->overlays_before)
689 XSETMISC (overlay, b->overlays_before);
690 Fdelete_overlay (overlay);
692 while (b->overlays_after)
694 XSETMISC (overlay, b->overlays_after);
695 Fdelete_overlay (overlay);
697 eassert (b->overlays_before == NULL);
698 eassert (b->overlays_after == NULL);
701 /* Reinitialize everything about a buffer except its name and contents
702 and local variables.
703 If called on an already-initialized buffer, the list of overlays
704 should be deleted before calling this function, otherwise we end up
705 with overlays that claim to belong to the buffer but the buffer
706 claims it doesn't belong to it. */
708 void
709 reset_buffer (register struct buffer *b)
711 BVAR (b, filename) = Qnil;
712 BVAR (b, file_truename) = Qnil;
713 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
714 b->modtime = 0;
715 b->modtime_size = -1;
716 XSETFASTINT (BVAR (b, save_length), 0);
717 b->last_window_start = 1;
718 /* It is more conservative to start out "changed" than "unchanged". */
719 b->clip_changed = 0;
720 b->prevent_redisplay_optimizations_p = 1;
721 BVAR (b, backed_up) = Qnil;
722 BUF_AUTOSAVE_MODIFF (b) = 0;
723 b->auto_save_failure_time = 0;
724 BVAR (b, auto_save_file_name) = Qnil;
725 BVAR (b, read_only) = Qnil;
726 b->overlays_before = NULL;
727 b->overlays_after = NULL;
728 b->overlay_center = BEG;
729 BVAR (b, mark_active) = Qnil;
730 BVAR (b, point_before_scroll) = Qnil;
731 BVAR (b, file_format) = Qnil;
732 BVAR (b, auto_save_file_format) = Qt;
733 BVAR (b, last_selected_window) = Qnil;
734 XSETINT (BVAR (b, display_count), 0);
735 BVAR (b, display_time) = Qnil;
736 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
737 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
738 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
740 b->display_error_modiff = 0;
743 /* Reset buffer B's local variables info.
744 Don't use this on a buffer that has already been in use;
745 it does not treat permanent locals consistently.
746 Instead, use Fkill_all_local_variables.
748 If PERMANENT_TOO is 1, then we reset permanent
749 buffer-local variables. If PERMANENT_TOO is 0,
750 we preserve those. */
752 static void
753 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
755 register int offset;
756 int i;
758 /* Reset the major mode to Fundamental, together with all the
759 things that depend on the major mode.
760 default-major-mode is handled at a higher level.
761 We ignore it here. */
762 BVAR (b, major_mode) = Qfundamental_mode;
763 BVAR (b, keymap) = Qnil;
764 BVAR (b, mode_name) = QSFundamental;
765 BVAR (b, minor_modes) = Qnil;
767 /* If the standard case table has been altered and invalidated,
768 fix up its insides first. */
769 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
770 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
771 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
772 Fset_standard_case_table (Vascii_downcase_table);
774 BVAR (b, downcase_table) = Vascii_downcase_table;
775 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
776 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
777 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
778 BVAR (b, invisibility_spec) = Qt;
780 /* Reset all (or most) per-buffer variables to their defaults. */
781 if (permanent_too)
782 BVAR (b, local_var_alist) = Qnil;
783 else
785 Lisp_Object tmp, prop, last = Qnil;
786 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
787 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
789 /* If permanent-local, keep it. */
790 last = tmp;
791 if (EQ (prop, Qpermanent_local_hook))
793 /* This is a partially permanent hook variable.
794 Preserve only the elements that want to be preserved. */
795 Lisp_Object list, newlist;
796 list = XCDR (XCAR (tmp));
797 if (!CONSP (list))
798 newlist = list;
799 else
800 for (newlist = Qnil; CONSP (list); list = XCDR (list))
802 Lisp_Object elt = XCAR (list);
803 /* Preserve element ELT if it's t,
804 if it is a function with a `permanent-local-hook' property,
805 or if it's not a symbol. */
806 if (! SYMBOLP (elt)
807 || EQ (elt, Qt)
808 || !NILP (Fget (elt, Qpermanent_local_hook)))
809 newlist = Fcons (elt, newlist);
811 XSETCDR (XCAR (tmp), Fnreverse (newlist));
814 /* Delete this local variable. */
815 else if (NILP (last))
816 BVAR (b, local_var_alist) = XCDR (tmp);
817 else
818 XSETCDR (last, XCDR (tmp));
821 for (i = 0; i < last_per_buffer_idx; ++i)
822 if (permanent_too || buffer_permanent_local_flags[i] == 0)
823 SET_PER_BUFFER_VALUE_P (b, i, 0);
825 /* For each slot that has a default value,
826 copy that into the slot. */
828 /* buffer-local Lisp variables start at `undo_list',
829 tho only the ones from `name' on are GC'd normally. */
830 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
831 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
832 offset += sizeof (Lisp_Object))
834 int idx = PER_BUFFER_IDX (offset);
835 if ((idx > 0
836 && (permanent_too
837 || buffer_permanent_local_flags[idx] == 0)))
838 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
842 /* We split this away from generate-new-buffer, because rename-buffer
843 and set-visited-file-name ought to be able to use this to really
844 rename the buffer properly. */
846 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
847 Sgenerate_new_buffer_name, 1, 2, 0,
848 doc: /* Return a string that is the name of no existing buffer based on NAME.
849 If there is no live buffer named NAME, then return NAME.
850 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
851 \(starting at 2) until an unused name is found, and then return that name.
852 Optional second argument IGNORE specifies a name that is okay to use (if
853 it is in the sequence to be tried) even if a buffer with that name exists. */)
854 (register Lisp_Object name, Lisp_Object ignore)
856 register Lisp_Object gentemp, tem;
857 EMACS_INT count;
858 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
860 CHECK_STRING (name);
862 tem = Fstring_equal (name, ignore);
863 if (!NILP (tem))
864 return name;
865 tem = Fget_buffer (name);
866 if (NILP (tem))
867 return name;
869 count = 1;
870 while (1)
872 sprintf (number, "<%"pI"d>", ++count);
873 gentemp = concat2 (name, build_string (number));
874 tem = Fstring_equal (gentemp, ignore);
875 if (!NILP (tem))
876 return gentemp;
877 tem = Fget_buffer (gentemp);
878 if (NILP (tem))
879 return gentemp;
884 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
885 doc: /* Return the name of BUFFER, as a string.
886 BUFFER defaults to the current buffer.
887 Return nil if BUFFER has been killed. */)
888 (register Lisp_Object buffer)
890 if (NILP (buffer))
891 return BVAR (current_buffer, name);
892 CHECK_BUFFER (buffer);
893 return BVAR (XBUFFER (buffer), name);
896 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
897 doc: /* Return name of file BUFFER is visiting, or nil if none.
898 No argument or nil as argument means use the current buffer. */)
899 (register Lisp_Object buffer)
901 if (NILP (buffer))
902 return BVAR (current_buffer, filename);
903 CHECK_BUFFER (buffer);
904 return BVAR (XBUFFER (buffer), filename);
907 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
908 0, 1, 0,
909 doc: /* Return the base buffer of indirect buffer BUFFER.
910 If BUFFER is not indirect, return nil.
911 BUFFER defaults to the current buffer. */)
912 (register Lisp_Object buffer)
914 struct buffer *base;
915 Lisp_Object base_buffer;
917 if (NILP (buffer))
918 base = current_buffer->base_buffer;
919 else
921 CHECK_BUFFER (buffer);
922 base = XBUFFER (buffer)->base_buffer;
925 if (! base)
926 return Qnil;
927 XSETBUFFER (base_buffer, base);
928 return base_buffer;
931 DEFUN ("buffer-local-value", Fbuffer_local_value,
932 Sbuffer_local_value, 2, 2, 0,
933 doc: /* Return the value of VARIABLE in BUFFER.
934 If VARIABLE does not have a buffer-local binding in BUFFER, the value
935 is the default binding of the variable. */)
936 (register Lisp_Object variable, register Lisp_Object buffer)
938 register struct buffer *buf;
939 register Lisp_Object result;
940 struct Lisp_Symbol *sym;
942 CHECK_SYMBOL (variable);
943 CHECK_BUFFER (buffer);
944 buf = XBUFFER (buffer);
945 sym = XSYMBOL (variable);
947 start:
948 switch (sym->redirect)
950 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
951 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
952 case SYMBOL_LOCALIZED:
953 { /* Look in local_var_alist. */
954 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
955 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
956 result = Fassoc (variable, BVAR (buf, local_var_alist));
957 if (!NILP (result))
959 if (blv->fwd)
960 { /* What binding is loaded right now? */
961 Lisp_Object current_alist_element = blv->valcell;
963 /* The value of the currently loaded binding is not
964 stored in it, but rather in the realvalue slot.
965 Store that value into the binding it belongs to
966 in case that is the one we are about to use. */
968 XSETCDR (current_alist_element,
969 do_symval_forwarding (blv->fwd));
971 /* Now get the (perhaps updated) value out of the binding. */
972 result = XCDR (result);
974 else
975 result = Fdefault_value (variable);
976 break;
978 case SYMBOL_FORWARDED:
980 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
981 if (BUFFER_OBJFWDP (fwd))
982 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
983 else
984 result = Fdefault_value (variable);
985 break;
987 default: abort ();
990 if (!EQ (result, Qunbound))
991 return result;
993 xsignal1 (Qvoid_variable, variable);
996 /* Return an alist of the Lisp-level buffer-local bindings of
997 buffer BUF. That is, don't include the variables maintained
998 in special slots in the buffer object. */
1000 static Lisp_Object
1001 buffer_lisp_local_variables (struct buffer *buf)
1003 Lisp_Object result = Qnil;
1004 register Lisp_Object tail;
1005 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1007 Lisp_Object val, elt;
1009 elt = XCAR (tail);
1011 /* Reference each variable in the alist in buf.
1012 If inquiring about the current buffer, this gets the current values,
1013 so store them into the alist so the alist is up to date.
1014 If inquiring about some other buffer, this swaps out any values
1015 for that buffer, making the alist up to date automatically. */
1016 val = find_symbol_value (XCAR (elt));
1017 /* Use the current buffer value only if buf is the current buffer. */
1018 if (buf != current_buffer)
1019 val = XCDR (elt);
1021 result = Fcons (EQ (val, Qunbound)
1022 ? XCAR (elt)
1023 : Fcons (XCAR (elt), val),
1024 result);
1027 return result;
1030 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1031 Sbuffer_local_variables, 0, 1, 0,
1032 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1033 Most elements look like (SYMBOL . VALUE), describing one variable.
1034 For a symbol that is locally unbound, just the symbol appears in the value.
1035 Note that storing new VALUEs in these elements doesn't change the variables.
1036 No argument or nil as argument means use current buffer as BUFFER. */)
1037 (register Lisp_Object buffer)
1039 register struct buffer *buf;
1040 register Lisp_Object result;
1042 if (NILP (buffer))
1043 buf = current_buffer;
1044 else
1046 CHECK_BUFFER (buffer);
1047 buf = XBUFFER (buffer);
1050 result = buffer_lisp_local_variables (buf);
1052 /* Add on all the variables stored in special slots. */
1054 int offset, idx;
1056 /* buffer-local Lisp variables start at `undo_list',
1057 tho only the ones from `name' on are GC'd normally. */
1058 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
1059 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
1060 /* sizeof EMACS_INT == sizeof Lisp_Object */
1061 offset += (sizeof (EMACS_INT)))
1063 idx = PER_BUFFER_IDX (offset);
1064 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1065 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1067 Lisp_Object sym = PER_BUFFER_SYMBOL (offset);
1068 Lisp_Object val = PER_BUFFER_VALUE (buf, offset);
1069 result = Fcons (EQ (val, Qunbound) ? sym : Fcons (sym, val),
1070 result);
1075 return result;
1078 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1079 0, 1, 0,
1080 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1081 No argument or nil as argument means use current buffer as BUFFER. */)
1082 (register Lisp_Object buffer)
1084 register struct buffer *buf;
1085 if (NILP (buffer))
1086 buf = current_buffer;
1087 else
1089 CHECK_BUFFER (buffer);
1090 buf = XBUFFER (buffer);
1093 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1096 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1097 1, 1, 0,
1098 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1099 A non-nil FLAG means mark the buffer modified. */)
1100 (register Lisp_Object flag)
1102 register int already;
1103 register Lisp_Object fn;
1104 Lisp_Object buffer, window;
1106 #ifdef CLASH_DETECTION
1107 /* If buffer becoming modified, lock the file.
1108 If buffer becoming unmodified, unlock the file. */
1110 fn = BVAR (current_buffer, file_truename);
1111 /* Test buffer-file-name so that binding it to nil is effective. */
1112 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1114 already = SAVE_MODIFF < MODIFF;
1115 if (!already && !NILP (flag))
1116 lock_file (fn);
1117 else if (already && NILP (flag))
1118 unlock_file (fn);
1120 #endif /* CLASH_DETECTION */
1122 /* Here we have a problem. SAVE_MODIFF is used here to encode
1123 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1124 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1125 modify SAVE_MODIFF to affect one, we may affect the other
1126 as well.
1127 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1128 if SAVE_MODIFF<auto_save_modified that means we risk changing
1129 recent-auto-save-p from t to nil.
1130 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1131 we risk changing recent-auto-save-p from nil to t. */
1132 SAVE_MODIFF = (NILP (flag)
1133 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1134 ? MODIFF
1135 /* Let's try to preserve recent-auto-save-p. */
1136 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1137 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1138 we can either decrease SAVE_MODIFF and auto_save_modified
1139 or increase MODIFF. */
1140 : MODIFF++);
1142 /* Set update_mode_lines only if buffer is displayed in some window.
1143 Packages like jit-lock or lazy-lock preserve a buffer's modified
1144 state by recording/restoring the state around blocks of code.
1145 Setting update_mode_lines makes redisplay consider all windows
1146 (on all frames). Stealth fontification of buffers not displayed
1147 would incur additional redisplay costs if we'd set
1148 update_modes_lines unconditionally.
1150 Ideally, I think there should be another mechanism for fontifying
1151 buffers without "modifying" buffers, or redisplay should be
1152 smarter about updating the `*' in mode lines. --gerd */
1153 XSETBUFFER (buffer, current_buffer);
1154 window = Fget_buffer_window (buffer, Qt);
1155 if (WINDOWP (window))
1157 ++update_mode_lines;
1158 current_buffer->prevent_redisplay_optimizations_p = 1;
1161 return flag;
1164 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1165 Srestore_buffer_modified_p, 1, 1, 0,
1166 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1167 It is not ensured that mode lines will be updated to show the modified
1168 state of the current buffer. Use with care. */)
1169 (Lisp_Object flag)
1171 #ifdef CLASH_DETECTION
1172 Lisp_Object fn;
1174 /* If buffer becoming modified, lock the file.
1175 If buffer becoming unmodified, unlock the file. */
1177 fn = BVAR (current_buffer, file_truename);
1178 /* Test buffer-file-name so that binding it to nil is effective. */
1179 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1181 int already = SAVE_MODIFF < MODIFF;
1182 if (!already && !NILP (flag))
1183 lock_file (fn);
1184 else if (already && NILP (flag))
1185 unlock_file (fn);
1187 #endif /* CLASH_DETECTION */
1189 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1190 return flag;
1193 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1194 0, 1, 0,
1195 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1196 Each buffer has a tick counter which is incremented each time the
1197 text in that buffer is changed. It wraps around occasionally.
1198 No argument or nil as argument means use current buffer as BUFFER. */)
1199 (register Lisp_Object buffer)
1201 register struct buffer *buf;
1202 if (NILP (buffer))
1203 buf = current_buffer;
1204 else
1206 CHECK_BUFFER (buffer);
1207 buf = XBUFFER (buffer);
1210 return make_number (BUF_MODIFF (buf));
1213 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1214 Sbuffer_chars_modified_tick, 0, 1, 0,
1215 doc: /* Return BUFFER's character-change tick counter.
1216 Each buffer has a character-change tick counter, which is set to the
1217 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1218 time text in that buffer is inserted or deleted. By comparing the
1219 values returned by two individual calls of `buffer-chars-modified-tick',
1220 you can tell whether a character change occurred in that buffer in
1221 between these calls. No argument or nil as argument means use current
1222 buffer as BUFFER. */)
1223 (register Lisp_Object buffer)
1225 register struct buffer *buf;
1226 if (NILP (buffer))
1227 buf = current_buffer;
1228 else
1230 CHECK_BUFFER (buffer);
1231 buf = XBUFFER (buffer);
1234 return make_number (BUF_CHARS_MODIFF (buf));
1237 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1238 "(list (read-string \"Rename buffer (to new name): \" \
1239 nil 'buffer-name-history (buffer-name (current-buffer))) \
1240 current-prefix-arg)",
1241 doc: /* Change current buffer's name to NEWNAME (a string).
1242 If second arg UNIQUE is nil or omitted, it is an error if a
1243 buffer named NEWNAME already exists.
1244 If UNIQUE is non-nil, come up with a new name using
1245 `generate-new-buffer-name'.
1246 Interactively, you can set UNIQUE with a prefix argument.
1247 We return the name we actually gave the buffer.
1248 This does not change the name of the visited file (if any). */)
1249 (register Lisp_Object newname, Lisp_Object unique)
1251 register Lisp_Object tem, buf;
1253 CHECK_STRING (newname);
1255 if (SCHARS (newname) == 0)
1256 error ("Empty string is invalid as a buffer name");
1258 tem = Fget_buffer (newname);
1259 if (!NILP (tem))
1261 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1262 rename the buffer automatically so you can create another
1263 with the original name. It makes UNIQUE equivalent to
1264 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1265 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1266 return BVAR (current_buffer, name);
1267 if (!NILP (unique))
1268 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1269 else
1270 error ("Buffer name `%s' is in use", SDATA (newname));
1273 BVAR (current_buffer, name) = newname;
1275 /* Catch redisplay's attention. Unless we do this, the mode lines for
1276 any windows displaying current_buffer will stay unchanged. */
1277 update_mode_lines++;
1279 XSETBUFFER (buf, current_buffer);
1280 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1281 if (NILP (BVAR (current_buffer, filename))
1282 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1283 call0 (intern ("rename-auto-save-file"));
1285 /* Run buffer-list-update-hook. */
1286 if (!NILP (Vrun_hooks))
1287 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1289 /* Refetch since that last call may have done GC. */
1290 return BVAR (current_buffer, name);
1293 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1294 doc: /* Return most recently selected buffer other than BUFFER.
1295 Buffers not visible in windows are preferred to visible buffers, unless
1296 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1297 BUFFER unless it denotes a live buffer. If the optional third argument
1298 FRAME is non-nil, use that frame's buffer list instead of the selected
1299 frame's buffer list.
1301 The buffer is found by scanning the selected or specified frame's buffer
1302 list first, followed by the list of all buffers. If no other buffer
1303 exists, return the buffer `*scratch*' (creating it if necessary). */)
1304 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1306 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1307 Lisp_Object tail, buf, pred;
1308 Lisp_Object notsogood = Qnil;
1310 if (NILP (frame))
1311 frame = selected_frame;
1313 CHECK_FRAME (frame);
1315 pred = frame_buffer_predicate (frame);
1316 /* Consider buffers that have been seen in the frame first. */
1317 tail = XFRAME (frame)->buffer_list;
1318 for (; CONSP (tail); tail = XCDR (tail))
1320 buf = XCAR (tail);
1321 if (BUFFERP (buf) && !EQ (buf, buffer)
1322 && !NILP (BVAR (XBUFFER (buf), name))
1323 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1324 /* If the frame has a buffer_predicate, disregard buffers that
1325 don't fit the predicate. */
1326 && (NILP (pred) || !NILP (call1 (pred, buf))))
1328 if (!NILP (visible_ok)
1329 || NILP (Fget_buffer_window (buf, Qvisible)))
1330 return buf;
1331 else if (NILP (notsogood))
1332 notsogood = buf;
1336 /* Consider alist of all buffers next. */
1337 tail = Vbuffer_alist;
1338 for (; CONSP (tail); tail = XCDR (tail))
1340 buf = Fcdr (XCAR (tail));
1341 if (BUFFERP (buf) && !EQ (buf, buffer)
1342 && !NILP (BVAR (XBUFFER (buf), name))
1343 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1344 /* If the frame has a buffer_predicate, disregard buffers that
1345 don't fit the predicate. */
1346 && (NILP (pred) || !NILP (call1 (pred, buf))))
1348 if (!NILP (visible_ok)
1349 || NILP (Fget_buffer_window (buf, Qvisible)))
1350 return buf;
1351 else if (NILP (notsogood))
1352 notsogood = buf;
1356 if (!NILP (notsogood))
1357 return notsogood;
1358 else
1360 buf = Fget_buffer (build_string ("*scratch*"));
1361 if (NILP (buf))
1363 buf = Fget_buffer_create (build_string ("*scratch*"));
1364 Fset_buffer_major_mode (buf);
1366 return buf;
1370 /* The following function is a safe variant of Fother_buffer: It doesn't
1371 pay attention to any frame-local buffer lists, doesn't care about
1372 visibility of buffers, and doesn't evaluate any frame predicates. */
1374 Lisp_Object
1375 other_buffer_safely (Lisp_Object buffer)
1377 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1378 Lisp_Object tail, buf;
1380 tail = Vbuffer_alist;
1381 for (; CONSP (tail); tail = XCDR (tail))
1383 buf = Fcdr (XCAR (tail));
1384 if (BUFFERP (buf) && !EQ (buf, buffer)
1385 && !NILP (BVAR (XBUFFER (buf), name))
1386 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1387 return buf;
1390 buf = Fget_buffer (build_string ("*scratch*"));
1391 if (NILP (buf))
1393 buf = Fget_buffer_create (build_string ("*scratch*"));
1394 Fset_buffer_major_mode (buf);
1397 return buf;
1400 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1401 0, 1, "",
1402 doc: /* Start keeping undo information for buffer BUFFER.
1403 No argument or nil as argument means do this for the current buffer. */)
1404 (register Lisp_Object buffer)
1406 Lisp_Object real_buffer;
1408 if (NILP (buffer))
1409 XSETBUFFER (real_buffer, current_buffer);
1410 else
1412 real_buffer = Fget_buffer (buffer);
1413 if (NILP (real_buffer))
1414 nsberror (buffer);
1417 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1418 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1420 return Qnil;
1424 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1425 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1426 The buffer being killed will be current while the hook is running.\n\
1427 See `kill-buffer'."
1429 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1430 doc: /* Kill buffer BUFFER-OR-NAME.
1431 The argument may be a buffer or the name of an existing buffer.
1432 Argument nil or omitted means kill the current buffer. Return t if the
1433 buffer is actually killed, nil otherwise.
1435 This function calls `replace-buffer-in-windows' for cleaning up all
1436 windows currently displaying the buffer to be killed. The functions in
1437 `kill-buffer-query-functions' are called with the buffer to be killed as
1438 the current buffer. If any of them returns nil, the buffer is not
1439 killed. The hook `kill-buffer-hook' is run before the buffer is
1440 actually killed. The buffer being killed will be current while the hook
1441 is running.
1443 Any processes that have this buffer as the `process-buffer' are killed
1444 with SIGHUP. */)
1445 (Lisp_Object buffer_or_name)
1447 Lisp_Object buffer;
1448 register struct buffer *b;
1449 register Lisp_Object tem;
1450 register struct Lisp_Marker *m;
1451 struct gcpro gcpro1;
1453 if (NILP (buffer_or_name))
1454 buffer = Fcurrent_buffer ();
1455 else
1456 buffer = Fget_buffer (buffer_or_name);
1457 if (NILP (buffer))
1458 nsberror (buffer_or_name);
1460 b = XBUFFER (buffer);
1462 /* Avoid trouble for buffer already dead. */
1463 if (NILP (BVAR (b, name)))
1464 return Qnil;
1466 /* Query if the buffer is still modified. */
1467 if (INTERACTIVE && !NILP (BVAR (b, filename))
1468 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1470 GCPRO1 (buffer);
1471 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1472 BVAR (b, name), make_number (0)));
1473 UNGCPRO;
1474 if (NILP (tem))
1475 return Qnil;
1478 /* Run hooks with the buffer to be killed the current buffer. */
1480 int count = SPECPDL_INDEX ();
1481 Lisp_Object arglist[1];
1483 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1484 set_buffer_internal (b);
1486 /* First run the query functions; if any query is answered no,
1487 don't kill the buffer. */
1488 arglist[0] = Qkill_buffer_query_functions;
1489 tem = Frun_hook_with_args_until_failure (1, arglist);
1490 if (NILP (tem))
1491 return unbind_to (count, Qnil);
1493 /* Then run the hooks. */
1494 Frun_hooks (1, &Qkill_buffer_hook);
1495 unbind_to (count, Qnil);
1498 /* We have no more questions to ask. Verify that it is valid
1499 to kill the buffer. This must be done after the questions
1500 since anything can happen within do_yes_or_no_p. */
1502 /* Don't kill the minibuffer now current. */
1503 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1504 return Qnil;
1506 if (NILP (BVAR (b, name)))
1507 return Qnil;
1509 /* When we kill a base buffer, kill all its indirect buffers.
1510 We do it at this stage so nothing terrible happens if they
1511 ask questions or their hooks get errors. */
1512 if (! b->base_buffer)
1514 struct buffer *other;
1516 GCPRO1 (buffer);
1518 for (other = all_buffers; other; other = other->header.next.buffer)
1519 /* all_buffers contains dead buffers too;
1520 don't re-kill them. */
1521 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1523 Lisp_Object buf;
1524 XSETBUFFER (buf, other);
1525 Fkill_buffer (buf);
1528 UNGCPRO;
1531 /* Run replace_buffer_in_windows before making another buffer current
1532 since set-window-buffer-start-and-point will refuse to make another
1533 buffer current if the selected window does not show the current
1534 buffer. (Bug#10114) */
1535 replace_buffer_in_windows (buffer);
1537 /* Make this buffer not be current.
1538 In the process, notice if this is the sole visible buffer
1539 and give up if so. */
1540 if (b == current_buffer)
1542 tem = Fother_buffer (buffer, Qnil, Qnil);
1543 Fset_buffer (tem);
1544 if (b == current_buffer)
1545 return Qnil;
1548 /* Notice if the buffer to kill is the sole visible buffer
1549 when we're currently in the mini-buffer, and give up if so. */
1550 XSETBUFFER (tem, current_buffer);
1551 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1553 tem = Fother_buffer (buffer, Qnil, Qnil);
1554 if (EQ (buffer, tem))
1555 return Qnil;
1558 /* Now there is no question: we can kill the buffer. */
1560 #ifdef CLASH_DETECTION
1561 /* Unlock this buffer's file, if it is locked. */
1562 unlock_buffer (b);
1563 #endif /* CLASH_DETECTION */
1565 GCPRO1 (buffer);
1566 kill_buffer_processes (buffer);
1567 UNGCPRO;
1569 /* Killing buffer processes may run sentinels which may
1570 have called kill-buffer. */
1572 if (NILP (BVAR (b, name)))
1573 return Qnil;
1575 /* These may run Lisp code and into infinite loops (if someone
1576 insisted on circular lists) so allow quitting here. */
1577 frames_discard_buffer (buffer);
1579 clear_charpos_cache (b);
1581 tem = Vinhibit_quit;
1582 Vinhibit_quit = Qt;
1583 /* Remove the buffer from the list of all buffers. */
1584 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1585 /* If replace_buffer_in_windows didn't do its job correctly fix that
1586 now. */
1587 replace_buffer_in_windows_safely (buffer);
1588 Vinhibit_quit = tem;
1590 /* Delete any auto-save file, if we saved it in this session.
1591 But not if the buffer is modified. */
1592 if (STRINGP (BVAR (b, auto_save_file_name))
1593 && BUF_AUTOSAVE_MODIFF (b) != 0
1594 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1595 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1596 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1598 Lisp_Object delete;
1599 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1600 if (! NILP (delete))
1601 internal_delete_file (BVAR (b, auto_save_file_name));
1604 if (b->base_buffer)
1606 /* Unchain all markers that belong to this indirect buffer.
1607 Don't unchain the markers that belong to the base buffer
1608 or its other indirect buffers. */
1609 for (m = BUF_MARKERS (b); m; )
1611 struct Lisp_Marker *next = m->next;
1612 if (m->buffer == b)
1613 unchain_marker (m);
1614 m = next;
1617 else
1619 /* Unchain all markers of this buffer and its indirect buffers.
1620 and leave them pointing nowhere. */
1621 for (m = BUF_MARKERS (b); m; )
1623 struct Lisp_Marker *next = m->next;
1624 m->buffer = 0;
1625 m->next = NULL;
1626 m = next;
1628 BUF_MARKERS (b) = NULL;
1629 BUF_INTERVALS (b) = NULL_INTERVAL;
1631 /* Perhaps we should explicitly free the interval tree here... */
1634 /* Reset the local variables, so that this buffer's local values
1635 won't be protected from GC. They would be protected
1636 if they happened to remain cached in their symbols.
1637 This gets rid of them for certain. */
1638 swap_out_buffer_local_variables (b);
1639 reset_buffer_local_variables (b, 1);
1641 BVAR (b, name) = Qnil;
1643 BLOCK_INPUT;
1644 if (! b->base_buffer)
1645 free_buffer_text (b);
1647 if (b->newline_cache)
1649 free_region_cache (b->newline_cache);
1650 b->newline_cache = 0;
1652 if (b->width_run_cache)
1654 free_region_cache (b->width_run_cache);
1655 b->width_run_cache = 0;
1657 BVAR (b, width_table) = Qnil;
1658 UNBLOCK_INPUT;
1659 BVAR (b, undo_list) = Qnil;
1661 /* Run buffer-list-update-hook. */
1662 if (!NILP (Vrun_hooks))
1663 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1665 return Qt;
1668 /* Move association for BUFFER to the front of buffer (a)lists. Since
1669 we do this each time BUFFER is selected visibly, the more recently
1670 selected buffers are always closer to the front of those lists. This
1671 means that other_buffer is more likely to choose a relevant buffer.
1673 Note that this moves BUFFER to the front of the buffer lists of the
1674 selected frame even if BUFFER is not shown there. If BUFFER is not
1675 shown in the selected frame, consider the present behavior a feature.
1676 `select-window' gets this right since it shows BUFFER in the selected
1677 window when calling us. */
1679 void
1680 record_buffer (Lisp_Object buffer)
1682 Lisp_Object aelt, aelt_cons, tem;
1683 register struct frame *f = XFRAME (selected_frame);
1685 CHECK_BUFFER (buffer);
1687 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1688 Don't allow quitting since this might leave the buffer list in an
1689 inconsistent state. */
1690 tem = Vinhibit_quit;
1691 Vinhibit_quit = Qt;
1692 aelt = Frassq (buffer, Vbuffer_alist);
1693 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1694 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1695 XSETCDR (aelt_cons, Vbuffer_alist);
1696 Vbuffer_alist = aelt_cons;
1697 Vinhibit_quit = tem;
1699 /* Update buffer list of selected frame. */
1700 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1701 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1703 /* Run buffer-list-update-hook. */
1704 if (!NILP (Vrun_hooks))
1705 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1709 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1710 buffer is killed. For the selected frame's buffer list this moves
1711 BUFFER to its end even if it was never shown in that frame. If
1712 this happens we have a feature, hence `bury-buffer-internal' should be
1713 called only when BUFFER was shown in the selected frame. */
1715 DEFUN ("bury-buffer-internal", Fbury_buffer_internal, Sbury_buffer_internal,
1716 1, 1, 0,
1717 doc: /* Move BUFFER to the end of the buffer list. */)
1718 (Lisp_Object buffer)
1720 Lisp_Object aelt, aelt_cons, tem;
1721 register struct frame *f = XFRAME (selected_frame);
1723 CHECK_BUFFER (buffer);
1725 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1726 Don't allow quitting since this might leave the buffer list in an
1727 inconsistent state. */
1728 tem = Vinhibit_quit;
1729 Vinhibit_quit = Qt;
1730 aelt = Frassq (buffer, Vbuffer_alist);
1731 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1732 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1733 XSETCDR (aelt_cons, Qnil);
1734 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1735 Vinhibit_quit = tem;
1737 /* Update buffer lists of selected frame. */
1738 f->buffer_list = Fdelq (buffer, f->buffer_list);
1739 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1741 /* Run buffer-list-update-hook. */
1742 if (!NILP (Vrun_hooks))
1743 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1745 return Qnil;
1748 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1749 doc: /* Set an appropriate major mode for BUFFER.
1750 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1751 according to `default-major-mode'.
1752 Use this function before selecting the buffer, since it may need to inspect
1753 the current buffer's major mode. */)
1754 (Lisp_Object buffer)
1756 int count;
1757 Lisp_Object function;
1759 CHECK_BUFFER (buffer);
1761 if (STRINGP (BVAR (XBUFFER (buffer), name))
1762 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1763 function = find_symbol_value (intern ("initial-major-mode"));
1764 else
1766 function = BVAR (&buffer_defaults, major_mode);
1767 if (NILP (function)
1768 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1769 function = BVAR (current_buffer, major_mode);
1772 if (NILP (function) || EQ (function, Qfundamental_mode))
1773 return Qnil;
1775 count = SPECPDL_INDEX ();
1777 /* To select a nonfundamental mode,
1778 select the buffer temporarily and then call the mode function. */
1780 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1782 Fset_buffer (buffer);
1783 call0 (function);
1785 return unbind_to (count, Qnil);
1788 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1789 doc: /* Return the current buffer as a Lisp object. */)
1790 (void)
1792 register Lisp_Object buf;
1793 XSETBUFFER (buf, current_buffer);
1794 return buf;
1797 /* Set the current buffer to B.
1799 We previously set windows_or_buffers_changed here to invalidate
1800 global unchanged information in beg_unchanged and end_unchanged.
1801 This is no longer necessary because we now compute unchanged
1802 information on a buffer-basis. Every action affecting other
1803 windows than the selected one requires a select_window at some
1804 time, and that increments windows_or_buffers_changed. */
1806 void
1807 set_buffer_internal (register struct buffer *b)
1809 if (current_buffer != b)
1810 set_buffer_internal_1 (b);
1813 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1814 This is used by redisplay. */
1816 void
1817 set_buffer_internal_1 (register struct buffer *b)
1819 register struct buffer *old_buf;
1820 register Lisp_Object tail;
1822 #ifdef USE_MMAP_FOR_BUFFERS
1823 if (b->text->beg == NULL)
1824 enlarge_buffer_text (b, 0);
1825 #endif /* USE_MMAP_FOR_BUFFERS */
1827 if (current_buffer == b)
1828 return;
1830 old_buf = current_buffer;
1831 current_buffer = b;
1832 last_known_column_point = -1; /* invalidate indentation cache */
1834 if (old_buf)
1836 /* Put the undo list back in the base buffer, so that it appears
1837 that an indirect buffer shares the undo list of its base. */
1838 if (old_buf->base_buffer)
1839 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1841 /* If the old current buffer has markers to record PT, BEGV and ZV
1842 when it is not current, update them now. */
1843 record_buffer_markers (old_buf);
1846 /* Get the undo list from the base buffer, so that it appears
1847 that an indirect buffer shares the undo list of its base. */
1848 if (b->base_buffer)
1849 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1851 /* If the new current buffer has markers to record PT, BEGV and ZV
1852 when it is not current, fetch them now. */
1853 fetch_buffer_markers (b);
1855 /* Look down buffer's list of local Lisp variables
1856 to find and update any that forward into C variables. */
1860 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1862 Lisp_Object var = XCAR (XCAR (tail));
1863 struct Lisp_Symbol *sym = XSYMBOL (var);
1864 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1865 && SYMBOL_BLV (sym)->fwd)
1866 /* Just reference the variable
1867 to cause it to become set for this buffer. */
1868 Fsymbol_value (var);
1871 /* Do the same with any others that were local to the previous buffer */
1872 while (b != old_buf && (b = old_buf, b));
1875 /* Switch to buffer B temporarily for redisplay purposes.
1876 This avoids certain things that don't need to be done within redisplay. */
1878 void
1879 set_buffer_temp (struct buffer *b)
1881 register struct buffer *old_buf;
1883 if (current_buffer == b)
1884 return;
1886 old_buf = current_buffer;
1887 current_buffer = b;
1889 /* If the old current buffer has markers to record PT, BEGV and ZV
1890 when it is not current, update them now. */
1891 record_buffer_markers (old_buf);
1893 /* If the new current buffer has markers to record PT, BEGV and ZV
1894 when it is not current, fetch them now. */
1895 fetch_buffer_markers (b);
1898 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1899 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1900 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1901 also `save-excursion' when you want to make a buffer current
1902 temporarily. This function does not display the buffer, so its effect
1903 ends when the current command terminates. Use `switch-to-buffer' or
1904 `pop-to-buffer' to switch buffers permanently. */)
1905 (register Lisp_Object buffer_or_name)
1907 register Lisp_Object buffer;
1908 buffer = Fget_buffer (buffer_or_name);
1909 if (NILP (buffer))
1910 nsberror (buffer_or_name);
1911 if (NILP (BVAR (XBUFFER (buffer), name)))
1912 error ("Selecting deleted buffer");
1913 set_buffer_internal (XBUFFER (buffer));
1914 return buffer;
1917 /* Set the current buffer to BUFFER provided it is alive. */
1919 Lisp_Object
1920 set_buffer_if_live (Lisp_Object buffer)
1922 if (! NILP (BVAR (XBUFFER (buffer), name)))
1923 Fset_buffer (buffer);
1924 return Qnil;
1927 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1928 Sbarf_if_buffer_read_only, 0, 0, 0,
1929 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1930 (void)
1932 if (!NILP (BVAR (current_buffer, read_only))
1933 && NILP (Vinhibit_read_only))
1934 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1935 return Qnil;
1938 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1939 doc: /* Delete the entire contents of the current buffer.
1940 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1941 so the buffer is truly empty after this. */)
1942 (void)
1944 Fwiden ();
1946 del_range (BEG, Z);
1948 current_buffer->last_window_start = 1;
1949 /* Prevent warnings, or suspension of auto saving, that would happen
1950 if future size is less than past size. Use of erase-buffer
1951 implies that the future text is not really related to the past text. */
1952 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1953 return Qnil;
1956 void
1957 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1959 CHECK_NUMBER_COERCE_MARKER (*b);
1960 CHECK_NUMBER_COERCE_MARKER (*e);
1962 if (XINT (*b) > XINT (*e))
1964 Lisp_Object tem;
1965 tem = *b; *b = *e; *e = tem;
1968 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1969 && XINT (*e) <= ZV))
1970 args_out_of_range (*b, *e);
1973 /* Advance BYTE_POS up to a character boundary
1974 and return the adjusted position. */
1976 static EMACS_INT
1977 advance_to_char_boundary (EMACS_INT byte_pos)
1979 int c;
1981 if (byte_pos == BEG)
1982 /* Beginning of buffer is always a character boundary. */
1983 return BEG;
1985 c = FETCH_BYTE (byte_pos);
1986 if (! CHAR_HEAD_P (c))
1988 /* We should advance BYTE_POS only when C is a constituent of a
1989 multibyte sequence. */
1990 EMACS_INT orig_byte_pos = byte_pos;
1994 byte_pos--;
1995 c = FETCH_BYTE (byte_pos);
1997 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
1998 INC_POS (byte_pos);
1999 if (byte_pos < orig_byte_pos)
2000 byte_pos = orig_byte_pos;
2001 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2002 surely advance to the correct character boundary. If C is
2003 not, BYTE_POS was unchanged. */
2006 return byte_pos;
2009 #ifdef REL_ALLOC
2010 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2011 #endif /* REL_ALLOC */
2013 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2014 1, 1, 0,
2015 doc: /* Swap the text between current buffer and BUFFER. */)
2016 (Lisp_Object buffer)
2018 struct buffer *other_buffer;
2019 CHECK_BUFFER (buffer);
2020 other_buffer = XBUFFER (buffer);
2022 if (NILP (BVAR (other_buffer, name)))
2023 error ("Cannot swap a dead buffer's text");
2025 /* Actually, it probably works just fine.
2026 * if (other_buffer == current_buffer)
2027 * error ("Cannot swap a buffer's text with itself"); */
2029 /* Actually, this may be workable as well, tho probably only if they're
2030 *both* indirect. */
2031 if (other_buffer->base_buffer
2032 || current_buffer->base_buffer)
2033 error ("Cannot swap indirect buffers's text");
2035 { /* This is probably harder to make work. */
2036 struct buffer *other;
2037 for (other = all_buffers; other; other = other->header.next.buffer)
2038 if (other->base_buffer == other_buffer
2039 || other->base_buffer == current_buffer)
2040 error ("One of the buffers to swap has indirect buffers");
2043 #define swapfield(field, type) \
2044 do { \
2045 type tmp##field = other_buffer->field; \
2046 other_buffer->field = current_buffer->field; \
2047 current_buffer->field = tmp##field; \
2048 } while (0)
2049 #define swapfield_(field, type) \
2050 do { \
2051 type tmp##field = BVAR (other_buffer, field); \
2052 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2053 BVAR (current_buffer, field) = tmp##field; \
2054 } while (0)
2056 swapfield (own_text, struct buffer_text);
2057 eassert (current_buffer->text == &current_buffer->own_text);
2058 eassert (other_buffer->text == &other_buffer->own_text);
2059 #ifdef REL_ALLOC
2060 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2061 (POINTER_TYPE **) &other_buffer->own_text.beg);
2062 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2063 (POINTER_TYPE **) &current_buffer->own_text.beg);
2064 #endif /* REL_ALLOC */
2066 swapfield (pt, EMACS_INT);
2067 swapfield (pt_byte, EMACS_INT);
2068 swapfield (begv, EMACS_INT);
2069 swapfield (begv_byte, EMACS_INT);
2070 swapfield (zv, EMACS_INT);
2071 swapfield (zv_byte, EMACS_INT);
2072 eassert (!current_buffer->base_buffer);
2073 eassert (!other_buffer->base_buffer);
2074 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2075 swapfield (newline_cache, struct region_cache *);
2076 swapfield (width_run_cache, struct region_cache *);
2077 current_buffer->prevent_redisplay_optimizations_p = 1;
2078 other_buffer->prevent_redisplay_optimizations_p = 1;
2079 swapfield (overlays_before, struct Lisp_Overlay *);
2080 swapfield (overlays_after, struct Lisp_Overlay *);
2081 swapfield (overlay_center, EMACS_INT);
2082 swapfield_ (undo_list, Lisp_Object);
2083 swapfield_ (mark, Lisp_Object);
2084 swapfield_ (enable_multibyte_characters, Lisp_Object);
2085 swapfield_ (bidi_display_reordering, Lisp_Object);
2086 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2087 /* FIXME: Not sure what we should do with these *_marker fields.
2088 Hopefully they're just nil anyway. */
2089 swapfield_ (pt_marker, Lisp_Object);
2090 swapfield_ (begv_marker, Lisp_Object);
2091 swapfield_ (zv_marker, Lisp_Object);
2092 BVAR (current_buffer, point_before_scroll) = Qnil;
2093 BVAR (other_buffer, point_before_scroll) = Qnil;
2095 current_buffer->text->modiff++; other_buffer->text->modiff++;
2096 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2097 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2098 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2099 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2100 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2101 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2103 struct Lisp_Marker *m;
2104 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2105 if (m->buffer == other_buffer)
2106 m->buffer = current_buffer;
2107 else
2108 /* Since there's no indirect buffer in sight, markers on
2109 BUF_MARKERS(buf) should either be for `buf' or dead. */
2110 eassert (!m->buffer);
2111 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2112 if (m->buffer == current_buffer)
2113 m->buffer = other_buffer;
2114 else
2115 /* Since there's no indirect buffer in sight, markers on
2116 BUF_MARKERS(buf) should either be for `buf' or dead. */
2117 eassert (!m->buffer);
2119 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2120 So since we just swapped the markers between the two buffers, we need
2121 to undo the effect of this swap for window markers. */
2122 Lisp_Object w = Fselected_window (), ws = Qnil;
2123 Lisp_Object buf1, buf2;
2124 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2126 while (NILP (Fmemq (w, ws)))
2128 ws = Fcons (w, ws);
2129 if (MARKERP (XWINDOW (w)->pointm)
2130 && (EQ (XWINDOW (w)->buffer, buf1)
2131 || EQ (XWINDOW (w)->buffer, buf2)))
2132 Fset_marker (XWINDOW (w)->pointm,
2133 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2134 XWINDOW (w)->buffer);
2135 w = Fnext_window (w, Qt, Qt);
2139 if (current_buffer->text->intervals)
2140 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2141 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2142 if (other_buffer->text->intervals)
2143 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2144 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2146 return Qnil;
2149 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2150 1, 1, 0,
2151 doc: /* Set the multibyte flag of the current buffer to FLAG.
2152 If FLAG is t, this makes the buffer a multibyte buffer.
2153 If FLAG is nil, this makes the buffer a single-byte buffer.
2154 In these cases, the buffer contents remain unchanged as a sequence of
2155 bytes but the contents viewed as characters do change.
2156 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2157 all eight-bit bytes to eight-bit characters.
2158 If the multibyte flag was really changed, undo information of the
2159 current buffer is cleared. */)
2160 (Lisp_Object flag)
2162 struct Lisp_Marker *tail, *markers;
2163 struct buffer *other;
2164 EMACS_INT begv, zv;
2165 int narrowed = (BEG != BEGV || Z != ZV);
2166 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2167 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2168 struct gcpro gcpro1;
2170 if (current_buffer->base_buffer)
2171 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2173 /* Do nothing if nothing actually changes. */
2174 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2175 return flag;
2177 GCPRO1 (old_undo);
2179 /* Don't record these buffer changes. We will put a special undo entry
2180 instead. */
2181 BVAR (current_buffer, undo_list) = Qt;
2183 /* If the cached position is for this buffer, clear it out. */
2184 clear_charpos_cache (current_buffer);
2186 if (NILP (flag))
2187 begv = BEGV_BYTE, zv = ZV_BYTE;
2188 else
2189 begv = BEGV, zv = ZV;
2191 if (narrowed)
2192 Fwiden ();
2194 if (NILP (flag))
2196 EMACS_INT pos, stop;
2197 unsigned char *p;
2199 /* Do this first, so it can use CHAR_TO_BYTE
2200 to calculate the old correspondences. */
2201 set_intervals_multibyte (0);
2203 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2205 Z = Z_BYTE;
2206 BEGV = BEGV_BYTE;
2207 ZV = ZV_BYTE;
2208 GPT = GPT_BYTE;
2209 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2212 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2213 tail->charpos = tail->bytepos;
2215 /* Convert multibyte form of 8-bit characters to unibyte. */
2216 pos = BEG;
2217 stop = GPT;
2218 p = BEG_ADDR;
2219 while (1)
2221 int c, bytes;
2223 if (pos == stop)
2225 if (pos == Z)
2226 break;
2227 p = GAP_END_ADDR;
2228 stop = Z;
2230 if (ASCII_BYTE_P (*p))
2231 p++, pos++;
2232 else if (CHAR_BYTE8_HEAD_P (*p))
2234 c = STRING_CHAR_AND_LENGTH (p, bytes);
2235 /* Delete all bytes for this 8-bit character but the
2236 last one, and change the last one to the character
2237 code. */
2238 bytes--;
2239 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2240 p = GAP_END_ADDR;
2241 *p++ = c;
2242 pos++;
2243 if (begv > pos)
2244 begv -= bytes;
2245 if (zv > pos)
2246 zv -= bytes;
2247 stop = Z;
2249 else
2251 bytes = BYTES_BY_CHAR_HEAD (*p);
2252 p += bytes, pos += bytes;
2255 if (narrowed)
2256 Fnarrow_to_region (make_number (begv), make_number (zv));
2258 else
2260 EMACS_INT pt = PT;
2261 EMACS_INT pos, stop;
2262 unsigned char *p, *pend;
2264 /* Be sure not to have a multibyte sequence striding over the GAP.
2265 Ex: We change this: "...abc\302 _GAP_ \241def..."
2266 to: "...abc _GAP_ \302\241def..." */
2268 if (EQ (flag, Qt)
2269 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2270 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2272 unsigned char *q = GPT_ADDR - 1;
2274 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2275 if (LEADING_CODE_P (*q))
2277 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
2279 move_gap_both (new_gpt, new_gpt);
2283 /* Make the buffer contents valid as multibyte by converting
2284 8-bit characters to multibyte form. */
2285 pos = BEG;
2286 stop = GPT;
2287 p = BEG_ADDR;
2288 pend = GPT_ADDR;
2289 while (1)
2291 int bytes;
2293 if (pos == stop)
2295 if (pos == Z)
2296 break;
2297 p = GAP_END_ADDR;
2298 pend = Z_ADDR;
2299 stop = Z;
2302 if (ASCII_BYTE_P (*p))
2303 p++, pos++;
2304 else if (EQ (flag, Qt)
2305 && ! CHAR_BYTE8_HEAD_P (*p)
2306 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2307 p += bytes, pos += bytes;
2308 else
2310 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2311 int c;
2313 c = BYTE8_TO_CHAR (*p);
2314 bytes = CHAR_STRING (c, tmp);
2315 *p = tmp[0];
2316 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2317 bytes--;
2318 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2319 /* Now the gap is after the just inserted data. */
2320 pos = GPT;
2321 p = GAP_END_ADDR;
2322 if (pos <= begv)
2323 begv += bytes;
2324 if (pos <= zv)
2325 zv += bytes;
2326 if (pos <= pt)
2327 pt += bytes;
2328 pend = Z_ADDR;
2329 stop = Z;
2333 if (pt != PT)
2334 TEMP_SET_PT (pt);
2336 if (narrowed)
2337 Fnarrow_to_region (make_number (begv), make_number (zv));
2339 /* Do this first, so that chars_in_text asks the right question.
2340 set_intervals_multibyte needs it too. */
2341 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2343 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2344 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2346 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2348 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2349 if (BEGV_BYTE > GPT_BYTE)
2350 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2351 else
2352 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2354 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2355 if (ZV_BYTE > GPT_BYTE)
2356 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2357 else
2358 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2361 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2362 EMACS_INT position;
2364 if (byte > GPT_BYTE)
2365 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2366 else
2367 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2368 TEMP_SET_PT_BOTH (position, byte);
2371 tail = markers = BUF_MARKERS (current_buffer);
2373 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2374 getting confused by the markers that have not yet been updated.
2375 It is also a signal that it should never create a marker. */
2376 BUF_MARKERS (current_buffer) = NULL;
2378 for (; tail; tail = tail->next)
2380 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2381 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2384 /* Make sure no markers were put on the chain
2385 while the chain value was incorrect. */
2386 if (BUF_MARKERS (current_buffer))
2387 abort ();
2389 BUF_MARKERS (current_buffer) = markers;
2391 /* Do this last, so it can calculate the new correspondences
2392 between chars and bytes. */
2393 set_intervals_multibyte (1);
2396 if (!EQ (old_undo, Qt))
2398 /* Represent all the above changes by a special undo entry. */
2399 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2400 intern ("set-buffer-multibyte"),
2401 NILP (flag) ? Qt : Qnil),
2402 old_undo);
2405 UNGCPRO;
2407 /* Changing the multibyteness of a buffer means that all windows
2408 showing that buffer must be updated thoroughly. */
2409 current_buffer->prevent_redisplay_optimizations_p = 1;
2410 ++windows_or_buffers_changed;
2412 /* Copy this buffer's new multibyte status
2413 into all of its indirect buffers. */
2414 for (other = all_buffers; other; other = other->header.next.buffer)
2415 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2417 BVAR (other, enable_multibyte_characters)
2418 = BVAR (current_buffer, enable_multibyte_characters);
2419 other->prevent_redisplay_optimizations_p = 1;
2422 /* Restore the modifiedness of the buffer. */
2423 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2424 Fset_buffer_modified_p (Qnil);
2426 /* Update coding systems of this buffer's process (if any). */
2428 Lisp_Object process;
2430 process = Fget_buffer_process (Fcurrent_buffer ());
2431 if (PROCESSP (process))
2432 setup_process_coding_systems (process);
2435 return flag;
2438 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2439 Skill_all_local_variables, 0, 0, 0,
2440 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2441 Most local variable bindings are eliminated so that the default values
2442 become effective once more. Also, the syntax table is set from
2443 `standard-syntax-table', the local keymap is set to nil,
2444 and the abbrev table from `fundamental-mode-abbrev-table'.
2445 This function also forces redisplay of the mode line.
2447 Every function to select a new major mode starts by
2448 calling this function.
2450 As a special exception, local variables whose names have
2451 a non-nil `permanent-local' property are not eliminated by this function.
2453 The first thing this function does is run
2454 the normal hook `change-major-mode-hook'. */)
2455 (void)
2457 Frun_hooks (1, &Qchange_major_mode_hook);
2459 /* Make sure none of the bindings in local_var_alist
2460 remain swapped in, in their symbols. */
2462 swap_out_buffer_local_variables (current_buffer);
2464 /* Actually eliminate all local bindings of this buffer. */
2466 reset_buffer_local_variables (current_buffer, 0);
2468 /* Force mode-line redisplay. Useful here because all major mode
2469 commands call this function. */
2470 update_mode_lines++;
2472 return Qnil;
2475 /* Make sure no local variables remain set up with buffer B
2476 for their current values. */
2478 static void
2479 swap_out_buffer_local_variables (struct buffer *b)
2481 Lisp_Object oalist, alist, buffer;
2483 XSETBUFFER (buffer, b);
2484 oalist = BVAR (b, local_var_alist);
2486 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2488 Lisp_Object sym = XCAR (XCAR (alist));
2489 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2490 /* Need not do anything if some other buffer's binding is
2491 now cached. */
2492 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2494 /* Symbol is set up for this buffer's old local value:
2495 swap it out! */
2496 swap_in_global_binding (XSYMBOL (sym));
2501 /* Find all the overlays in the current buffer that contain position POS.
2502 Return the number found, and store them in a vector in *VEC_PTR.
2503 Store in *LEN_PTR the size allocated for the vector.
2504 Store in *NEXT_PTR the next position after POS where an overlay starts,
2505 or ZV if there are no more overlays between POS and ZV.
2506 Store in *PREV_PTR the previous position before POS where an overlay ends,
2507 or where an overlay starts which ends at or after POS;
2508 or BEGV if there are no such overlays from BEGV to POS.
2509 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2511 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2512 when this function is called.
2514 If EXTEND is non-zero, we make the vector bigger if necessary.
2515 If EXTEND is zero, we never extend the vector,
2516 and we store only as many overlays as will fit.
2517 But we still return the total number of overlays.
2519 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2520 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2521 default (BEGV or ZV). */
2523 ptrdiff_t
2524 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2525 ptrdiff_t *len_ptr,
2526 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
2528 Lisp_Object overlay, start, end;
2529 struct Lisp_Overlay *tail;
2530 ptrdiff_t idx = 0;
2531 ptrdiff_t len = *len_ptr;
2532 Lisp_Object *vec = *vec_ptr;
2533 EMACS_INT next = ZV;
2534 EMACS_INT prev = BEGV;
2535 int inhibit_storing = 0;
2537 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2539 EMACS_INT startpos, endpos;
2541 XSETMISC (overlay, tail);
2543 start = OVERLAY_START (overlay);
2544 end = OVERLAY_END (overlay);
2545 endpos = OVERLAY_POSITION (end);
2546 if (endpos < pos)
2548 if (prev < endpos)
2549 prev = endpos;
2550 break;
2552 startpos = OVERLAY_POSITION (start);
2553 /* This one ends at or after POS
2554 so its start counts for PREV_PTR if it's before POS. */
2555 if (prev < startpos && startpos < pos)
2556 prev = startpos;
2557 if (endpos == pos)
2558 continue;
2559 if (startpos <= pos)
2561 if (idx == len)
2563 /* The supplied vector is full.
2564 Either make it bigger, or don't store any more in it. */
2565 if (extend)
2567 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2568 sizeof *vec);
2569 *vec_ptr = vec;
2570 len = *len_ptr;
2572 else
2573 inhibit_storing = 1;
2576 if (!inhibit_storing)
2577 vec[idx] = overlay;
2578 /* Keep counting overlays even if we can't return them all. */
2579 idx++;
2581 else if (startpos < next)
2582 next = startpos;
2585 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2587 EMACS_INT startpos, endpos;
2589 XSETMISC (overlay, tail);
2591 start = OVERLAY_START (overlay);
2592 end = OVERLAY_END (overlay);
2593 startpos = OVERLAY_POSITION (start);
2594 if (pos < startpos)
2596 if (startpos < next)
2597 next = startpos;
2598 break;
2600 endpos = OVERLAY_POSITION (end);
2601 if (pos < endpos)
2603 if (idx == len)
2605 if (extend)
2607 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2608 sizeof *vec);
2609 *vec_ptr = vec;
2610 len = *len_ptr;
2612 else
2613 inhibit_storing = 1;
2616 if (!inhibit_storing)
2617 vec[idx] = overlay;
2618 idx++;
2620 if (startpos < pos && startpos > prev)
2621 prev = startpos;
2623 else if (endpos < pos && endpos > prev)
2624 prev = endpos;
2625 else if (endpos == pos && startpos > prev
2626 && (!change_req || startpos < pos))
2627 prev = startpos;
2630 if (next_ptr)
2631 *next_ptr = next;
2632 if (prev_ptr)
2633 *prev_ptr = prev;
2634 return idx;
2637 /* Find all the overlays in the current buffer that overlap the range
2638 BEG-END, or are empty at BEG, or are empty at END provided END
2639 denotes the position at the end of the current buffer.
2641 Return the number found, and store them in a vector in *VEC_PTR.
2642 Store in *LEN_PTR the size allocated for the vector.
2643 Store in *NEXT_PTR the next position after POS where an overlay starts,
2644 or ZV if there are no more overlays.
2645 Store in *PREV_PTR the previous position before POS where an overlay ends,
2646 or BEGV if there are no previous overlays.
2647 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2649 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2650 when this function is called.
2652 If EXTEND is non-zero, we make the vector bigger if necessary.
2653 If EXTEND is zero, we never extend the vector,
2654 and we store only as many overlays as will fit.
2655 But we still return the total number of overlays. */
2657 static ptrdiff_t
2658 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2659 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2660 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
2662 Lisp_Object overlay, ostart, oend;
2663 struct Lisp_Overlay *tail;
2664 ptrdiff_t idx = 0;
2665 ptrdiff_t len = *len_ptr;
2666 Lisp_Object *vec = *vec_ptr;
2667 EMACS_INT next = ZV;
2668 EMACS_INT prev = BEGV;
2669 int inhibit_storing = 0;
2670 int end_is_Z = end == Z;
2672 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2674 EMACS_INT startpos, endpos;
2676 XSETMISC (overlay, tail);
2678 ostart = OVERLAY_START (overlay);
2679 oend = OVERLAY_END (overlay);
2680 endpos = OVERLAY_POSITION (oend);
2681 if (endpos < beg)
2683 if (prev < endpos)
2684 prev = endpos;
2685 break;
2687 startpos = OVERLAY_POSITION (ostart);
2688 /* Count an interval if it overlaps the range, is empty at the
2689 start of the range, or is empty at END provided END denotes the
2690 end of the buffer. */
2691 if ((beg < endpos && startpos < end)
2692 || (startpos == endpos
2693 && (beg == endpos || (end_is_Z && endpos == end))))
2695 if (idx == len)
2697 /* The supplied vector is full.
2698 Either make it bigger, or don't store any more in it. */
2699 if (extend)
2701 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2702 sizeof *vec);
2703 *vec_ptr = vec;
2704 len = *len_ptr;
2706 else
2707 inhibit_storing = 1;
2710 if (!inhibit_storing)
2711 vec[idx] = overlay;
2712 /* Keep counting overlays even if we can't return them all. */
2713 idx++;
2715 else if (startpos < next)
2716 next = startpos;
2719 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2721 EMACS_INT startpos, endpos;
2723 XSETMISC (overlay, tail);
2725 ostart = OVERLAY_START (overlay);
2726 oend = OVERLAY_END (overlay);
2727 startpos = OVERLAY_POSITION (ostart);
2728 if (end < startpos)
2730 if (startpos < next)
2731 next = startpos;
2732 break;
2734 endpos = OVERLAY_POSITION (oend);
2735 /* Count an interval if it overlaps the range, is empty at the
2736 start of the range, or is empty at END provided END denotes the
2737 end of the buffer. */
2738 if ((beg < endpos && startpos < end)
2739 || (startpos == endpos
2740 && (beg == endpos || (end_is_Z && endpos == end))))
2742 if (idx == len)
2744 if (extend)
2746 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2747 sizeof *vec);
2748 *vec_ptr = vec;
2749 len = *len_ptr;
2751 else
2752 inhibit_storing = 1;
2755 if (!inhibit_storing)
2756 vec[idx] = overlay;
2757 idx++;
2759 else if (endpos < beg && endpos > prev)
2760 prev = endpos;
2763 if (next_ptr)
2764 *next_ptr = next;
2765 if (prev_ptr)
2766 *prev_ptr = prev;
2767 return idx;
2771 /* Return non-zero if there exists an overlay with a non-nil
2772 `mouse-face' property overlapping OVERLAY. */
2775 mouse_face_overlay_overlaps (Lisp_Object overlay)
2777 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2778 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
2779 ptrdiff_t n, i, size;
2780 Lisp_Object *v, tem;
2782 size = 10;
2783 v = (Lisp_Object *) alloca (size * sizeof *v);
2784 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2785 if (n > size)
2787 v = (Lisp_Object *) alloca (n * sizeof *v);
2788 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2791 for (i = 0; i < n; ++i)
2792 if (!EQ (v[i], overlay)
2793 && (tem = Foverlay_get (overlay, Qmouse_face),
2794 !NILP (tem)))
2795 break;
2797 return i < n;
2802 /* Fast function to just test if we're at an overlay boundary. */
2804 overlay_touches_p (EMACS_INT pos)
2806 Lisp_Object overlay;
2807 struct Lisp_Overlay *tail;
2809 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2811 EMACS_INT endpos;
2813 XSETMISC (overlay ,tail);
2814 if (!OVERLAYP (overlay))
2815 abort ();
2817 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2818 if (endpos < pos)
2819 break;
2820 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2821 return 1;
2824 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2826 EMACS_INT startpos;
2828 XSETMISC (overlay, tail);
2829 if (!OVERLAYP (overlay))
2830 abort ();
2832 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2833 if (pos < startpos)
2834 break;
2835 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2836 return 1;
2838 return 0;
2841 struct sortvec
2843 Lisp_Object overlay;
2844 EMACS_INT beg, end;
2845 EMACS_INT priority;
2848 static int
2849 compare_overlays (const void *v1, const void *v2)
2851 const struct sortvec *s1 = (const struct sortvec *) v1;
2852 const struct sortvec *s2 = (const struct sortvec *) v2;
2853 if (s1->priority != s2->priority)
2854 return s1->priority < s2->priority ? -1 : 1;
2855 if (s1->beg != s2->beg)
2856 return s1->beg < s2->beg ? -1 : 1;
2857 if (s1->end != s2->end)
2858 return s2->end < s1->end ? -1 : 1;
2859 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
2860 between "equal" overlays. The result can still change between
2861 invocations of Emacs, but it won't change in the middle of
2862 `find_field' (bug#6830). */
2863 if (XHASH (s1->overlay) != XHASH (s2->overlay))
2864 return XHASH (s1->overlay) < XHASH (s2->overlay) ? -1 : 1;
2865 return 0;
2868 /* Sort an array of overlays by priority. The array is modified in place.
2869 The return value is the new size; this may be smaller than the original
2870 size if some of the overlays were invalid or were window-specific. */
2871 ptrdiff_t
2872 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2874 ptrdiff_t i, j;
2875 struct sortvec *sortvec;
2876 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2878 /* Put the valid and relevant overlays into sortvec. */
2880 for (i = 0, j = 0; i < noverlays; i++)
2882 Lisp_Object tem;
2883 Lisp_Object overlay;
2885 overlay = overlay_vec[i];
2886 if (OVERLAY_VALID (overlay)
2887 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2888 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2890 /* If we're interested in a specific window, then ignore
2891 overlays that are limited to some other window. */
2892 if (w)
2894 Lisp_Object window;
2896 window = Foverlay_get (overlay, Qwindow);
2897 if (WINDOWP (window) && XWINDOW (window) != w)
2898 continue;
2901 /* This overlay is good and counts: put it into sortvec. */
2902 sortvec[j].overlay = overlay;
2903 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2904 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2905 tem = Foverlay_get (overlay, Qpriority);
2906 if (INTEGERP (tem))
2907 sortvec[j].priority = XINT (tem);
2908 else
2909 sortvec[j].priority = 0;
2910 j++;
2913 noverlays = j;
2915 /* Sort the overlays into the proper order: increasing priority. */
2917 if (noverlays > 1)
2918 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2920 for (i = 0; i < noverlays; i++)
2921 overlay_vec[i] = sortvec[i].overlay;
2922 return (noverlays);
2925 struct sortstr
2927 Lisp_Object string, string2;
2928 ptrdiff_t size;
2929 EMACS_INT priority;
2932 struct sortstrlist
2934 struct sortstr *buf; /* An array that expands as needed; never freed. */
2935 ptrdiff_t size; /* Allocated length of that array. */
2936 ptrdiff_t used; /* How much of the array is currently in use. */
2937 ptrdiff_t bytes; /* Total length of the strings in buf. */
2940 /* Buffers for storing information about the overlays touching a given
2941 position. These could be automatic variables in overlay_strings, but
2942 it's more efficient to hold onto the memory instead of repeatedly
2943 allocating and freeing it. */
2944 static struct sortstrlist overlay_heads, overlay_tails;
2945 static unsigned char *overlay_str_buf;
2947 /* Allocated length of overlay_str_buf. */
2948 static ptrdiff_t overlay_str_len;
2950 /* A comparison function suitable for passing to qsort. */
2951 static int
2952 cmp_for_strings (const void *as1, const void *as2)
2954 struct sortstr *s1 = (struct sortstr *)as1;
2955 struct sortstr *s2 = (struct sortstr *)as2;
2956 if (s1->size != s2->size)
2957 return s2->size < s1->size ? -1 : 1;
2958 if (s1->priority != s2->priority)
2959 return s1->priority < s2->priority ? -1 : 1;
2960 return 0;
2963 static void
2964 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2965 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2967 EMACS_INT nbytes;
2969 if (ssl->used == ssl->size)
2970 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
2971 ssl->buf[ssl->used].string = str;
2972 ssl->buf[ssl->used].string2 = str2;
2973 ssl->buf[ssl->used].size = size;
2974 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2975 ssl->used++;
2977 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2978 nbytes = SCHARS (str);
2979 else if (! STRING_MULTIBYTE (str))
2980 nbytes = count_size_as_multibyte (SDATA (str),
2981 SBYTES (str));
2982 else
2983 nbytes = SBYTES (str);
2985 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
2986 memory_full (SIZE_MAX);
2987 ssl->bytes += nbytes;
2989 if (STRINGP (str2))
2991 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2992 nbytes = SCHARS (str2);
2993 else if (! STRING_MULTIBYTE (str2))
2994 nbytes = count_size_as_multibyte (SDATA (str2),
2995 SBYTES (str2));
2996 else
2997 nbytes = SBYTES (str2);
2999 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
3000 memory_full (SIZE_MAX);
3001 ssl->bytes += nbytes;
3005 /* Return the concatenation of the strings associated with overlays that
3006 begin or end at POS, ignoring overlays that are specific to a window
3007 other than W. The strings are concatenated in the appropriate order:
3008 shorter overlays nest inside longer ones, and higher priority inside
3009 lower. Normally all of the after-strings come first, but zero-sized
3010 overlays have their after-strings ride along with the before-strings
3011 because it would look strange to print them inside-out.
3013 Returns the string length, and stores the contents indirectly through
3014 PSTR, if that variable is non-null. The string may be overwritten by
3015 subsequent calls. */
3017 EMACS_INT
3018 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3020 Lisp_Object overlay, window, str;
3021 struct Lisp_Overlay *ov;
3022 EMACS_INT startpos, endpos;
3023 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3025 overlay_heads.used = overlay_heads.bytes = 0;
3026 overlay_tails.used = overlay_tails.bytes = 0;
3027 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3029 XSETMISC (overlay, ov);
3030 eassert (OVERLAYP (overlay));
3032 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3033 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3034 if (endpos < pos)
3035 break;
3036 if (endpos != pos && startpos != pos)
3037 continue;
3038 window = Foverlay_get (overlay, Qwindow);
3039 if (WINDOWP (window) && XWINDOW (window) != w)
3040 continue;
3041 if (startpos == pos
3042 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3043 record_overlay_string (&overlay_heads, str,
3044 (startpos == endpos
3045 ? Foverlay_get (overlay, Qafter_string)
3046 : Qnil),
3047 Foverlay_get (overlay, Qpriority),
3048 endpos - startpos);
3049 else if (endpos == pos
3050 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3051 record_overlay_string (&overlay_tails, str, Qnil,
3052 Foverlay_get (overlay, Qpriority),
3053 endpos - startpos);
3055 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3057 XSETMISC (overlay, ov);
3058 eassert (OVERLAYP (overlay));
3060 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3061 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3062 if (startpos > pos)
3063 break;
3064 if (endpos != pos && startpos != pos)
3065 continue;
3066 window = Foverlay_get (overlay, Qwindow);
3067 if (WINDOWP (window) && XWINDOW (window) != w)
3068 continue;
3069 if (startpos == pos
3070 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3071 record_overlay_string (&overlay_heads, str,
3072 (startpos == endpos
3073 ? Foverlay_get (overlay, Qafter_string)
3074 : Qnil),
3075 Foverlay_get (overlay, Qpriority),
3076 endpos - startpos);
3077 else if (endpos == pos
3078 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3079 record_overlay_string (&overlay_tails, str, Qnil,
3080 Foverlay_get (overlay, Qpriority),
3081 endpos - startpos);
3083 if (overlay_tails.used > 1)
3084 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3085 cmp_for_strings);
3086 if (overlay_heads.used > 1)
3087 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3088 cmp_for_strings);
3089 if (overlay_heads.bytes || overlay_tails.bytes)
3091 Lisp_Object tem;
3092 EMACS_INT i;
3093 unsigned char *p;
3094 ptrdiff_t total;
3096 if (INT_ADD_OVERFLOW (overlay_heads.bytes, overlay_tails.bytes))
3097 memory_full (SIZE_MAX);
3098 total = overlay_heads.bytes + overlay_tails.bytes;
3099 if (total > overlay_str_len)
3100 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3101 total - overlay_str_len, -1, 1);
3103 p = overlay_str_buf;
3104 for (i = overlay_tails.used; --i >= 0;)
3106 EMACS_INT nbytes;
3107 tem = overlay_tails.buf[i].string;
3108 nbytes = copy_text (SDATA (tem), p,
3109 SBYTES (tem),
3110 STRING_MULTIBYTE (tem), multibyte);
3111 p += nbytes;
3113 for (i = 0; i < overlay_heads.used; ++i)
3115 EMACS_INT nbytes;
3116 tem = overlay_heads.buf[i].string;
3117 nbytes = copy_text (SDATA (tem), p,
3118 SBYTES (tem),
3119 STRING_MULTIBYTE (tem), multibyte);
3120 p += nbytes;
3121 tem = overlay_heads.buf[i].string2;
3122 if (STRINGP (tem))
3124 nbytes = copy_text (SDATA (tem), p,
3125 SBYTES (tem),
3126 STRING_MULTIBYTE (tem), multibyte);
3127 p += nbytes;
3130 if (p != overlay_str_buf + total)
3131 abort ();
3132 if (pstr)
3133 *pstr = overlay_str_buf;
3134 return total;
3136 return 0;
3139 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3141 void
3142 recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
3144 Lisp_Object overlay, beg, end;
3145 struct Lisp_Overlay *prev, *tail, *next;
3147 /* See if anything in overlays_before should move to overlays_after. */
3149 /* We don't strictly need prev in this loop; it should always be nil.
3150 But we use it for symmetry and in case that should cease to be true
3151 with some future change. */
3152 prev = NULL;
3153 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3155 next = tail->next;
3156 XSETMISC (overlay, tail);
3158 /* If the overlay is not valid, get rid of it. */
3159 if (!OVERLAY_VALID (overlay))
3160 #if 1
3161 abort ();
3162 #else
3164 /* Splice the cons cell TAIL out of overlays_before. */
3165 if (!NILP (prev))
3166 XCDR (prev) = next;
3167 else
3168 buf->overlays_before = next;
3169 tail = prev;
3170 continue;
3172 #endif
3174 beg = OVERLAY_START (overlay);
3175 end = OVERLAY_END (overlay);
3177 if (OVERLAY_POSITION (end) > pos)
3179 /* OVERLAY needs to be moved. */
3180 EMACS_INT where = OVERLAY_POSITION (beg);
3181 struct Lisp_Overlay *other, *other_prev;
3183 /* Splice the cons cell TAIL out of overlays_before. */
3184 if (prev)
3185 prev->next = next;
3186 else
3187 buf->overlays_before = next;
3189 /* Search thru overlays_after for where to put it. */
3190 other_prev = NULL;
3191 for (other = buf->overlays_after; other;
3192 other_prev = other, other = other->next)
3194 Lisp_Object otherbeg, otheroverlay;
3196 XSETMISC (otheroverlay, other);
3197 eassert (OVERLAY_VALID (otheroverlay));
3199 otherbeg = OVERLAY_START (otheroverlay);
3200 if (OVERLAY_POSITION (otherbeg) >= where)
3201 break;
3204 /* Add TAIL to overlays_after before OTHER. */
3205 tail->next = other;
3206 if (other_prev)
3207 other_prev->next = tail;
3208 else
3209 buf->overlays_after = tail;
3210 tail = prev;
3212 else
3213 /* We've reached the things that should stay in overlays_before.
3214 All the rest of overlays_before must end even earlier,
3215 so stop now. */
3216 break;
3219 /* See if anything in overlays_after should be in overlays_before. */
3220 prev = NULL;
3221 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3223 next = tail->next;
3224 XSETMISC (overlay, tail);
3226 /* If the overlay is not valid, get rid of it. */
3227 if (!OVERLAY_VALID (overlay))
3228 #if 1
3229 abort ();
3230 #else
3232 /* Splice the cons cell TAIL out of overlays_after. */
3233 if (!NILP (prev))
3234 XCDR (prev) = next;
3235 else
3236 buf->overlays_after = next;
3237 tail = prev;
3238 continue;
3240 #endif
3242 beg = OVERLAY_START (overlay);
3243 end = OVERLAY_END (overlay);
3245 /* Stop looking, when we know that nothing further
3246 can possibly end before POS. */
3247 if (OVERLAY_POSITION (beg) > pos)
3248 break;
3250 if (OVERLAY_POSITION (end) <= pos)
3252 /* OVERLAY needs to be moved. */
3253 EMACS_INT where = OVERLAY_POSITION (end);
3254 struct Lisp_Overlay *other, *other_prev;
3256 /* Splice the cons cell TAIL out of overlays_after. */
3257 if (prev)
3258 prev->next = next;
3259 else
3260 buf->overlays_after = next;
3262 /* Search thru overlays_before for where to put it. */
3263 other_prev = NULL;
3264 for (other = buf->overlays_before; other;
3265 other_prev = other, other = other->next)
3267 Lisp_Object otherend, otheroverlay;
3269 XSETMISC (otheroverlay, other);
3270 eassert (OVERLAY_VALID (otheroverlay));
3272 otherend = OVERLAY_END (otheroverlay);
3273 if (OVERLAY_POSITION (otherend) <= where)
3274 break;
3277 /* Add TAIL to overlays_before before OTHER. */
3278 tail->next = other;
3279 if (other_prev)
3280 other_prev->next = tail;
3281 else
3282 buf->overlays_before = tail;
3283 tail = prev;
3287 buf->overlay_center = pos;
3290 void
3291 adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
3293 /* After an insertion, the lists are still sorted properly,
3294 but we may need to update the value of the overlay center. */
3295 if (current_buffer->overlay_center >= pos)
3296 current_buffer->overlay_center += length;
3299 void
3300 adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
3302 if (current_buffer->overlay_center < pos)
3303 /* The deletion was to our right. No change needed; the before- and
3304 after-lists are still consistent. */
3306 else if (current_buffer->overlay_center > pos + length)
3307 /* The deletion was to our left. We need to adjust the center value
3308 to account for the change in position, but the lists are consistent
3309 given the new value. */
3310 current_buffer->overlay_center -= length;
3311 else
3312 /* We're right in the middle. There might be things on the after-list
3313 that now belong on the before-list. Recentering will move them,
3314 and also update the center point. */
3315 recenter_overlay_lists (current_buffer, pos);
3318 /* Fix up overlays that were garbled as a result of permuting markers
3319 in the range START through END. Any overlay with at least one
3320 endpoint in this range will need to be unlinked from the overlay
3321 list and reinserted in its proper place.
3322 Such an overlay might even have negative size at this point.
3323 If so, we'll make the overlay empty. */
3324 void
3325 fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
3327 Lisp_Object overlay;
3328 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3329 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3330 /* These are either nil, indicating that before_list or after_list
3331 should be assigned, or the cons cell the cdr of which should be
3332 assigned. */
3333 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3334 /* 'Parent', likewise, indicates a cons cell or
3335 current_buffer->overlays_before or overlays_after, depending
3336 which loop we're in. */
3337 struct Lisp_Overlay *tail, *parent;
3338 EMACS_INT startpos, endpos;
3340 /* This algorithm shifts links around instead of consing and GCing.
3341 The loop invariant is that before_list (resp. after_list) is a
3342 well-formed list except that its last element, the CDR of beforep
3343 (resp. afterp) if beforep (afterp) isn't nil or before_list
3344 (after_list) if it is, is still uninitialized. So it's not a bug
3345 that before_list isn't initialized, although it may look
3346 strange. */
3347 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3349 XSETMISC (overlay, tail);
3351 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3352 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3354 /* If the overlay is backwards, make it empty. */
3355 if (endpos < startpos)
3357 startpos = endpos;
3358 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3359 Qnil);
3362 if (endpos < start)
3363 break;
3365 if (endpos < end
3366 || (startpos >= start && startpos < end))
3368 /* Add it to the end of the wrong list. Later on,
3369 recenter_overlay_lists will move it to the right place. */
3370 if (endpos < current_buffer->overlay_center)
3372 if (!afterp)
3373 after_list = tail;
3374 else
3375 afterp->next = tail;
3376 afterp = tail;
3378 else
3380 if (!beforep)
3381 before_list = tail;
3382 else
3383 beforep->next = tail;
3384 beforep = tail;
3386 if (!parent)
3387 current_buffer->overlays_before = tail->next;
3388 else
3389 parent->next = tail->next;
3390 tail = tail->next;
3392 else
3393 parent = tail, tail = parent->next;
3395 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3397 XSETMISC (overlay, tail);
3399 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3400 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3402 /* If the overlay is backwards, make it empty. */
3403 if (endpos < startpos)
3405 startpos = endpos;
3406 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3407 Qnil);
3410 if (startpos >= end)
3411 break;
3413 if (startpos >= start
3414 || (endpos >= start && endpos < end))
3416 if (endpos < current_buffer->overlay_center)
3418 if (!afterp)
3419 after_list = tail;
3420 else
3421 afterp->next = tail;
3422 afterp = tail;
3424 else
3426 if (!beforep)
3427 before_list = tail;
3428 else
3429 beforep->next = tail;
3430 beforep = tail;
3432 if (!parent)
3433 current_buffer->overlays_after = tail->next;
3434 else
3435 parent->next = tail->next;
3436 tail = tail->next;
3438 else
3439 parent = tail, tail = parent->next;
3442 /* Splice the constructed (wrong) lists into the buffer's lists,
3443 and let the recenter function make it sane again. */
3444 if (beforep)
3446 beforep->next = current_buffer->overlays_before;
3447 current_buffer->overlays_before = before_list;
3449 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3451 if (afterp)
3453 afterp->next = current_buffer->overlays_after;
3454 current_buffer->overlays_after = after_list;
3456 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3459 /* We have two types of overlay: the one whose ending marker is
3460 after-insertion-marker (this is the usual case) and the one whose
3461 ending marker is before-insertion-marker. When `overlays_before'
3462 contains overlays of the latter type and the former type in this
3463 order and both overlays end at inserting position, inserting a text
3464 increases only the ending marker of the latter type, which results
3465 in incorrect ordering of `overlays_before'.
3467 This function fixes ordering of overlays in the slot
3468 `overlays_before' of the buffer *BP. Before the insertion, `point'
3469 was at PREV, and now is at POS. */
3471 void
3472 fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3474 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3475 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3476 Lisp_Object tem;
3477 EMACS_INT end IF_LINT (= 0);
3479 /* After the insertion, the several overlays may be in incorrect
3480 order. The possibility is that, in the list `overlays_before',
3481 an overlay which ends at POS appears after an overlay which ends
3482 at PREV. Since POS is greater than PREV, we must fix the
3483 ordering of these overlays, by moving overlays ends at POS before
3484 the overlays ends at PREV. */
3486 /* At first, find a place where disordered overlays should be linked
3487 in. It is where an overlay which end before POS exists. (i.e. an
3488 overlay whose ending marker is after-insertion-marker if disorder
3489 exists). */
3490 while (tail
3491 && (XSETMISC (tem, tail),
3492 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3494 parent = tail;
3495 tail = tail->next;
3498 /* If we don't find such an overlay,
3499 or the found one ends before PREV,
3500 or the found one is the last one in the list,
3501 we don't have to fix anything. */
3502 if (!tail || end < prev || !tail->next)
3503 return;
3505 right_pair = parent;
3506 parent = tail;
3507 tail = tail->next;
3509 /* Now, end position of overlays in the list TAIL should be before
3510 or equal to PREV. In the loop, an overlay which ends at POS is
3511 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3512 we found an overlay which ends before PREV, the remaining
3513 overlays are in correct order. */
3514 while (tail)
3516 XSETMISC (tem, tail);
3517 end = OVERLAY_POSITION (OVERLAY_END (tem));
3519 if (end == pos)
3520 { /* This overlay is disordered. */
3521 struct Lisp_Overlay *found = tail;
3523 /* Unlink the found overlay. */
3524 tail = found->next;
3525 parent->next = tail;
3526 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3527 and link it into the right place. */
3528 if (!right_pair)
3530 found->next = bp->overlays_before;
3531 bp->overlays_before = found;
3533 else
3535 found->next = right_pair->next;
3536 right_pair->next = found;
3539 else if (end == prev)
3541 parent = tail;
3542 tail = tail->next;
3544 else /* No more disordered overlay. */
3545 break;
3549 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3550 doc: /* Return t if OBJECT is an overlay. */)
3551 (Lisp_Object object)
3553 return (OVERLAYP (object) ? Qt : Qnil);
3556 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3557 doc: /* Create a new overlay with range BEG to END in BUFFER.
3558 If omitted, BUFFER defaults to the current buffer.
3559 BEG and END may be integers or markers.
3560 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3561 for the front of the overlay advance when text is inserted there
3562 \(which means the text *is not* included in the overlay).
3563 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3564 for the rear of the overlay advance when text is inserted there
3565 \(which means the text *is* included in the overlay). */)
3566 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3568 Lisp_Object overlay;
3569 struct buffer *b;
3571 if (NILP (buffer))
3572 XSETBUFFER (buffer, current_buffer);
3573 else
3574 CHECK_BUFFER (buffer);
3575 if (MARKERP (beg)
3576 && ! EQ (Fmarker_buffer (beg), buffer))
3577 error ("Marker points into wrong buffer");
3578 if (MARKERP (end)
3579 && ! EQ (Fmarker_buffer (end), buffer))
3580 error ("Marker points into wrong buffer");
3582 CHECK_NUMBER_COERCE_MARKER (beg);
3583 CHECK_NUMBER_COERCE_MARKER (end);
3585 if (XINT (beg) > XINT (end))
3587 Lisp_Object temp;
3588 temp = beg; beg = end; end = temp;
3591 b = XBUFFER (buffer);
3593 beg = Fset_marker (Fmake_marker (), beg, buffer);
3594 end = Fset_marker (Fmake_marker (), end, buffer);
3596 if (!NILP (front_advance))
3597 XMARKER (beg)->insertion_type = 1;
3598 if (!NILP (rear_advance))
3599 XMARKER (end)->insertion_type = 1;
3601 overlay = allocate_misc ();
3602 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3603 XOVERLAY (overlay)->start = beg;
3604 XOVERLAY (overlay)->end = end;
3605 XOVERLAY (overlay)->plist = Qnil;
3606 XOVERLAY (overlay)->next = NULL;
3608 /* Put the new overlay on the wrong list. */
3609 end = OVERLAY_END (overlay);
3610 if (OVERLAY_POSITION (end) < b->overlay_center)
3612 if (b->overlays_after)
3613 XOVERLAY (overlay)->next = b->overlays_after;
3614 b->overlays_after = XOVERLAY (overlay);
3616 else
3618 if (b->overlays_before)
3619 XOVERLAY (overlay)->next = b->overlays_before;
3620 b->overlays_before = XOVERLAY (overlay);
3623 /* This puts it in the right list, and in the right order. */
3624 recenter_overlay_lists (b, b->overlay_center);
3626 /* We don't need to redisplay the region covered by the overlay, because
3627 the overlay has no properties at the moment. */
3629 return overlay;
3632 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3634 static void
3635 modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
3637 if (start > end)
3639 EMACS_INT temp = start;
3640 start = end;
3641 end = temp;
3644 BUF_COMPUTE_UNCHANGED (buf, start, end);
3646 /* If this is a buffer not in the selected window,
3647 we must do other windows. */
3648 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3649 windows_or_buffers_changed = 1;
3650 /* If multiple windows show this buffer, we must do other windows. */
3651 else if (buffer_shared > 1)
3652 windows_or_buffers_changed = 1;
3653 /* If we modify an overlay at the end of the buffer, we cannot
3654 be sure that window end is still valid. */
3655 else if (end >= ZV && start <= ZV)
3656 windows_or_buffers_changed = 1;
3658 ++BUF_OVERLAY_MODIFF (buf);
3662 static struct Lisp_Overlay *
3663 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3665 struct Lisp_Overlay *tmp, *prev;
3666 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3667 if (tmp == overlay)
3669 if (prev)
3670 prev->next = tmp->next;
3671 else
3672 list = tmp->next;
3673 overlay->next = NULL;
3674 break;
3676 return list;
3679 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3680 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3681 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3682 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3683 buffer. */)
3684 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3686 struct buffer *b, *ob;
3687 Lisp_Object obuffer;
3688 int count = SPECPDL_INDEX ();
3690 CHECK_OVERLAY (overlay);
3691 if (NILP (buffer))
3692 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3693 if (NILP (buffer))
3694 XSETBUFFER (buffer, current_buffer);
3695 CHECK_BUFFER (buffer);
3697 if (MARKERP (beg)
3698 && ! EQ (Fmarker_buffer (beg), buffer))
3699 error ("Marker points into wrong buffer");
3700 if (MARKERP (end)
3701 && ! EQ (Fmarker_buffer (end), buffer))
3702 error ("Marker points into wrong buffer");
3704 CHECK_NUMBER_COERCE_MARKER (beg);
3705 CHECK_NUMBER_COERCE_MARKER (end);
3707 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3708 return Fdelete_overlay (overlay);
3710 if (XINT (beg) > XINT (end))
3712 Lisp_Object temp;
3713 temp = beg; beg = end; end = temp;
3716 specbind (Qinhibit_quit, Qt);
3718 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3719 b = XBUFFER (buffer);
3720 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3722 /* If the overlay has changed buffers, do a thorough redisplay. */
3723 if (!EQ (buffer, obuffer))
3725 /* Redisplay where the overlay was. */
3726 if (!NILP (obuffer))
3728 EMACS_INT o_beg;
3729 EMACS_INT o_end;
3731 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3732 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3734 modify_overlay (ob, o_beg, o_end);
3737 /* Redisplay where the overlay is going to be. */
3738 modify_overlay (b, XINT (beg), XINT (end));
3740 else
3741 /* Redisplay the area the overlay has just left, or just enclosed. */
3743 EMACS_INT o_beg, o_end;
3745 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3746 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3748 if (o_beg == XINT (beg))
3749 modify_overlay (b, o_end, XINT (end));
3750 else if (o_end == XINT (end))
3751 modify_overlay (b, o_beg, XINT (beg));
3752 else
3754 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3755 if (XINT (end) > o_end) o_end = XINT (end);
3756 modify_overlay (b, o_beg, o_end);
3760 if (!NILP (obuffer))
3762 ob->overlays_before
3763 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3764 ob->overlays_after
3765 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3766 eassert (XOVERLAY (overlay)->next == NULL);
3769 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3770 Fset_marker (OVERLAY_END (overlay), end, buffer);
3772 /* Put the overlay on the wrong list. */
3773 end = OVERLAY_END (overlay);
3774 if (OVERLAY_POSITION (end) < b->overlay_center)
3776 XOVERLAY (overlay)->next = b->overlays_after;
3777 b->overlays_after = XOVERLAY (overlay);
3779 else
3781 XOVERLAY (overlay)->next = b->overlays_before;
3782 b->overlays_before = XOVERLAY (overlay);
3785 /* This puts it in the right list, and in the right order. */
3786 recenter_overlay_lists (b, b->overlay_center);
3788 return unbind_to (count, overlay);
3791 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3792 doc: /* Delete the overlay OVERLAY from its buffer. */)
3793 (Lisp_Object overlay)
3795 Lisp_Object buffer;
3796 struct buffer *b;
3797 int count = SPECPDL_INDEX ();
3799 CHECK_OVERLAY (overlay);
3801 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3802 if (NILP (buffer))
3803 return Qnil;
3805 b = XBUFFER (buffer);
3806 specbind (Qinhibit_quit, Qt);
3808 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3809 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3810 eassert (XOVERLAY (overlay)->next == NULL);
3811 modify_overlay (b,
3812 marker_position (OVERLAY_START (overlay)),
3813 marker_position (OVERLAY_END (overlay)));
3814 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3815 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3817 /* When deleting an overlay with before or after strings, turn off
3818 display optimizations for the affected buffer, on the basis that
3819 these strings may contain newlines. This is easier to do than to
3820 check for that situation during redisplay. */
3821 if (!windows_or_buffers_changed
3822 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3823 || !NILP (Foverlay_get (overlay, Qafter_string))))
3824 b->prevent_redisplay_optimizations_p = 1;
3826 return unbind_to (count, Qnil);
3829 /* Overlay dissection functions. */
3831 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3832 doc: /* Return the position at which OVERLAY starts. */)
3833 (Lisp_Object overlay)
3835 CHECK_OVERLAY (overlay);
3837 return (Fmarker_position (OVERLAY_START (overlay)));
3840 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3841 doc: /* Return the position at which OVERLAY ends. */)
3842 (Lisp_Object overlay)
3844 CHECK_OVERLAY (overlay);
3846 return (Fmarker_position (OVERLAY_END (overlay)));
3849 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3850 doc: /* Return the buffer OVERLAY belongs to.
3851 Return nil if OVERLAY has been deleted. */)
3852 (Lisp_Object overlay)
3854 CHECK_OVERLAY (overlay);
3856 return Fmarker_buffer (OVERLAY_START (overlay));
3859 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3860 doc: /* Return a list of the properties on OVERLAY.
3861 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3862 OVERLAY. */)
3863 (Lisp_Object overlay)
3865 CHECK_OVERLAY (overlay);
3867 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3871 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3872 doc: /* Return a list of the overlays that contain the character at POS. */)
3873 (Lisp_Object pos)
3875 ptrdiff_t len, noverlays;
3876 Lisp_Object *overlay_vec;
3877 Lisp_Object result;
3879 CHECK_NUMBER_COERCE_MARKER (pos);
3881 len = 10;
3882 /* We can't use alloca here because overlays_at can call xrealloc. */
3883 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3885 /* Put all the overlays we want in a vector in overlay_vec.
3886 Store the length in len. */
3887 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3888 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3890 /* Make a list of them all. */
3891 result = Flist (noverlays, overlay_vec);
3893 xfree (overlay_vec);
3894 return result;
3897 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3898 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3899 Overlap means that at least one character is contained within the overlay
3900 and also contained within the specified region.
3901 Empty overlays are included in the result if they are located at BEG,
3902 between BEG and END, or at END provided END denotes the position at the
3903 end of the buffer. */)
3904 (Lisp_Object beg, Lisp_Object end)
3906 ptrdiff_t len, noverlays;
3907 Lisp_Object *overlay_vec;
3908 Lisp_Object result;
3910 CHECK_NUMBER_COERCE_MARKER (beg);
3911 CHECK_NUMBER_COERCE_MARKER (end);
3913 len = 10;
3914 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3916 /* Put all the overlays we want in a vector in overlay_vec.
3917 Store the length in len. */
3918 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3919 NULL, NULL);
3921 /* Make a list of them all. */
3922 result = Flist (noverlays, overlay_vec);
3924 xfree (overlay_vec);
3925 return result;
3928 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3929 1, 1, 0,
3930 doc: /* Return the next position after POS where an overlay starts or ends.
3931 If there are no overlay boundaries from POS to (point-max),
3932 the value is (point-max). */)
3933 (Lisp_Object pos)
3935 ptrdiff_t i, len, noverlays;
3936 EMACS_INT endpos;
3937 Lisp_Object *overlay_vec;
3939 CHECK_NUMBER_COERCE_MARKER (pos);
3941 len = 10;
3942 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3944 /* Put all the overlays we want in a vector in overlay_vec.
3945 Store the length in len.
3946 endpos gets the position where the next overlay starts. */
3947 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3948 &endpos, (EMACS_INT *) 0, 1);
3950 /* If any of these overlays ends before endpos,
3951 use its ending point instead. */
3952 for (i = 0; i < noverlays; i++)
3954 Lisp_Object oend;
3955 EMACS_INT oendpos;
3957 oend = OVERLAY_END (overlay_vec[i]);
3958 oendpos = OVERLAY_POSITION (oend);
3959 if (oendpos < endpos)
3960 endpos = oendpos;
3963 xfree (overlay_vec);
3964 return make_number (endpos);
3967 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3968 Sprevious_overlay_change, 1, 1, 0,
3969 doc: /* Return the previous position before POS where an overlay starts or ends.
3970 If there are no overlay boundaries from (point-min) to POS,
3971 the value is (point-min). */)
3972 (Lisp_Object pos)
3974 EMACS_INT prevpos;
3975 Lisp_Object *overlay_vec;
3976 ptrdiff_t len;
3978 CHECK_NUMBER_COERCE_MARKER (pos);
3980 /* At beginning of buffer, we know the answer;
3981 avoid bug subtracting 1 below. */
3982 if (XINT (pos) == BEGV)
3983 return pos;
3985 len = 10;
3986 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3988 /* Put all the overlays we want in a vector in overlay_vec.
3989 Store the length in len.
3990 prevpos gets the position of the previous change. */
3991 overlays_at (XINT (pos), 1, &overlay_vec, &len,
3992 (EMACS_INT *) 0, &prevpos, 1);
3994 xfree (overlay_vec);
3995 return make_number (prevpos);
3998 /* These functions are for debugging overlays. */
4000 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4001 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4002 The car has all the overlays before the overlay center;
4003 the cdr has all the overlays after the overlay center.
4004 Recentering overlays moves overlays between these lists.
4005 The lists you get are copies, so that changing them has no effect.
4006 However, the overlays you get are the real objects that the buffer uses. */)
4007 (void)
4009 struct Lisp_Overlay *ol;
4010 Lisp_Object before = Qnil, after = Qnil, tmp;
4011 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4013 XSETMISC (tmp, ol);
4014 before = Fcons (tmp, before);
4016 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4018 XSETMISC (tmp, ol);
4019 after = Fcons (tmp, after);
4021 return Fcons (Fnreverse (before), Fnreverse (after));
4024 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4025 doc: /* Recenter the overlays of the current buffer around position POS.
4026 That makes overlay lookup faster for positions near POS (but perhaps slower
4027 for positions far away from POS). */)
4028 (Lisp_Object pos)
4030 CHECK_NUMBER_COERCE_MARKER (pos);
4032 recenter_overlay_lists (current_buffer, XINT (pos));
4033 return Qnil;
4036 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4037 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4038 (Lisp_Object overlay, Lisp_Object prop)
4040 CHECK_OVERLAY (overlay);
4041 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4044 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4045 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4046 VALUE will be returned.*/)
4047 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4049 Lisp_Object tail, buffer;
4050 int changed;
4052 CHECK_OVERLAY (overlay);
4054 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4056 for (tail = XOVERLAY (overlay)->plist;
4057 CONSP (tail) && CONSP (XCDR (tail));
4058 tail = XCDR (XCDR (tail)))
4059 if (EQ (XCAR (tail), prop))
4061 changed = !EQ (XCAR (XCDR (tail)), value);
4062 XSETCAR (XCDR (tail), value);
4063 goto found;
4065 /* It wasn't in the list, so add it to the front. */
4066 changed = !NILP (value);
4067 XOVERLAY (overlay)->plist
4068 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4069 found:
4070 if (! NILP (buffer))
4072 if (changed)
4073 modify_overlay (XBUFFER (buffer),
4074 marker_position (OVERLAY_START (overlay)),
4075 marker_position (OVERLAY_END (overlay)));
4076 if (EQ (prop, Qevaporate) && ! NILP (value)
4077 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4078 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4079 Fdelete_overlay (overlay);
4082 return value;
4085 /* Subroutine of report_overlay_modification. */
4087 /* Lisp vector holding overlay hook functions to call.
4088 Vector elements come in pairs.
4089 Each even-index element is a list of hook functions.
4090 The following odd-index element is the overlay they came from.
4092 Before the buffer change, we fill in this vector
4093 as we call overlay hook functions.
4094 After the buffer change, we get the functions to call from this vector.
4095 This way we always call the same functions before and after the change. */
4096 static Lisp_Object last_overlay_modification_hooks;
4098 /* Number of elements actually used in last_overlay_modification_hooks. */
4099 static int last_overlay_modification_hooks_used;
4101 /* Add one functionlist/overlay pair
4102 to the end of last_overlay_modification_hooks. */
4104 static void
4105 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4107 int oldsize = ASIZE (last_overlay_modification_hooks);
4109 if (last_overlay_modification_hooks_used == oldsize)
4110 last_overlay_modification_hooks = larger_vector
4111 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4112 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4113 functionlist); last_overlay_modification_hooks_used++;
4114 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4115 overlay); last_overlay_modification_hooks_used++;
4118 /* Run the modification-hooks of overlays that include
4119 any part of the text in START to END.
4120 If this change is an insertion, also
4121 run the insert-before-hooks of overlay starting at END,
4122 and the insert-after-hooks of overlay ending at START.
4124 This is called both before and after the modification.
4125 AFTER is nonzero when we call after the modification.
4127 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4128 When AFTER is nonzero, they are the start position,
4129 the position after the inserted new text,
4130 and the length of deleted or replaced old text. */
4132 void
4133 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4134 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4136 Lisp_Object prop, overlay;
4137 struct Lisp_Overlay *tail;
4138 /* 1 if this change is an insertion. */
4139 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4140 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4142 overlay = Qnil;
4143 tail = NULL;
4145 /* We used to run the functions as soon as we found them and only register
4146 them in last_overlay_modification_hooks for the purpose of the `after'
4147 case. But running elisp code as we traverse the list of overlays is
4148 painful because the list can be modified by the elisp code so we had to
4149 copy at several places. We now simply do a read-only traversal that
4150 only collects the functions to run and we run them afterwards. It's
4151 simpler, especially since all the code was already there. -stef */
4153 if (!after)
4155 /* We are being called before a change.
4156 Scan the overlays to find the functions to call. */
4157 last_overlay_modification_hooks_used = 0;
4158 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4160 EMACS_INT startpos, endpos;
4161 Lisp_Object ostart, oend;
4163 XSETMISC (overlay, tail);
4165 ostart = OVERLAY_START (overlay);
4166 oend = OVERLAY_END (overlay);
4167 endpos = OVERLAY_POSITION (oend);
4168 if (XFASTINT (start) > endpos)
4169 break;
4170 startpos = OVERLAY_POSITION (ostart);
4171 if (insertion && (XFASTINT (start) == startpos
4172 || XFASTINT (end) == startpos))
4174 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4175 if (!NILP (prop))
4176 add_overlay_mod_hooklist (prop, overlay);
4178 if (insertion && (XFASTINT (start) == endpos
4179 || XFASTINT (end) == endpos))
4181 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4182 if (!NILP (prop))
4183 add_overlay_mod_hooklist (prop, overlay);
4185 /* Test for intersecting intervals. This does the right thing
4186 for both insertion and deletion. */
4187 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4189 prop = Foverlay_get (overlay, Qmodification_hooks);
4190 if (!NILP (prop))
4191 add_overlay_mod_hooklist (prop, overlay);
4195 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4197 EMACS_INT startpos, endpos;
4198 Lisp_Object ostart, oend;
4200 XSETMISC (overlay, tail);
4202 ostart = OVERLAY_START (overlay);
4203 oend = OVERLAY_END (overlay);
4204 startpos = OVERLAY_POSITION (ostart);
4205 endpos = OVERLAY_POSITION (oend);
4206 if (XFASTINT (end) < startpos)
4207 break;
4208 if (insertion && (XFASTINT (start) == startpos
4209 || XFASTINT (end) == startpos))
4211 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4212 if (!NILP (prop))
4213 add_overlay_mod_hooklist (prop, overlay);
4215 if (insertion && (XFASTINT (start) == endpos
4216 || XFASTINT (end) == endpos))
4218 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4219 if (!NILP (prop))
4220 add_overlay_mod_hooklist (prop, overlay);
4222 /* Test for intersecting intervals. This does the right thing
4223 for both insertion and deletion. */
4224 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4226 prop = Foverlay_get (overlay, Qmodification_hooks);
4227 if (!NILP (prop))
4228 add_overlay_mod_hooklist (prop, overlay);
4233 GCPRO4 (overlay, arg1, arg2, arg3);
4235 /* Call the functions recorded in last_overlay_modification_hooks.
4236 First copy the vector contents, in case some of these hooks
4237 do subsequent modification of the buffer. */
4238 int size = last_overlay_modification_hooks_used;
4239 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4240 int i;
4242 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4243 size * sizeof (Lisp_Object));
4244 gcpro1.var = copy;
4245 gcpro1.nvars = size;
4247 for (i = 0; i < size;)
4249 Lisp_Object prop_i, overlay_i;
4250 prop_i = copy[i++];
4251 overlay_i = copy[i++];
4252 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4255 UNGCPRO;
4258 static void
4259 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4260 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4262 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4264 GCPRO4 (list, arg1, arg2, arg3);
4266 while (CONSP (list))
4268 if (NILP (arg3))
4269 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4270 else
4271 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4272 list = XCDR (list);
4274 UNGCPRO;
4277 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4278 property is set. */
4279 void
4280 evaporate_overlays (EMACS_INT pos)
4282 Lisp_Object overlay, hit_list;
4283 struct Lisp_Overlay *tail;
4285 hit_list = Qnil;
4286 if (pos <= current_buffer->overlay_center)
4287 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4289 EMACS_INT endpos;
4290 XSETMISC (overlay, tail);
4291 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4292 if (endpos < pos)
4293 break;
4294 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4295 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4296 hit_list = Fcons (overlay, hit_list);
4298 else
4299 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4301 EMACS_INT startpos;
4302 XSETMISC (overlay, tail);
4303 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4304 if (startpos > pos)
4305 break;
4306 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4307 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4308 hit_list = Fcons (overlay, hit_list);
4310 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4311 Fdelete_overlay (XCAR (hit_list));
4314 /* Somebody has tried to store a value with an unacceptable type
4315 in the slot with offset OFFSET. */
4317 void
4318 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4320 Lisp_Object predicate;
4322 switch (type)
4324 case_Lisp_Int: predicate = Qintegerp; break;
4325 case Lisp_String: predicate = Qstringp; break;
4326 case Lisp_Symbol: predicate = Qsymbolp; break;
4327 default: abort ();
4330 wrong_type_argument (predicate, newval);
4334 /***********************************************************************
4335 Allocation with mmap
4336 ***********************************************************************/
4338 #ifdef USE_MMAP_FOR_BUFFERS
4340 #include <sys/types.h>
4341 #include <sys/mman.h>
4343 #ifndef MAP_ANON
4344 #ifdef MAP_ANONYMOUS
4345 #define MAP_ANON MAP_ANONYMOUS
4346 #else
4347 #define MAP_ANON 0
4348 #endif
4349 #endif
4351 #ifndef MAP_FAILED
4352 #define MAP_FAILED ((void *) -1)
4353 #endif
4355 #include <stdio.h>
4357 #if MAP_ANON == 0
4358 #include <fcntl.h>
4359 #endif
4361 #include "coding.h"
4364 /* Memory is allocated in regions which are mapped using mmap(2).
4365 The current implementation lets the system select mapped
4366 addresses; we're not using MAP_FIXED in general, except when
4367 trying to enlarge regions.
4369 Each mapped region starts with a mmap_region structure, the user
4370 area starts after that structure, aligned to MEM_ALIGN.
4372 +-----------------------+
4373 | struct mmap_info + |
4374 | padding |
4375 +-----------------------+
4376 | user data |
4379 +-----------------------+ */
4381 struct mmap_region
4383 /* User-specified size. */
4384 size_t nbytes_specified;
4386 /* Number of bytes mapped */
4387 size_t nbytes_mapped;
4389 /* Pointer to the location holding the address of the memory
4390 allocated with the mmap'd block. The variable actually points
4391 after this structure. */
4392 POINTER_TYPE **var;
4394 /* Next and previous in list of all mmap'd regions. */
4395 struct mmap_region *next, *prev;
4398 /* Doubly-linked list of mmap'd regions. */
4400 static struct mmap_region *mmap_regions;
4402 /* File descriptor for mmap. If we don't have anonymous mapping,
4403 /dev/zero will be opened on it. */
4405 static int mmap_fd;
4407 /* Temporary storage for mmap_set_vars, see there. */
4409 static struct mmap_region *mmap_regions_1;
4410 static int mmap_fd_1;
4412 /* Page size on this system. */
4414 static int mmap_page_size;
4416 /* 1 means mmap has been initialized. */
4418 static int mmap_initialized_p;
4420 /* Value is X rounded up to the next multiple of N. */
4422 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4424 /* Size of mmap_region structure plus padding. */
4426 #define MMAP_REGION_STRUCT_SIZE \
4427 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4429 /* Given a pointer P to the start of the user-visible part of a mapped
4430 region, return a pointer to the start of the region. */
4432 #define MMAP_REGION(P) \
4433 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4435 /* Given a pointer P to the start of a mapped region, return a pointer
4436 to the start of the user-visible part of the region. */
4438 #define MMAP_USER_AREA(P) \
4439 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4441 #define MEM_ALIGN sizeof (double)
4443 /* Predicate returning true if part of the address range [START .. END]
4444 is currently mapped. Used to prevent overwriting an existing
4445 memory mapping.
4447 Default is to conservatively assume the address range is occupied by
4448 something else. This can be overridden by system configuration
4449 files if system-specific means to determine this exists. */
4451 #ifndef MMAP_ALLOCATED_P
4452 #define MMAP_ALLOCATED_P(start, end) 1
4453 #endif
4455 /* Perform necessary initializations for the use of mmap. */
4457 static void
4458 mmap_init (void)
4460 #if MAP_ANON == 0
4461 /* The value of mmap_fd is initially 0 in temacs, and -1
4462 in a dumped Emacs. */
4463 if (mmap_fd <= 0)
4465 /* No anonymous mmap -- we need the file descriptor. */
4466 mmap_fd = open ("/dev/zero", O_RDONLY);
4467 if (mmap_fd == -1)
4468 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4470 #endif /* MAP_ANON == 0 */
4472 if (mmap_initialized_p)
4473 return;
4474 mmap_initialized_p = 1;
4476 #if MAP_ANON != 0
4477 mmap_fd = -1;
4478 #endif
4480 mmap_page_size = getpagesize ();
4483 /* Return a region overlapping address range START...END, or null if
4484 none. END is not including, i.e. the last byte in the range
4485 is at END - 1. */
4487 static struct mmap_region *
4488 mmap_find (POINTER_TYPE *start, POINTER_TYPE *end)
4490 struct mmap_region *r;
4491 char *s = (char *) start, *e = (char *) end;
4493 for (r = mmap_regions; r; r = r->next)
4495 char *rstart = (char *) r;
4496 char *rend = rstart + r->nbytes_mapped;
4498 if (/* First byte of range, i.e. START, in this region? */
4499 (s >= rstart && s < rend)
4500 /* Last byte of range, i.e. END - 1, in this region? */
4501 || (e > rstart && e <= rend)
4502 /* First byte of this region in the range? */
4503 || (rstart >= s && rstart < e)
4504 /* Last byte of this region in the range? */
4505 || (rend > s && rend <= e))
4506 break;
4509 return r;
4513 /* Unmap a region. P is a pointer to the start of the user-araa of
4514 the region. Value is non-zero if successful. */
4516 static int
4517 mmap_free_1 (struct mmap_region *r)
4519 if (r->next)
4520 r->next->prev = r->prev;
4521 if (r->prev)
4522 r->prev->next = r->next;
4523 else
4524 mmap_regions = r->next;
4526 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4528 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4529 return 0;
4532 return 1;
4536 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4537 Value is non-zero if successful. */
4539 static int
4540 mmap_enlarge (struct mmap_region *r, int npages)
4542 char *region_end = (char *) r + r->nbytes_mapped;
4543 size_t nbytes;
4544 int success = 0;
4546 if (npages < 0)
4548 /* Unmap pages at the end of the region. */
4549 nbytes = - npages * mmap_page_size;
4550 if (munmap (region_end - nbytes, nbytes) == -1)
4551 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4552 else
4554 r->nbytes_mapped -= nbytes;
4555 success = 1;
4558 else if (npages > 0)
4560 nbytes = npages * mmap_page_size;
4562 /* Try to map additional pages at the end of the region. We
4563 cannot do this if the address range is already occupied by
4564 something else because mmap deletes any previous mapping.
4565 I'm not sure this is worth doing, let's see. */
4566 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4568 POINTER_TYPE *p;
4570 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4571 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4572 if (p == MAP_FAILED)
4573 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4574 else if (p != (POINTER_TYPE *) region_end)
4576 /* Kernels are free to choose a different address. In
4577 that case, unmap what we've mapped above; we have
4578 no use for it. */
4579 if (munmap (p, nbytes) == -1)
4580 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4582 else
4584 r->nbytes_mapped += nbytes;
4585 success = 1;
4590 return success;
4594 /* Set or reset variables holding references to mapped regions. If
4595 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4596 non-zero, set all variables to the start of the user-areas
4597 of mapped regions.
4599 This function is called from Fdump_emacs to ensure that the dumped
4600 Emacs doesn't contain references to memory that won't be mapped
4601 when Emacs starts. */
4603 void
4604 mmap_set_vars (int restore_p)
4606 struct mmap_region *r;
4608 if (restore_p)
4610 mmap_regions = mmap_regions_1;
4611 mmap_fd = mmap_fd_1;
4612 for (r = mmap_regions; r; r = r->next)
4613 *r->var = MMAP_USER_AREA (r);
4615 else
4617 for (r = mmap_regions; r; r = r->next)
4618 *r->var = NULL;
4619 mmap_regions_1 = mmap_regions;
4620 mmap_regions = NULL;
4621 mmap_fd_1 = mmap_fd;
4622 mmap_fd = -1;
4627 /* Allocate a block of storage large enough to hold NBYTES bytes of
4628 data. A pointer to the data is returned in *VAR. VAR is thus the
4629 address of some variable which will use the data area.
4631 The allocation of 0 bytes is valid.
4633 If we can't allocate the necessary memory, set *VAR to null, and
4634 return null. */
4636 static POINTER_TYPE *
4637 mmap_alloc (POINTER_TYPE **var, size_t nbytes)
4639 void *p;
4640 size_t map;
4642 mmap_init ();
4644 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4645 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4646 mmap_fd, 0);
4648 if (p == MAP_FAILED)
4650 if (errno != ENOMEM)
4651 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4652 p = NULL;
4654 else
4656 struct mmap_region *r = (struct mmap_region *) p;
4658 r->nbytes_specified = nbytes;
4659 r->nbytes_mapped = map;
4660 r->var = var;
4661 r->prev = NULL;
4662 r->next = mmap_regions;
4663 if (r->next)
4664 r->next->prev = r;
4665 mmap_regions = r;
4667 p = MMAP_USER_AREA (p);
4670 return *var = p;
4674 /* Free a block of relocatable storage whose data is pointed to by
4675 PTR. Store 0 in *PTR to show there's no block allocated. */
4677 static void
4678 mmap_free (POINTER_TYPE **var)
4680 mmap_init ();
4682 if (*var)
4684 mmap_free_1 (MMAP_REGION (*var));
4685 *var = NULL;
4690 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4691 resize it to size NBYTES. Change *VAR to reflect the new block,
4692 and return this value. If more memory cannot be allocated, then
4693 leave *VAR unchanged, and return null. */
4695 static POINTER_TYPE *
4696 mmap_realloc (POINTER_TYPE **var, size_t nbytes)
4698 POINTER_TYPE *result;
4700 mmap_init ();
4702 if (*var == NULL)
4703 result = mmap_alloc (var, nbytes);
4704 else if (nbytes == 0)
4706 mmap_free (var);
4707 result = mmap_alloc (var, nbytes);
4709 else
4711 struct mmap_region *r = MMAP_REGION (*var);
4712 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4714 if (room < nbytes)
4716 /* Must enlarge. */
4717 POINTER_TYPE *old_ptr = *var;
4719 /* Try to map additional pages at the end of the region.
4720 If that fails, allocate a new region, copy data
4721 from the old region, then free it. */
4722 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4723 / mmap_page_size)))
4725 r->nbytes_specified = nbytes;
4726 *var = result = old_ptr;
4728 else if (mmap_alloc (var, nbytes))
4730 memcpy (*var, old_ptr, r->nbytes_specified);
4731 mmap_free_1 (MMAP_REGION (old_ptr));
4732 result = *var;
4733 r = MMAP_REGION (result);
4734 r->nbytes_specified = nbytes;
4736 else
4738 *var = old_ptr;
4739 result = NULL;
4742 else if (room - nbytes >= mmap_page_size)
4744 /* Shrinking by at least a page. Let's give some
4745 memory back to the system.
4747 The extra parens are to make the division happens first,
4748 on positive values, so we know it will round towards
4749 zero. */
4750 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4751 result = *var;
4752 r->nbytes_specified = nbytes;
4754 else
4756 /* Leave it alone. */
4757 result = *var;
4758 r->nbytes_specified = nbytes;
4762 return result;
4766 #endif /* USE_MMAP_FOR_BUFFERS */
4770 /***********************************************************************
4771 Buffer-text Allocation
4772 ***********************************************************************/
4774 #ifdef REL_ALLOC
4775 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4776 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4777 extern void r_alloc_free (POINTER_TYPE **ptr);
4778 #endif /* REL_ALLOC */
4781 /* Allocate NBYTES bytes for buffer B's text buffer. */
4783 static void
4784 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4786 POINTER_TYPE *p;
4788 BLOCK_INPUT;
4789 #if defined USE_MMAP_FOR_BUFFERS
4790 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4791 #elif defined REL_ALLOC
4792 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4793 #else
4794 p = xmalloc (nbytes);
4795 #endif
4797 if (p == NULL)
4799 UNBLOCK_INPUT;
4800 memory_full (nbytes);
4803 b->text->beg = (unsigned char *) p;
4804 UNBLOCK_INPUT;
4807 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4808 shrink it. */
4810 void
4811 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4813 POINTER_TYPE *p;
4814 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4815 + delta);
4816 BLOCK_INPUT;
4817 #if defined USE_MMAP_FOR_BUFFERS
4818 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4819 #elif defined REL_ALLOC
4820 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4821 #else
4822 p = xrealloc (b->text->beg, nbytes);
4823 #endif
4825 if (p == NULL)
4827 UNBLOCK_INPUT;
4828 memory_full (nbytes);
4831 BUF_BEG_ADDR (b) = (unsigned char *) p;
4832 UNBLOCK_INPUT;
4836 /* Free buffer B's text buffer. */
4838 static void
4839 free_buffer_text (struct buffer *b)
4841 BLOCK_INPUT;
4843 #if defined USE_MMAP_FOR_BUFFERS
4844 mmap_free ((POINTER_TYPE **) &b->text->beg);
4845 #elif defined REL_ALLOC
4846 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4847 #else
4848 xfree (b->text->beg);
4849 #endif
4851 BUF_BEG_ADDR (b) = NULL;
4852 UNBLOCK_INPUT;
4857 /***********************************************************************
4858 Initialization
4859 ***********************************************************************/
4861 void
4862 init_buffer_once (void)
4864 int idx;
4866 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4868 /* Make sure all markable slots in buffer_defaults
4869 are initialized reasonably, so mark_buffer won't choke. */
4870 reset_buffer (&buffer_defaults);
4871 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4872 reset_buffer_local_variables (&buffer_defaults, 1);
4873 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4874 reset_buffer (&buffer_local_symbols);
4875 reset_buffer_local_variables (&buffer_local_symbols, 1);
4876 /* Prevent GC from getting confused. */
4877 buffer_defaults.text = &buffer_defaults.own_text;
4878 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4879 BUF_INTERVALS (&buffer_defaults) = 0;
4880 BUF_INTERVALS (&buffer_local_symbols) = 0;
4881 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4882 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4883 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4884 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4886 /* Set up the default values of various buffer slots. */
4887 /* Must do these before making the first buffer! */
4889 /* real setup is done in bindings.el */
4890 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4891 BVAR (&buffer_defaults, header_line_format) = Qnil;
4892 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4893 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4894 BVAR (&buffer_defaults, case_fold_search) = Qt;
4895 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4896 BVAR (&buffer_defaults, selective_display) = Qnil;
4897 #ifndef old
4898 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4899 #endif
4900 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4901 BVAR (&buffer_defaults, display_table) = Qnil;
4902 BVAR (&buffer_defaults, undo_list) = Qnil;
4903 BVAR (&buffer_defaults, mark_active) = Qnil;
4904 BVAR (&buffer_defaults, file_format) = Qnil;
4905 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4906 buffer_defaults.overlays_before = NULL;
4907 buffer_defaults.overlays_after = NULL;
4908 buffer_defaults.overlay_center = BEG;
4910 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4911 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4912 BVAR (&buffer_defaults, word_wrap) = Qnil;
4913 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4914 BVAR (&buffer_defaults, bidi_display_reordering) = Qt;
4915 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4916 BVAR (&buffer_defaults, cursor_type) = Qt;
4917 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4918 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4920 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4921 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4922 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4923 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4924 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4925 BVAR (&buffer_defaults, file_truename) = Qnil;
4926 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4927 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4928 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4929 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4930 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4931 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4932 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4933 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4934 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4935 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4936 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4937 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4938 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4939 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4940 BVAR (&buffer_defaults, display_time) = Qnil;
4942 /* Assign the local-flags to the slots that have default values.
4943 The local flag is a bit that is used in the buffer
4944 to say that it has its own local value for the slot.
4945 The local flag bits are in the local_var_flags slot of the buffer. */
4947 /* Nothing can work if this isn't true */
4948 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4950 /* 0 means not a lisp var, -1 means always local, else mask */
4951 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4952 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4953 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4954 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4955 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4956 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4957 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4958 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4959 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4960 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4961 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4962 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4963 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4964 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4965 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4966 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4967 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4968 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4969 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4971 idx = 1;
4972 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4973 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4974 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4975 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
4976 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
4977 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
4978 #ifndef old
4979 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
4980 #endif
4981 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
4982 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
4983 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
4984 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
4985 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
4986 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
4987 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
4988 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
4989 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
4990 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
4991 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
4992 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
4993 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
4994 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
4995 /* Make this one a permanent local. */
4996 buffer_permanent_local_flags[idx++] = 1;
4997 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
4998 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5009 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5010 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5011 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5015 /* Need more room? */
5016 if (idx >= MAX_PER_BUFFER_VARS)
5017 abort ();
5018 last_per_buffer_idx = idx;
5020 Vbuffer_alist = Qnil;
5021 current_buffer = 0;
5022 all_buffers = 0;
5024 QSFundamental = make_pure_c_string ("Fundamental");
5026 Qfundamental_mode = intern_c_string ("fundamental-mode");
5027 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5029 Qmode_class = intern_c_string ("mode-class");
5031 Qprotected_field = intern_c_string ("protected-field");
5033 Qpermanent_local = intern_c_string ("permanent-local");
5035 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5036 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5038 /* super-magic invisible buffer */
5039 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5040 Vbuffer_alist = Qnil;
5042 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5044 inhibit_modification_hooks = 0;
5047 void
5048 init_buffer (void)
5050 char *pwd;
5051 Lisp_Object temp;
5052 ptrdiff_t len;
5054 #ifdef USE_MMAP_FOR_BUFFERS
5056 /* When using the ralloc implementation based on mmap(2), buffer
5057 text pointers will have been set to null in the dumped Emacs.
5058 Map new memory. */
5059 struct buffer *b;
5061 for (b = all_buffers; b; b = b->header.next.buffer)
5062 if (b->text->beg == NULL)
5063 enlarge_buffer_text (b, 0);
5065 #endif /* USE_MMAP_FOR_BUFFERS */
5067 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5068 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5069 Fset_buffer_multibyte (Qnil);
5071 pwd = get_current_dir_name ();
5073 if (!pwd)
5074 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5076 /* Maybe this should really use some standard subroutine
5077 whose definition is filename syntax dependent. */
5078 len = strlen (pwd);
5079 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5081 /* Grow buffer to add directory separator and '\0'. */
5082 pwd = (char *) realloc (pwd, len + 2);
5083 if (!pwd)
5084 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5085 pwd[len] = DIRECTORY_SEP;
5086 pwd[len + 1] = '\0';
5089 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5090 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5091 /* At this moment, we still don't know how to decode the
5092 directory name. So, we keep the bytes in multibyte form so
5093 that ENCODE_FILE correctly gets the original bytes. */
5094 BVAR (current_buffer, directory)
5095 = string_to_multibyte (BVAR (current_buffer, directory));
5097 /* Add /: to the front of the name
5098 if it would otherwise be treated as magic. */
5099 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5100 if (! NILP (temp)
5101 /* If the default dir is just /, TEMP is non-nil
5102 because of the ange-ftp completion handler.
5103 However, it is not necessary to turn / into /:/.
5104 So avoid doing that. */
5105 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5106 BVAR (current_buffer, directory)
5107 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5109 temp = get_minibuffer (0);
5110 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5112 free (pwd);
5115 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5116 Object stored in the current buffer. address is the address of the slot
5117 in the buffer that is current now. */
5119 /* TYPE is nil for a general Lisp variable.
5120 An integer specifies a type; then only Lisp values
5121 with that type code are allowed (except that nil is allowed too).
5122 LNAME is the Lisp-level variable name.
5123 VNAME is the name of the buffer slot.
5124 DOC is a dummy where you write the doc string as a comment. */
5125 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5126 do { \
5127 static struct Lisp_Buffer_Objfwd bo_fwd; \
5128 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5129 } while (0)
5131 static void
5132 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5133 Lisp_Object *address, Lisp_Object type)
5135 struct Lisp_Symbol *sym;
5136 int offset;
5138 sym = XSYMBOL (intern (namestring));
5139 offset = (char *)address - (char *)current_buffer;
5141 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5142 bo_fwd->offset = offset;
5143 bo_fwd->slottype = type;
5144 sym->declared_special = 1;
5145 sym->redirect = SYMBOL_FORWARDED;
5147 /* I tried to do the job without a cast, but it seems impossible.
5148 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5149 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5151 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5153 if (PER_BUFFER_IDX (offset) == 0)
5154 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5155 slot of buffer_local_flags */
5156 abort ();
5160 /* initialize the buffer routines */
5161 void
5162 syms_of_buffer (void)
5164 staticpro (&last_overlay_modification_hooks);
5165 last_overlay_modification_hooks
5166 = Fmake_vector (make_number (10), Qnil);
5168 staticpro (&Vbuffer_defaults);
5169 staticpro (&Vbuffer_local_symbols);
5170 staticpro (&Qfundamental_mode);
5171 staticpro (&Qmode_class);
5172 staticpro (&QSFundamental);
5173 staticpro (&Vbuffer_alist);
5174 staticpro (&Qprotected_field);
5175 staticpro (&Qpermanent_local);
5176 staticpro (&Qkill_buffer_hook);
5178 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5179 DEFSYM (Qoverlayp, "overlayp");
5180 DEFSYM (Qevaporate, "evaporate");
5181 DEFSYM (Qmodification_hooks, "modification-hooks");
5182 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5183 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5184 DEFSYM (Qget_file_buffer, "get-file-buffer");
5185 DEFSYM (Qpriority, "priority");
5186 DEFSYM (Qbefore_string, "before-string");
5187 DEFSYM (Qafter_string, "after-string");
5188 DEFSYM (Qfirst_change_hook, "first-change-hook");
5189 DEFSYM (Qbefore_change_functions, "before-change-functions");
5190 DEFSYM (Qafter_change_functions, "after-change-functions");
5191 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5193 Fput (Qprotected_field, Qerror_conditions,
5194 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5195 Fput (Qprotected_field, Qerror_message,
5196 make_pure_c_string ("Attempt to modify a protected field"));
5198 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5199 mode_line_format,
5200 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5201 This is the same as (default-value 'mode-line-format). */);
5203 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5204 header_line_format,
5205 doc: /* Default value of `header-line-format' for buffers that don't override it.
5206 This is the same as (default-value 'header-line-format). */);
5208 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5209 doc: /* Default value of `cursor-type' for buffers that don't override it.
5210 This is the same as (default-value 'cursor-type). */);
5212 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5213 extra_line_spacing,
5214 doc: /* Default value of `line-spacing' for buffers that don't override it.
5215 This is the same as (default-value 'line-spacing). */);
5217 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5218 cursor_in_non_selected_windows,
5219 doc: /* Default value of `cursor-in-non-selected-windows'.
5220 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5222 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5223 abbrev_mode,
5224 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5225 This is the same as (default-value 'abbrev-mode). */);
5227 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5228 ctl_arrow,
5229 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5230 This is the same as (default-value 'ctl-arrow). */);
5232 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5233 enable_multibyte_characters,
5234 doc: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5235 This is the same as (default-value 'enable-multibyte-characters). */);
5237 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5238 buffer_file_coding_system,
5239 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5240 This is the same as (default-value 'buffer-file-coding-system). */);
5242 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5243 truncate_lines,
5244 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5245 This is the same as (default-value 'truncate-lines). */);
5247 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5248 fill_column,
5249 doc: /* Default value of `fill-column' for buffers that do not override it.
5250 This is the same as (default-value 'fill-column). */);
5252 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5253 left_margin,
5254 doc: /* Default value of `left-margin' for buffers that do not override it.
5255 This is the same as (default-value 'left-margin). */);
5257 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5258 tab_width,
5259 doc: /* Default value of `tab-width' for buffers that do not override it.
5260 This is the same as (default-value 'tab-width). */);
5262 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5263 case_fold_search,
5264 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5265 This is the same as (default-value 'case-fold-search). */);
5267 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5268 left_margin_cols,
5269 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5270 This is the same as (default-value 'left-margin-width). */);
5272 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5273 right_margin_cols,
5274 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5275 This is the same as (default-value 'right-margin-width). */);
5277 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5278 left_fringe_width,
5279 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5280 This is the same as (default-value 'left-fringe-width). */);
5282 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5283 right_fringe_width,
5284 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5285 This is the same as (default-value 'right-fringe-width). */);
5287 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5288 fringes_outside_margins,
5289 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5290 This is the same as (default-value 'fringes-outside-margins). */);
5292 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5293 scroll_bar_width,
5294 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5295 This is the same as (default-value 'scroll-bar-width). */);
5297 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5298 vertical_scroll_bar_type,
5299 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5300 This is the same as (default-value 'vertical-scroll-bar). */);
5302 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5303 indicate_empty_lines,
5304 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5305 This is the same as (default-value 'indicate-empty-lines). */);
5307 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5308 indicate_buffer_boundaries,
5309 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5310 This is the same as (default-value 'indicate-buffer-boundaries). */);
5312 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5313 fringe_indicator_alist,
5314 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5315 This is the same as (default-value 'fringe-indicator-alist'). */);
5317 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5318 fringe_cursor_alist,
5319 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5320 This is the same as (default-value 'fringe-cursor-alist'). */);
5322 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5323 scroll_up_aggressively,
5324 doc: /* Default value of `scroll-up-aggressively'.
5325 This value applies in buffers that don't have their own local values.
5326 This is the same as (default-value 'scroll-up-aggressively). */);
5328 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5329 scroll_down_aggressively,
5330 doc: /* Default value of `scroll-down-aggressively'.
5331 This value applies in buffers that don't have their own local values.
5332 This is the same as (default-value 'scroll-down-aggressively). */);
5334 DEFVAR_PER_BUFFER ("header-line-format",
5335 &BVAR (current_buffer, header_line_format),
5336 Qnil,
5337 doc: /* Analogous to `mode-line-format', but controls the header line.
5338 The header line appears, optionally, at the top of a window;
5339 the mode line appears at the bottom. */);
5341 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5342 Qnil,
5343 doc: /* Template for displaying mode line for current buffer.
5344 Each buffer has its own value of this variable.
5345 Value may be nil, a string, a symbol or a list or cons cell.
5346 A value of nil means don't display a mode line.
5347 For a symbol, its value is used (but it is ignored if t or nil).
5348 A string appearing directly as the value of a symbol is processed verbatim
5349 in that the %-constructs below are not recognized.
5350 Note that unless the symbol is marked as a `risky-local-variable', all
5351 properties in any strings, as well as all :eval and :propertize forms
5352 in the value of that symbol will be ignored.
5353 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5354 is used as a mode line element. Be careful--FORM should not load any files,
5355 because that can cause an infinite recursion.
5356 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5357 with the specified properties PROPS applied.
5358 For a list whose car is a symbol, the symbol's value is taken,
5359 and if that is non-nil, the cadr of the list is processed recursively.
5360 Otherwise, the caddr of the list (if there is one) is processed.
5361 For a list whose car is a string or list, each element is processed
5362 recursively and the results are effectively concatenated.
5363 For a list whose car is an integer, the cdr of the list is processed
5364 and padded (if the number is positive) or truncated (if negative)
5365 to the width specified by that number.
5366 A string is printed verbatim in the mode line except for %-constructs:
5367 (%-constructs are allowed when the string is the entire mode-line-format
5368 or when it is found in a cons-cell or a list)
5369 %b -- print buffer name. %f -- print visited file name.
5370 %F -- print frame name.
5371 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5372 %& is like %*, but ignore read-only-ness.
5373 % means buffer is read-only and * means it is modified.
5374 For a modified read-only buffer, %* gives % and %+ gives *.
5375 %s -- print process status. %l -- print the current line number.
5376 %c -- print the current column number (this makes editing slower).
5377 To make the column number update correctly in all cases,
5378 `column-number-mode' must be non-nil.
5379 %i -- print the size of the buffer.
5380 %I -- like %i, but use k, M, G, etc., to abbreviate.
5381 %p -- print percent of buffer above top of window, or Top, Bot or All.
5382 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5383 or print Bottom or All.
5384 %n -- print Narrow if appropriate.
5385 %t -- visited file is text or binary (if OS supports this distinction).
5386 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5387 %Z -- like %z, but including the end-of-line format.
5388 %e -- print error message about full memory.
5389 %@ -- print @ or hyphen. @ means that default-directory is on a
5390 remote machine.
5391 %[ -- print one [ for each recursive editing level. %] similar.
5392 %% -- print %. %- -- print infinitely many dashes.
5393 Decimal digits after the % specify field width to which to pad. */);
5395 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5396 doc: /* Value of `major-mode' for new buffers. */);
5398 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5399 make_number (Lisp_Symbol),
5400 doc: /* Symbol for current buffer's major mode.
5401 The default value (normally `fundamental-mode') affects new buffers.
5402 A value of nil means to use the current buffer's major mode, provided
5403 it is not marked as "special".
5405 When a mode is used by default, `find-file' switches to it before it
5406 reads the contents into the buffer and before it finishes setting up
5407 the buffer. Thus, the mode and its hooks should not expect certain
5408 variables such as `buffer-read-only' and `buffer-file-coding-system'
5409 to be set up. */);
5411 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5412 Qnil,
5413 doc: /* Pretty name of current buffer's major mode.
5414 Usually a string, but can use any of the constructs for `mode-line-format',
5415 which see.
5416 Format with `format-mode-line' to produce a string value. */);
5418 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5419 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5421 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5422 doc: /* Non-nil if Abbrev mode is enabled.
5423 Use the command `abbrev-mode' to change this variable. */);
5425 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5426 Qnil,
5427 doc: /* Non-nil if searches and matches should ignore case. */);
5429 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5430 make_number (LISP_INT_TAG),
5431 doc: /* Column beyond which automatic line-wrapping should happen.
5432 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5434 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5435 make_number (LISP_INT_TAG),
5436 doc: /* Column for the default `indent-line-function' to indent to.
5437 Linefeed indents to this column in Fundamental mode. */);
5439 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5440 make_number (LISP_INT_TAG),
5441 doc: /* Distance between tab stops (for display of tab characters), in columns.
5442 This should be an integer greater than zero. */);
5444 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5445 doc: /* Non-nil means display control chars with uparrow.
5446 A value of nil means use backslash and octal digits.
5447 This variable does not apply to characters whose display is specified
5448 in the current display table (if there is one). */);
5450 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5451 &BVAR (current_buffer, enable_multibyte_characters),
5452 Qnil,
5453 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5454 Otherwise they are regarded as unibyte. This affects the display,
5455 file I/O and the behavior of various editing commands.
5457 This variable is buffer-local but you cannot set it directly;
5458 use the function `set-buffer-multibyte' to change a buffer's representation.
5459 See also Info node `(elisp)Text Representations'. */);
5460 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5462 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5463 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5464 doc: /* Coding system to be used for encoding the buffer contents on saving.
5465 This variable applies to saving the buffer, and also to `write-region'
5466 and other functions that use `write-region'.
5467 It does not apply to sending output to subprocesses, however.
5469 If this is nil, the buffer is saved without any code conversion
5470 unless some coding system is specified in `file-coding-system-alist'
5471 for the buffer file.
5473 If the text to be saved cannot be encoded as specified by this variable,
5474 an alternative encoding is selected by `select-safe-coding-system', which see.
5476 The variable `coding-system-for-write', if non-nil, overrides this variable.
5478 This variable is never applied to a way of decoding a file while reading it. */);
5480 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5481 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5482 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5484 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5485 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5486 doc: /* If non-nil, forces directionality of text paragraphs in the buffer.
5488 If this is nil (the default), the direction of each paragraph is
5489 determined by the first strong directional character of its text.
5490 The values of `right-to-left' and `left-to-right' override that.
5491 Any other value is treated as nil.
5493 This variable has no effect unless the buffer's value of
5494 \`bidi-display-reordering' is non-nil. */);
5496 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5497 doc: /* Non-nil means do not display continuation lines.
5498 Instead, give each line of text just one screen line.
5500 Note that this is overridden by the variable
5501 `truncate-partial-width-windows' if that variable is non-nil
5502 and this buffer is not full-frame width.
5504 Minibuffers set this variable to nil. */);
5506 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5507 doc: /* Non-nil means to use word-wrapping for continuation lines.
5508 When word-wrapping is on, continuation lines are wrapped at the space
5509 or tab character nearest to the right window edge.
5510 If nil, continuation lines are wrapped at the right screen edge.
5512 This variable has no effect if long lines are truncated (see
5513 `truncate-lines' and `truncate-partial-width-windows'). If you use
5514 word-wrapping, you might want to reduce the value of
5515 `truncate-partial-width-windows', since wrapping can make text readable
5516 in narrower windows. */);
5518 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5519 make_number (Lisp_String),
5520 doc: /* Name of default directory of current buffer. Should end with slash.
5521 To interactively change the default directory, use command `cd'. */);
5523 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5524 Qnil,
5525 doc: /* Function called (if non-nil) to perform auto-fill.
5526 It is called after self-inserting any character specified in
5527 the `auto-fill-chars' table.
5528 NOTE: This variable is not a hook;
5529 its value may not be a list of functions. */);
5531 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5532 make_number (Lisp_String),
5533 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5535 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5536 make_number (Lisp_String),
5537 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5538 The truename of a file is calculated by `file-truename'
5539 and then abbreviated with `abbreviate-file-name'. */);
5541 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5542 &BVAR (current_buffer, auto_save_file_name),
5543 make_number (Lisp_String),
5544 doc: /* Name of file for auto-saving current buffer.
5545 If it is nil, that means don't auto-save this buffer. */);
5547 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5548 doc: /* Non-nil if this buffer is read-only. */);
5550 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5551 doc: /* Non-nil if this buffer's file has been backed up.
5552 Backing up is done before the first time the file is saved. */);
5554 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5555 make_number (LISP_INT_TAG),
5556 doc: /* Length of current buffer when last read in, saved or auto-saved.
5557 0 initially.
5558 -1 means auto-saving turned off until next real save.
5560 If you set this to -2, that means don't turn off auto-saving in this buffer
5561 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5562 you probably should set this to -2 in that buffer. */);
5564 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5565 Qnil,
5566 doc: /* Non-nil enables selective display.
5567 An integer N as value means display only lines
5568 that start with less than N columns of space.
5569 A value of t means that the character ^M makes itself and
5570 all the rest of the line invisible; also, when saving the buffer
5571 in a file, save the ^M as a newline. */);
5573 #ifndef old
5574 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5575 &BVAR (current_buffer, selective_display_ellipses),
5576 Qnil,
5577 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5578 #endif
5580 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5581 doc: /* Non-nil if self-insertion should replace existing text.
5582 The value should be one of `overwrite-mode-textual',
5583 `overwrite-mode-binary', or nil.
5584 If it is `overwrite-mode-textual', self-insertion still
5585 inserts at the end of a line, and inserts when point is before a tab,
5586 until the tab is filled in.
5587 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5589 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5590 Qnil,
5591 doc: /* Display table that controls display of the contents of current buffer.
5593 If this variable is nil, the value of `standard-display-table' is used.
5594 Each window can have its own, overriding display table, see
5595 `set-window-display-table' and `window-display-table'.
5597 The display table is a char-table created with `make-display-table'.
5598 A char-table is an array indexed by character codes. Normal array
5599 primitives `aref' and `aset' can be used to access elements of a char-table.
5601 Each of the char-table elements control how to display the corresponding
5602 text character: the element at index C in the table says how to display
5603 the character whose code is C. Each element should be a vector of
5604 characters or nil. The value nil means display the character in the
5605 default fashion; otherwise, the characters from the vector are delivered
5606 to the screen instead of the original character.
5608 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5609 to display a capital Y instead of each X character.
5611 In addition, a char-table has six extra slots to control the display of:
5613 the end of a truncated screen line (extra-slot 0, a single character);
5614 the end of a continued line (extra-slot 1, a single character);
5615 the escape character used to display character codes in octal
5616 (extra-slot 2, a single character);
5617 the character used as an arrow for control characters (extra-slot 3,
5618 a single character);
5619 the decoration indicating the presence of invisible lines (extra-slot 4,
5620 a vector of characters);
5621 the character used to draw the border between side-by-side windows
5622 (extra-slot 5, a single character).
5624 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5626 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5627 Qnil,
5628 doc: /* Width of left marginal area for display of a buffer.
5629 A value of nil means no marginal area. */);
5631 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5632 Qnil,
5633 doc: /* Width of right marginal area for display of a buffer.
5634 A value of nil means no marginal area. */);
5636 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5637 Qnil,
5638 doc: /* Width of this buffer's left fringe (in pixels).
5639 A value of 0 means no left fringe is shown in this buffer's window.
5640 A value of nil means to use the left fringe width from the window's frame. */);
5642 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5643 Qnil,
5644 doc: /* Width of this buffer's right fringe (in pixels).
5645 A value of 0 means no right fringe is shown in this buffer's window.
5646 A value of nil means to use the right fringe width from the window's frame. */);
5648 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5649 Qnil,
5650 doc: /* Non-nil means to display fringes outside display margins.
5651 A value of nil means to display fringes between margins and buffer text. */);
5653 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5654 Qnil,
5655 doc: /* Width of this buffer's scroll bars in pixels.
5656 A value of nil means to use the scroll bar width from the window's frame. */);
5658 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5659 Qnil,
5660 doc: /* Position of this buffer's vertical scroll bar.
5661 The value takes effect whenever you tell a window to display this buffer;
5662 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5664 A value of `left' or `right' means put the vertical scroll bar at that side
5665 of the window; a value of nil means don't show any vertical scroll bars.
5666 A value of t (the default) means do whatever the window's frame specifies. */);
5668 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5669 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5670 doc: /* Visually indicate empty lines after the buffer end.
5671 If non-nil, a bitmap is displayed in the left fringe of a window on
5672 window-systems. */);
5674 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5675 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5676 doc: /* Visually indicate buffer boundaries and scrolling.
5677 If non-nil, the first and last line of the buffer are marked in the fringe
5678 of a window on window-systems with angle bitmaps, or if the window can be
5679 scrolled, the top and bottom line of the window are marked with up and down
5680 arrow bitmaps.
5682 If value is a symbol `left' or `right', both angle and arrow bitmaps
5683 are displayed in the left or right fringe, resp. Any other value
5684 that doesn't look like an alist means display the angle bitmaps in
5685 the left fringe but no arrows.
5687 You can exercise more precise control by using an alist as the
5688 value. Each alist element (INDICATOR . POSITION) specifies
5689 where to show one of the indicators. INDICATOR is one of `top',
5690 `bottom', `up', `down', or t, which specifies the default position,
5691 and POSITION is one of `left', `right', or nil, meaning do not show
5692 this indicator.
5694 For example, ((top . left) (t . right)) places the top angle bitmap in
5695 left fringe, the bottom angle bitmap in right fringe, and both arrow
5696 bitmaps in right fringe. To show just the angle bitmaps in the left
5697 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5699 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5700 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5701 doc: /* Mapping from logical to physical fringe indicator bitmaps.
5702 The value is an alist where each element (INDICATOR . BITMAPS)
5703 specifies the fringe bitmaps used to display a specific logical
5704 fringe indicator.
5706 INDICATOR specifies the logical indicator type which is one of the
5707 following symbols: `truncation' , `continuation', `overlay-arrow',
5708 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5710 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5711 the actual bitmap shown in the left or right fringe for the logical
5712 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5713 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5714 are used only for the `bottom' and `top-bottom' indicators when the
5715 last (only) line has no final newline. BITMAPS may also be a single
5716 symbol which is used in both left and right fringes. */);
5718 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5719 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5720 doc: /* Mapping from logical to physical fringe cursor bitmaps.
5721 The value is an alist where each element (CURSOR . BITMAP)
5722 specifies the fringe bitmaps used to display a specific logical
5723 cursor type in the fringe.
5725 CURSOR specifies the logical cursor type which is one of the following
5726 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5727 one is used to show a hollow cursor on narrow lines display lines
5728 where the normal hollow cursor will not fit.
5730 BITMAP is the corresponding fringe bitmap shown for the logical
5731 cursor type. */);
5733 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5734 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5735 doc: /* How far to scroll windows upward.
5736 If you move point off the bottom, the window scrolls automatically.
5737 This variable controls how far it scrolls. The value nil, the default,
5738 means scroll to center point. A fraction means scroll to put point
5739 that fraction of the window's height from the bottom of the window.
5740 When the value is 0.0, point goes at the bottom line, which in the
5741 simple case that you moved off with C-f means scrolling just one line.
5742 1.0 means point goes at the top, so that in that simple case, the
5743 window scrolls by a full window height. Meaningful values are
5744 between 0.0 and 1.0, inclusive. */);
5746 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5747 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5748 doc: /* How far to scroll windows downward.
5749 If you move point off the top, the window scrolls automatically.
5750 This variable controls how far it scrolls. The value nil, the default,
5751 means scroll to center point. A fraction means scroll to put point
5752 that fraction of the window's height from the top of the window.
5753 When the value is 0.0, point goes at the top line, which in the
5754 simple case that you moved off with C-b means scrolling just one line.
5755 1.0 means point goes at the bottom, so that in that simple case, the
5756 window scrolls by a full window height. Meaningful values are
5757 between 0.0 and 1.0, inclusive. */);
5759 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5760 "Don't ask.");
5763 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5764 doc: /* List of functions to call before each text change.
5765 Two arguments are passed to each function: the positions of
5766 the beginning and end of the range of old text to be changed.
5767 \(For an insertion, the beginning and end are at the same place.)
5768 No information is given about the length of the text after the change.
5770 Buffer changes made while executing the `before-change-functions'
5771 don't call any before-change or after-change functions.
5772 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5774 If an unhandled error happens in running these functions,
5775 the variable's value remains nil. That prevents the error
5776 from happening repeatedly and making Emacs nonfunctional. */);
5777 Vbefore_change_functions = Qnil;
5779 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5780 doc: /* List of functions to call after each text change.
5781 Three arguments are passed to each function: the positions of
5782 the beginning and end of the range of changed text,
5783 and the length in bytes of the pre-change text replaced by that range.
5784 \(For an insertion, the pre-change length is zero;
5785 for a deletion, that length is the number of bytes deleted,
5786 and the post-change beginning and end are at the same place.)
5788 Buffer changes made while executing the `after-change-functions'
5789 don't call any before-change or after-change functions.
5790 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5792 If an unhandled error happens in running these functions,
5793 the variable's value remains nil. That prevents the error
5794 from happening repeatedly and making Emacs nonfunctional. */);
5795 Vafter_change_functions = Qnil;
5797 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5798 doc: /* A list of functions to call before changing a buffer which is unmodified.
5799 The functions are run using the `run-hooks' function. */);
5800 Vfirst_change_hook = Qnil;
5802 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5803 doc: /* List of undo entries in current buffer.
5804 Recent changes come first; older changes follow newer.
5806 An entry (BEG . END) represents an insertion which begins at
5807 position BEG and ends at position END.
5809 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5810 from (abs POSITION). If POSITION is positive, point was at the front
5811 of the text being deleted; if negative, point was at the end.
5813 An entry (t HIGH . LOW) indicates that the buffer previously had
5814 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5815 of the visited file's modification time, as of that time. If the
5816 modification time of the most recent save is different, this entry is
5817 obsolete.
5819 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5820 was modified between BEG and END. PROPERTY is the property name,
5821 and VALUE is the old value.
5823 An entry (apply FUN-NAME . ARGS) means undo the change with
5824 \(apply FUN-NAME ARGS).
5826 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5827 in the active region. BEG and END is the range affected by this entry
5828 and DELTA is the number of bytes added or deleted in that range by
5829 this change.
5831 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5832 was adjusted in position by the offset DISTANCE (an integer).
5834 An entry of the form POSITION indicates that point was at the buffer
5835 location given by the integer. Undoing an entry of this form places
5836 point at POSITION.
5838 Entries with value `nil' mark undo boundaries. The undo command treats
5839 the changes between two undo boundaries as a single step to be undone.
5841 If the value of the variable is t, undo information is not recorded. */);
5843 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5844 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5846 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5847 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5849 Normally, the line-motion functions work by scanning the buffer for
5850 newlines. Columnar operations (like `move-to-column' and
5851 `compute-motion') also work by scanning the buffer, summing character
5852 widths as they go. This works well for ordinary text, but if the
5853 buffer's lines are very long (say, more than 500 characters), these
5854 motion functions will take longer to execute. Emacs may also take
5855 longer to update the display.
5857 If `cache-long-line-scans' is non-nil, these motion functions cache the
5858 results of their scans, and consult the cache to avoid rescanning
5859 regions of the buffer until the text is modified. The caches are most
5860 beneficial when they prevent the most searching---that is, when the
5861 buffer contains long lines and large regions of characters with the
5862 same, fixed screen width.
5864 When `cache-long-line-scans' is non-nil, processing short lines will
5865 become slightly slower (because of the overhead of consulting the
5866 cache), and the caches will use memory roughly proportional to the
5867 number of newlines and characters whose screen width varies.
5869 The caches require no explicit maintenance; their accuracy is
5870 maintained internally by the Emacs primitives. Enabling or disabling
5871 the cache should not affect the behavior of any of the motion
5872 functions; it should only affect their performance. */);
5874 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5875 doc: /* Value of point before the last series of scroll operations, or nil. */);
5877 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5878 doc: /* List of formats to use when saving this buffer.
5879 Formats are defined by `format-alist'. This variable is
5880 set when a file is visited. */);
5882 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5883 &BVAR (current_buffer, auto_save_file_format), Qnil,
5884 doc: /* Format in which to write auto-save files.
5885 Should be a list of symbols naming formats that are defined in `format-alist'.
5886 If it is t, which is the default, auto-save files are written in the
5887 same format as a regular save would use. */);
5889 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5890 &BVAR (current_buffer, invisibility_spec), Qnil,
5891 doc: /* Invisibility spec of this buffer.
5892 The default is t, which means that text is invisible
5893 if it has a non-nil `invisible' property.
5894 If the value is a list, a text character is invisible if its `invisible'
5895 property is an element in that list (or is a list with members in common).
5896 If an element is a cons cell of the form (PROP . ELLIPSIS),
5897 then characters with property value PROP are invisible,
5898 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5900 DEFVAR_PER_BUFFER ("buffer-display-count",
5901 &BVAR (current_buffer, display_count), Qnil,
5902 doc: /* A number incremented each time this buffer is displayed in a window.
5903 The function `set-window-buffer' increments it. */);
5905 DEFVAR_PER_BUFFER ("buffer-display-time",
5906 &BVAR (current_buffer, display_time), Qnil,
5907 doc: /* Time stamp updated each time this buffer is displayed in a window.
5908 The function `set-window-buffer' updates this variable
5909 to the value obtained by calling `current-time'.
5910 If the buffer has never been shown in a window, the value is nil. */);
5912 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5913 doc: /* Non-nil if Transient Mark mode is enabled.
5914 See the command `transient-mark-mode' for a description of this minor mode.
5916 Non-nil also enables highlighting of the region whenever the mark is active.
5917 The variable `highlight-nonselected-windows' controls whether to highlight
5918 all windows or just the selected window.
5920 Lisp programs may give this variable certain special values:
5922 - A value of `lambda' enables Transient Mark mode temporarily.
5923 It is disabled again after any subsequent action that would
5924 normally deactivate the mark (e.g. buffer modification).
5926 - A value of (only . OLDVAL) enables Transient Mark mode
5927 temporarily. After any subsequent point motion command that is
5928 not shift-translated, or any other action that would normally
5929 deactivate the mark (e.g. buffer modification), the value of
5930 `transient-mark-mode' is set to OLDVAL. */);
5931 Vtransient_mark_mode = Qnil;
5933 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5934 doc: /* Non-nil means disregard read-only status of buffers or characters.
5935 If the value is t, disregard `buffer-read-only' and all `read-only'
5936 text properties. If the value is a list, disregard `buffer-read-only'
5937 and disregard a `read-only' text property if the property value
5938 is a member of the list. */);
5939 Vinhibit_read_only = Qnil;
5941 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5942 doc: /* Cursor to use when this buffer is in the selected window.
5943 Values are interpreted as follows:
5945 t use the cursor specified for the frame
5946 nil don't display a cursor
5947 box display a filled box cursor
5948 hollow display a hollow box cursor
5949 bar display a vertical bar cursor with default width
5950 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5951 hbar display a horizontal bar cursor with default height
5952 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5953 ANYTHING ELSE display a hollow box cursor
5955 When the buffer is displayed in a non-selected window, the
5956 cursor's appearance is instead controlled by the variable
5957 `cursor-in-non-selected-windows'. */);
5959 DEFVAR_PER_BUFFER ("line-spacing",
5960 &BVAR (current_buffer, extra_line_spacing), Qnil,
5961 doc: /* Additional space to put between lines when displaying a buffer.
5962 The space is measured in pixels, and put below lines on graphic displays,
5963 see `display-graphic-p'.
5964 If value is a floating point number, it specifies the spacing relative
5965 to the default frame line height. A value of nil means add no extra space. */);
5967 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
5968 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
5969 doc: /* Non-nil means show a cursor in non-selected windows.
5970 If nil, only shows a cursor in the selected window.
5971 If t, displays a cursor related to the usual cursor type
5972 \(a solid box becomes hollow, a bar becomes a narrower bar).
5973 You can also specify the cursor type as in the `cursor-type' variable.
5974 Use Custom to set this variable and update the display." */);
5976 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
5977 doc: /* List of functions called with no args to query before killing a buffer.
5978 The buffer being killed will be current while the functions are running.
5979 If any of them returns nil, the buffer is not killed. */);
5980 Vkill_buffer_query_functions = Qnil;
5982 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
5983 doc: /* Normal hook run before changing the major mode of a buffer.
5984 The function `kill-all-local-variables' runs this before doing anything else. */);
5985 Vchange_major_mode_hook = Qnil;
5986 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
5988 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
5989 doc: /* Hook run when the buffer list changes.
5990 Functions running this hook are `get-buffer-create',
5991 `make-indirect-buffer', `rename-buffer', `kill-buffer',
5992 and `bury-buffer-internal'. */);
5993 Vbuffer_list_update_hook = Qnil;
5994 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
5996 defsubr (&Sbuffer_live_p);
5997 defsubr (&Sbuffer_list);
5998 defsubr (&Sget_buffer);
5999 defsubr (&Sget_file_buffer);
6000 defsubr (&Sget_buffer_create);
6001 defsubr (&Smake_indirect_buffer);
6002 defsubr (&Sgenerate_new_buffer_name);
6003 defsubr (&Sbuffer_name);
6004 /*defsubr (&Sbuffer_number);*/
6005 defsubr (&Sbuffer_file_name);
6006 defsubr (&Sbuffer_base_buffer);
6007 defsubr (&Sbuffer_local_value);
6008 defsubr (&Sbuffer_local_variables);
6009 defsubr (&Sbuffer_modified_p);
6010 defsubr (&Sset_buffer_modified_p);
6011 defsubr (&Sbuffer_modified_tick);
6012 defsubr (&Sbuffer_chars_modified_tick);
6013 defsubr (&Srename_buffer);
6014 defsubr (&Sother_buffer);
6015 defsubr (&Sbuffer_enable_undo);
6016 defsubr (&Skill_buffer);
6017 defsubr (&Sbury_buffer_internal);
6018 defsubr (&Sset_buffer_major_mode);
6019 defsubr (&Scurrent_buffer);
6020 defsubr (&Sset_buffer);
6021 defsubr (&Sbarf_if_buffer_read_only);
6022 defsubr (&Serase_buffer);
6023 defsubr (&Sbuffer_swap_text);
6024 defsubr (&Sset_buffer_multibyte);
6025 defsubr (&Skill_all_local_variables);
6027 defsubr (&Soverlayp);
6028 defsubr (&Smake_overlay);
6029 defsubr (&Sdelete_overlay);
6030 defsubr (&Smove_overlay);
6031 defsubr (&Soverlay_start);
6032 defsubr (&Soverlay_end);
6033 defsubr (&Soverlay_buffer);
6034 defsubr (&Soverlay_properties);
6035 defsubr (&Soverlays_at);
6036 defsubr (&Soverlays_in);
6037 defsubr (&Snext_overlay_change);
6038 defsubr (&Sprevious_overlay_change);
6039 defsubr (&Soverlay_recenter);
6040 defsubr (&Soverlay_lists);
6041 defsubr (&Soverlay_get);
6042 defsubr (&Soverlay_put);
6043 defsubr (&Srestore_buffer_modified_p);
6046 void
6047 keys_of_buffer (void)
6049 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6050 initial_define_key (control_x_map, 'k', "kill-buffer");
6052 /* This must not be in syms_of_buffer, because Qdisabled is not
6053 initialized when that function gets called. */
6054 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);