gnus.el (gnus-valid-select-methods): Fix custom type
[emacs.git] / src / buffer.c
blob833eb8431683be489b0969fd010159773dbb1ca3
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 "character.h"
37 #include "buffer.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 struct buffer alignas (GCALIGNMENT) 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 struct buffer alignas (GCALIGNMENT) 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 void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
111 int after, Lisp_Object arg1,
112 Lisp_Object arg2, Lisp_Object arg3);
113 static void swap_out_buffer_local_variables (struct buffer *b);
114 static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
116 /* Alist of all buffer names vs the buffers. */
117 /* This used to be a variable, but is no longer,
118 to prevent lossage due to user rplac'ing this alist or its elements. */
119 Lisp_Object Vbuffer_alist;
121 static Lisp_Object Qkill_buffer_query_functions;
123 /* Hook run before changing a major mode. */
124 static Lisp_Object Qchange_major_mode_hook;
126 Lisp_Object Qfirst_change_hook;
127 Lisp_Object Qbefore_change_functions;
128 Lisp_Object Qafter_change_functions;
130 static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
131 static Lisp_Object Qpermanent_local_hook;
133 static Lisp_Object Qprotected_field;
135 static Lisp_Object QSFundamental; /* A string "Fundamental" */
137 static Lisp_Object Qkill_buffer_hook;
138 static Lisp_Object Qbuffer_list_update_hook;
140 static Lisp_Object Qget_file_buffer;
142 static Lisp_Object Qoverlayp;
144 Lisp_Object Qpriority, Qbefore_string, Qafter_string;
146 static Lisp_Object Qevaporate;
148 Lisp_Object Qmodification_hooks;
149 Lisp_Object Qinsert_in_front_hooks;
150 Lisp_Object Qinsert_behind_hooks;
152 static void alloc_buffer_text (struct buffer *, ptrdiff_t);
153 static void free_buffer_text (struct buffer *b);
154 static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
155 static void modify_overlay (struct buffer *, ptrdiff_t, ptrdiff_t);
156 static Lisp_Object buffer_lisp_local_variables (struct buffer *, int);
158 /* For debugging; temporary. See set_buffer_internal. */
159 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
161 void
162 nsberror (Lisp_Object spec)
164 if (STRINGP (spec))
165 error ("No buffer named %s", SDATA (spec));
166 error ("Invalid buffer argument");
169 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
170 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
171 Value is nil if OBJECT is not a buffer or if it has been killed. */)
172 (Lisp_Object object)
174 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
175 ? Qt : Qnil);
178 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
179 doc: /* Return a list of all existing live buffers.
180 If the optional arg FRAME is a frame, we return the buffer list in the
181 proper order for that frame: the buffers show in FRAME come first,
182 followed by the rest of the buffers. */)
183 (Lisp_Object frame)
185 Lisp_Object general;
186 general = Fmapcar (Qcdr, Vbuffer_alist);
188 if (FRAMEP (frame))
190 Lisp_Object framelist, prevlist, tail;
191 Lisp_Object args[3];
193 CHECK_FRAME (frame);
194 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
195 prevlist = Fnreverse (Fcopy_sequence
196 (XFRAME (frame)->buried_buffer_list));
198 /* Remove from GENERAL any buffer that duplicates one in
199 FRAMELIST or PREVLIST. */
200 tail = framelist;
201 while (CONSP (tail))
203 general = Fdelq (XCAR (tail), general);
204 tail = XCDR (tail);
206 tail = prevlist;
207 while (CONSP (tail))
209 general = Fdelq (XCAR (tail), general);
210 tail = XCDR (tail);
213 args[0] = framelist;
214 args[1] = general;
215 args[2] = prevlist;
216 return Fnconc (3, args);
218 else
219 return general;
222 /* Like Fassoc, but use Fstring_equal to compare
223 (which ignores text properties),
224 and don't ever QUIT. */
226 static Lisp_Object
227 assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
229 register Lisp_Object tail;
230 for (tail = list; CONSP (tail); tail = XCDR (tail))
232 register Lisp_Object elt, tem;
233 elt = XCAR (tail);
234 tem = Fstring_equal (Fcar (elt), key);
235 if (!NILP (tem))
236 return elt;
238 return Qnil;
241 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
242 doc: /* Return the buffer named BUFFER-OR-NAME.
243 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
244 is a string and there is no buffer with that name, return nil. If
245 BUFFER-OR-NAME is a buffer, return it as given. */)
246 (register Lisp_Object buffer_or_name)
248 if (BUFFERP (buffer_or_name))
249 return buffer_or_name;
250 CHECK_STRING (buffer_or_name);
252 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
255 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
256 doc: /* Return the buffer visiting file FILENAME (a string).
257 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
258 If there is no such live buffer, return nil.
259 See also `find-buffer-visiting'. */)
260 (register Lisp_Object filename)
262 register Lisp_Object tail, buf, tem;
263 Lisp_Object handler;
265 CHECK_STRING (filename);
266 filename = Fexpand_file_name (filename, Qnil);
268 /* If the file name has special constructs in it,
269 call the corresponding file handler. */
270 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
271 if (!NILP (handler))
273 Lisp_Object handled_buf = call2 (handler, Qget_file_buffer,
274 filename);
275 return BUFFERP (handled_buf) ? handled_buf : Qnil;
278 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
280 buf = Fcdr (XCAR (tail));
281 if (!BUFFERP (buf)) continue;
282 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
283 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
284 if (!NILP (tem))
285 return buf;
287 return Qnil;
290 Lisp_Object
291 get_truename_buffer (register Lisp_Object filename)
293 register Lisp_Object tail, buf, tem;
295 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
297 buf = Fcdr (XCAR (tail));
298 if (!BUFFERP (buf)) continue;
299 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
300 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
301 if (!NILP (tem))
302 return buf;
304 return Qnil;
307 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
308 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
309 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
310 return that buffer. If no such buffer exists, create a new buffer with
311 that name and return it. If BUFFER-OR-NAME starts with a space, the new
312 buffer does not keep undo information.
314 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
315 even if it is dead. The return value is never nil. */)
316 (register Lisp_Object buffer_or_name)
318 register Lisp_Object buffer, name;
319 register struct buffer *b;
321 buffer = Fget_buffer (buffer_or_name);
322 if (!NILP (buffer))
323 return buffer;
325 if (SCHARS (buffer_or_name) == 0)
326 error ("Empty string for buffer name is not allowed");
328 b = allocate_buffer ();
330 /* An ordinary buffer uses its own struct buffer_text. */
331 b->text = &b->own_text;
332 b->base_buffer = NULL;
333 /* No one shares the text with us now. */
334 b->indirections = 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;
396 /* Put this in the alist of all live buffers. */
397 XSETBUFFER (buffer, b);
398 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
399 /* And run buffer-list-update-hook. */
400 if (!NILP (Vrun_hooks))
401 call1 (Vrun_hooks, Qbuffer_list_update_hook);
403 return buffer;
407 /* Return a list of overlays which is a copy of the overlay list
408 LIST, but for buffer B. */
410 static struct Lisp_Overlay *
411 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
413 struct Lisp_Overlay *result = NULL, *tail = NULL;
415 for (; list; list = list->next)
417 Lisp_Object overlay, start, end;
418 struct Lisp_Marker *m;
420 eassert (MARKERP (list->start));
421 m = XMARKER (list->start);
422 start = build_marker (b, m->charpos, m->bytepos);
423 XMARKER (start)->insertion_type = m->insertion_type;
425 eassert (MARKERP (list->end));
426 m = XMARKER (list->end);
427 end = build_marker (b, m->charpos, m->bytepos);
428 XMARKER (end)->insertion_type = m->insertion_type;
430 overlay = build_overlay (start, end, Fcopy_sequence (list->plist));
431 if (tail)
432 tail = tail->next = XOVERLAY (overlay);
433 else
434 result = tail = XOVERLAY (overlay);
437 return result;
441 /* Clone per-buffer values of buffer FROM.
443 Buffer TO gets the same per-buffer values as FROM, with the
444 following exceptions: (1) TO's name is left untouched, (2) markers
445 are copied and made to refer to TO, and (3) overlay lists are
446 copied. */
448 static void
449 clone_per_buffer_values (struct buffer *from, struct buffer *to)
451 int offset;
453 FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
455 Lisp_Object obj;
457 /* Don't touch the `name' which should be unique for every buffer. */
458 if (offset == PER_BUFFER_VAR_OFFSET (name))
459 continue;
461 obj = PER_BUFFER_VALUE (from, offset);
462 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
464 struct Lisp_Marker *m = XMARKER (obj);
466 obj = build_marker (to, m->charpos, m->bytepos);
467 XMARKER (obj)->insertion_type = m->insertion_type;
470 PER_BUFFER_VALUE (to, offset) = obj;
473 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
475 to->overlays_before = copy_overlays (to, from->overlays_before);
476 to->overlays_after = copy_overlays (to, from->overlays_after);
478 /* Get (a copy of) the alist of Lisp-level local variables of FROM
479 and install that in TO. */
480 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from, 1);
484 /* If buffer B has markers to record PT, BEGV and ZV when it is not
485 current, update these markers. */
487 static void
488 record_buffer_markers (struct buffer *b)
490 if (! NILP (BVAR (b, pt_marker)))
492 Lisp_Object buffer;
494 eassert (!NILP (BVAR (b, begv_marker)));
495 eassert (!NILP (BVAR (b, zv_marker)));
497 XSETBUFFER (buffer, b);
498 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
499 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
500 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
505 /* If buffer B has markers to record PT, BEGV and ZV when it is not
506 current, fetch these values into B->begv etc. */
508 static void
509 fetch_buffer_markers (struct buffer *b)
511 if (! NILP (BVAR (b, pt_marker)))
513 Lisp_Object m;
515 eassert (!NILP (BVAR (b, begv_marker)));
516 eassert (!NILP (BVAR (b, zv_marker)));
518 m = BVAR (b, pt_marker);
519 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
521 m = BVAR (b, begv_marker);
522 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
524 m = BVAR (b, zv_marker);
525 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
530 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
531 2, 3,
532 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
533 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
534 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
535 NAME should be a string which is not the name of an existing buffer.
536 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
537 such as major and minor modes, in the indirect buffer.
538 CLONE nil means the indirect buffer's state is reset to default values. */)
539 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
541 Lisp_Object buf, tem;
542 struct buffer *b;
544 CHECK_STRING (name);
545 buf = Fget_buffer (name);
546 if (!NILP (buf))
547 error ("Buffer name `%s' is in use", SDATA (name));
549 tem = base_buffer;
550 base_buffer = Fget_buffer (base_buffer);
551 if (NILP (base_buffer))
552 error ("No such buffer: `%s'", SDATA (tem));
553 if (NILP (BVAR (XBUFFER (base_buffer), name)))
554 error ("Base buffer has been killed");
556 if (SCHARS (name) == 0)
557 error ("Empty string for buffer name is not allowed");
559 b = allocate_buffer ();
561 /* No double indirection - if base buffer is indirect,
562 new buffer becomes an indirect to base's base. */
563 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
564 ? XBUFFER (base_buffer)->base_buffer
565 : XBUFFER (base_buffer));
567 /* Use the base buffer's text object. */
568 b->text = b->base_buffer->text;
569 /* We have no own text. */
570 b->indirections = -1;
571 /* Notify base buffer that we share the text now. */
572 b->base_buffer->indirections++;
574 b->pt = b->base_buffer->pt;
575 b->begv = b->base_buffer->begv;
576 b->zv = b->base_buffer->zv;
577 b->pt_byte = b->base_buffer->pt_byte;
578 b->begv_byte = b->base_buffer->begv_byte;
579 b->zv_byte = b->base_buffer->zv_byte;
581 b->newline_cache = 0;
582 b->width_run_cache = 0;
583 BVAR (b, width_table) = Qnil;
585 /* Put this on the chain of all buffers including killed ones. */
586 b->header.next.buffer = all_buffers;
587 all_buffers = b;
589 name = Fcopy_sequence (name);
590 STRING_SET_INTERVALS (name, NULL_INTERVAL);
591 BVAR (b, name) = name;
593 reset_buffer (b);
594 reset_buffer_local_variables (b, 1);
596 /* Put this in the alist of all live buffers. */
597 XSETBUFFER (buf, b);
598 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
600 BVAR (b, mark) = Fmake_marker ();
602 /* The multibyte status belongs to the base buffer. */
603 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
605 /* Make sure the base buffer has markers for its narrowing. */
606 if (NILP (BVAR (b->base_buffer, pt_marker)))
608 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
609 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
611 BVAR (b->base_buffer, pt_marker)
612 = build_marker (b->base_buffer, b->base_buffer->pt, b->base_buffer->pt_byte);
614 BVAR (b->base_buffer, begv_marker)
615 = build_marker (b->base_buffer, b->base_buffer->begv, b->base_buffer->begv_byte);
617 BVAR (b->base_buffer, zv_marker)
618 = build_marker (b->base_buffer, b->base_buffer->zv, b->base_buffer->zv_byte);
620 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
623 if (NILP (clone))
625 /* Give the indirect buffer markers for its narrowing. */
626 BVAR (b, pt_marker) = build_marker (b, b->pt, b->pt_byte);
627 BVAR (b, begv_marker) = build_marker (b, b->begv, b->begv_byte);
628 BVAR (b, zv_marker) = build_marker (b, b->zv, b->zv_byte);
629 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
631 else
633 struct buffer *old_b = current_buffer;
635 clone_per_buffer_values (b->base_buffer, b);
636 BVAR (b, filename) = Qnil;
637 BVAR (b, file_truename) = Qnil;
638 BVAR (b, display_count) = make_number (0);
639 BVAR (b, backed_up) = Qnil;
640 BVAR (b, auto_save_file_name) = Qnil;
641 set_buffer_internal_1 (b);
642 Fset (intern ("buffer-save-without-query"), Qnil);
643 Fset (intern ("buffer-file-number"), Qnil);
644 Fset (intern ("buffer-stale-function"), Qnil);
645 set_buffer_internal_1 (old_b);
648 /* Run buffer-list-update-hook. */
649 if (!NILP (Vrun_hooks))
650 call1 (Vrun_hooks, Qbuffer_list_update_hook);
652 return buf;
655 /* Mark OV as no longer associated with B. */
657 static void
658 drop_overlay (struct buffer *b, struct Lisp_Overlay *ov)
660 eassert (b == XBUFFER (Fmarker_buffer (ov->start)));
661 modify_overlay (b, marker_position (ov->start), marker_position (ov->end));
662 Fset_marker (ov->start, Qnil, Qnil);
663 Fset_marker (ov->end, Qnil, Qnil);
667 /* Delete all overlays of B and reset it's overlay lists. */
669 void
670 delete_all_overlays (struct buffer *b)
672 struct Lisp_Overlay *ov, *next;
674 for (ov = b->overlays_before; ov; ov = next)
676 drop_overlay (b, ov);
677 next = ov->next;
678 ov->next = NULL;
681 for (ov = b->overlays_after; ov; ov = next)
683 drop_overlay (b, ov);
684 next = ov->next;
685 ov->next = NULL;
688 b->overlays_before = b->overlays_after = NULL;
691 /* Reinitialize everything about a buffer except its name and contents
692 and local variables.
693 If called on an already-initialized buffer, the list of overlays
694 should be deleted before calling this function, otherwise we end up
695 with overlays that claim to belong to the buffer but the buffer
696 claims it doesn't belong to it. */
698 void
699 reset_buffer (register struct buffer *b)
701 BVAR (b, filename) = Qnil;
702 BVAR (b, file_truename) = Qnil;
703 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
704 b->modtime = make_emacs_time (0, UNKNOWN_MODTIME_NSECS);
705 b->modtime_size = -1;
706 XSETFASTINT (BVAR (b, save_length), 0);
707 b->last_window_start = 1;
708 /* It is more conservative to start out "changed" than "unchanged". */
709 b->clip_changed = 0;
710 b->prevent_redisplay_optimizations_p = 1;
711 BVAR (b, backed_up) = Qnil;
712 BUF_AUTOSAVE_MODIFF (b) = 0;
713 b->auto_save_failure_time = 0;
714 BVAR (b, auto_save_file_name) = Qnil;
715 BVAR (b, read_only) = Qnil;
716 b->overlays_before = NULL;
717 b->overlays_after = NULL;
718 b->overlay_center = BEG;
719 BVAR (b, mark_active) = Qnil;
720 BVAR (b, point_before_scroll) = Qnil;
721 BVAR (b, file_format) = Qnil;
722 BVAR (b, auto_save_file_format) = Qt;
723 BVAR (b, last_selected_window) = Qnil;
724 XSETINT (BVAR (b, display_count), 0);
725 BVAR (b, display_time) = Qnil;
726 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
727 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
728 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
730 b->display_error_modiff = 0;
733 /* Reset buffer B's local variables info.
734 Don't use this on a buffer that has already been in use;
735 it does not treat permanent locals consistently.
736 Instead, use Fkill_all_local_variables.
738 If PERMANENT_TOO is 1, then we reset permanent
739 buffer-local variables. If PERMANENT_TOO is 0,
740 we preserve those. */
742 static void
743 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
745 register int offset;
746 int i;
748 /* Reset the major mode to Fundamental, together with all the
749 things that depend on the major mode.
750 default-major-mode is handled at a higher level.
751 We ignore it here. */
752 BVAR (b, major_mode) = Qfundamental_mode;
753 BVAR (b, keymap) = Qnil;
754 BVAR (b, mode_name) = QSFundamental;
755 BVAR (b, minor_modes) = Qnil;
757 /* If the standard case table has been altered and invalidated,
758 fix up its insides first. */
759 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
760 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
761 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
762 Fset_standard_case_table (Vascii_downcase_table);
764 BVAR (b, downcase_table) = Vascii_downcase_table;
765 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
766 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
767 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
768 BVAR (b, invisibility_spec) = Qt;
770 /* Reset all (or most) per-buffer variables to their defaults. */
771 if (permanent_too)
772 BVAR (b, local_var_alist) = Qnil;
773 else
775 Lisp_Object tmp, prop, last = Qnil;
776 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
777 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
779 /* If permanent-local, keep it. */
780 last = tmp;
781 if (EQ (prop, Qpermanent_local_hook))
783 /* This is a partially permanent hook variable.
784 Preserve only the elements that want to be preserved. */
785 Lisp_Object list, newlist;
786 list = XCDR (XCAR (tmp));
787 if (!CONSP (list))
788 newlist = list;
789 else
790 for (newlist = Qnil; CONSP (list); list = XCDR (list))
792 Lisp_Object elt = XCAR (list);
793 /* Preserve element ELT if it's t,
794 if it is a function with a `permanent-local-hook' property,
795 or if it's not a symbol. */
796 if (! SYMBOLP (elt)
797 || EQ (elt, Qt)
798 || !NILP (Fget (elt, Qpermanent_local_hook)))
799 newlist = Fcons (elt, newlist);
801 XSETCDR (XCAR (tmp), Fnreverse (newlist));
804 /* Delete this local variable. */
805 else if (NILP (last))
806 BVAR (b, local_var_alist) = XCDR (tmp);
807 else
808 XSETCDR (last, XCDR (tmp));
811 for (i = 0; i < last_per_buffer_idx; ++i)
812 if (permanent_too || buffer_permanent_local_flags[i] == 0)
813 SET_PER_BUFFER_VALUE_P (b, i, 0);
815 /* For each slot that has a default value, copy that into the slot. */
816 FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
818 int idx = PER_BUFFER_IDX (offset);
819 if ((idx > 0
820 && (permanent_too
821 || buffer_permanent_local_flags[idx] == 0)))
822 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
826 /* We split this away from generate-new-buffer, because rename-buffer
827 and set-visited-file-name ought to be able to use this to really
828 rename the buffer properly. */
830 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
831 Sgenerate_new_buffer_name, 1, 2, 0,
832 doc: /* Return a string that is the name of no existing buffer based on NAME.
833 If there is no live buffer named NAME, then return NAME.
834 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
835 \(starting at 2) until an unused name is found, and then return that name.
836 Optional second argument IGNORE specifies a name that is okay to use (if
837 it is in the sequence to be tried) even if a buffer with that name exists.
839 If NAME begins with a space (i.e., a buffer that is not normally
840 visible to users), then if buffer NAME already exists a random number
841 is first appended to NAME, to speed up finding a non-existent buffer. */)
842 (register Lisp_Object name, Lisp_Object ignore)
844 register Lisp_Object gentemp, tem, tem2;
845 ptrdiff_t count;
846 char number[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
848 CHECK_STRING (name);
850 tem = Fstring_equal (name, ignore);
851 if (!NILP (tem))
852 return name;
853 tem = Fget_buffer (name);
854 if (NILP (tem))
855 return name;
857 if (!strncmp (SSDATA (name), " ", 1)) /* see bug#1229 */
859 /* Note fileio.c:make_temp_name does random differently. */
860 tem2 = concat2 (name, make_formatted_string
861 (number, "-%"pI"d",
862 XFASTINT (Frandom (make_number (999999)))));
863 tem = Fget_buffer (tem2);
864 if (NILP (tem))
865 return tem2;
867 else
868 tem2 = name;
870 count = 1;
871 while (1)
873 gentemp = concat2 (tem2, make_formatted_string
874 (number, "<%"pD"d>", ++count));
875 tem = Fstring_equal (gentemp, ignore);
876 if (!NILP (tem))
877 return gentemp;
878 tem = Fget_buffer (gentemp);
879 if (NILP (tem))
880 return gentemp;
885 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
886 doc: /* Return the name of BUFFER, as a string.
887 BUFFER defaults to the current buffer.
888 Return nil if BUFFER has been killed. */)
889 (register Lisp_Object buffer)
891 if (NILP (buffer))
892 return BVAR (current_buffer, name);
893 CHECK_BUFFER (buffer);
894 return BVAR (XBUFFER (buffer), name);
897 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
898 doc: /* Return name of file BUFFER is visiting, or nil if none.
899 No argument or nil as argument means use the current buffer. */)
900 (register Lisp_Object buffer)
902 if (NILP (buffer))
903 return BVAR (current_buffer, filename);
904 CHECK_BUFFER (buffer);
905 return BVAR (XBUFFER (buffer), filename);
908 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
909 0, 1, 0,
910 doc: /* Return the base buffer of indirect buffer BUFFER.
911 If BUFFER is not indirect, return nil.
912 BUFFER defaults to the current buffer. */)
913 (register Lisp_Object buffer)
915 struct buffer *base;
916 Lisp_Object base_buffer;
918 if (NILP (buffer))
919 base = current_buffer->base_buffer;
920 else
922 CHECK_BUFFER (buffer);
923 base = XBUFFER (buffer)->base_buffer;
926 if (! base)
927 return Qnil;
928 XSETBUFFER (base_buffer, base);
929 return base_buffer;
932 DEFUN ("buffer-local-value", Fbuffer_local_value,
933 Sbuffer_local_value, 2, 2, 0,
934 doc: /* Return the value of VARIABLE in BUFFER.
935 If VARIABLE does not have a buffer-local binding in BUFFER, the value
936 is the default binding of the variable. */)
937 (register Lisp_Object variable, register Lisp_Object buffer)
939 register Lisp_Object result = buffer_local_value_1 (variable, buffer);
941 if (EQ (result, Qunbound))
942 xsignal1 (Qvoid_variable, variable);
944 return result;
948 /* Like Fbuffer_local_value, but return Qunbound if the variable is
949 locally unbound. */
951 Lisp_Object
952 buffer_local_value_1 (Lisp_Object variable, Lisp_Object buffer)
954 register struct buffer *buf;
955 register Lisp_Object result;
956 struct Lisp_Symbol *sym;
958 CHECK_SYMBOL (variable);
959 CHECK_BUFFER (buffer);
960 buf = XBUFFER (buffer);
961 sym = XSYMBOL (variable);
963 start:
964 switch (sym->redirect)
966 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
967 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
968 case SYMBOL_LOCALIZED:
969 { /* Look in local_var_alist. */
970 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
971 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
972 result = Fassoc (variable, BVAR (buf, local_var_alist));
973 if (!NILP (result))
975 if (blv->fwd)
976 { /* What binding is loaded right now? */
977 Lisp_Object current_alist_element = blv->valcell;
979 /* The value of the currently loaded binding is not
980 stored in it, but rather in the realvalue slot.
981 Store that value into the binding it belongs to
982 in case that is the one we are about to use. */
984 XSETCDR (current_alist_element,
985 do_symval_forwarding (blv->fwd));
987 /* Now get the (perhaps updated) value out of the binding. */
988 result = XCDR (result);
990 else
991 result = Fdefault_value (variable);
992 break;
994 case SYMBOL_FORWARDED:
996 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
997 if (BUFFER_OBJFWDP (fwd))
998 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
999 else
1000 result = Fdefault_value (variable);
1001 break;
1003 default: abort ();
1006 return result;
1009 /* Return an alist of the Lisp-level buffer-local bindings of
1010 buffer BUF. That is, don't include the variables maintained
1011 in special slots in the buffer object.
1012 If CLONE is zero elements of the form (VAR . unbound) are replaced
1013 by VAR. */
1015 static Lisp_Object
1016 buffer_lisp_local_variables (struct buffer *buf, int clone)
1018 Lisp_Object result = Qnil;
1019 register Lisp_Object tail;
1020 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1022 Lisp_Object val, elt;
1024 elt = XCAR (tail);
1026 /* Reference each variable in the alist in buf.
1027 If inquiring about the current buffer, this gets the current values,
1028 so store them into the alist so the alist is up to date.
1029 If inquiring about some other buffer, this swaps out any values
1030 for that buffer, making the alist up to date automatically. */
1031 val = find_symbol_value (XCAR (elt));
1032 /* Use the current buffer value only if buf is the current buffer. */
1033 if (buf != current_buffer)
1034 val = XCDR (elt);
1036 result = Fcons (!clone && EQ (val, Qunbound)
1037 ? XCAR (elt)
1038 : Fcons (XCAR (elt), val),
1039 result);
1042 return result;
1045 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1046 Sbuffer_local_variables, 0, 1, 0,
1047 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1048 Most elements look like (SYMBOL . VALUE), describing one variable.
1049 For a symbol that is locally unbound, just the symbol appears in the value.
1050 Note that storing new VALUEs in these elements doesn't change the variables.
1051 No argument or nil as argument means use current buffer as BUFFER. */)
1052 (register Lisp_Object buffer)
1054 register struct buffer *buf;
1055 register Lisp_Object result;
1057 if (NILP (buffer))
1058 buf = current_buffer;
1059 else
1061 CHECK_BUFFER (buffer);
1062 buf = XBUFFER (buffer);
1065 result = buffer_lisp_local_variables (buf, 0);
1067 /* Add on all the variables stored in special slots. */
1069 int offset, idx;
1071 FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
1073 idx = PER_BUFFER_IDX (offset);
1074 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1075 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1077 Lisp_Object sym = PER_BUFFER_SYMBOL (offset);
1078 Lisp_Object val = PER_BUFFER_VALUE (buf, offset);
1079 result = Fcons (EQ (val, Qunbound) ? sym : Fcons (sym, val),
1080 result);
1085 return result;
1088 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1089 0, 1, 0,
1090 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1091 No argument or nil as argument means use current buffer as BUFFER. */)
1092 (register Lisp_Object buffer)
1094 register struct buffer *buf;
1095 if (NILP (buffer))
1096 buf = current_buffer;
1097 else
1099 CHECK_BUFFER (buffer);
1100 buf = XBUFFER (buffer);
1103 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1106 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1107 1, 1, 0,
1108 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1109 A non-nil FLAG means mark the buffer modified. */)
1110 (register Lisp_Object flag)
1112 register int already;
1113 register Lisp_Object fn;
1114 Lisp_Object buffer, window;
1116 #ifdef CLASH_DETECTION
1117 /* If buffer becoming modified, lock the file.
1118 If buffer becoming unmodified, unlock the file. */
1120 fn = BVAR (current_buffer, file_truename);
1121 /* Test buffer-file-name so that binding it to nil is effective. */
1122 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1124 already = SAVE_MODIFF < MODIFF;
1125 if (!already && !NILP (flag))
1126 lock_file (fn);
1127 else if (already && NILP (flag))
1128 unlock_file (fn);
1130 #endif /* CLASH_DETECTION */
1132 /* Here we have a problem. SAVE_MODIFF is used here to encode
1133 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1134 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1135 modify SAVE_MODIFF to affect one, we may affect the other
1136 as well.
1137 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1138 if SAVE_MODIFF<auto_save_modified that means we risk changing
1139 recent-auto-save-p from t to nil.
1140 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1141 we risk changing recent-auto-save-p from nil to t. */
1142 SAVE_MODIFF = (NILP (flag)
1143 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1144 ? MODIFF
1145 /* Let's try to preserve recent-auto-save-p. */
1146 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1147 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1148 we can either decrease SAVE_MODIFF and auto_save_modified
1149 or increase MODIFF. */
1150 : MODIFF++);
1152 /* Set update_mode_lines only if buffer is displayed in some window.
1153 Packages like jit-lock or lazy-lock preserve a buffer's modified
1154 state by recording/restoring the state around blocks of code.
1155 Setting update_mode_lines makes redisplay consider all windows
1156 (on all frames). Stealth fontification of buffers not displayed
1157 would incur additional redisplay costs if we'd set
1158 update_modes_lines unconditionally.
1160 Ideally, I think there should be another mechanism for fontifying
1161 buffers without "modifying" buffers, or redisplay should be
1162 smarter about updating the `*' in mode lines. --gerd */
1163 XSETBUFFER (buffer, current_buffer);
1164 window = Fget_buffer_window (buffer, Qt);
1165 if (WINDOWP (window))
1167 ++update_mode_lines;
1168 current_buffer->prevent_redisplay_optimizations_p = 1;
1171 return flag;
1174 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1175 Srestore_buffer_modified_p, 1, 1, 0,
1176 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1177 It is not ensured that mode lines will be updated to show the modified
1178 state of the current buffer. Use with care. */)
1179 (Lisp_Object flag)
1181 #ifdef CLASH_DETECTION
1182 Lisp_Object fn;
1184 /* If buffer becoming modified, lock the file.
1185 If buffer becoming unmodified, unlock the file. */
1187 fn = BVAR (current_buffer, file_truename);
1188 /* Test buffer-file-name so that binding it to nil is effective. */
1189 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1191 int already = SAVE_MODIFF < MODIFF;
1192 if (!already && !NILP (flag))
1193 lock_file (fn);
1194 else if (already && NILP (flag))
1195 unlock_file (fn);
1197 #endif /* CLASH_DETECTION */
1199 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1200 return flag;
1203 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1204 0, 1, 0,
1205 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1206 Each buffer has a tick counter which is incremented each time the
1207 text in that buffer is changed. It wraps around occasionally.
1208 No argument or nil as argument means use current buffer as BUFFER. */)
1209 (register Lisp_Object buffer)
1211 register struct buffer *buf;
1212 if (NILP (buffer))
1213 buf = current_buffer;
1214 else
1216 CHECK_BUFFER (buffer);
1217 buf = XBUFFER (buffer);
1220 return make_number (BUF_MODIFF (buf));
1223 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1224 Sbuffer_chars_modified_tick, 0, 1, 0,
1225 doc: /* Return BUFFER's character-change tick counter.
1226 Each buffer has a character-change tick counter, which is set to the
1227 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1228 time text in that buffer is inserted or deleted. By comparing the
1229 values returned by two individual calls of `buffer-chars-modified-tick',
1230 you can tell whether a character change occurred in that buffer in
1231 between these calls. No argument or nil as argument means use current
1232 buffer as BUFFER. */)
1233 (register Lisp_Object buffer)
1235 register struct buffer *buf;
1236 if (NILP (buffer))
1237 buf = current_buffer;
1238 else
1240 CHECK_BUFFER (buffer);
1241 buf = XBUFFER (buffer);
1244 return make_number (BUF_CHARS_MODIFF (buf));
1247 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1248 "(list (read-string \"Rename buffer (to new name): \" \
1249 nil 'buffer-name-history (buffer-name (current-buffer))) \
1250 current-prefix-arg)",
1251 doc: /* Change current buffer's name to NEWNAME (a string).
1252 If second arg UNIQUE is nil or omitted, it is an error if a
1253 buffer named NEWNAME already exists.
1254 If UNIQUE is non-nil, come up with a new name using
1255 `generate-new-buffer-name'.
1256 Interactively, you can set UNIQUE with a prefix argument.
1257 We return the name we actually gave the buffer.
1258 This does not change the name of the visited file (if any). */)
1259 (register Lisp_Object newname, Lisp_Object unique)
1261 register Lisp_Object tem, buf;
1263 CHECK_STRING (newname);
1265 if (SCHARS (newname) == 0)
1266 error ("Empty string is invalid as a buffer name");
1268 tem = Fget_buffer (newname);
1269 if (!NILP (tem))
1271 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1272 rename the buffer automatically so you can create another
1273 with the original name. It makes UNIQUE equivalent to
1274 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1275 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1276 return BVAR (current_buffer, name);
1277 if (!NILP (unique))
1278 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1279 else
1280 error ("Buffer name `%s' is in use", SDATA (newname));
1283 BVAR (current_buffer, name) = newname;
1285 /* Catch redisplay's attention. Unless we do this, the mode lines for
1286 any windows displaying current_buffer will stay unchanged. */
1287 update_mode_lines++;
1289 XSETBUFFER (buf, current_buffer);
1290 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1291 if (NILP (BVAR (current_buffer, filename))
1292 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1293 call0 (intern ("rename-auto-save-file"));
1295 /* Run buffer-list-update-hook. */
1296 if (!NILP (Vrun_hooks))
1297 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1299 /* Refetch since that last call may have done GC. */
1300 return BVAR (current_buffer, name);
1303 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1304 doc: /* Return most recently selected buffer other than BUFFER.
1305 Buffers not visible in windows are preferred to visible buffers, unless
1306 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1307 BUFFER unless it denotes a live buffer. If the optional third argument
1308 FRAME is non-nil, use that frame's buffer list instead of the selected
1309 frame's buffer list.
1311 The buffer is found by scanning the selected or specified frame's buffer
1312 list first, followed by the list of all buffers. If no other buffer
1313 exists, return the buffer `*scratch*' (creating it if necessary). */)
1314 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1316 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1317 Lisp_Object tail, buf, pred;
1318 Lisp_Object notsogood = Qnil;
1320 if (NILP (frame))
1321 frame = selected_frame;
1323 CHECK_FRAME (frame);
1325 pred = frame_buffer_predicate (frame);
1326 /* Consider buffers that have been seen in the frame first. */
1327 tail = XFRAME (frame)->buffer_list;
1328 for (; CONSP (tail); tail = XCDR (tail))
1330 buf = XCAR (tail);
1331 if (BUFFERP (buf) && !EQ (buf, buffer)
1332 && !NILP (BVAR (XBUFFER (buf), name))
1333 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1334 /* If the frame has a buffer_predicate, disregard buffers that
1335 don't fit the predicate. */
1336 && (NILP (pred) || !NILP (call1 (pred, buf))))
1338 if (!NILP (visible_ok)
1339 || NILP (Fget_buffer_window (buf, Qvisible)))
1340 return buf;
1341 else if (NILP (notsogood))
1342 notsogood = buf;
1346 /* Consider alist of all buffers next. */
1347 tail = Vbuffer_alist;
1348 for (; CONSP (tail); tail = XCDR (tail))
1350 buf = Fcdr (XCAR (tail));
1351 if (BUFFERP (buf) && !EQ (buf, buffer)
1352 && !NILP (BVAR (XBUFFER (buf), name))
1353 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1354 /* If the frame has a buffer_predicate, disregard buffers that
1355 don't fit the predicate. */
1356 && (NILP (pred) || !NILP (call1 (pred, buf))))
1358 if (!NILP (visible_ok)
1359 || NILP (Fget_buffer_window (buf, Qvisible)))
1360 return buf;
1361 else if (NILP (notsogood))
1362 notsogood = buf;
1366 if (!NILP (notsogood))
1367 return notsogood;
1368 else
1370 buf = Fget_buffer (build_string ("*scratch*"));
1371 if (NILP (buf))
1373 buf = Fget_buffer_create (build_string ("*scratch*"));
1374 Fset_buffer_major_mode (buf);
1376 return buf;
1380 /* The following function is a safe variant of Fother_buffer: It doesn't
1381 pay attention to any frame-local buffer lists, doesn't care about
1382 visibility of buffers, and doesn't evaluate any frame predicates. */
1384 Lisp_Object
1385 other_buffer_safely (Lisp_Object buffer)
1387 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1388 Lisp_Object tail, buf;
1390 tail = Vbuffer_alist;
1391 for (; CONSP (tail); tail = XCDR (tail))
1393 buf = Fcdr (XCAR (tail));
1394 if (BUFFERP (buf) && !EQ (buf, buffer)
1395 && !NILP (BVAR (XBUFFER (buf), name))
1396 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1397 return buf;
1400 buf = Fget_buffer (build_string ("*scratch*"));
1401 if (NILP (buf))
1403 buf = Fget_buffer_create (build_string ("*scratch*"));
1404 Fset_buffer_major_mode (buf);
1407 return buf;
1410 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1411 0, 1, "",
1412 doc: /* Start keeping undo information for buffer BUFFER.
1413 No argument or nil as argument means do this for the current buffer. */)
1414 (register Lisp_Object buffer)
1416 Lisp_Object real_buffer;
1418 if (NILP (buffer))
1419 XSETBUFFER (real_buffer, current_buffer);
1420 else
1422 real_buffer = Fget_buffer (buffer);
1423 if (NILP (real_buffer))
1424 nsberror (buffer);
1427 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1428 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1430 return Qnil;
1433 /* Truncate undo list and shrink the gap of BUFFER. */
1436 compact_buffer (struct buffer *buffer)
1438 /* Verify indirection counters. */
1439 if (buffer->base_buffer)
1441 eassert (buffer->indirections == -1);
1442 eassert (buffer->base_buffer->indirections > 0);
1444 else
1445 eassert (buffer->indirections >= 0);
1447 /* Skip dead buffers, indirect buffers and buffers
1448 which aren't changed since last compaction. */
1449 if (!NILP (buffer->BUFFER_INTERNAL_FIELD (name))
1450 && (buffer->base_buffer == NULL)
1451 && (buffer->text->compact != buffer->text->modiff))
1453 /* If a buffer's undo list is Qt, that means that undo is
1454 turned off in that buffer. Calling truncate_undo_list on
1455 Qt tends to return NULL, which effectively turns undo back on.
1456 So don't call truncate_undo_list if undo_list is Qt. */
1457 if (!EQ (buffer->BUFFER_INTERNAL_FIELD (undo_list), Qt))
1458 truncate_undo_list (buffer);
1460 /* Shrink buffer gaps. */
1461 if (!buffer->text->inhibit_shrinking)
1463 /* If a buffer's gap size is more than 10% of the buffer
1464 size, or larger than 2000 bytes, then shrink it
1465 accordingly. Keep a minimum size of 20 bytes. */
1466 int size = min (2000, max (20, (buffer->text->z_byte / 10)));
1468 if (buffer->text->gap_size > size)
1470 struct buffer *save_current = current_buffer;
1471 current_buffer = buffer;
1472 make_gap (-(buffer->text->gap_size - size));
1473 current_buffer = save_current;
1476 buffer->text->compact = buffer->text->modiff;
1477 return 1;
1479 return 0;
1482 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1483 doc: /* Kill the buffer specified by BUFFER-OR-NAME.
1484 The argument may be a buffer or the name of an existing buffer.
1485 Argument nil or omitted means kill the current buffer. Return t if the
1486 buffer is actually killed, nil otherwise.
1488 The functions in `kill-buffer-query-functions' are called with the
1489 buffer to be killed as the current buffer. If any of them returns nil,
1490 the buffer is not killed. The hook `kill-buffer-hook' is run before the
1491 buffer is actually killed. The buffer being killed will be current
1492 while the hook is running. Functions called by any of these hooks are
1493 supposed to not change the current buffer.
1495 Any processes that have this buffer as the `process-buffer' are killed
1496 with SIGHUP. This function calls `replace-buffer-in-windows' for
1497 cleaning up all windows currently displaying the buffer to be killed. */)
1498 (Lisp_Object buffer_or_name)
1500 Lisp_Object buffer;
1501 register struct buffer *b;
1502 register Lisp_Object tem;
1503 register struct Lisp_Marker *m;
1504 struct gcpro gcpro1;
1506 if (NILP (buffer_or_name))
1507 buffer = Fcurrent_buffer ();
1508 else
1509 buffer = Fget_buffer (buffer_or_name);
1510 if (NILP (buffer))
1511 nsberror (buffer_or_name);
1513 b = XBUFFER (buffer);
1515 /* Avoid trouble for buffer already dead. */
1516 if (NILP (BVAR (b, name)))
1517 return Qnil;
1519 /* Query if the buffer is still modified. */
1520 if (INTERACTIVE && !NILP (BVAR (b, filename))
1521 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1523 GCPRO1 (buffer);
1524 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1525 BVAR (b, name), make_number (0)));
1526 UNGCPRO;
1527 if (NILP (tem))
1528 return Qnil;
1531 /* Run hooks with the buffer to be killed the current buffer. */
1533 ptrdiff_t count = SPECPDL_INDEX ();
1534 Lisp_Object arglist[1];
1536 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1537 set_buffer_internal (b);
1539 /* First run the query functions; if any query is answered no,
1540 don't kill the buffer. */
1541 arglist[0] = Qkill_buffer_query_functions;
1542 tem = Frun_hook_with_args_until_failure (1, arglist);
1543 if (NILP (tem))
1544 return unbind_to (count, Qnil);
1546 /* Then run the hooks. */
1547 Frun_hooks (1, &Qkill_buffer_hook);
1548 unbind_to (count, Qnil);
1551 /* If the hooks have killed the buffer, exit now. */
1552 if (NILP (BVAR (b, name)))
1553 return Qt;
1555 /* We have no more questions to ask. Verify that it is valid
1556 to kill the buffer. This must be done after the questions
1557 since anything can happen within do_yes_or_no_p. */
1559 /* Don't kill the minibuffer now current. */
1560 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1561 return Qnil;
1563 /* When we kill an ordinary buffer which shares it's buffer text
1564 with indirect buffer(s), we must kill indirect buffer(s) too.
1565 We do it at this stage so nothing terrible happens if they
1566 ask questions or their hooks get errors. */
1567 if (!b->base_buffer && b->indirections > 0)
1569 struct buffer *other;
1571 GCPRO1 (buffer);
1573 FOR_EACH_BUFFER (other)
1574 if (other->base_buffer == b)
1576 Lisp_Object buf;
1577 XSETBUFFER (buf, other);
1578 Fkill_buffer (buf);
1581 UNGCPRO;
1583 /* Exit if we now have killed the base buffer (Bug#11665). */
1584 if (NILP (BVAR (b, name)))
1585 return Qt;
1588 /* Run replace_buffer_in_windows before making another buffer current
1589 since set-window-buffer-start-and-point will refuse to make another
1590 buffer current if the selected window does not show the current
1591 buffer. (Bug#10114) */
1592 replace_buffer_in_windows (buffer);
1594 /* Exit if replacing the buffer in windows has killed our buffer. */
1595 if (NILP (BVAR (b, name)))
1596 return Qt;
1598 /* Make this buffer not be current. Exit if it is the sole visible
1599 buffer. */
1600 if (b == current_buffer)
1602 tem = Fother_buffer (buffer, Qnil, Qnil);
1603 Fset_buffer (tem);
1604 if (b == current_buffer)
1605 return Qnil;
1608 /* If the buffer now current is shown in the minibuffer and our buffer
1609 is the sole other buffer give up. */
1610 XSETBUFFER (tem, current_buffer);
1611 if (EQ (tem, XWINDOW (minibuf_window)->buffer)
1612 && EQ (buffer, Fother_buffer (buffer, Qnil, Qnil)))
1613 return Qnil;
1615 /* Now there is no question: we can kill the buffer. */
1617 #ifdef CLASH_DETECTION
1618 /* Unlock this buffer's file, if it is locked. */
1619 unlock_buffer (b);
1620 #endif /* CLASH_DETECTION */
1622 GCPRO1 (buffer);
1623 kill_buffer_processes (buffer);
1624 UNGCPRO;
1626 /* Killing buffer processes may run sentinels which may have killed
1627 our buffer. */
1628 if (NILP (BVAR (b, name)))
1629 return Qt;
1631 /* These may run Lisp code and into infinite loops (if someone
1632 insisted on circular lists) so allow quitting here. */
1633 frames_discard_buffer (buffer);
1635 clear_charpos_cache (b);
1637 tem = Vinhibit_quit;
1638 Vinhibit_quit = Qt;
1639 /* Remove the buffer from the list of all buffers. */
1640 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1641 /* If replace_buffer_in_windows didn't do its job fix that now. */
1642 replace_buffer_in_windows_safely (buffer);
1643 Vinhibit_quit = tem;
1645 /* Delete any auto-save file, if we saved it in this session.
1646 But not if the buffer is modified. */
1647 if (STRINGP (BVAR (b, auto_save_file_name))
1648 && BUF_AUTOSAVE_MODIFF (b) != 0
1649 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1650 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1651 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1653 Lisp_Object delete;
1654 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1655 if (! NILP (delete))
1656 internal_delete_file (BVAR (b, auto_save_file_name));
1659 /* Deleting an auto-save file could have killed our buffer. */
1660 if (NILP (BVAR (b, name)))
1661 return Qt;
1663 if (b->base_buffer)
1665 /* Unchain all markers that belong to this indirect buffer.
1666 Don't unchain the markers that belong to the base buffer
1667 or its other indirect buffers. */
1668 for (m = BUF_MARKERS (b); m; )
1670 struct Lisp_Marker *next = m->next;
1671 if (m->buffer == b)
1672 unchain_marker (m);
1673 m = next;
1676 else
1678 /* Unchain all markers of this buffer and its indirect buffers.
1679 and leave them pointing nowhere. */
1680 for (m = BUF_MARKERS (b); m; )
1682 struct Lisp_Marker *next = m->next;
1683 m->buffer = 0;
1684 m->next = NULL;
1685 m = next;
1687 BUF_MARKERS (b) = NULL;
1688 BUF_INTERVALS (b) = NULL_INTERVAL;
1690 /* Perhaps we should explicitly free the interval tree here... */
1693 /* Reset the local variables, so that this buffer's local values
1694 won't be protected from GC. They would be protected
1695 if they happened to remain cached in their symbols.
1696 This gets rid of them for certain. */
1697 swap_out_buffer_local_variables (b);
1698 reset_buffer_local_variables (b, 1);
1700 BVAR (b, name) = Qnil;
1702 BLOCK_INPUT;
1703 if (b->base_buffer)
1705 /* Notify our base buffer that we don't share the text anymore. */
1706 eassert (b->indirections == -1);
1707 b->base_buffer->indirections--;
1708 eassert (b->base_buffer->indirections >= 0);
1710 else
1711 /* No one shares our buffer text, can free it. */
1712 free_buffer_text (b);
1714 if (b->newline_cache)
1716 free_region_cache (b->newline_cache);
1717 b->newline_cache = 0;
1719 if (b->width_run_cache)
1721 free_region_cache (b->width_run_cache);
1722 b->width_run_cache = 0;
1724 BVAR (b, width_table) = Qnil;
1725 UNBLOCK_INPUT;
1726 BVAR (b, undo_list) = Qnil;
1728 /* Run buffer-list-update-hook. */
1729 if (!NILP (Vrun_hooks))
1730 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1732 return Qt;
1735 /* Move association for BUFFER to the front of buffer (a)lists. Since
1736 we do this each time BUFFER is selected visibly, the more recently
1737 selected buffers are always closer to the front of those lists. This
1738 means that other_buffer is more likely to choose a relevant buffer.
1740 Note that this moves BUFFER to the front of the buffer lists of the
1741 selected frame even if BUFFER is not shown there. If BUFFER is not
1742 shown in the selected frame, consider the present behavior a feature.
1743 `select-window' gets this right since it shows BUFFER in the selected
1744 window when calling us. */
1746 void
1747 record_buffer (Lisp_Object buffer)
1749 Lisp_Object aelt, aelt_cons, tem;
1750 register struct frame *f = XFRAME (selected_frame);
1752 CHECK_BUFFER (buffer);
1754 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1755 Don't allow quitting since this might leave the buffer list in an
1756 inconsistent state. */
1757 tem = Vinhibit_quit;
1758 Vinhibit_quit = Qt;
1759 aelt = Frassq (buffer, Vbuffer_alist);
1760 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1761 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1762 XSETCDR (aelt_cons, Vbuffer_alist);
1763 Vbuffer_alist = aelt_cons;
1764 Vinhibit_quit = tem;
1766 /* Update buffer list of selected frame. */
1767 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1768 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1770 /* Run buffer-list-update-hook. */
1771 if (!NILP (Vrun_hooks))
1772 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1776 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1777 buffer is killed. For the selected frame's buffer list this moves
1778 BUFFER to its end even if it was never shown in that frame. If
1779 this happens we have a feature, hence `bury-buffer-internal' should be
1780 called only when BUFFER was shown in the selected frame. */
1782 DEFUN ("bury-buffer-internal", Fbury_buffer_internal, Sbury_buffer_internal,
1783 1, 1, 0,
1784 doc: /* Move BUFFER to the end of the buffer list. */)
1785 (Lisp_Object buffer)
1787 Lisp_Object aelt, aelt_cons, tem;
1788 register struct frame *f = XFRAME (selected_frame);
1790 CHECK_BUFFER (buffer);
1792 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1793 Don't allow quitting since this might leave the buffer list in an
1794 inconsistent state. */
1795 tem = Vinhibit_quit;
1796 Vinhibit_quit = Qt;
1797 aelt = Frassq (buffer, Vbuffer_alist);
1798 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1799 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1800 XSETCDR (aelt_cons, Qnil);
1801 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1802 Vinhibit_quit = tem;
1804 /* Update buffer lists of selected frame. */
1805 f->buffer_list = Fdelq (buffer, f->buffer_list);
1806 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1808 /* Run buffer-list-update-hook. */
1809 if (!NILP (Vrun_hooks))
1810 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1812 return Qnil;
1815 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1816 doc: /* Set an appropriate major mode for BUFFER.
1817 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1818 according to `default-major-mode'.
1819 Use this function before selecting the buffer, since it may need to inspect
1820 the current buffer's major mode. */)
1821 (Lisp_Object buffer)
1823 ptrdiff_t count;
1824 Lisp_Object function;
1826 CHECK_BUFFER (buffer);
1828 if (STRINGP (BVAR (XBUFFER (buffer), name))
1829 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1830 function = find_symbol_value (intern ("initial-major-mode"));
1831 else
1833 function = BVAR (&buffer_defaults, major_mode);
1834 if (NILP (function)
1835 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1836 function = BVAR (current_buffer, major_mode);
1839 if (NILP (function) || EQ (function, Qfundamental_mode))
1840 return Qnil;
1842 count = SPECPDL_INDEX ();
1844 /* To select a nonfundamental mode,
1845 select the buffer temporarily and then call the mode function. */
1847 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1849 Fset_buffer (buffer);
1850 call0 (function);
1852 return unbind_to (count, Qnil);
1855 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1856 doc: /* Return the current buffer as a Lisp object. */)
1857 (void)
1859 register Lisp_Object buf;
1860 XSETBUFFER (buf, current_buffer);
1861 return buf;
1864 /* Set the current buffer to B.
1866 We previously set windows_or_buffers_changed here to invalidate
1867 global unchanged information in beg_unchanged and end_unchanged.
1868 This is no longer necessary because we now compute unchanged
1869 information on a buffer-basis. Every action affecting other
1870 windows than the selected one requires a select_window at some
1871 time, and that increments windows_or_buffers_changed. */
1873 void
1874 set_buffer_internal (register struct buffer *b)
1876 if (current_buffer != b)
1877 set_buffer_internal_1 (b);
1880 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1881 This is used by redisplay. */
1883 void
1884 set_buffer_internal_1 (register struct buffer *b)
1886 register struct buffer *old_buf;
1887 register Lisp_Object tail;
1889 #ifdef USE_MMAP_FOR_BUFFERS
1890 if (b->text->beg == NULL)
1891 enlarge_buffer_text (b, 0);
1892 #endif /* USE_MMAP_FOR_BUFFERS */
1894 if (current_buffer == b)
1895 return;
1897 old_buf = current_buffer;
1898 current_buffer = b;
1899 last_known_column_point = -1; /* invalidate indentation cache */
1901 if (old_buf)
1903 /* Put the undo list back in the base buffer, so that it appears
1904 that an indirect buffer shares the undo list of its base. */
1905 if (old_buf->base_buffer)
1906 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1908 /* If the old current buffer has markers to record PT, BEGV and ZV
1909 when it is not current, update them now. */
1910 record_buffer_markers (old_buf);
1913 /* Get the undo list from the base buffer, so that it appears
1914 that an indirect buffer shares the undo list of its base. */
1915 if (b->base_buffer)
1916 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1918 /* If the new current buffer has markers to record PT, BEGV and ZV
1919 when it is not current, fetch them now. */
1920 fetch_buffer_markers (b);
1922 /* Look down buffer's list of local Lisp variables
1923 to find and update any that forward into C variables. */
1927 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1929 Lisp_Object var = XCAR (XCAR (tail));
1930 struct Lisp_Symbol *sym = XSYMBOL (var);
1931 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1932 && SYMBOL_BLV (sym)->fwd)
1933 /* Just reference the variable
1934 to cause it to become set for this buffer. */
1935 Fsymbol_value (var);
1938 /* Do the same with any others that were local to the previous buffer */
1939 while (b != old_buf && (b = old_buf, b));
1942 /* Switch to buffer B temporarily for redisplay purposes.
1943 This avoids certain things that don't need to be done within redisplay. */
1945 void
1946 set_buffer_temp (struct buffer *b)
1948 register struct buffer *old_buf;
1950 if (current_buffer == b)
1951 return;
1953 old_buf = current_buffer;
1954 current_buffer = b;
1956 /* If the old current buffer has markers to record PT, BEGV and ZV
1957 when it is not current, update them now. */
1958 record_buffer_markers (old_buf);
1960 /* If the new current buffer has markers to record PT, BEGV and ZV
1961 when it is not current, fetch them now. */
1962 fetch_buffer_markers (b);
1965 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1966 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1967 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1968 also `save-excursion' when you want to make a buffer current
1969 temporarily. This function does not display the buffer, so its effect
1970 ends when the current command terminates. Use `switch-to-buffer' or
1971 `pop-to-buffer' to switch buffers permanently. */)
1972 (register Lisp_Object buffer_or_name)
1974 register Lisp_Object buffer;
1975 buffer = Fget_buffer (buffer_or_name);
1976 if (NILP (buffer))
1977 nsberror (buffer_or_name);
1978 if (NILP (BVAR (XBUFFER (buffer), name)))
1979 error ("Selecting deleted buffer");
1980 set_buffer_internal (XBUFFER (buffer));
1981 return buffer;
1984 /* Set the current buffer to BUFFER provided it is alive. */
1986 Lisp_Object
1987 set_buffer_if_live (Lisp_Object buffer)
1989 if (! NILP (BVAR (XBUFFER (buffer), name)))
1990 Fset_buffer (buffer);
1991 return Qnil;
1994 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1995 Sbarf_if_buffer_read_only, 0, 0, 0,
1996 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1997 (void)
1999 if (!NILP (BVAR (current_buffer, read_only))
2000 && NILP (Vinhibit_read_only))
2001 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2002 return Qnil;
2005 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2006 doc: /* Delete the entire contents of the current buffer.
2007 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2008 so the buffer is truly empty after this. */)
2009 (void)
2011 Fwiden ();
2013 del_range (BEG, Z);
2015 current_buffer->last_window_start = 1;
2016 /* Prevent warnings, or suspension of auto saving, that would happen
2017 if future size is less than past size. Use of erase-buffer
2018 implies that the future text is not really related to the past text. */
2019 XSETFASTINT (BVAR (current_buffer, save_length), 0);
2020 return Qnil;
2023 void
2024 validate_region (register Lisp_Object *b, register Lisp_Object *e)
2026 CHECK_NUMBER_COERCE_MARKER (*b);
2027 CHECK_NUMBER_COERCE_MARKER (*e);
2029 if (XINT (*b) > XINT (*e))
2031 Lisp_Object tem;
2032 tem = *b; *b = *e; *e = tem;
2035 if (! (BEGV <= XINT (*b) && XINT (*e) <= ZV))
2036 args_out_of_range (*b, *e);
2039 /* Advance BYTE_POS up to a character boundary
2040 and return the adjusted position. */
2042 static ptrdiff_t
2043 advance_to_char_boundary (ptrdiff_t byte_pos)
2045 int c;
2047 if (byte_pos == BEG)
2048 /* Beginning of buffer is always a character boundary. */
2049 return BEG;
2051 c = FETCH_BYTE (byte_pos);
2052 if (! CHAR_HEAD_P (c))
2054 /* We should advance BYTE_POS only when C is a constituent of a
2055 multibyte sequence. */
2056 ptrdiff_t orig_byte_pos = byte_pos;
2060 byte_pos--;
2061 c = FETCH_BYTE (byte_pos);
2063 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2064 INC_POS (byte_pos);
2065 if (byte_pos < orig_byte_pos)
2066 byte_pos = orig_byte_pos;
2067 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2068 surely advance to the correct character boundary. If C is
2069 not, BYTE_POS was unchanged. */
2072 return byte_pos;
2075 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2076 1, 1, 0,
2077 doc: /* Swap the text between current buffer and BUFFER. */)
2078 (Lisp_Object buffer)
2080 struct buffer *other_buffer;
2081 CHECK_BUFFER (buffer);
2082 other_buffer = XBUFFER (buffer);
2084 if (NILP (BVAR (other_buffer, name)))
2085 error ("Cannot swap a dead buffer's text");
2087 /* Actually, it probably works just fine.
2088 * if (other_buffer == current_buffer)
2089 * error ("Cannot swap a buffer's text with itself"); */
2091 /* Actually, this may be workable as well, tho probably only if they're
2092 *both* indirect. */
2093 if (other_buffer->base_buffer
2094 || current_buffer->base_buffer)
2095 error ("Cannot swap indirect buffers's text");
2097 { /* This is probably harder to make work. */
2098 struct buffer *other;
2099 FOR_EACH_BUFFER (other)
2100 if (other->base_buffer == other_buffer
2101 || other->base_buffer == current_buffer)
2102 error ("One of the buffers to swap has indirect buffers");
2105 #define swapfield(field, type) \
2106 do { \
2107 type tmp##field = other_buffer->field; \
2108 other_buffer->field = current_buffer->field; \
2109 current_buffer->field = tmp##field; \
2110 } while (0)
2111 #define swapfield_(field, type) \
2112 do { \
2113 type tmp##field = BVAR (other_buffer, field); \
2114 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2115 BVAR (current_buffer, field) = tmp##field; \
2116 } while (0)
2118 swapfield (own_text, struct buffer_text);
2119 eassert (current_buffer->text == &current_buffer->own_text);
2120 eassert (other_buffer->text == &other_buffer->own_text);
2121 #ifdef REL_ALLOC
2122 r_alloc_reset_variable ((void **) &current_buffer->own_text.beg,
2123 (void **) &other_buffer->own_text.beg);
2124 r_alloc_reset_variable ((void **) &other_buffer->own_text.beg,
2125 (void **) &current_buffer->own_text.beg);
2126 #endif /* REL_ALLOC */
2128 swapfield (pt, ptrdiff_t);
2129 swapfield (pt_byte, ptrdiff_t);
2130 swapfield (begv, ptrdiff_t);
2131 swapfield (begv_byte, ptrdiff_t);
2132 swapfield (zv, ptrdiff_t);
2133 swapfield (zv_byte, ptrdiff_t);
2134 eassert (!current_buffer->base_buffer);
2135 eassert (!other_buffer->base_buffer);
2136 swapfield (indirections, ptrdiff_t);
2137 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2138 swapfield (newline_cache, struct region_cache *);
2139 swapfield (width_run_cache, struct region_cache *);
2140 current_buffer->prevent_redisplay_optimizations_p = 1;
2141 other_buffer->prevent_redisplay_optimizations_p = 1;
2142 swapfield (overlays_before, struct Lisp_Overlay *);
2143 swapfield (overlays_after, struct Lisp_Overlay *);
2144 swapfield (overlay_center, ptrdiff_t);
2145 swapfield_ (undo_list, Lisp_Object);
2146 swapfield_ (mark, Lisp_Object);
2147 swapfield_ (enable_multibyte_characters, Lisp_Object);
2148 swapfield_ (bidi_display_reordering, Lisp_Object);
2149 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2150 /* FIXME: Not sure what we should do with these *_marker fields.
2151 Hopefully they're just nil anyway. */
2152 swapfield_ (pt_marker, Lisp_Object);
2153 swapfield_ (begv_marker, Lisp_Object);
2154 swapfield_ (zv_marker, Lisp_Object);
2155 BVAR (current_buffer, point_before_scroll) = Qnil;
2156 BVAR (other_buffer, point_before_scroll) = Qnil;
2158 current_buffer->text->modiff++; other_buffer->text->modiff++;
2159 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2160 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2161 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2162 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2163 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2164 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2166 struct Lisp_Marker *m;
2167 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2168 if (m->buffer == other_buffer)
2169 m->buffer = current_buffer;
2170 else
2171 /* Since there's no indirect buffer in sight, markers on
2172 BUF_MARKERS(buf) should either be for `buf' or dead. */
2173 eassert (!m->buffer);
2174 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2175 if (m->buffer == current_buffer)
2176 m->buffer = other_buffer;
2177 else
2178 /* Since there's no indirect buffer in sight, markers on
2179 BUF_MARKERS(buf) should either be for `buf' or dead. */
2180 eassert (!m->buffer);
2182 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2183 So since we just swapped the markers between the two buffers, we need
2184 to undo the effect of this swap for window markers. */
2185 Lisp_Object w = Fselected_window (), ws = Qnil;
2186 Lisp_Object buf1, buf2;
2187 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2189 while (NILP (Fmemq (w, ws)))
2191 ws = Fcons (w, ws);
2192 if (MARKERP (XWINDOW (w)->pointm)
2193 && (EQ (XWINDOW (w)->buffer, buf1)
2194 || EQ (XWINDOW (w)->buffer, buf2)))
2195 Fset_marker (XWINDOW (w)->pointm,
2196 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2197 XWINDOW (w)->buffer);
2198 w = Fnext_window (w, Qt, Qt);
2202 if (current_buffer->text->intervals)
2203 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2204 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2205 if (other_buffer->text->intervals)
2206 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2207 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2209 return Qnil;
2212 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2213 1, 1, 0,
2214 doc: /* Set the multibyte flag of the current buffer to FLAG.
2215 If FLAG is t, this makes the buffer a multibyte buffer.
2216 If FLAG is nil, this makes the buffer a single-byte buffer.
2217 In these cases, the buffer contents remain unchanged as a sequence of
2218 bytes but the contents viewed as characters do change.
2219 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2220 all eight-bit bytes to eight-bit characters.
2221 If the multibyte flag was really changed, undo information of the
2222 current buffer is cleared. */)
2223 (Lisp_Object flag)
2225 struct Lisp_Marker *tail, *markers;
2226 struct buffer *other;
2227 ptrdiff_t begv, zv;
2228 int narrowed = (BEG != BEGV || Z != ZV);
2229 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2230 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2231 struct gcpro gcpro1;
2233 if (current_buffer->base_buffer)
2234 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2236 /* Do nothing if nothing actually changes. */
2237 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2238 return flag;
2240 GCPRO1 (old_undo);
2242 /* Don't record these buffer changes. We will put a special undo entry
2243 instead. */
2244 BVAR (current_buffer, undo_list) = Qt;
2246 /* If the cached position is for this buffer, clear it out. */
2247 clear_charpos_cache (current_buffer);
2249 if (NILP (flag))
2250 begv = BEGV_BYTE, zv = ZV_BYTE;
2251 else
2252 begv = BEGV, zv = ZV;
2254 if (narrowed)
2255 Fwiden ();
2257 if (NILP (flag))
2259 ptrdiff_t pos, stop;
2260 unsigned char *p;
2262 /* Do this first, so it can use CHAR_TO_BYTE
2263 to calculate the old correspondences. */
2264 set_intervals_multibyte (0);
2266 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2268 Z = Z_BYTE;
2269 BEGV = BEGV_BYTE;
2270 ZV = ZV_BYTE;
2271 GPT = GPT_BYTE;
2272 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2275 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2276 tail->charpos = tail->bytepos;
2278 /* Convert multibyte form of 8-bit characters to unibyte. */
2279 pos = BEG;
2280 stop = GPT;
2281 p = BEG_ADDR;
2282 while (1)
2284 int c, bytes;
2286 if (pos == stop)
2288 if (pos == Z)
2289 break;
2290 p = GAP_END_ADDR;
2291 stop = Z;
2293 if (ASCII_BYTE_P (*p))
2294 p++, pos++;
2295 else if (CHAR_BYTE8_HEAD_P (*p))
2297 c = STRING_CHAR_AND_LENGTH (p, bytes);
2298 /* Delete all bytes for this 8-bit character but the
2299 last one, and change the last one to the character
2300 code. */
2301 bytes--;
2302 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2303 p = GAP_END_ADDR;
2304 *p++ = c;
2305 pos++;
2306 if (begv > pos)
2307 begv -= bytes;
2308 if (zv > pos)
2309 zv -= bytes;
2310 stop = Z;
2312 else
2314 bytes = BYTES_BY_CHAR_HEAD (*p);
2315 p += bytes, pos += bytes;
2318 if (narrowed)
2319 Fnarrow_to_region (make_number (begv), make_number (zv));
2321 else
2323 ptrdiff_t pt = PT;
2324 ptrdiff_t pos, stop;
2325 unsigned char *p, *pend;
2327 /* Be sure not to have a multibyte sequence striding over the GAP.
2328 Ex: We change this: "...abc\302 _GAP_ \241def..."
2329 to: "...abc _GAP_ \302\241def..." */
2331 if (EQ (flag, Qt)
2332 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2333 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2335 unsigned char *q = GPT_ADDR - 1;
2337 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2338 if (LEADING_CODE_P (*q))
2340 ptrdiff_t new_gpt = GPT_BYTE - (GPT_ADDR - q);
2342 move_gap_both (new_gpt, new_gpt);
2346 /* Make the buffer contents valid as multibyte by converting
2347 8-bit characters to multibyte form. */
2348 pos = BEG;
2349 stop = GPT;
2350 p = BEG_ADDR;
2351 pend = GPT_ADDR;
2352 while (1)
2354 int bytes;
2356 if (pos == stop)
2358 if (pos == Z)
2359 break;
2360 p = GAP_END_ADDR;
2361 pend = Z_ADDR;
2362 stop = Z;
2365 if (ASCII_BYTE_P (*p))
2366 p++, pos++;
2367 else if (EQ (flag, Qt)
2368 && ! CHAR_BYTE8_HEAD_P (*p)
2369 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2370 p += bytes, pos += bytes;
2371 else
2373 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2374 int c;
2376 c = BYTE8_TO_CHAR (*p);
2377 bytes = CHAR_STRING (c, tmp);
2378 *p = tmp[0];
2379 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2380 bytes--;
2381 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2382 /* Now the gap is after the just inserted data. */
2383 pos = GPT;
2384 p = GAP_END_ADDR;
2385 if (pos <= begv)
2386 begv += bytes;
2387 if (pos <= zv)
2388 zv += bytes;
2389 if (pos <= pt)
2390 pt += bytes;
2391 pend = Z_ADDR;
2392 stop = Z;
2396 if (pt != PT)
2397 TEMP_SET_PT (pt);
2399 if (narrowed)
2400 Fnarrow_to_region (make_number (begv), make_number (zv));
2402 /* Do this first, so that chars_in_text asks the right question.
2403 set_intervals_multibyte needs it too. */
2404 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2406 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2407 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2409 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2411 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2412 if (BEGV_BYTE > GPT_BYTE)
2413 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2414 else
2415 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2417 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2418 if (ZV_BYTE > GPT_BYTE)
2419 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2420 else
2421 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2424 ptrdiff_t byte = advance_to_char_boundary (PT_BYTE);
2425 ptrdiff_t position;
2427 if (byte > GPT_BYTE)
2428 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2429 else
2430 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2431 TEMP_SET_PT_BOTH (position, byte);
2434 tail = markers = BUF_MARKERS (current_buffer);
2436 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2437 getting confused by the markers that have not yet been updated.
2438 It is also a signal that it should never create a marker. */
2439 BUF_MARKERS (current_buffer) = NULL;
2441 for (; tail; tail = tail->next)
2443 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2444 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2447 /* Make sure no markers were put on the chain
2448 while the chain value was incorrect. */
2449 if (BUF_MARKERS (current_buffer))
2450 abort ();
2452 BUF_MARKERS (current_buffer) = markers;
2454 /* Do this last, so it can calculate the new correspondences
2455 between chars and bytes. */
2456 set_intervals_multibyte (1);
2459 if (!EQ (old_undo, Qt))
2461 /* Represent all the above changes by a special undo entry. */
2462 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2463 intern ("set-buffer-multibyte"),
2464 NILP (flag) ? Qt : Qnil),
2465 old_undo);
2468 UNGCPRO;
2470 /* Changing the multibyteness of a buffer means that all windows
2471 showing that buffer must be updated thoroughly. */
2472 current_buffer->prevent_redisplay_optimizations_p = 1;
2473 ++windows_or_buffers_changed;
2475 /* Copy this buffer's new multibyte status
2476 into all of its indirect buffers. */
2477 FOR_EACH_BUFFER (other)
2478 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2480 BVAR (other, enable_multibyte_characters)
2481 = BVAR (current_buffer, enable_multibyte_characters);
2482 other->prevent_redisplay_optimizations_p = 1;
2485 /* Restore the modifiedness of the buffer. */
2486 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2487 Fset_buffer_modified_p (Qnil);
2489 /* Update coding systems of this buffer's process (if any). */
2491 Lisp_Object process;
2493 process = Fget_buffer_process (Fcurrent_buffer ());
2494 if (PROCESSP (process))
2495 setup_process_coding_systems (process);
2498 return flag;
2501 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2502 Skill_all_local_variables, 0, 0, 0,
2503 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2504 Most local variable bindings are eliminated so that the default values
2505 become effective once more. Also, the syntax table is set from
2506 `standard-syntax-table', the local keymap is set to nil,
2507 and the abbrev table from `fundamental-mode-abbrev-table'.
2508 This function also forces redisplay of the mode line.
2510 Every function to select a new major mode starts by
2511 calling this function.
2513 As a special exception, local variables whose names have
2514 a non-nil `permanent-local' property are not eliminated by this function.
2516 The first thing this function does is run
2517 the normal hook `change-major-mode-hook'. */)
2518 (void)
2520 Frun_hooks (1, &Qchange_major_mode_hook);
2522 /* Make sure none of the bindings in local_var_alist
2523 remain swapped in, in their symbols. */
2525 swap_out_buffer_local_variables (current_buffer);
2527 /* Actually eliminate all local bindings of this buffer. */
2529 reset_buffer_local_variables (current_buffer, 0);
2531 /* Force mode-line redisplay. Useful here because all major mode
2532 commands call this function. */
2533 update_mode_lines++;
2535 return Qnil;
2538 /* Make sure no local variables remain set up with buffer B
2539 for their current values. */
2541 static void
2542 swap_out_buffer_local_variables (struct buffer *b)
2544 Lisp_Object oalist, alist, buffer;
2546 XSETBUFFER (buffer, b);
2547 oalist = BVAR (b, local_var_alist);
2549 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2551 Lisp_Object sym = XCAR (XCAR (alist));
2552 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2553 /* Need not do anything if some other buffer's binding is
2554 now cached. */
2555 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2557 /* Symbol is set up for this buffer's old local value:
2558 swap it out! */
2559 swap_in_global_binding (XSYMBOL (sym));
2564 /* Find all the overlays in the current buffer that contain position POS.
2565 Return the number found, and store them in a vector in *VEC_PTR.
2566 Store in *LEN_PTR the size allocated for the vector.
2567 Store in *NEXT_PTR the next position after POS where an overlay starts,
2568 or ZV if there are no more overlays between POS and ZV.
2569 Store in *PREV_PTR the previous position before POS where an overlay ends,
2570 or where an overlay starts which ends at or after POS;
2571 or BEGV if there are no such overlays from BEGV to POS.
2572 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2574 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2575 when this function is called.
2577 If EXTEND is non-zero, we make the vector bigger if necessary.
2578 If EXTEND is zero, we never extend the vector,
2579 and we store only as many overlays as will fit.
2580 But we still return the total number of overlays.
2582 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2583 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2584 default (BEGV or ZV). */
2586 ptrdiff_t
2587 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2588 ptrdiff_t *len_ptr,
2589 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr, int change_req)
2591 Lisp_Object overlay, start, end;
2592 struct Lisp_Overlay *tail;
2593 ptrdiff_t idx = 0;
2594 ptrdiff_t len = *len_ptr;
2595 Lisp_Object *vec = *vec_ptr;
2596 ptrdiff_t next = ZV;
2597 ptrdiff_t prev = BEGV;
2598 int inhibit_storing = 0;
2600 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2602 ptrdiff_t startpos, endpos;
2604 XSETMISC (overlay, tail);
2606 start = OVERLAY_START (overlay);
2607 end = OVERLAY_END (overlay);
2608 endpos = OVERLAY_POSITION (end);
2609 if (endpos < pos)
2611 if (prev < endpos)
2612 prev = endpos;
2613 break;
2615 startpos = OVERLAY_POSITION (start);
2616 /* This one ends at or after POS
2617 so its start counts for PREV_PTR if it's before POS. */
2618 if (prev < startpos && startpos < pos)
2619 prev = startpos;
2620 if (endpos == pos)
2621 continue;
2622 if (startpos <= pos)
2624 if (idx == len)
2626 /* The supplied vector is full.
2627 Either make it bigger, or don't store any more in it. */
2628 if (extend)
2630 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2631 sizeof *vec);
2632 *vec_ptr = vec;
2633 len = *len_ptr;
2635 else
2636 inhibit_storing = 1;
2639 if (!inhibit_storing)
2640 vec[idx] = overlay;
2641 /* Keep counting overlays even if we can't return them all. */
2642 idx++;
2644 else if (startpos < next)
2645 next = startpos;
2648 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2650 ptrdiff_t startpos, endpos;
2652 XSETMISC (overlay, tail);
2654 start = OVERLAY_START (overlay);
2655 end = OVERLAY_END (overlay);
2656 startpos = OVERLAY_POSITION (start);
2657 if (pos < startpos)
2659 if (startpos < next)
2660 next = startpos;
2661 break;
2663 endpos = OVERLAY_POSITION (end);
2664 if (pos < endpos)
2666 if (idx == len)
2668 if (extend)
2670 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2671 sizeof *vec);
2672 *vec_ptr = vec;
2673 len = *len_ptr;
2675 else
2676 inhibit_storing = 1;
2679 if (!inhibit_storing)
2680 vec[idx] = overlay;
2681 idx++;
2683 if (startpos < pos && startpos > prev)
2684 prev = startpos;
2686 else if (endpos < pos && endpos > prev)
2687 prev = endpos;
2688 else if (endpos == pos && startpos > prev
2689 && (!change_req || startpos < pos))
2690 prev = startpos;
2693 if (next_ptr)
2694 *next_ptr = next;
2695 if (prev_ptr)
2696 *prev_ptr = prev;
2697 return idx;
2700 /* Find all the overlays in the current buffer that overlap the range
2701 BEG-END, or are empty at BEG, or are empty at END provided END
2702 denotes the position at the end of the current buffer.
2704 Return the number found, and store them in a vector in *VEC_PTR.
2705 Store in *LEN_PTR the size allocated for the vector.
2706 Store in *NEXT_PTR the next position after POS where an overlay starts,
2707 or ZV if there are no more overlays.
2708 Store in *PREV_PTR the previous position before POS where an overlay ends,
2709 or BEGV if there are no previous overlays.
2710 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2712 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2713 when this function is called.
2715 If EXTEND is non-zero, we make the vector bigger if necessary.
2716 If EXTEND is zero, we never extend the vector,
2717 and we store only as many overlays as will fit.
2718 But we still return the total number of overlays. */
2720 static ptrdiff_t
2721 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2722 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2723 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr)
2725 Lisp_Object overlay, ostart, oend;
2726 struct Lisp_Overlay *tail;
2727 ptrdiff_t idx = 0;
2728 ptrdiff_t len = *len_ptr;
2729 Lisp_Object *vec = *vec_ptr;
2730 ptrdiff_t next = ZV;
2731 ptrdiff_t prev = BEGV;
2732 int inhibit_storing = 0;
2733 int end_is_Z = end == Z;
2735 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2737 ptrdiff_t startpos, endpos;
2739 XSETMISC (overlay, tail);
2741 ostart = OVERLAY_START (overlay);
2742 oend = OVERLAY_END (overlay);
2743 endpos = OVERLAY_POSITION (oend);
2744 if (endpos < beg)
2746 if (prev < endpos)
2747 prev = endpos;
2748 break;
2750 startpos = OVERLAY_POSITION (ostart);
2751 /* Count an interval if it overlaps the range, is empty at the
2752 start of the range, or is empty at END provided END denotes the
2753 end of the buffer. */
2754 if ((beg < endpos && startpos < end)
2755 || (startpos == endpos
2756 && (beg == endpos || (end_is_Z && endpos == end))))
2758 if (idx == len)
2760 /* The supplied vector is full.
2761 Either make it bigger, or don't store any more in it. */
2762 if (extend)
2764 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2765 sizeof *vec);
2766 *vec_ptr = vec;
2767 len = *len_ptr;
2769 else
2770 inhibit_storing = 1;
2773 if (!inhibit_storing)
2774 vec[idx] = overlay;
2775 /* Keep counting overlays even if we can't return them all. */
2776 idx++;
2778 else if (startpos < next)
2779 next = startpos;
2782 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2784 ptrdiff_t startpos, endpos;
2786 XSETMISC (overlay, tail);
2788 ostart = OVERLAY_START (overlay);
2789 oend = OVERLAY_END (overlay);
2790 startpos = OVERLAY_POSITION (ostart);
2791 if (end < startpos)
2793 if (startpos < next)
2794 next = startpos;
2795 break;
2797 endpos = OVERLAY_POSITION (oend);
2798 /* Count an interval if it overlaps the range, is empty at the
2799 start of the range, or is empty at END provided END denotes the
2800 end of the buffer. */
2801 if ((beg < endpos && startpos < end)
2802 || (startpos == endpos
2803 && (beg == endpos || (end_is_Z && endpos == end))))
2805 if (idx == len)
2807 if (extend)
2809 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2810 sizeof *vec);
2811 *vec_ptr = vec;
2812 len = *len_ptr;
2814 else
2815 inhibit_storing = 1;
2818 if (!inhibit_storing)
2819 vec[idx] = overlay;
2820 idx++;
2822 else if (endpos < beg && endpos > prev)
2823 prev = endpos;
2826 if (next_ptr)
2827 *next_ptr = next;
2828 if (prev_ptr)
2829 *prev_ptr = prev;
2830 return idx;
2834 /* Return non-zero if there exists an overlay with a non-nil
2835 `mouse-face' property overlapping OVERLAY. */
2838 mouse_face_overlay_overlaps (Lisp_Object overlay)
2840 ptrdiff_t start = OVERLAY_POSITION (OVERLAY_START (overlay));
2841 ptrdiff_t end = OVERLAY_POSITION (OVERLAY_END (overlay));
2842 ptrdiff_t n, i, size;
2843 Lisp_Object *v, tem;
2845 size = 10;
2846 v = alloca (size * sizeof *v);
2847 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2848 if (n > size)
2850 v = alloca (n * sizeof *v);
2851 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2854 for (i = 0; i < n; ++i)
2855 if (!EQ (v[i], overlay)
2856 && (tem = Foverlay_get (overlay, Qmouse_face),
2857 !NILP (tem)))
2858 break;
2860 return i < n;
2865 /* Fast function to just test if we're at an overlay boundary. */
2867 overlay_touches_p (ptrdiff_t pos)
2869 Lisp_Object overlay;
2870 struct Lisp_Overlay *tail;
2872 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2874 ptrdiff_t endpos;
2876 XSETMISC (overlay ,tail);
2877 eassert (OVERLAYP (overlay));
2879 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2880 if (endpos < pos)
2881 break;
2882 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2883 return 1;
2886 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2888 ptrdiff_t startpos;
2890 XSETMISC (overlay, tail);
2891 eassert (OVERLAYP (overlay));
2893 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2894 if (pos < startpos)
2895 break;
2896 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2897 return 1;
2899 return 0;
2902 struct sortvec
2904 Lisp_Object overlay;
2905 ptrdiff_t beg, end;
2906 EMACS_INT priority;
2909 static int
2910 compare_overlays (const void *v1, const void *v2)
2912 const struct sortvec *s1 = (const struct sortvec *) v1;
2913 const struct sortvec *s2 = (const struct sortvec *) v2;
2914 if (s1->priority != s2->priority)
2915 return s1->priority < s2->priority ? -1 : 1;
2916 if (s1->beg != s2->beg)
2917 return s1->beg < s2->beg ? -1 : 1;
2918 if (s1->end != s2->end)
2919 return s2->end < s1->end ? -1 : 1;
2920 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
2921 between "equal" overlays. The result can still change between
2922 invocations of Emacs, but it won't change in the middle of
2923 `find_field' (bug#6830). */
2924 if (XHASH (s1->overlay) != XHASH (s2->overlay))
2925 return XHASH (s1->overlay) < XHASH (s2->overlay) ? -1 : 1;
2926 return 0;
2929 /* Sort an array of overlays by priority. The array is modified in place.
2930 The return value is the new size; this may be smaller than the original
2931 size if some of the overlays were invalid or were window-specific. */
2932 ptrdiff_t
2933 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2935 ptrdiff_t i, j;
2936 struct sortvec *sortvec = alloca (noverlays * sizeof *sortvec);
2938 /* Put the valid and relevant overlays into sortvec. */
2940 for (i = 0, j = 0; i < noverlays; i++)
2942 Lisp_Object tem;
2943 Lisp_Object overlay;
2945 overlay = overlay_vec[i];
2946 if (OVERLAYP (overlay)
2947 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2948 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2950 /* If we're interested in a specific window, then ignore
2951 overlays that are limited to some other window. */
2952 if (w)
2954 Lisp_Object window;
2956 window = Foverlay_get (overlay, Qwindow);
2957 if (WINDOWP (window) && XWINDOW (window) != w)
2958 continue;
2961 /* This overlay is good and counts: put it into sortvec. */
2962 sortvec[j].overlay = overlay;
2963 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2964 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2965 tem = Foverlay_get (overlay, Qpriority);
2966 if (INTEGERP (tem))
2967 sortvec[j].priority = XINT (tem);
2968 else
2969 sortvec[j].priority = 0;
2970 j++;
2973 noverlays = j;
2975 /* Sort the overlays into the proper order: increasing priority. */
2977 if (noverlays > 1)
2978 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2980 for (i = 0; i < noverlays; i++)
2981 overlay_vec[i] = sortvec[i].overlay;
2982 return (noverlays);
2985 struct sortstr
2987 Lisp_Object string, string2;
2988 ptrdiff_t size;
2989 EMACS_INT priority;
2992 struct sortstrlist
2994 struct sortstr *buf; /* An array that expands as needed; never freed. */
2995 ptrdiff_t size; /* Allocated length of that array. */
2996 ptrdiff_t used; /* How much of the array is currently in use. */
2997 ptrdiff_t bytes; /* Total length of the strings in buf. */
3000 /* Buffers for storing information about the overlays touching a given
3001 position. These could be automatic variables in overlay_strings, but
3002 it's more efficient to hold onto the memory instead of repeatedly
3003 allocating and freeing it. */
3004 static struct sortstrlist overlay_heads, overlay_tails;
3005 static unsigned char *overlay_str_buf;
3007 /* Allocated length of overlay_str_buf. */
3008 static ptrdiff_t overlay_str_len;
3010 /* A comparison function suitable for passing to qsort. */
3011 static int
3012 cmp_for_strings (const void *as1, const void *as2)
3014 struct sortstr *s1 = (struct sortstr *)as1;
3015 struct sortstr *s2 = (struct sortstr *)as2;
3016 if (s1->size != s2->size)
3017 return s2->size < s1->size ? -1 : 1;
3018 if (s1->priority != s2->priority)
3019 return s1->priority < s2->priority ? -1 : 1;
3020 return 0;
3023 static void
3024 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
3025 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
3027 ptrdiff_t nbytes;
3029 if (ssl->used == ssl->size)
3030 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
3031 ssl->buf[ssl->used].string = str;
3032 ssl->buf[ssl->used].string2 = str2;
3033 ssl->buf[ssl->used].size = size;
3034 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3035 ssl->used++;
3037 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3038 nbytes = SCHARS (str);
3039 else if (! STRING_MULTIBYTE (str))
3040 nbytes = count_size_as_multibyte (SDATA (str),
3041 SBYTES (str));
3042 else
3043 nbytes = SBYTES (str);
3045 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
3046 memory_full (SIZE_MAX);
3047 ssl->bytes += nbytes;
3049 if (STRINGP (str2))
3051 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3052 nbytes = SCHARS (str2);
3053 else if (! STRING_MULTIBYTE (str2))
3054 nbytes = count_size_as_multibyte (SDATA (str2),
3055 SBYTES (str2));
3056 else
3057 nbytes = SBYTES (str2);
3059 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
3060 memory_full (SIZE_MAX);
3061 ssl->bytes += nbytes;
3065 /* Return the concatenation of the strings associated with overlays that
3066 begin or end at POS, ignoring overlays that are specific to a window
3067 other than W. The strings are concatenated in the appropriate order:
3068 shorter overlays nest inside longer ones, and higher priority inside
3069 lower. Normally all of the after-strings come first, but zero-sized
3070 overlays have their after-strings ride along with the before-strings
3071 because it would look strange to print them inside-out.
3073 Returns the string length, and stores the contents indirectly through
3074 PSTR, if that variable is non-null. The string may be overwritten by
3075 subsequent calls. */
3077 ptrdiff_t
3078 overlay_strings (ptrdiff_t pos, struct window *w, unsigned char **pstr)
3080 Lisp_Object overlay, window, str;
3081 struct Lisp_Overlay *ov;
3082 ptrdiff_t startpos, endpos;
3083 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3085 overlay_heads.used = overlay_heads.bytes = 0;
3086 overlay_tails.used = overlay_tails.bytes = 0;
3087 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3089 XSETMISC (overlay, ov);
3090 eassert (OVERLAYP (overlay));
3092 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3093 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3094 if (endpos < pos)
3095 break;
3096 if (endpos != pos && startpos != pos)
3097 continue;
3098 window = Foverlay_get (overlay, Qwindow);
3099 if (WINDOWP (window) && XWINDOW (window) != w)
3100 continue;
3101 if (startpos == pos
3102 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3103 record_overlay_string (&overlay_heads, str,
3104 (startpos == endpos
3105 ? Foverlay_get (overlay, Qafter_string)
3106 : Qnil),
3107 Foverlay_get (overlay, Qpriority),
3108 endpos - startpos);
3109 else if (endpos == pos
3110 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3111 record_overlay_string (&overlay_tails, str, Qnil,
3112 Foverlay_get (overlay, Qpriority),
3113 endpos - startpos);
3115 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3117 XSETMISC (overlay, ov);
3118 eassert (OVERLAYP (overlay));
3120 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3121 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3122 if (startpos > pos)
3123 break;
3124 if (endpos != pos && startpos != pos)
3125 continue;
3126 window = Foverlay_get (overlay, Qwindow);
3127 if (WINDOWP (window) && XWINDOW (window) != w)
3128 continue;
3129 if (startpos == pos
3130 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3131 record_overlay_string (&overlay_heads, str,
3132 (startpos == endpos
3133 ? Foverlay_get (overlay, Qafter_string)
3134 : Qnil),
3135 Foverlay_get (overlay, Qpriority),
3136 endpos - startpos);
3137 else if (endpos == pos
3138 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3139 record_overlay_string (&overlay_tails, str, Qnil,
3140 Foverlay_get (overlay, Qpriority),
3141 endpos - startpos);
3143 if (overlay_tails.used > 1)
3144 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3145 cmp_for_strings);
3146 if (overlay_heads.used > 1)
3147 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3148 cmp_for_strings);
3149 if (overlay_heads.bytes || overlay_tails.bytes)
3151 Lisp_Object tem;
3152 ptrdiff_t i;
3153 unsigned char *p;
3154 ptrdiff_t total;
3156 if (INT_ADD_OVERFLOW (overlay_heads.bytes, overlay_tails.bytes))
3157 memory_full (SIZE_MAX);
3158 total = overlay_heads.bytes + overlay_tails.bytes;
3159 if (total > overlay_str_len)
3160 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3161 total - overlay_str_len, -1, 1);
3163 p = overlay_str_buf;
3164 for (i = overlay_tails.used; --i >= 0;)
3166 ptrdiff_t nbytes;
3167 tem = overlay_tails.buf[i].string;
3168 nbytes = copy_text (SDATA (tem), p,
3169 SBYTES (tem),
3170 STRING_MULTIBYTE (tem), multibyte);
3171 p += nbytes;
3173 for (i = 0; i < overlay_heads.used; ++i)
3175 ptrdiff_t nbytes;
3176 tem = overlay_heads.buf[i].string;
3177 nbytes = copy_text (SDATA (tem), p,
3178 SBYTES (tem),
3179 STRING_MULTIBYTE (tem), multibyte);
3180 p += nbytes;
3181 tem = overlay_heads.buf[i].string2;
3182 if (STRINGP (tem))
3184 nbytes = copy_text (SDATA (tem), p,
3185 SBYTES (tem),
3186 STRING_MULTIBYTE (tem), multibyte);
3187 p += nbytes;
3190 if (p != overlay_str_buf + total)
3191 abort ();
3192 if (pstr)
3193 *pstr = overlay_str_buf;
3194 return total;
3196 return 0;
3199 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3201 void
3202 recenter_overlay_lists (struct buffer *buf, ptrdiff_t pos)
3204 Lisp_Object overlay, beg, end;
3205 struct Lisp_Overlay *prev, *tail, *next;
3207 /* See if anything in overlays_before should move to overlays_after. */
3209 /* We don't strictly need prev in this loop; it should always be nil.
3210 But we use it for symmetry and in case that should cease to be true
3211 with some future change. */
3212 prev = NULL;
3213 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3215 next = tail->next;
3216 XSETMISC (overlay, tail);
3217 eassert (OVERLAYP (overlay));
3219 beg = OVERLAY_START (overlay);
3220 end = OVERLAY_END (overlay);
3222 if (OVERLAY_POSITION (end) > pos)
3224 /* OVERLAY needs to be moved. */
3225 ptrdiff_t where = OVERLAY_POSITION (beg);
3226 struct Lisp_Overlay *other, *other_prev;
3228 /* Splice the cons cell TAIL out of overlays_before. */
3229 if (prev)
3230 prev->next = next;
3231 else
3232 buf->overlays_before = next;
3234 /* Search thru overlays_after for where to put it. */
3235 other_prev = NULL;
3236 for (other = buf->overlays_after; other;
3237 other_prev = other, other = other->next)
3239 Lisp_Object otherbeg, otheroverlay;
3241 XSETMISC (otheroverlay, other);
3242 eassert (OVERLAYP (otheroverlay));
3244 otherbeg = OVERLAY_START (otheroverlay);
3245 if (OVERLAY_POSITION (otherbeg) >= where)
3246 break;
3249 /* Add TAIL to overlays_after before OTHER. */
3250 tail->next = other;
3251 if (other_prev)
3252 other_prev->next = tail;
3253 else
3254 buf->overlays_after = tail;
3255 tail = prev;
3257 else
3258 /* We've reached the things that should stay in overlays_before.
3259 All the rest of overlays_before must end even earlier,
3260 so stop now. */
3261 break;
3264 /* See if anything in overlays_after should be in overlays_before. */
3265 prev = NULL;
3266 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3268 next = tail->next;
3269 XSETMISC (overlay, tail);
3270 eassert (OVERLAYP (overlay));
3272 beg = OVERLAY_START (overlay);
3273 end = OVERLAY_END (overlay);
3275 /* Stop looking, when we know that nothing further
3276 can possibly end before POS. */
3277 if (OVERLAY_POSITION (beg) > pos)
3278 break;
3280 if (OVERLAY_POSITION (end) <= pos)
3282 /* OVERLAY needs to be moved. */
3283 ptrdiff_t where = OVERLAY_POSITION (end);
3284 struct Lisp_Overlay *other, *other_prev;
3286 /* Splice the cons cell TAIL out of overlays_after. */
3287 if (prev)
3288 prev->next = next;
3289 else
3290 buf->overlays_after = next;
3292 /* Search thru overlays_before for where to put it. */
3293 other_prev = NULL;
3294 for (other = buf->overlays_before; other;
3295 other_prev = other, other = other->next)
3297 Lisp_Object otherend, otheroverlay;
3299 XSETMISC (otheroverlay, other);
3300 eassert (OVERLAYP (otheroverlay));
3302 otherend = OVERLAY_END (otheroverlay);
3303 if (OVERLAY_POSITION (otherend) <= where)
3304 break;
3307 /* Add TAIL to overlays_before before OTHER. */
3308 tail->next = other;
3309 if (other_prev)
3310 other_prev->next = tail;
3311 else
3312 buf->overlays_before = tail;
3313 tail = prev;
3317 buf->overlay_center = pos;
3320 void
3321 adjust_overlays_for_insert (ptrdiff_t pos, ptrdiff_t length)
3323 /* After an insertion, the lists are still sorted properly,
3324 but we may need to update the value of the overlay center. */
3325 if (current_buffer->overlay_center >= pos)
3326 current_buffer->overlay_center += length;
3329 void
3330 adjust_overlays_for_delete (ptrdiff_t pos, ptrdiff_t length)
3332 if (current_buffer->overlay_center < pos)
3333 /* The deletion was to our right. No change needed; the before- and
3334 after-lists are still consistent. */
3336 else if (current_buffer->overlay_center - pos > length)
3337 /* The deletion was to our left. We need to adjust the center value
3338 to account for the change in position, but the lists are consistent
3339 given the new value. */
3340 current_buffer->overlay_center -= length;
3341 else
3342 /* We're right in the middle. There might be things on the after-list
3343 that now belong on the before-list. Recentering will move them,
3344 and also update the center point. */
3345 recenter_overlay_lists (current_buffer, pos);
3348 /* Fix up overlays that were garbled as a result of permuting markers
3349 in the range START through END. Any overlay with at least one
3350 endpoint in this range will need to be unlinked from the overlay
3351 list and reinserted in its proper place.
3352 Such an overlay might even have negative size at this point.
3353 If so, we'll make the overlay empty. */
3354 void
3355 fix_start_end_in_overlays (register ptrdiff_t start, register ptrdiff_t end)
3357 Lisp_Object overlay;
3358 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3359 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3360 /* These are either nil, indicating that before_list or after_list
3361 should be assigned, or the cons cell the cdr of which should be
3362 assigned. */
3363 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3364 /* 'Parent', likewise, indicates a cons cell or
3365 current_buffer->overlays_before or overlays_after, depending
3366 which loop we're in. */
3367 struct Lisp_Overlay *tail, *parent;
3368 ptrdiff_t startpos, endpos;
3370 /* This algorithm shifts links around instead of consing and GCing.
3371 The loop invariant is that before_list (resp. after_list) is a
3372 well-formed list except that its last element, the CDR of beforep
3373 (resp. afterp) if beforep (afterp) isn't nil or before_list
3374 (after_list) if it is, is still uninitialized. So it's not a bug
3375 that before_list isn't initialized, although it may look
3376 strange. */
3377 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3379 XSETMISC (overlay, tail);
3381 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3382 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3384 /* If the overlay is backwards, make it empty. */
3385 if (endpos < startpos)
3387 startpos = endpos;
3388 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3389 Qnil);
3392 if (endpos < start)
3393 break;
3395 if (endpos < end
3396 || (startpos >= start && startpos < end))
3398 /* Add it to the end of the wrong list. Later on,
3399 recenter_overlay_lists will move it to the right place. */
3400 if (endpos < current_buffer->overlay_center)
3402 if (!afterp)
3403 after_list = tail;
3404 else
3405 afterp->next = tail;
3406 afterp = tail;
3408 else
3410 if (!beforep)
3411 before_list = tail;
3412 else
3413 beforep->next = tail;
3414 beforep = tail;
3416 if (!parent)
3417 current_buffer->overlays_before = tail->next;
3418 else
3419 parent->next = tail->next;
3420 tail = tail->next;
3422 else
3423 parent = tail, tail = parent->next;
3425 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3427 XSETMISC (overlay, tail);
3429 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3430 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3432 /* If the overlay is backwards, make it empty. */
3433 if (endpos < startpos)
3435 startpos = endpos;
3436 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3437 Qnil);
3440 if (startpos >= end)
3441 break;
3443 if (startpos >= start
3444 || (endpos >= start && endpos < end))
3446 if (endpos < current_buffer->overlay_center)
3448 if (!afterp)
3449 after_list = tail;
3450 else
3451 afterp->next = tail;
3452 afterp = tail;
3454 else
3456 if (!beforep)
3457 before_list = tail;
3458 else
3459 beforep->next = tail;
3460 beforep = tail;
3462 if (!parent)
3463 current_buffer->overlays_after = tail->next;
3464 else
3465 parent->next = tail->next;
3466 tail = tail->next;
3468 else
3469 parent = tail, tail = parent->next;
3472 /* Splice the constructed (wrong) lists into the buffer's lists,
3473 and let the recenter function make it sane again. */
3474 if (beforep)
3476 beforep->next = current_buffer->overlays_before;
3477 current_buffer->overlays_before = before_list;
3479 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3481 if (afterp)
3483 afterp->next = current_buffer->overlays_after;
3484 current_buffer->overlays_after = after_list;
3486 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3489 /* We have two types of overlay: the one whose ending marker is
3490 after-insertion-marker (this is the usual case) and the one whose
3491 ending marker is before-insertion-marker. When `overlays_before'
3492 contains overlays of the latter type and the former type in this
3493 order and both overlays end at inserting position, inserting a text
3494 increases only the ending marker of the latter type, which results
3495 in incorrect ordering of `overlays_before'.
3497 This function fixes ordering of overlays in the slot
3498 `overlays_before' of the buffer *BP. Before the insertion, `point'
3499 was at PREV, and now is at POS. */
3501 void
3502 fix_overlays_before (struct buffer *bp, ptrdiff_t prev, ptrdiff_t pos)
3504 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3505 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3506 Lisp_Object tem;
3507 ptrdiff_t end IF_LINT (= 0);
3509 /* After the insertion, the several overlays may be in incorrect
3510 order. The possibility is that, in the list `overlays_before',
3511 an overlay which ends at POS appears after an overlay which ends
3512 at PREV. Since POS is greater than PREV, we must fix the
3513 ordering of these overlays, by moving overlays ends at POS before
3514 the overlays ends at PREV. */
3516 /* At first, find a place where disordered overlays should be linked
3517 in. It is where an overlay which end before POS exists. (i.e. an
3518 overlay whose ending marker is after-insertion-marker if disorder
3519 exists). */
3520 while (tail
3521 && (XSETMISC (tem, tail),
3522 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3524 parent = tail;
3525 tail = tail->next;
3528 /* If we don't find such an overlay,
3529 or the found one ends before PREV,
3530 or the found one is the last one in the list,
3531 we don't have to fix anything. */
3532 if (!tail || end < prev || !tail->next)
3533 return;
3535 right_pair = parent;
3536 parent = tail;
3537 tail = tail->next;
3539 /* Now, end position of overlays in the list TAIL should be before
3540 or equal to PREV. In the loop, an overlay which ends at POS is
3541 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3542 we found an overlay which ends before PREV, the remaining
3543 overlays are in correct order. */
3544 while (tail)
3546 XSETMISC (tem, tail);
3547 end = OVERLAY_POSITION (OVERLAY_END (tem));
3549 if (end == pos)
3550 { /* This overlay is disordered. */
3551 struct Lisp_Overlay *found = tail;
3553 /* Unlink the found overlay. */
3554 tail = found->next;
3555 parent->next = tail;
3556 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3557 and link it into the right place. */
3558 if (!right_pair)
3560 found->next = bp->overlays_before;
3561 bp->overlays_before = found;
3563 else
3565 found->next = right_pair->next;
3566 right_pair->next = found;
3569 else if (end == prev)
3571 parent = tail;
3572 tail = tail->next;
3574 else /* No more disordered overlay. */
3575 break;
3579 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3580 doc: /* Return t if OBJECT is an overlay. */)
3581 (Lisp_Object object)
3583 return (OVERLAYP (object) ? Qt : Qnil);
3586 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3587 doc: /* Create a new overlay with range BEG to END in BUFFER.
3588 If omitted, BUFFER defaults to the current buffer.
3589 BEG and END may be integers or markers.
3590 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3591 for the front of the overlay advance when text is inserted there
3592 \(which means the text *is not* included in the overlay).
3593 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3594 for the rear of the overlay advance when text is inserted there
3595 \(which means the text *is* included in the overlay). */)
3596 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3598 Lisp_Object overlay;
3599 struct buffer *b;
3601 if (NILP (buffer))
3602 XSETBUFFER (buffer, current_buffer);
3603 else
3604 CHECK_BUFFER (buffer);
3605 if (MARKERP (beg)
3606 && ! EQ (Fmarker_buffer (beg), buffer))
3607 error ("Marker points into wrong buffer");
3608 if (MARKERP (end)
3609 && ! EQ (Fmarker_buffer (end), buffer))
3610 error ("Marker points into wrong buffer");
3612 CHECK_NUMBER_COERCE_MARKER (beg);
3613 CHECK_NUMBER_COERCE_MARKER (end);
3615 if (XINT (beg) > XINT (end))
3617 Lisp_Object temp;
3618 temp = beg; beg = end; end = temp;
3621 b = XBUFFER (buffer);
3623 beg = Fset_marker (Fmake_marker (), beg, buffer);
3624 end = Fset_marker (Fmake_marker (), end, buffer);
3626 if (!NILP (front_advance))
3627 XMARKER (beg)->insertion_type = 1;
3628 if (!NILP (rear_advance))
3629 XMARKER (end)->insertion_type = 1;
3631 overlay = build_overlay (beg, end, Qnil);
3633 /* Put the new overlay on the wrong list. */
3634 end = OVERLAY_END (overlay);
3635 if (OVERLAY_POSITION (end) < b->overlay_center)
3637 if (b->overlays_after)
3638 XOVERLAY (overlay)->next = b->overlays_after;
3639 b->overlays_after = XOVERLAY (overlay);
3641 else
3643 if (b->overlays_before)
3644 XOVERLAY (overlay)->next = b->overlays_before;
3645 b->overlays_before = XOVERLAY (overlay);
3648 /* This puts it in the right list, and in the right order. */
3649 recenter_overlay_lists (b, b->overlay_center);
3651 /* We don't need to redisplay the region covered by the overlay, because
3652 the overlay has no properties at the moment. */
3654 return overlay;
3657 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3659 static void
3660 modify_overlay (struct buffer *buf, ptrdiff_t start, ptrdiff_t end)
3662 if (start > end)
3664 ptrdiff_t temp = start;
3665 start = end;
3666 end = temp;
3669 BUF_COMPUTE_UNCHANGED (buf, start, end);
3671 /* If this is a buffer not in the selected window,
3672 we must do other windows. */
3673 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3674 windows_or_buffers_changed = 1;
3675 /* If multiple windows show this buffer, we must do other windows. */
3676 else if (buffer_shared > 1)
3677 windows_or_buffers_changed = 1;
3678 /* If we modify an overlay at the end of the buffer, we cannot
3679 be sure that window end is still valid. */
3680 else if (end >= ZV && start <= ZV)
3681 windows_or_buffers_changed = 1;
3683 ++BUF_OVERLAY_MODIFF (buf);
3686 /* Remove OVERLAY from LIST. */
3688 static struct Lisp_Overlay *
3689 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3691 register struct Lisp_Overlay *tail, **prev = &list;
3693 for (tail = list; tail; prev = &tail->next, tail = *prev)
3694 if (tail == overlay)
3696 *prev = overlay->next;
3697 overlay->next = NULL;
3698 break;
3700 return list;
3703 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3704 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3705 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3706 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3707 buffer. */)
3708 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3710 struct buffer *b, *ob = 0;
3711 Lisp_Object obuffer;
3712 ptrdiff_t count = SPECPDL_INDEX ();
3713 ptrdiff_t n_beg, n_end, o_beg IF_LINT (= 0), o_end IF_LINT (= 0);
3715 CHECK_OVERLAY (overlay);
3716 if (NILP (buffer))
3717 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3718 if (NILP (buffer))
3719 XSETBUFFER (buffer, current_buffer);
3720 CHECK_BUFFER (buffer);
3722 if (NILP (Fbuffer_live_p (buffer)))
3723 error ("Attempt to move overlay to a dead buffer");
3725 if (MARKERP (beg)
3726 && ! EQ (Fmarker_buffer (beg), buffer))
3727 error ("Marker points into wrong buffer");
3728 if (MARKERP (end)
3729 && ! EQ (Fmarker_buffer (end), buffer))
3730 error ("Marker points into wrong buffer");
3732 CHECK_NUMBER_COERCE_MARKER (beg);
3733 CHECK_NUMBER_COERCE_MARKER (end);
3735 if (XINT (beg) > XINT (end))
3737 Lisp_Object temp;
3738 temp = beg; beg = end; end = temp;
3741 specbind (Qinhibit_quit, Qt);
3743 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3744 b = XBUFFER (buffer);
3746 if (!NILP (obuffer))
3748 ob = XBUFFER (obuffer);
3750 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3751 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3753 ob->overlays_before =
3754 unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3755 ob->overlays_after =
3756 unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3757 eassert (XOVERLAY (overlay)->next == NULL);
3760 /* Set the overlay boundaries, which may clip them. */
3761 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3762 Fset_marker (OVERLAY_END (overlay), end, buffer);
3764 n_beg = marker_position (OVERLAY_START (overlay));
3765 n_end = marker_position (OVERLAY_END (overlay));
3767 /* If the overlay has changed buffers, do a thorough redisplay. */
3768 if (!EQ (buffer, obuffer))
3770 /* Redisplay where the overlay was. */
3771 if (ob)
3772 modify_overlay (ob, o_beg, o_end);
3774 /* Redisplay where the overlay is going to be. */
3775 modify_overlay (b, n_beg, n_end);
3777 else
3778 /* Redisplay the area the overlay has just left, or just enclosed. */
3780 if (o_beg == n_beg)
3781 modify_overlay (b, o_end, n_end);
3782 else if (o_end == n_end)
3783 modify_overlay (b, o_beg, n_beg);
3784 else
3785 modify_overlay (b, min (o_beg, n_beg), max (o_end, n_end));
3788 /* Delete the overlay if it is empty after clipping and has the
3789 evaporate property. */
3790 if (n_beg == n_end && !NILP (Foverlay_get (overlay, Qevaporate)))
3791 return unbind_to (count, Fdelete_overlay (overlay));
3793 /* Put the overlay into the new buffer's overlay lists, first on the
3794 wrong list. */
3795 if (n_end < b->overlay_center)
3797 XOVERLAY (overlay)->next = b->overlays_after;
3798 b->overlays_after = XOVERLAY (overlay);
3800 else
3802 XOVERLAY (overlay)->next = b->overlays_before;
3803 b->overlays_before = XOVERLAY (overlay);
3806 /* This puts it in the right list, and in the right order. */
3807 recenter_overlay_lists (b, b->overlay_center);
3809 return unbind_to (count, overlay);
3812 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3813 doc: /* Delete the overlay OVERLAY from its buffer. */)
3814 (Lisp_Object overlay)
3816 Lisp_Object buffer;
3817 struct buffer *b;
3818 ptrdiff_t count = SPECPDL_INDEX ();
3820 CHECK_OVERLAY (overlay);
3822 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3823 if (NILP (buffer))
3824 return Qnil;
3826 b = XBUFFER (buffer);
3827 specbind (Qinhibit_quit, Qt);
3829 b->overlays_before
3830 = unchain_overlay (b->overlays_before, XOVERLAY (overlay));
3831 b->overlays_after
3832 = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3833 eassert (XOVERLAY (overlay)->next == NULL);
3835 drop_overlay (b, XOVERLAY (overlay));
3837 /* When deleting an overlay with before or after strings, turn off
3838 display optimizations for the affected buffer, on the basis that
3839 these strings may contain newlines. This is easier to do than to
3840 check for that situation during redisplay. */
3841 if (!windows_or_buffers_changed
3842 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3843 || !NILP (Foverlay_get (overlay, Qafter_string))))
3844 b->prevent_redisplay_optimizations_p = 1;
3846 return unbind_to (count, Qnil);
3849 /* Overlay dissection functions. */
3851 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3852 doc: /* Return the position at which OVERLAY starts. */)
3853 (Lisp_Object overlay)
3855 CHECK_OVERLAY (overlay);
3857 return (Fmarker_position (OVERLAY_START (overlay)));
3860 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3861 doc: /* Return the position at which OVERLAY ends. */)
3862 (Lisp_Object overlay)
3864 CHECK_OVERLAY (overlay);
3866 return (Fmarker_position (OVERLAY_END (overlay)));
3869 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3870 doc: /* Return the buffer OVERLAY belongs to.
3871 Return nil if OVERLAY has been deleted. */)
3872 (Lisp_Object overlay)
3874 CHECK_OVERLAY (overlay);
3876 return Fmarker_buffer (OVERLAY_START (overlay));
3879 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3880 doc: /* Return a list of the properties on OVERLAY.
3881 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3882 OVERLAY. */)
3883 (Lisp_Object overlay)
3885 CHECK_OVERLAY (overlay);
3887 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3891 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3892 doc: /* Return a list of the overlays that contain the character at POS. */)
3893 (Lisp_Object pos)
3895 ptrdiff_t len, noverlays;
3896 Lisp_Object *overlay_vec;
3897 Lisp_Object result;
3899 CHECK_NUMBER_COERCE_MARKER (pos);
3901 len = 10;
3902 /* We can't use alloca here because overlays_at can call xrealloc. */
3903 overlay_vec = xmalloc (len * sizeof *overlay_vec);
3905 /* Put all the overlays we want in a vector in overlay_vec.
3906 Store the length in len. */
3907 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3908 0, 0, 0);
3910 /* Make a list of them all. */
3911 result = Flist (noverlays, overlay_vec);
3913 xfree (overlay_vec);
3914 return result;
3917 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3918 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3919 Overlap means that at least one character is contained within the overlay
3920 and also contained within the specified region.
3921 Empty overlays are included in the result if they are located at BEG,
3922 between BEG and END, or at END provided END denotes the position at the
3923 end of the buffer. */)
3924 (Lisp_Object beg, Lisp_Object end)
3926 ptrdiff_t len, noverlays;
3927 Lisp_Object *overlay_vec;
3928 Lisp_Object result;
3930 CHECK_NUMBER_COERCE_MARKER (beg);
3931 CHECK_NUMBER_COERCE_MARKER (end);
3933 len = 10;
3934 overlay_vec = xmalloc (len * sizeof *overlay_vec);
3936 /* Put all the overlays we want in a vector in overlay_vec.
3937 Store the length in len. */
3938 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3939 NULL, NULL);
3941 /* Make a list of them all. */
3942 result = Flist (noverlays, overlay_vec);
3944 xfree (overlay_vec);
3945 return result;
3948 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3949 1, 1, 0,
3950 doc: /* Return the next position after POS where an overlay starts or ends.
3951 If there are no overlay boundaries from POS to (point-max),
3952 the value is (point-max). */)
3953 (Lisp_Object pos)
3955 ptrdiff_t i, len, noverlays;
3956 ptrdiff_t endpos;
3957 Lisp_Object *overlay_vec;
3959 CHECK_NUMBER_COERCE_MARKER (pos);
3961 len = 10;
3962 overlay_vec = xmalloc (len * sizeof *overlay_vec);
3964 /* Put all the overlays we want in a vector in overlay_vec.
3965 Store the length in len.
3966 endpos gets the position where the next overlay starts. */
3967 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3968 &endpos, 0, 1);
3970 /* If any of these overlays ends before endpos,
3971 use its ending point instead. */
3972 for (i = 0; i < noverlays; i++)
3974 Lisp_Object oend;
3975 ptrdiff_t oendpos;
3977 oend = OVERLAY_END (overlay_vec[i]);
3978 oendpos = OVERLAY_POSITION (oend);
3979 if (oendpos < endpos)
3980 endpos = oendpos;
3983 xfree (overlay_vec);
3984 return make_number (endpos);
3987 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3988 Sprevious_overlay_change, 1, 1, 0,
3989 doc: /* Return the previous position before POS where an overlay starts or ends.
3990 If there are no overlay boundaries from (point-min) to POS,
3991 the value is (point-min). */)
3992 (Lisp_Object pos)
3994 ptrdiff_t prevpos;
3995 Lisp_Object *overlay_vec;
3996 ptrdiff_t len;
3998 CHECK_NUMBER_COERCE_MARKER (pos);
4000 /* At beginning of buffer, we know the answer;
4001 avoid bug subtracting 1 below. */
4002 if (XINT (pos) == BEGV)
4003 return pos;
4005 len = 10;
4006 overlay_vec = xmalloc (len * sizeof *overlay_vec);
4008 /* Put all the overlays we want in a vector in overlay_vec.
4009 Store the length in len.
4010 prevpos gets the position of the previous change. */
4011 overlays_at (XINT (pos), 1, &overlay_vec, &len,
4012 0, &prevpos, 1);
4014 xfree (overlay_vec);
4015 return make_number (prevpos);
4018 /* These functions are for debugging overlays. */
4020 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4021 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4022 The car has all the overlays before the overlay center;
4023 the cdr has all the overlays after the overlay center.
4024 Recentering overlays moves overlays between these lists.
4025 The lists you get are copies, so that changing them has no effect.
4026 However, the overlays you get are the real objects that the buffer uses. */)
4027 (void)
4029 struct Lisp_Overlay *ol;
4030 Lisp_Object before = Qnil, after = Qnil, tmp;
4031 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4033 XSETMISC (tmp, ol);
4034 before = Fcons (tmp, before);
4036 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4038 XSETMISC (tmp, ol);
4039 after = Fcons (tmp, after);
4041 return Fcons (Fnreverse (before), Fnreverse (after));
4044 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4045 doc: /* Recenter the overlays of the current buffer around position POS.
4046 That makes overlay lookup faster for positions near POS (but perhaps slower
4047 for positions far away from POS). */)
4048 (Lisp_Object pos)
4050 ptrdiff_t p;
4051 CHECK_NUMBER_COERCE_MARKER (pos);
4053 p = clip_to_bounds (PTRDIFF_MIN, XINT (pos), PTRDIFF_MAX);
4054 recenter_overlay_lists (current_buffer, p);
4055 return Qnil;
4058 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4059 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4060 (Lisp_Object overlay, Lisp_Object prop)
4062 CHECK_OVERLAY (overlay);
4063 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4066 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4067 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4068 VALUE will be returned.*/)
4069 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4071 Lisp_Object tail, buffer;
4072 int changed;
4074 CHECK_OVERLAY (overlay);
4076 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4078 for (tail = XOVERLAY (overlay)->plist;
4079 CONSP (tail) && CONSP (XCDR (tail));
4080 tail = XCDR (XCDR (tail)))
4081 if (EQ (XCAR (tail), prop))
4083 changed = !EQ (XCAR (XCDR (tail)), value);
4084 XSETCAR (XCDR (tail), value);
4085 goto found;
4087 /* It wasn't in the list, so add it to the front. */
4088 changed = !NILP (value);
4089 XOVERLAY (overlay)->plist
4090 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4091 found:
4092 if (! NILP (buffer))
4094 if (changed)
4095 modify_overlay (XBUFFER (buffer),
4096 marker_position (OVERLAY_START (overlay)),
4097 marker_position (OVERLAY_END (overlay)));
4098 if (EQ (prop, Qevaporate) && ! NILP (value)
4099 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4100 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4101 Fdelete_overlay (overlay);
4104 return value;
4107 /* Subroutine of report_overlay_modification. */
4109 /* Lisp vector holding overlay hook functions to call.
4110 Vector elements come in pairs.
4111 Each even-index element is a list of hook functions.
4112 The following odd-index element is the overlay they came from.
4114 Before the buffer change, we fill in this vector
4115 as we call overlay hook functions.
4116 After the buffer change, we get the functions to call from this vector.
4117 This way we always call the same functions before and after the change. */
4118 static Lisp_Object last_overlay_modification_hooks;
4120 /* Number of elements actually used in last_overlay_modification_hooks. */
4121 static ptrdiff_t last_overlay_modification_hooks_used;
4123 /* Add one functionlist/overlay pair
4124 to the end of last_overlay_modification_hooks. */
4126 static void
4127 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4129 ptrdiff_t oldsize = ASIZE (last_overlay_modification_hooks);
4131 if (oldsize - 1 <= last_overlay_modification_hooks_used)
4132 last_overlay_modification_hooks =
4133 larger_vector (last_overlay_modification_hooks, 2, -1);
4134 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4135 functionlist); last_overlay_modification_hooks_used++;
4136 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4137 overlay); last_overlay_modification_hooks_used++;
4140 /* Run the modification-hooks of overlays that include
4141 any part of the text in START to END.
4142 If this change is an insertion, also
4143 run the insert-before-hooks of overlay starting at END,
4144 and the insert-after-hooks of overlay ending at START.
4146 This is called both before and after the modification.
4147 AFTER is nonzero when we call after the modification.
4149 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4150 When AFTER is nonzero, they are the start position,
4151 the position after the inserted new text,
4152 and the length of deleted or replaced old text. */
4154 void
4155 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4156 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4158 Lisp_Object prop, overlay;
4159 struct Lisp_Overlay *tail;
4160 /* 1 if this change is an insertion. */
4161 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4162 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4164 overlay = Qnil;
4165 tail = NULL;
4167 /* We used to run the functions as soon as we found them and only register
4168 them in last_overlay_modification_hooks for the purpose of the `after'
4169 case. But running elisp code as we traverse the list of overlays is
4170 painful because the list can be modified by the elisp code so we had to
4171 copy at several places. We now simply do a read-only traversal that
4172 only collects the functions to run and we run them afterwards. It's
4173 simpler, especially since all the code was already there. -stef */
4175 if (!after)
4177 /* We are being called before a change.
4178 Scan the overlays to find the functions to call. */
4179 last_overlay_modification_hooks_used = 0;
4180 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4182 ptrdiff_t startpos, endpos;
4183 Lisp_Object ostart, oend;
4185 XSETMISC (overlay, tail);
4187 ostart = OVERLAY_START (overlay);
4188 oend = OVERLAY_END (overlay);
4189 endpos = OVERLAY_POSITION (oend);
4190 if (XFASTINT (start) > endpos)
4191 break;
4192 startpos = OVERLAY_POSITION (ostart);
4193 if (insertion && (XFASTINT (start) == startpos
4194 || XFASTINT (end) == startpos))
4196 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4197 if (!NILP (prop))
4198 add_overlay_mod_hooklist (prop, overlay);
4200 if (insertion && (XFASTINT (start) == endpos
4201 || XFASTINT (end) == endpos))
4203 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4204 if (!NILP (prop))
4205 add_overlay_mod_hooklist (prop, overlay);
4207 /* Test for intersecting intervals. This does the right thing
4208 for both insertion and deletion. */
4209 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4211 prop = Foverlay_get (overlay, Qmodification_hooks);
4212 if (!NILP (prop))
4213 add_overlay_mod_hooklist (prop, overlay);
4217 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4219 ptrdiff_t startpos, endpos;
4220 Lisp_Object ostart, oend;
4222 XSETMISC (overlay, tail);
4224 ostart = OVERLAY_START (overlay);
4225 oend = OVERLAY_END (overlay);
4226 startpos = OVERLAY_POSITION (ostart);
4227 endpos = OVERLAY_POSITION (oend);
4228 if (XFASTINT (end) < startpos)
4229 break;
4230 if (insertion && (XFASTINT (start) == startpos
4231 || XFASTINT (end) == startpos))
4233 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4234 if (!NILP (prop))
4235 add_overlay_mod_hooklist (prop, overlay);
4237 if (insertion && (XFASTINT (start) == endpos
4238 || XFASTINT (end) == endpos))
4240 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4241 if (!NILP (prop))
4242 add_overlay_mod_hooklist (prop, overlay);
4244 /* Test for intersecting intervals. This does the right thing
4245 for both insertion and deletion. */
4246 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4248 prop = Foverlay_get (overlay, Qmodification_hooks);
4249 if (!NILP (prop))
4250 add_overlay_mod_hooklist (prop, overlay);
4255 GCPRO4 (overlay, arg1, arg2, arg3);
4257 /* Call the functions recorded in last_overlay_modification_hooks.
4258 First copy the vector contents, in case some of these hooks
4259 do subsequent modification of the buffer. */
4260 ptrdiff_t size = last_overlay_modification_hooks_used;
4261 Lisp_Object *copy = alloca (size * sizeof *copy);
4262 ptrdiff_t i;
4264 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4265 size * sizeof (Lisp_Object));
4266 gcpro1.var = copy;
4267 gcpro1.nvars = size;
4269 for (i = 0; i < size;)
4271 Lisp_Object prop_i, overlay_i;
4272 prop_i = copy[i++];
4273 overlay_i = copy[i++];
4274 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4277 UNGCPRO;
4280 static void
4281 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4282 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4284 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4286 GCPRO4 (list, arg1, arg2, arg3);
4288 while (CONSP (list))
4290 if (NILP (arg3))
4291 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4292 else
4293 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4294 list = XCDR (list);
4296 UNGCPRO;
4299 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4300 property is set. */
4301 void
4302 evaporate_overlays (ptrdiff_t pos)
4304 Lisp_Object overlay, hit_list;
4305 struct Lisp_Overlay *tail;
4307 hit_list = Qnil;
4308 if (pos <= current_buffer->overlay_center)
4309 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4311 ptrdiff_t endpos;
4312 XSETMISC (overlay, tail);
4313 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4314 if (endpos < pos)
4315 break;
4316 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4317 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4318 hit_list = Fcons (overlay, hit_list);
4320 else
4321 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4323 ptrdiff_t startpos;
4324 XSETMISC (overlay, tail);
4325 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4326 if (startpos > pos)
4327 break;
4328 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4329 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4330 hit_list = Fcons (overlay, hit_list);
4332 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4333 Fdelete_overlay (XCAR (hit_list));
4336 /* Somebody has tried to store a value with an unacceptable type
4337 in the slot with offset OFFSET. */
4339 void
4340 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4342 Lisp_Object predicate;
4344 switch (type)
4346 case_Lisp_Int: predicate = Qintegerp; break;
4347 case Lisp_String: predicate = Qstringp; break;
4348 case Lisp_Symbol: predicate = Qsymbolp; break;
4349 default: abort ();
4352 wrong_type_argument (predicate, newval);
4356 /***********************************************************************
4357 Allocation with mmap
4358 ***********************************************************************/
4360 #ifdef USE_MMAP_FOR_BUFFERS
4362 #include <sys/types.h>
4363 #include <sys/mman.h>
4365 #ifndef MAP_ANON
4366 #ifdef MAP_ANONYMOUS
4367 #define MAP_ANON MAP_ANONYMOUS
4368 #else
4369 #define MAP_ANON 0
4370 #endif
4371 #endif
4373 #ifndef MAP_FAILED
4374 #define MAP_FAILED ((void *) -1)
4375 #endif
4377 #include <stdio.h>
4379 #if MAP_ANON == 0
4380 #include <fcntl.h>
4381 #endif
4383 #include "coding.h"
4386 /* Memory is allocated in regions which are mapped using mmap(2).
4387 The current implementation lets the system select mapped
4388 addresses; we're not using MAP_FIXED in general, except when
4389 trying to enlarge regions.
4391 Each mapped region starts with a mmap_region structure, the user
4392 area starts after that structure, aligned to MEM_ALIGN.
4394 +-----------------------+
4395 | struct mmap_info + |
4396 | padding |
4397 +-----------------------+
4398 | user data |
4401 +-----------------------+ */
4403 struct mmap_region
4405 /* User-specified size. */
4406 size_t nbytes_specified;
4408 /* Number of bytes mapped */
4409 size_t nbytes_mapped;
4411 /* Pointer to the location holding the address of the memory
4412 allocated with the mmap'd block. The variable actually points
4413 after this structure. */
4414 void **var;
4416 /* Next and previous in list of all mmap'd regions. */
4417 struct mmap_region *next, *prev;
4420 /* Doubly-linked list of mmap'd regions. */
4422 static struct mmap_region *mmap_regions;
4424 /* File descriptor for mmap. If we don't have anonymous mapping,
4425 /dev/zero will be opened on it. */
4427 static int mmap_fd;
4429 /* Temporary storage for mmap_set_vars, see there. */
4431 static struct mmap_region *mmap_regions_1;
4432 static int mmap_fd_1;
4434 /* Page size on this system. */
4436 static int mmap_page_size;
4438 /* 1 means mmap has been initialized. */
4440 static int mmap_initialized_p;
4442 /* Value is X rounded up to the next multiple of N. */
4444 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4446 /* Size of mmap_region structure plus padding. */
4448 #define MMAP_REGION_STRUCT_SIZE \
4449 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4451 /* Given a pointer P to the start of the user-visible part of a mapped
4452 region, return a pointer to the start of the region. */
4454 #define MMAP_REGION(P) \
4455 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4457 /* Given a pointer P to the start of a mapped region, return a pointer
4458 to the start of the user-visible part of the region. */
4460 #define MMAP_USER_AREA(P) \
4461 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4463 #define MEM_ALIGN sizeof (double)
4465 /* Predicate returning true if part of the address range [START .. END]
4466 is currently mapped. Used to prevent overwriting an existing
4467 memory mapping.
4469 Default is to conservatively assume the address range is occupied by
4470 something else. This can be overridden by system configuration
4471 files if system-specific means to determine this exists. */
4473 #ifndef MMAP_ALLOCATED_P
4474 #define MMAP_ALLOCATED_P(start, end) 1
4475 #endif
4477 /* Perform necessary initializations for the use of mmap. */
4479 static void
4480 mmap_init (void)
4482 #if MAP_ANON == 0
4483 /* The value of mmap_fd is initially 0 in temacs, and -1
4484 in a dumped Emacs. */
4485 if (mmap_fd <= 0)
4487 /* No anonymous mmap -- we need the file descriptor. */
4488 mmap_fd = open ("/dev/zero", O_RDONLY);
4489 if (mmap_fd == -1)
4490 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4492 #endif /* MAP_ANON == 0 */
4494 if (mmap_initialized_p)
4495 return;
4496 mmap_initialized_p = 1;
4498 #if MAP_ANON != 0
4499 mmap_fd = -1;
4500 #endif
4502 mmap_page_size = getpagesize ();
4505 /* Return a region overlapping address range START...END, or null if
4506 none. END is not including, i.e. the last byte in the range
4507 is at END - 1. */
4509 static struct mmap_region *
4510 mmap_find (void *start, void *end)
4512 struct mmap_region *r;
4513 char *s = (char *) start, *e = (char *) end;
4515 for (r = mmap_regions; r; r = r->next)
4517 char *rstart = (char *) r;
4518 char *rend = rstart + r->nbytes_mapped;
4520 if (/* First byte of range, i.e. START, in this region? */
4521 (s >= rstart && s < rend)
4522 /* Last byte of range, i.e. END - 1, in this region? */
4523 || (e > rstart && e <= rend)
4524 /* First byte of this region in the range? */
4525 || (rstart >= s && rstart < e)
4526 /* Last byte of this region in the range? */
4527 || (rend > s && rend <= e))
4528 break;
4531 return r;
4535 /* Unmap a region. P is a pointer to the start of the user-araa of
4536 the region. Value is non-zero if successful. */
4538 static int
4539 mmap_free_1 (struct mmap_region *r)
4541 if (r->next)
4542 r->next->prev = r->prev;
4543 if (r->prev)
4544 r->prev->next = r->next;
4545 else
4546 mmap_regions = r->next;
4548 if (munmap (r, r->nbytes_mapped) == -1)
4550 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4551 return 0;
4554 return 1;
4558 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4559 Value is non-zero if successful. */
4561 static int
4562 mmap_enlarge (struct mmap_region *r, int npages)
4564 char *region_end = (char *) r + r->nbytes_mapped;
4565 size_t nbytes;
4566 int success = 0;
4568 if (npages < 0)
4570 /* Unmap pages at the end of the region. */
4571 nbytes = - npages * mmap_page_size;
4572 if (munmap (region_end - nbytes, nbytes) == -1)
4573 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4574 else
4576 r->nbytes_mapped -= nbytes;
4577 success = 1;
4580 else if (npages > 0)
4582 nbytes = npages * mmap_page_size;
4584 /* Try to map additional pages at the end of the region. We
4585 cannot do this if the address range is already occupied by
4586 something else because mmap deletes any previous mapping.
4587 I'm not sure this is worth doing, let's see. */
4588 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4590 void *p;
4592 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4593 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4594 if (p == MAP_FAILED)
4595 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4596 else if (p != region_end)
4598 /* Kernels are free to choose a different address. In
4599 that case, unmap what we've mapped above; we have
4600 no use for it. */
4601 if (munmap (p, nbytes) == -1)
4602 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4604 else
4606 r->nbytes_mapped += nbytes;
4607 success = 1;
4612 return success;
4616 /* Set or reset variables holding references to mapped regions. If
4617 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4618 non-zero, set all variables to the start of the user-areas
4619 of mapped regions.
4621 This function is called from Fdump_emacs to ensure that the dumped
4622 Emacs doesn't contain references to memory that won't be mapped
4623 when Emacs starts. */
4625 void
4626 mmap_set_vars (int restore_p)
4628 struct mmap_region *r;
4630 if (restore_p)
4632 mmap_regions = mmap_regions_1;
4633 mmap_fd = mmap_fd_1;
4634 for (r = mmap_regions; r; r = r->next)
4635 *r->var = MMAP_USER_AREA (r);
4637 else
4639 for (r = mmap_regions; r; r = r->next)
4640 *r->var = NULL;
4641 mmap_regions_1 = mmap_regions;
4642 mmap_regions = NULL;
4643 mmap_fd_1 = mmap_fd;
4644 mmap_fd = -1;
4649 /* Allocate a block of storage large enough to hold NBYTES bytes of
4650 data. A pointer to the data is returned in *VAR. VAR is thus the
4651 address of some variable which will use the data area.
4653 The allocation of 0 bytes is valid.
4655 If we can't allocate the necessary memory, set *VAR to null, and
4656 return null. */
4658 static void *
4659 mmap_alloc (void **var, size_t nbytes)
4661 void *p;
4662 size_t map;
4664 mmap_init ();
4666 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4667 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4668 mmap_fd, 0);
4670 if (p == MAP_FAILED)
4672 if (errno != ENOMEM)
4673 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4674 p = NULL;
4676 else
4678 struct mmap_region *r = (struct mmap_region *) p;
4680 r->nbytes_specified = nbytes;
4681 r->nbytes_mapped = map;
4682 r->var = var;
4683 r->prev = NULL;
4684 r->next = mmap_regions;
4685 if (r->next)
4686 r->next->prev = r;
4687 mmap_regions = r;
4689 p = MMAP_USER_AREA (p);
4692 return *var = p;
4696 /* Free a block of relocatable storage whose data is pointed to by
4697 PTR. Store 0 in *PTR to show there's no block allocated. */
4699 static void
4700 mmap_free (void **var)
4702 mmap_init ();
4704 if (*var)
4706 mmap_free_1 (MMAP_REGION (*var));
4707 *var = NULL;
4712 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4713 resize it to size NBYTES. Change *VAR to reflect the new block,
4714 and return this value. If more memory cannot be allocated, then
4715 leave *VAR unchanged, and return null. */
4717 static void *
4718 mmap_realloc (void **var, size_t nbytes)
4720 void *result;
4722 mmap_init ();
4724 if (*var == NULL)
4725 result = mmap_alloc (var, nbytes);
4726 else if (nbytes == 0)
4728 mmap_free (var);
4729 result = mmap_alloc (var, nbytes);
4731 else
4733 struct mmap_region *r = MMAP_REGION (*var);
4734 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4736 if (room < nbytes)
4738 /* Must enlarge. */
4739 void *old_ptr = *var;
4741 /* Try to map additional pages at the end of the region.
4742 If that fails, allocate a new region, copy data
4743 from the old region, then free it. */
4744 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4745 / mmap_page_size)))
4747 r->nbytes_specified = nbytes;
4748 *var = result = old_ptr;
4750 else if (mmap_alloc (var, nbytes))
4752 memcpy (*var, old_ptr, r->nbytes_specified);
4753 mmap_free_1 (MMAP_REGION (old_ptr));
4754 result = *var;
4755 r = MMAP_REGION (result);
4756 r->nbytes_specified = nbytes;
4758 else
4760 *var = old_ptr;
4761 result = NULL;
4764 else if (room - nbytes >= mmap_page_size)
4766 /* Shrinking by at least a page. Let's give some
4767 memory back to the system.
4769 The extra parens are to make the division happens first,
4770 on positive values, so we know it will round towards
4771 zero. */
4772 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4773 result = *var;
4774 r->nbytes_specified = nbytes;
4776 else
4778 /* Leave it alone. */
4779 result = *var;
4780 r->nbytes_specified = nbytes;
4784 return result;
4788 #endif /* USE_MMAP_FOR_BUFFERS */
4792 /***********************************************************************
4793 Buffer-text Allocation
4794 ***********************************************************************/
4796 /* Allocate NBYTES bytes for buffer B's text buffer. */
4798 static void
4799 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4801 void *p;
4803 BLOCK_INPUT;
4804 #if defined USE_MMAP_FOR_BUFFERS
4805 p = mmap_alloc ((void **) &b->text->beg, nbytes);
4806 #elif defined REL_ALLOC
4807 p = r_alloc ((void **) &b->text->beg, nbytes);
4808 #else
4809 p = xmalloc (nbytes);
4810 #endif
4812 if (p == NULL)
4814 UNBLOCK_INPUT;
4815 memory_full (nbytes);
4818 b->text->beg = (unsigned char *) p;
4819 UNBLOCK_INPUT;
4822 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4823 shrink it. */
4825 void
4826 enlarge_buffer_text (struct buffer *b, ptrdiff_t delta)
4828 void *p;
4829 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4830 + delta);
4831 BLOCK_INPUT;
4832 #if defined USE_MMAP_FOR_BUFFERS
4833 p = mmap_realloc ((void **) &b->text->beg, nbytes);
4834 #elif defined REL_ALLOC
4835 p = r_re_alloc ((void **) &b->text->beg, nbytes);
4836 #else
4837 p = xrealloc (b->text->beg, nbytes);
4838 #endif
4840 if (p == NULL)
4842 UNBLOCK_INPUT;
4843 memory_full (nbytes);
4846 BUF_BEG_ADDR (b) = (unsigned char *) p;
4847 UNBLOCK_INPUT;
4851 /* Free buffer B's text buffer. */
4853 static void
4854 free_buffer_text (struct buffer *b)
4856 BLOCK_INPUT;
4858 #if defined USE_MMAP_FOR_BUFFERS
4859 mmap_free ((void **) &b->text->beg);
4860 #elif defined REL_ALLOC
4861 r_alloc_free ((void **) &b->text->beg);
4862 #else
4863 xfree (b->text->beg);
4864 #endif
4866 BUF_BEG_ADDR (b) = NULL;
4867 UNBLOCK_INPUT;
4872 /***********************************************************************
4873 Initialization
4874 ***********************************************************************/
4876 void
4877 init_buffer_once (void)
4879 int idx;
4880 /* If you add, remove, or reorder Lisp_Objects in a struct buffer, make
4881 sure that this is still correct. Otherwise, mark_vectorlike may not
4882 trace all Lisp_Objects in buffer_defaults and buffer_local_symbols. */
4883 const int pvecsize
4884 = (offsetof (struct buffer, own_text) - sizeof (struct vectorlike_header))
4885 / sizeof (Lisp_Object);
4887 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4889 /* Make sure all markable slots in buffer_defaults
4890 are initialized reasonably, so mark_buffer won't choke. */
4891 reset_buffer (&buffer_defaults);
4892 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4893 reset_buffer_local_variables (&buffer_defaults, 1);
4894 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4895 reset_buffer (&buffer_local_symbols);
4896 reset_buffer_local_variables (&buffer_local_symbols, 1);
4897 /* Prevent GC from getting confused. */
4898 buffer_defaults.text = &buffer_defaults.own_text;
4899 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4900 /* No one will share the text with these buffers, but let's play it safe. */
4901 buffer_defaults.indirections = 0;
4902 buffer_local_symbols.indirections = 0;
4903 BUF_INTERVALS (&buffer_defaults) = 0;
4904 BUF_INTERVALS (&buffer_local_symbols) = 0;
4905 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, pvecsize);
4906 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4907 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, pvecsize);
4908 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4910 /* Set up the default values of various buffer slots. */
4911 /* Must do these before making the first buffer! */
4913 /* real setup is done in bindings.el */
4914 BVAR (&buffer_defaults, mode_line_format) = build_pure_c_string ("%-");
4915 BVAR (&buffer_defaults, header_line_format) = Qnil;
4916 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4917 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4918 BVAR (&buffer_defaults, case_fold_search) = Qt;
4919 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4920 BVAR (&buffer_defaults, selective_display) = Qnil;
4921 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4922 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4923 BVAR (&buffer_defaults, display_table) = Qnil;
4924 BVAR (&buffer_defaults, undo_list) = Qnil;
4925 BVAR (&buffer_defaults, mark_active) = Qnil;
4926 BVAR (&buffer_defaults, file_format) = Qnil;
4927 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4928 buffer_defaults.overlays_before = NULL;
4929 buffer_defaults.overlays_after = NULL;
4930 buffer_defaults.overlay_center = BEG;
4932 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4933 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4934 BVAR (&buffer_defaults, word_wrap) = Qnil;
4935 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4936 BVAR (&buffer_defaults, bidi_display_reordering) = Qt;
4937 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4938 BVAR (&buffer_defaults, cursor_type) = Qt;
4939 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4940 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4942 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4943 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4944 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4945 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4946 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4947 BVAR (&buffer_defaults, file_truename) = Qnil;
4948 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4949 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4950 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4951 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4952 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4953 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4954 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4955 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4956 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4957 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4958 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4959 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4960 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4961 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4962 BVAR (&buffer_defaults, display_time) = Qnil;
4964 /* Assign the local-flags to the slots that have default values.
4965 The local flag is a bit that is used in the buffer
4966 to say that it has its own local value for the slot.
4967 The local flag bits are in the local_var_flags slot of the buffer. */
4969 /* Nothing can work if this isn't true */
4970 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4972 /* 0 means not a lisp var, -1 means always local, else mask */
4973 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4974 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4975 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4976 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4977 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4978 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4979 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4980 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4981 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4982 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4983 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4984 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4985 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4986 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4987 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4988 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4989 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4990 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4991 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4993 idx = 1;
4994 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4995 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4996 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4997 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
4998 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
5009 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5010 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
5011 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5014 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5015 /* Make this one a permanent local. */
5016 buffer_permanent_local_flags[idx++] = 1;
5017 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5018 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5019 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5020 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5021 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5022 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5023 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5024 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5025 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5026 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5027 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5028 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5029 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5030 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5031 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5032 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5033 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5035 /* Need more room? */
5036 if (idx >= MAX_PER_BUFFER_VARS)
5037 abort ();
5038 last_per_buffer_idx = idx;
5040 Vbuffer_alist = Qnil;
5041 current_buffer = 0;
5042 all_buffers = 0;
5044 QSFundamental = build_pure_c_string ("Fundamental");
5046 Qfundamental_mode = intern_c_string ("fundamental-mode");
5047 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5049 Qmode_class = intern_c_string ("mode-class");
5051 Qprotected_field = intern_c_string ("protected-field");
5053 Qpermanent_local = intern_c_string ("permanent-local");
5055 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5056 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5058 /* super-magic invisible buffer */
5059 Vprin1_to_string_buffer = Fget_buffer_create (build_pure_c_string (" prin1"));
5060 Vbuffer_alist = Qnil;
5062 Fset_buffer (Fget_buffer_create (build_pure_c_string ("*scratch*")));
5064 inhibit_modification_hooks = 0;
5067 void
5068 init_buffer (void)
5070 char *pwd;
5071 Lisp_Object temp;
5072 ptrdiff_t len;
5074 #ifdef USE_MMAP_FOR_BUFFERS
5076 /* When using the ralloc implementation based on mmap(2), buffer
5077 text pointers will have been set to null in the dumped Emacs.
5078 Map new memory. */
5079 struct buffer *b;
5081 FOR_EACH_BUFFER (b)
5082 if (b->text->beg == NULL)
5083 enlarge_buffer_text (b, 0);
5085 #endif /* USE_MMAP_FOR_BUFFERS */
5087 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5088 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5089 Fset_buffer_multibyte (Qnil);
5091 pwd = get_current_dir_name ();
5093 if (!pwd)
5094 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5096 /* Maybe this should really use some standard subroutine
5097 whose definition is filename syntax dependent. */
5098 len = strlen (pwd);
5099 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5101 /* Grow buffer to add directory separator and '\0'. */
5102 pwd = realloc (pwd, len + 2);
5103 if (!pwd)
5104 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5105 pwd[len] = DIRECTORY_SEP;
5106 pwd[len + 1] = '\0';
5107 len++;
5110 BVAR (current_buffer, directory) = make_unibyte_string (pwd, len);
5111 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5112 /* At this moment, we still don't know how to decode the
5113 directory name. So, we keep the bytes in multibyte form so
5114 that ENCODE_FILE correctly gets the original bytes. */
5115 BVAR (current_buffer, directory)
5116 = string_to_multibyte (BVAR (current_buffer, directory));
5118 /* Add /: to the front of the name
5119 if it would otherwise be treated as magic. */
5120 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5121 if (! NILP (temp)
5122 /* If the default dir is just /, TEMP is non-nil
5123 because of the ange-ftp completion handler.
5124 However, it is not necessary to turn / into /:/.
5125 So avoid doing that. */
5126 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5127 BVAR (current_buffer, directory)
5128 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5130 temp = get_minibuffer (0);
5131 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5133 free (pwd);
5136 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5137 Object stored in the current buffer. address is the address of the slot
5138 in the buffer that is current now. */
5140 /* TYPE is nil for a general Lisp variable.
5141 An integer specifies a type; then only Lisp values
5142 with that type code are allowed (except that nil is allowed too).
5143 LNAME is the Lisp-level variable name.
5144 VNAME is the name of the buffer slot.
5145 DOC is a dummy where you write the doc string as a comment. */
5146 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5147 do { \
5148 static struct Lisp_Buffer_Objfwd bo_fwd; \
5149 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5150 } while (0)
5152 static void
5153 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5154 Lisp_Object *address, Lisp_Object type)
5156 struct Lisp_Symbol *sym;
5157 int offset;
5159 sym = XSYMBOL (intern (namestring));
5160 offset = (char *)address - (char *)current_buffer;
5162 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5163 bo_fwd->offset = offset;
5164 bo_fwd->slottype = type;
5165 sym->declared_special = 1;
5166 sym->redirect = SYMBOL_FORWARDED;
5168 /* I tried to do the job without a cast, but it seems impossible.
5169 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5170 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5172 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5174 if (PER_BUFFER_IDX (offset) == 0)
5175 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5176 slot of buffer_local_flags */
5177 abort ();
5181 /* initialize the buffer routines */
5182 void
5183 syms_of_buffer (void)
5185 staticpro (&last_overlay_modification_hooks);
5186 last_overlay_modification_hooks
5187 = Fmake_vector (make_number (10), Qnil);
5189 staticpro (&Vbuffer_defaults);
5190 staticpro (&Vbuffer_local_symbols);
5191 staticpro (&Qfundamental_mode);
5192 staticpro (&Qmode_class);
5193 staticpro (&QSFundamental);
5194 staticpro (&Vbuffer_alist);
5195 staticpro (&Qprotected_field);
5196 staticpro (&Qpermanent_local);
5197 staticpro (&Qkill_buffer_hook);
5199 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5200 DEFSYM (Qoverlayp, "overlayp");
5201 DEFSYM (Qevaporate, "evaporate");
5202 DEFSYM (Qmodification_hooks, "modification-hooks");
5203 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5204 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5205 DEFSYM (Qget_file_buffer, "get-file-buffer");
5206 DEFSYM (Qpriority, "priority");
5207 DEFSYM (Qbefore_string, "before-string");
5208 DEFSYM (Qafter_string, "after-string");
5209 DEFSYM (Qfirst_change_hook, "first-change-hook");
5210 DEFSYM (Qbefore_change_functions, "before-change-functions");
5211 DEFSYM (Qafter_change_functions, "after-change-functions");
5212 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5214 Fput (Qprotected_field, Qerror_conditions,
5215 listn (CONSTYPE_PURE, 2, Qprotected_field, Qerror));
5216 Fput (Qprotected_field, Qerror_message,
5217 build_pure_c_string ("Attempt to modify a protected field"));
5219 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5220 mode_line_format,
5221 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5222 This is the same as (default-value 'mode-line-format). */);
5224 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5225 header_line_format,
5226 doc: /* Default value of `header-line-format' for buffers that don't override it.
5227 This is the same as (default-value 'header-line-format). */);
5229 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5230 doc: /* Default value of `cursor-type' for buffers that don't override it.
5231 This is the same as (default-value 'cursor-type). */);
5233 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5234 extra_line_spacing,
5235 doc: /* Default value of `line-spacing' for buffers that don't override it.
5236 This is the same as (default-value 'line-spacing). */);
5238 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5239 cursor_in_non_selected_windows,
5240 doc: /* Default value of `cursor-in-non-selected-windows'.
5241 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5243 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5244 abbrev_mode,
5245 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5246 This is the same as (default-value 'abbrev-mode). */);
5248 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5249 ctl_arrow,
5250 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5251 This is the same as (default-value 'ctl-arrow). */);
5253 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5254 enable_multibyte_characters,
5255 doc: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5256 This is the same as (default-value 'enable-multibyte-characters). */);
5258 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5259 buffer_file_coding_system,
5260 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5261 This is the same as (default-value 'buffer-file-coding-system). */);
5263 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5264 truncate_lines,
5265 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5266 This is the same as (default-value 'truncate-lines). */);
5268 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5269 fill_column,
5270 doc: /* Default value of `fill-column' for buffers that do not override it.
5271 This is the same as (default-value 'fill-column). */);
5273 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5274 left_margin,
5275 doc: /* Default value of `left-margin' for buffers that do not override it.
5276 This is the same as (default-value 'left-margin). */);
5278 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5279 tab_width,
5280 doc: /* Default value of `tab-width' for buffers that do not override it.
5281 This is the same as (default-value 'tab-width). */);
5283 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5284 case_fold_search,
5285 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5286 This is the same as (default-value 'case-fold-search). */);
5288 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5289 left_margin_cols,
5290 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5291 This is the same as (default-value 'left-margin-width). */);
5293 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5294 right_margin_cols,
5295 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5296 This is the same as (default-value 'right-margin-width). */);
5298 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5299 left_fringe_width,
5300 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5301 This is the same as (default-value 'left-fringe-width). */);
5303 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5304 right_fringe_width,
5305 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5306 This is the same as (default-value 'right-fringe-width). */);
5308 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5309 fringes_outside_margins,
5310 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5311 This is the same as (default-value 'fringes-outside-margins). */);
5313 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5314 scroll_bar_width,
5315 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5316 This is the same as (default-value 'scroll-bar-width). */);
5318 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5319 vertical_scroll_bar_type,
5320 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5321 This is the same as (default-value 'vertical-scroll-bar). */);
5323 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5324 indicate_empty_lines,
5325 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5326 This is the same as (default-value 'indicate-empty-lines). */);
5328 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5329 indicate_buffer_boundaries,
5330 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5331 This is the same as (default-value 'indicate-buffer-boundaries). */);
5333 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5334 fringe_indicator_alist,
5335 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5336 This is the same as (default-value 'fringe-indicator-alist'). */);
5338 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5339 fringe_cursor_alist,
5340 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5341 This is the same as (default-value 'fringe-cursor-alist'). */);
5343 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5344 scroll_up_aggressively,
5345 doc: /* Default value of `scroll-up-aggressively'.
5346 This value applies in buffers that don't have their own local values.
5347 This is the same as (default-value 'scroll-up-aggressively). */);
5349 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5350 scroll_down_aggressively,
5351 doc: /* Default value of `scroll-down-aggressively'.
5352 This value applies in buffers that don't have their own local values.
5353 This is the same as (default-value 'scroll-down-aggressively). */);
5355 DEFVAR_PER_BUFFER ("header-line-format",
5356 &BVAR (current_buffer, header_line_format),
5357 Qnil,
5358 doc: /* Analogous to `mode-line-format', but controls the header line.
5359 The header line appears, optionally, at the top of a window;
5360 the mode line appears at the bottom. */);
5362 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5363 Qnil,
5364 doc: /* Template for displaying mode line for current buffer.
5366 The value may be nil, a string, a symbol or a list.
5368 A value of nil means don't display a mode line.
5370 For any symbol other than t or nil, the symbol's value is processed as
5371 a mode line construct. As a special exception, if that value is a
5372 string, the string is processed verbatim, without handling any
5373 %-constructs (see below). Also, unless the symbol has a non-nil
5374 `risky-local-variable' property, all properties in any strings, as
5375 well as all :eval and :propertize forms in the value, are ignored.
5377 A list whose car is a string or list is processed by processing each
5378 of the list elements recursively, as separate mode line constructs,
5379 and concatenating the results.
5381 A list of the form `(:eval FORM)' is processed by evaluating FORM and
5382 using the result as a mode line construct. Be careful--FORM should
5383 not load any files, because that can cause an infinite recursion.
5385 A list of the form `(:propertize ELT PROPS...)' is processed by
5386 processing ELT as the mode line construct, and adding the text
5387 properties PROPS to the result.
5389 A list whose car is a symbol is processed by examining the symbol's
5390 value, and, if that value is non-nil, processing the cadr of the list
5391 recursively; and if that value is nil, processing the caddr of the
5392 list recursively.
5394 A list whose car is an integer is processed by processing the cadr of
5395 the list, and padding (if the number is positive) or truncating (if
5396 negative) to the width specified by that number.
5398 A string is printed verbatim in the mode line except for %-constructs:
5399 %b -- print buffer name. %f -- print visited file name.
5400 %F -- print frame name.
5401 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5402 %& is like %*, but ignore read-only-ness.
5403 % means buffer is read-only and * means it is modified.
5404 For a modified read-only buffer, %* gives % and %+ gives *.
5405 %s -- print process status. %l -- print the current line number.
5406 %c -- print the current column number (this makes editing slower).
5407 To make the column number update correctly in all cases,
5408 `column-number-mode' must be non-nil.
5409 %i -- print the size of the buffer.
5410 %I -- like %i, but use k, M, G, etc., to abbreviate.
5411 %p -- print percent of buffer above top of window, or Top, Bot or All.
5412 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5413 or print Bottom or All.
5414 %n -- print Narrow if appropriate.
5415 %t -- visited file is text or binary (if OS supports this distinction).
5416 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5417 %Z -- like %z, but including the end-of-line format.
5418 %e -- print error message about full memory.
5419 %@ -- print @ or hyphen. @ means that default-directory is on a
5420 remote machine.
5421 %[ -- print one [ for each recursive editing level. %] similar.
5422 %% -- print %. %- -- print infinitely many dashes.
5423 Decimal digits after the % specify field width to which to pad. */);
5425 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5426 doc: /* Value of `major-mode' for new buffers. */);
5428 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5429 make_number (Lisp_Symbol),
5430 doc: /* Symbol for current buffer's major mode.
5431 The default value (normally `fundamental-mode') affects new buffers.
5432 A value of nil means to use the current buffer's major mode, provided
5433 it is not marked as "special".
5435 When a mode is used by default, `find-file' switches to it before it
5436 reads the contents into the buffer and before it finishes setting up
5437 the buffer. Thus, the mode and its hooks should not expect certain
5438 variables such as `buffer-read-only' and `buffer-file-coding-system'
5439 to be set up. */);
5441 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5442 Qnil,
5443 doc: /* Pretty name of current buffer's major mode.
5444 Usually a string, but can use any of the constructs for `mode-line-format',
5445 which see.
5446 Format with `format-mode-line' to produce a string value. */);
5448 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5449 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5451 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5452 doc: /* Non-nil if Abbrev mode is enabled.
5453 Use the command `abbrev-mode' to change this variable. */);
5455 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5456 Qnil,
5457 doc: /* Non-nil if searches and matches should ignore case. */);
5459 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5460 make_number (Lisp_Int0),
5461 doc: /* Column beyond which automatic line-wrapping should happen.
5462 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5464 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5465 make_number (Lisp_Int0),
5466 doc: /* Column for the default `indent-line-function' to indent to.
5467 Linefeed indents to this column in Fundamental mode. */);
5469 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5470 make_number (Lisp_Int0),
5471 doc: /* Distance between tab stops (for display of tab characters), in columns.
5472 This should be an integer greater than zero. */);
5474 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5475 doc: /* Non-nil means display control chars with uparrow.
5476 A value of nil means use backslash and octal digits.
5477 This variable does not apply to characters whose display is specified
5478 in the current display table (if there is one). */);
5480 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5481 &BVAR (current_buffer, enable_multibyte_characters),
5482 Qnil,
5483 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5484 Otherwise they are regarded as unibyte. This affects the display,
5485 file I/O and the behavior of various editing commands.
5487 This variable is buffer-local but you cannot set it directly;
5488 use the function `set-buffer-multibyte' to change a buffer's representation.
5489 See also Info node `(elisp)Text Representations'. */);
5490 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5492 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5493 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5494 doc: /* Coding system to be used for encoding the buffer contents on saving.
5495 This variable applies to saving the buffer, and also to `write-region'
5496 and other functions that use `write-region'.
5497 It does not apply to sending output to subprocesses, however.
5499 If this is nil, the buffer is saved without any code conversion
5500 unless some coding system is specified in `file-coding-system-alist'
5501 for the buffer file.
5503 If the text to be saved cannot be encoded as specified by this variable,
5504 an alternative encoding is selected by `select-safe-coding-system', which see.
5506 The variable `coding-system-for-write', if non-nil, overrides this variable.
5508 This variable is never applied to a way of decoding a file while reading it. */);
5510 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5511 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5512 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5514 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5515 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5516 doc: /* If non-nil, forces directionality of text paragraphs in the buffer.
5518 If this is nil (the default), the direction of each paragraph is
5519 determined by the first strong directional character of its text.
5520 The values of `right-to-left' and `left-to-right' override that.
5521 Any other value is treated as nil.
5523 This variable has no effect unless the buffer's value of
5524 \`bidi-display-reordering' is non-nil. */);
5526 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5527 doc: /* Non-nil means do not display continuation lines.
5528 Instead, give each line of text just one screen line.
5530 Note that this is overridden by the variable
5531 `truncate-partial-width-windows' if that variable is non-nil
5532 and this buffer is not full-frame width.
5534 Minibuffers set this variable to nil. */);
5536 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5537 doc: /* Non-nil means to use word-wrapping for continuation lines.
5538 When word-wrapping is on, continuation lines are wrapped at the space
5539 or tab character nearest to the right window edge.
5540 If nil, continuation lines are wrapped at the right screen edge.
5542 This variable has no effect if long lines are truncated (see
5543 `truncate-lines' and `truncate-partial-width-windows'). If you use
5544 word-wrapping, you might want to reduce the value of
5545 `truncate-partial-width-windows', since wrapping can make text readable
5546 in narrower windows.
5548 Instead of setting this variable directly, most users should use
5549 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5550 to t, and additionally redefines simple editing commands to act on
5551 visual lines rather than logical lines. See the documentation of
5552 `visual-line-mode'. */);
5554 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5555 make_number (Lisp_String),
5556 doc: /* Name of default directory of current buffer. Should end with slash.
5557 To interactively change the default directory, use command `cd'. */);
5559 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5560 Qnil,
5561 doc: /* Function called (if non-nil) to perform auto-fill.
5562 It is called after self-inserting any character specified in
5563 the `auto-fill-chars' table.
5564 NOTE: This variable is not a hook;
5565 its value may not be a list of functions. */);
5567 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5568 make_number (Lisp_String),
5569 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5571 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5572 make_number (Lisp_String),
5573 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5574 The truename of a file is calculated by `file-truename'
5575 and then abbreviated with `abbreviate-file-name'. */);
5577 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5578 &BVAR (current_buffer, auto_save_file_name),
5579 make_number (Lisp_String),
5580 doc: /* Name of file for auto-saving current buffer.
5581 If it is nil, that means don't auto-save this buffer. */);
5583 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5584 doc: /* Non-nil if this buffer is read-only. */);
5586 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5587 doc: /* Non-nil if this buffer's file has been backed up.
5588 Backing up is done before the first time the file is saved. */);
5590 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5591 make_number (Lisp_Int0),
5592 doc: /* Length of current buffer when last read in, saved or auto-saved.
5593 0 initially.
5594 -1 means auto-saving turned off until next real save.
5596 If you set this to -2, that means don't turn off auto-saving in this buffer
5597 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5598 you probably should set this to -2 in that buffer. */);
5600 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5601 Qnil,
5602 doc: /* Non-nil enables selective display.
5603 An integer N as value means display only lines
5604 that start with less than N columns of space.
5605 A value of t means that the character ^M makes itself and
5606 all the rest of the line invisible; also, when saving the buffer
5607 in a file, save the ^M as a newline. */);
5609 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5610 &BVAR (current_buffer, selective_display_ellipses),
5611 Qnil,
5612 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5614 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5615 doc: /* Non-nil if self-insertion should replace existing text.
5616 The value should be one of `overwrite-mode-textual',
5617 `overwrite-mode-binary', or nil.
5618 If it is `overwrite-mode-textual', self-insertion still
5619 inserts at the end of a line, and inserts when point is before a tab,
5620 until the tab is filled in.
5621 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5623 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5624 Qnil,
5625 doc: /* Display table that controls display of the contents of current buffer.
5627 If this variable is nil, the value of `standard-display-table' is used.
5628 Each window can have its own, overriding display table, see
5629 `set-window-display-table' and `window-display-table'.
5631 The display table is a char-table created with `make-display-table'.
5632 A char-table is an array indexed by character codes. Normal array
5633 primitives `aref' and `aset' can be used to access elements of a char-table.
5635 Each of the char-table elements control how to display the corresponding
5636 text character: the element at index C in the table says how to display
5637 the character whose code is C. Each element should be a vector of
5638 characters or nil. The value nil means display the character in the
5639 default fashion; otherwise, the characters from the vector are delivered
5640 to the screen instead of the original character.
5642 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5643 to display a capital Y instead of each X character.
5645 In addition, a char-table has six extra slots to control the display of:
5647 the end of a truncated screen line (extra-slot 0, a single character);
5648 the end of a continued line (extra-slot 1, a single character);
5649 the escape character used to display character codes in octal
5650 (extra-slot 2, a single character);
5651 the character used as an arrow for control characters (extra-slot 3,
5652 a single character);
5653 the decoration indicating the presence of invisible lines (extra-slot 4,
5654 a vector of characters);
5655 the character used to draw the border between side-by-side windows
5656 (extra-slot 5, a single character).
5658 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5660 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5661 Qnil,
5662 doc: /* Width of left marginal area for display of a buffer.
5663 A value of nil means no marginal area. */);
5665 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5666 Qnil,
5667 doc: /* Width of right marginal area for display of a buffer.
5668 A value of nil means no marginal area. */);
5670 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5671 Qnil,
5672 doc: /* Width of this buffer's left fringe (in pixels).
5673 A value of 0 means no left fringe is shown in this buffer's window.
5674 A value of nil means to use the left fringe width from the window's frame. */);
5676 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5677 Qnil,
5678 doc: /* Width of this buffer's right fringe (in pixels).
5679 A value of 0 means no right fringe is shown in this buffer's window.
5680 A value of nil means to use the right fringe width from the window's frame. */);
5682 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5683 Qnil,
5684 doc: /* Non-nil means to display fringes outside display margins.
5685 A value of nil means to display fringes between margins and buffer text. */);
5687 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5688 Qnil,
5689 doc: /* Width of this buffer's scroll bars in pixels.
5690 A value of nil means to use the scroll bar width from the window's frame. */);
5692 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5693 Qnil,
5694 doc: /* Position of this buffer's vertical scroll bar.
5695 The value takes effect whenever you tell a window to display this buffer;
5696 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5698 A value of `left' or `right' means put the vertical scroll bar at that side
5699 of the window; a value of nil means don't show any vertical scroll bars.
5700 A value of t (the default) means do whatever the window's frame specifies. */);
5702 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5703 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5704 doc: /* Visually indicate empty lines after the buffer end.
5705 If non-nil, a bitmap is displayed in the left fringe of a window on
5706 window-systems. */);
5708 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5709 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5710 doc: /* Visually indicate buffer boundaries and scrolling.
5711 If non-nil, the first and last line of the buffer are marked in the fringe
5712 of a window on window-systems with angle bitmaps, or if the window can be
5713 scrolled, the top and bottom line of the window are marked with up and down
5714 arrow bitmaps.
5716 If value is a symbol `left' or `right', both angle and arrow bitmaps
5717 are displayed in the left or right fringe, resp. Any other value
5718 that doesn't look like an alist means display the angle bitmaps in
5719 the left fringe but no arrows.
5721 You can exercise more precise control by using an alist as the
5722 value. Each alist element (INDICATOR . POSITION) specifies
5723 where to show one of the indicators. INDICATOR is one of `top',
5724 `bottom', `up', `down', or t, which specifies the default position,
5725 and POSITION is one of `left', `right', or nil, meaning do not show
5726 this indicator.
5728 For example, ((top . left) (t . right)) places the top angle bitmap in
5729 left fringe, the bottom angle bitmap in right fringe, and both arrow
5730 bitmaps in right fringe. To show just the angle bitmaps in the left
5731 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5733 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5734 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5735 doc: /* Mapping from logical to physical fringe indicator bitmaps.
5736 The value is an alist where each element (INDICATOR . BITMAPS)
5737 specifies the fringe bitmaps used to display a specific logical
5738 fringe indicator.
5740 INDICATOR specifies the logical indicator type which is one of the
5741 following symbols: `truncation' , `continuation', `overlay-arrow',
5742 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5744 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5745 the actual bitmap shown in the left or right fringe for the logical
5746 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5747 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5748 are used only for the `bottom' and `top-bottom' indicators when the
5749 last (only) line has no final newline. BITMAPS may also be a single
5750 symbol which is used in both left and right fringes. */);
5752 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5753 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5754 doc: /* Mapping from logical to physical fringe cursor bitmaps.
5755 The value is an alist where each element (CURSOR . BITMAP)
5756 specifies the fringe bitmaps used to display a specific logical
5757 cursor type in the fringe.
5759 CURSOR specifies the logical cursor type which is one of the following
5760 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5761 one is used to show a hollow cursor on narrow lines display lines
5762 where the normal hollow cursor will not fit.
5764 BITMAP is the corresponding fringe bitmap shown for the logical
5765 cursor type. */);
5767 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5768 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5769 doc: /* How far to scroll windows upward.
5770 If you move point off the bottom, the window scrolls automatically.
5771 This variable controls how far it scrolls. The value nil, the default,
5772 means scroll to center point. A fraction means scroll to put point
5773 that fraction of the window's height from the bottom of the window.
5774 When the value is 0.0, point goes at the bottom line, which in the
5775 simple case that you moved off with C-f means scrolling just one line.
5776 1.0 means point goes at the top, so that in that simple case, the
5777 window scrolls by a full window height. Meaningful values are
5778 between 0.0 and 1.0, inclusive. */);
5780 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5781 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5782 doc: /* How far to scroll windows downward.
5783 If you move point off the top, the window scrolls automatically.
5784 This variable controls how far it scrolls. The value nil, the default,
5785 means scroll to center point. A fraction means scroll to put point
5786 that fraction of the window's height from the top of the window.
5787 When the value is 0.0, point goes at the top line, which in the
5788 simple case that you moved off with C-b means scrolling just one line.
5789 1.0 means point goes at the bottom, so that in that simple case, the
5790 window scrolls by a full window height. Meaningful values are
5791 between 0.0 and 1.0, inclusive. */);
5793 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5794 "Don't ask.");
5797 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5798 doc: /* List of functions to call before each text change.
5799 Two arguments are passed to each function: the positions of
5800 the beginning and end of the range of old text to be changed.
5801 \(For an insertion, the beginning and end are at the same place.)
5802 No information is given about the length of the text after the change.
5804 Buffer changes made while executing the `before-change-functions'
5805 don't call any before-change or after-change functions.
5806 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5808 If an unhandled error happens in running these functions,
5809 the variable's value remains nil. That prevents the error
5810 from happening repeatedly and making Emacs nonfunctional. */);
5811 Vbefore_change_functions = Qnil;
5813 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5814 doc: /* List of functions to call after each text change.
5815 Three arguments are passed to each function: the positions of
5816 the beginning and end of the range of changed text,
5817 and the length in bytes of the pre-change text replaced by that range.
5818 \(For an insertion, the pre-change length is zero;
5819 for a deletion, that length is the number of bytes deleted,
5820 and the post-change beginning and end are at the same place.)
5822 Buffer changes made while executing the `after-change-functions'
5823 don't call any before-change or after-change functions.
5824 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5826 If an unhandled error happens in running these functions,
5827 the variable's value remains nil. That prevents the error
5828 from happening repeatedly and making Emacs nonfunctional. */);
5829 Vafter_change_functions = Qnil;
5831 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5832 doc: /* A list of functions to call before changing a buffer which is unmodified.
5833 The functions are run using the `run-hooks' function. */);
5834 Vfirst_change_hook = Qnil;
5836 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5837 doc: /* List of undo entries in current buffer.
5838 Recent changes come first; older changes follow newer.
5840 An entry (BEG . END) represents an insertion which begins at
5841 position BEG and ends at position END.
5843 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5844 from (abs POSITION). If POSITION is positive, point was at the front
5845 of the text being deleted; if negative, point was at the end.
5847 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
5848 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
5849 and is the visited file's modification time, as of that time. If the
5850 modification time of the most recent save is different, this entry is
5851 obsolete.
5853 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5854 was modified between BEG and END. PROPERTY is the property name,
5855 and VALUE is the old value.
5857 An entry (apply FUN-NAME . ARGS) means undo the change with
5858 \(apply FUN-NAME ARGS).
5860 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5861 in the active region. BEG and END is the range affected by this entry
5862 and DELTA is the number of bytes added or deleted in that range by
5863 this change.
5865 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5866 was adjusted in position by the offset DISTANCE (an integer).
5868 An entry of the form POSITION indicates that point was at the buffer
5869 location given by the integer. Undoing an entry of this form places
5870 point at POSITION.
5872 Entries with value `nil' mark undo boundaries. The undo command treats
5873 the changes between two undo boundaries as a single step to be undone.
5875 If the value of the variable is t, undo information is not recorded. */);
5877 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5878 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5880 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5881 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5883 Normally, the line-motion functions work by scanning the buffer for
5884 newlines. Columnar operations (like `move-to-column' and
5885 `compute-motion') also work by scanning the buffer, summing character
5886 widths as they go. This works well for ordinary text, but if the
5887 buffer's lines are very long (say, more than 500 characters), these
5888 motion functions will take longer to execute. Emacs may also take
5889 longer to update the display.
5891 If `cache-long-line-scans' is non-nil, these motion functions cache the
5892 results of their scans, and consult the cache to avoid rescanning
5893 regions of the buffer until the text is modified. The caches are most
5894 beneficial when they prevent the most searching---that is, when the
5895 buffer contains long lines and large regions of characters with the
5896 same, fixed screen width.
5898 When `cache-long-line-scans' is non-nil, processing short lines will
5899 become slightly slower (because of the overhead of consulting the
5900 cache), and the caches will use memory roughly proportional to the
5901 number of newlines and characters whose screen width varies.
5903 The caches require no explicit maintenance; their accuracy is
5904 maintained internally by the Emacs primitives. Enabling or disabling
5905 the cache should not affect the behavior of any of the motion
5906 functions; it should only affect their performance. */);
5908 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5909 doc: /* Value of point before the last series of scroll operations, or nil. */);
5911 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5912 doc: /* List of formats to use when saving this buffer.
5913 Formats are defined by `format-alist'. This variable is
5914 set when a file is visited. */);
5916 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5917 &BVAR (current_buffer, auto_save_file_format), Qnil,
5918 doc: /* Format in which to write auto-save files.
5919 Should be a list of symbols naming formats that are defined in `format-alist'.
5920 If it is t, which is the default, auto-save files are written in the
5921 same format as a regular save would use. */);
5923 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5924 &BVAR (current_buffer, invisibility_spec), Qnil,
5925 doc: /* Invisibility spec of this buffer.
5926 The default is t, which means that text is invisible
5927 if it has a non-nil `invisible' property.
5928 If the value is a list, a text character is invisible if its `invisible'
5929 property is an element in that list (or is a list with members in common).
5930 If an element is a cons cell of the form (PROP . ELLIPSIS),
5931 then characters with property value PROP are invisible,
5932 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5934 DEFVAR_PER_BUFFER ("buffer-display-count",
5935 &BVAR (current_buffer, display_count), Qnil,
5936 doc: /* A number incremented each time this buffer is displayed in a window.
5937 The function `set-window-buffer' increments it. */);
5939 DEFVAR_PER_BUFFER ("buffer-display-time",
5940 &BVAR (current_buffer, display_time), Qnil,
5941 doc: /* Time stamp updated each time this buffer is displayed in a window.
5942 The function `set-window-buffer' updates this variable
5943 to the value obtained by calling `current-time'.
5944 If the buffer has never been shown in a window, the value is nil. */);
5946 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5947 doc: /* Non-nil if Transient Mark mode is enabled.
5948 See the command `transient-mark-mode' for a description of this minor mode.
5950 Non-nil also enables highlighting of the region whenever the mark is active.
5951 The variable `highlight-nonselected-windows' controls whether to highlight
5952 all windows or just the selected window.
5954 Lisp programs may give this variable certain special values:
5956 - A value of `lambda' enables Transient Mark mode temporarily.
5957 It is disabled again after any subsequent action that would
5958 normally deactivate the mark (e.g. buffer modification).
5960 - A value of (only . OLDVAL) enables Transient Mark mode
5961 temporarily. After any subsequent point motion command that is
5962 not shift-translated, or any other action that would normally
5963 deactivate the mark (e.g. buffer modification), the value of
5964 `transient-mark-mode' is set to OLDVAL. */);
5965 Vtransient_mark_mode = Qnil;
5967 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5968 doc: /* Non-nil means disregard read-only status of buffers or characters.
5969 If the value is t, disregard `buffer-read-only' and all `read-only'
5970 text properties. If the value is a list, disregard `buffer-read-only'
5971 and disregard a `read-only' text property if the property value
5972 is a member of the list. */);
5973 Vinhibit_read_only = Qnil;
5975 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5976 doc: /* Cursor to use when this buffer is in the selected window.
5977 Values are interpreted as follows:
5979 t use the cursor specified for the frame
5980 nil don't display a cursor
5981 box display a filled box cursor
5982 hollow display a hollow box cursor
5983 bar display a vertical bar cursor with default width
5984 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5985 hbar display a horizontal bar cursor with default height
5986 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5987 ANYTHING ELSE display a hollow box cursor
5989 When the buffer is displayed in a non-selected window, the
5990 cursor's appearance is instead controlled by the variable
5991 `cursor-in-non-selected-windows'. */);
5993 DEFVAR_PER_BUFFER ("line-spacing",
5994 &BVAR (current_buffer, extra_line_spacing), Qnil,
5995 doc: /* Additional space to put between lines when displaying a buffer.
5996 The space is measured in pixels, and put below lines on graphic displays,
5997 see `display-graphic-p'.
5998 If value is a floating point number, it specifies the spacing relative
5999 to the default frame line height. A value of nil means add no extra space. */);
6001 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6002 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
6003 doc: /* Non-nil means show a cursor in non-selected windows.
6004 If nil, only shows a cursor in the selected window.
6005 If t, displays a cursor related to the usual cursor type
6006 \(a solid box becomes hollow, a bar becomes a narrower bar).
6007 You can also specify the cursor type as in the `cursor-type' variable.
6008 Use Custom to set this variable and update the display." */);
6010 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
6011 doc: /* List of functions called with no args to query before killing a buffer.
6012 The buffer being killed will be current while the functions are running.
6014 If any of them returns nil, the buffer is not killed. Functions run by
6015 this hook are supposed to not change the current buffer. */);
6016 Vkill_buffer_query_functions = Qnil;
6018 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
6019 doc: /* Normal hook run before changing the major mode of a buffer.
6020 The function `kill-all-local-variables' runs this before doing anything else. */);
6021 Vchange_major_mode_hook = Qnil;
6022 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
6024 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6025 doc: /* Hook run when the buffer list changes.
6026 Functions running this hook are `get-buffer-create',
6027 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6028 and `bury-buffer-internal'. */);
6029 Vbuffer_list_update_hook = Qnil;
6030 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
6032 defsubr (&Sbuffer_live_p);
6033 defsubr (&Sbuffer_list);
6034 defsubr (&Sget_buffer);
6035 defsubr (&Sget_file_buffer);
6036 defsubr (&Sget_buffer_create);
6037 defsubr (&Smake_indirect_buffer);
6038 defsubr (&Sgenerate_new_buffer_name);
6039 defsubr (&Sbuffer_name);
6040 defsubr (&Sbuffer_file_name);
6041 defsubr (&Sbuffer_base_buffer);
6042 defsubr (&Sbuffer_local_value);
6043 defsubr (&Sbuffer_local_variables);
6044 defsubr (&Sbuffer_modified_p);
6045 defsubr (&Sset_buffer_modified_p);
6046 defsubr (&Sbuffer_modified_tick);
6047 defsubr (&Sbuffer_chars_modified_tick);
6048 defsubr (&Srename_buffer);
6049 defsubr (&Sother_buffer);
6050 defsubr (&Sbuffer_enable_undo);
6051 defsubr (&Skill_buffer);
6052 defsubr (&Sbury_buffer_internal);
6053 defsubr (&Sset_buffer_major_mode);
6054 defsubr (&Scurrent_buffer);
6055 defsubr (&Sset_buffer);
6056 defsubr (&Sbarf_if_buffer_read_only);
6057 defsubr (&Serase_buffer);
6058 defsubr (&Sbuffer_swap_text);
6059 defsubr (&Sset_buffer_multibyte);
6060 defsubr (&Skill_all_local_variables);
6062 defsubr (&Soverlayp);
6063 defsubr (&Smake_overlay);
6064 defsubr (&Sdelete_overlay);
6065 defsubr (&Smove_overlay);
6066 defsubr (&Soverlay_start);
6067 defsubr (&Soverlay_end);
6068 defsubr (&Soverlay_buffer);
6069 defsubr (&Soverlay_properties);
6070 defsubr (&Soverlays_at);
6071 defsubr (&Soverlays_in);
6072 defsubr (&Snext_overlay_change);
6073 defsubr (&Sprevious_overlay_change);
6074 defsubr (&Soverlay_recenter);
6075 defsubr (&Soverlay_lists);
6076 defsubr (&Soverlay_get);
6077 defsubr (&Soverlay_put);
6078 defsubr (&Srestore_buffer_modified_p);
6081 void
6082 keys_of_buffer (void)
6084 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6085 initial_define_key (control_x_map, 'k', "kill-buffer");
6087 /* This must not be in syms_of_buffer, because Qdisabled is not
6088 initialized when that function gets called. */
6089 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);