Use INTERNAL_FIELD for windows.
[emacs.git] / src / buffer.c
blobe70360f51739a13b35ab64890d928f4cc79d594e
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 (FVAR (XFRAME (frame), buffer_list));
195 prevlist = Fnreverse (Fcopy_sequence
196 (FVAR (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 = FVAR (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->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->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, WVAR (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, WVAR (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 FVAR (f, buffer_list) = Fcons (buffer, Fdelq (buffer, FVAR (f, buffer_list)));
1768 FVAR (f, buried_buffer_list) = Fdelq (buffer, FVAR (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 FVAR (f, buffer_list) = Fdelq (buffer, FVAR (f, buffer_list));
1806 FVAR (f, buried_buffer_list)
1807 = Fcons (buffer, Fdelq (buffer, FVAR (f, buried_buffer_list)));
1809 /* Run buffer-list-update-hook. */
1810 if (!NILP (Vrun_hooks))
1811 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1813 return Qnil;
1816 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1817 doc: /* Set an appropriate major mode for BUFFER.
1818 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1819 according to `default-major-mode'.
1820 Use this function before selecting the buffer, since it may need to inspect
1821 the current buffer's major mode. */)
1822 (Lisp_Object buffer)
1824 ptrdiff_t count;
1825 Lisp_Object function;
1827 CHECK_BUFFER (buffer);
1829 if (STRINGP (BVAR (XBUFFER (buffer), name))
1830 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1831 function = find_symbol_value (intern ("initial-major-mode"));
1832 else
1834 function = BVAR (&buffer_defaults, major_mode);
1835 if (NILP (function)
1836 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1837 function = BVAR (current_buffer, major_mode);
1840 if (NILP (function) || EQ (function, Qfundamental_mode))
1841 return Qnil;
1843 count = SPECPDL_INDEX ();
1845 /* To select a nonfundamental mode,
1846 select the buffer temporarily and then call the mode function. */
1848 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1850 Fset_buffer (buffer);
1851 call0 (function);
1853 return unbind_to (count, Qnil);
1856 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1857 doc: /* Return the current buffer as a Lisp object. */)
1858 (void)
1860 register Lisp_Object buf;
1861 XSETBUFFER (buf, current_buffer);
1862 return buf;
1865 /* Set the current buffer to B.
1867 We previously set windows_or_buffers_changed here to invalidate
1868 global unchanged information in beg_unchanged and end_unchanged.
1869 This is no longer necessary because we now compute unchanged
1870 information on a buffer-basis. Every action affecting other
1871 windows than the selected one requires a select_window at some
1872 time, and that increments windows_or_buffers_changed. */
1874 void
1875 set_buffer_internal (register struct buffer *b)
1877 if (current_buffer != b)
1878 set_buffer_internal_1 (b);
1881 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1882 This is used by redisplay. */
1884 void
1885 set_buffer_internal_1 (register struct buffer *b)
1887 register struct buffer *old_buf;
1888 register Lisp_Object tail;
1890 #ifdef USE_MMAP_FOR_BUFFERS
1891 if (b->text->beg == NULL)
1892 enlarge_buffer_text (b, 0);
1893 #endif /* USE_MMAP_FOR_BUFFERS */
1895 if (current_buffer == b)
1896 return;
1898 old_buf = current_buffer;
1899 current_buffer = b;
1900 last_known_column_point = -1; /* invalidate indentation cache */
1902 if (old_buf)
1904 /* Put the undo list back in the base buffer, so that it appears
1905 that an indirect buffer shares the undo list of its base. */
1906 if (old_buf->base_buffer)
1907 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1909 /* If the old current buffer has markers to record PT, BEGV and ZV
1910 when it is not current, update them now. */
1911 record_buffer_markers (old_buf);
1914 /* Get the undo list from the base buffer, so that it appears
1915 that an indirect buffer shares the undo list of its base. */
1916 if (b->base_buffer)
1917 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1919 /* If the new current buffer has markers to record PT, BEGV and ZV
1920 when it is not current, fetch them now. */
1921 fetch_buffer_markers (b);
1923 /* Look down buffer's list of local Lisp variables
1924 to find and update any that forward into C variables. */
1928 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1930 Lisp_Object var = XCAR (XCAR (tail));
1931 struct Lisp_Symbol *sym = XSYMBOL (var);
1932 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1933 && SYMBOL_BLV (sym)->fwd)
1934 /* Just reference the variable
1935 to cause it to become set for this buffer. */
1936 Fsymbol_value (var);
1939 /* Do the same with any others that were local to the previous buffer */
1940 while (b != old_buf && (b = old_buf, b));
1943 /* Switch to buffer B temporarily for redisplay purposes.
1944 This avoids certain things that don't need to be done within redisplay. */
1946 void
1947 set_buffer_temp (struct buffer *b)
1949 register struct buffer *old_buf;
1951 if (current_buffer == b)
1952 return;
1954 old_buf = current_buffer;
1955 current_buffer = b;
1957 /* If the old current buffer has markers to record PT, BEGV and ZV
1958 when it is not current, update them now. */
1959 record_buffer_markers (old_buf);
1961 /* If the new current buffer has markers to record PT, BEGV and ZV
1962 when it is not current, fetch them now. */
1963 fetch_buffer_markers (b);
1966 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1967 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1968 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1969 also `save-excursion' when you want to make a buffer current
1970 temporarily. This function does not display the buffer, so its effect
1971 ends when the current command terminates. Use `switch-to-buffer' or
1972 `pop-to-buffer' to switch buffers permanently. */)
1973 (register Lisp_Object buffer_or_name)
1975 register Lisp_Object buffer;
1976 buffer = Fget_buffer (buffer_or_name);
1977 if (NILP (buffer))
1978 nsberror (buffer_or_name);
1979 if (NILP (BVAR (XBUFFER (buffer), name)))
1980 error ("Selecting deleted buffer");
1981 set_buffer_internal (XBUFFER (buffer));
1982 return buffer;
1985 /* Set the current buffer to BUFFER provided it is alive. */
1987 Lisp_Object
1988 set_buffer_if_live (Lisp_Object buffer)
1990 if (! NILP (BVAR (XBUFFER (buffer), name)))
1991 Fset_buffer (buffer);
1992 return Qnil;
1995 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1996 Sbarf_if_buffer_read_only, 0, 0, 0,
1997 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1998 (void)
2000 if (!NILP (BVAR (current_buffer, read_only))
2001 && NILP (Vinhibit_read_only))
2002 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2003 return Qnil;
2006 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2007 doc: /* Delete the entire contents of the current buffer.
2008 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2009 so the buffer is truly empty after this. */)
2010 (void)
2012 Fwiden ();
2014 del_range (BEG, Z);
2016 current_buffer->last_window_start = 1;
2017 /* Prevent warnings, or suspension of auto saving, that would happen
2018 if future size is less than past size. Use of erase-buffer
2019 implies that the future text is not really related to the past text. */
2020 XSETFASTINT (BVAR (current_buffer, save_length), 0);
2021 return Qnil;
2024 void
2025 validate_region (register Lisp_Object *b, register Lisp_Object *e)
2027 CHECK_NUMBER_COERCE_MARKER (*b);
2028 CHECK_NUMBER_COERCE_MARKER (*e);
2030 if (XINT (*b) > XINT (*e))
2032 Lisp_Object tem;
2033 tem = *b; *b = *e; *e = tem;
2036 if (! (BEGV <= XINT (*b) && XINT (*e) <= ZV))
2037 args_out_of_range (*b, *e);
2040 /* Advance BYTE_POS up to a character boundary
2041 and return the adjusted position. */
2043 static ptrdiff_t
2044 advance_to_char_boundary (ptrdiff_t byte_pos)
2046 int c;
2048 if (byte_pos == BEG)
2049 /* Beginning of buffer is always a character boundary. */
2050 return BEG;
2052 c = FETCH_BYTE (byte_pos);
2053 if (! CHAR_HEAD_P (c))
2055 /* We should advance BYTE_POS only when C is a constituent of a
2056 multibyte sequence. */
2057 ptrdiff_t orig_byte_pos = byte_pos;
2061 byte_pos--;
2062 c = FETCH_BYTE (byte_pos);
2064 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2065 INC_POS (byte_pos);
2066 if (byte_pos < orig_byte_pos)
2067 byte_pos = orig_byte_pos;
2068 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2069 surely advance to the correct character boundary. If C is
2070 not, BYTE_POS was unchanged. */
2073 return byte_pos;
2076 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2077 1, 1, 0,
2078 doc: /* Swap the text between current buffer and BUFFER. */)
2079 (Lisp_Object buffer)
2081 struct buffer *other_buffer;
2082 CHECK_BUFFER (buffer);
2083 other_buffer = XBUFFER (buffer);
2085 if (NILP (BVAR (other_buffer, name)))
2086 error ("Cannot swap a dead buffer's text");
2088 /* Actually, it probably works just fine.
2089 * if (other_buffer == current_buffer)
2090 * error ("Cannot swap a buffer's text with itself"); */
2092 /* Actually, this may be workable as well, tho probably only if they're
2093 *both* indirect. */
2094 if (other_buffer->base_buffer
2095 || current_buffer->base_buffer)
2096 error ("Cannot swap indirect buffers's text");
2098 { /* This is probably harder to make work. */
2099 struct buffer *other;
2100 FOR_EACH_BUFFER (other)
2101 if (other->base_buffer == other_buffer
2102 || other->base_buffer == current_buffer)
2103 error ("One of the buffers to swap has indirect buffers");
2106 #define swapfield(field, type) \
2107 do { \
2108 type tmp##field = other_buffer->field; \
2109 other_buffer->field = current_buffer->field; \
2110 current_buffer->field = tmp##field; \
2111 } while (0)
2112 #define swapfield_(field, type) \
2113 do { \
2114 type tmp##field = BVAR (other_buffer, field); \
2115 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2116 BVAR (current_buffer, field) = tmp##field; \
2117 } while (0)
2119 swapfield (own_text, struct buffer_text);
2120 eassert (current_buffer->text == &current_buffer->own_text);
2121 eassert (other_buffer->text == &other_buffer->own_text);
2122 #ifdef REL_ALLOC
2123 r_alloc_reset_variable ((void **) &current_buffer->own_text.beg,
2124 (void **) &other_buffer->own_text.beg);
2125 r_alloc_reset_variable ((void **) &other_buffer->own_text.beg,
2126 (void **) &current_buffer->own_text.beg);
2127 #endif /* REL_ALLOC */
2129 swapfield (pt, ptrdiff_t);
2130 swapfield (pt_byte, ptrdiff_t);
2131 swapfield (begv, ptrdiff_t);
2132 swapfield (begv_byte, ptrdiff_t);
2133 swapfield (zv, ptrdiff_t);
2134 swapfield (zv_byte, ptrdiff_t);
2135 eassert (!current_buffer->base_buffer);
2136 eassert (!other_buffer->base_buffer);
2137 swapfield (indirections, ptrdiff_t);
2138 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2139 swapfield (newline_cache, struct region_cache *);
2140 swapfield (width_run_cache, struct region_cache *);
2141 current_buffer->prevent_redisplay_optimizations_p = 1;
2142 other_buffer->prevent_redisplay_optimizations_p = 1;
2143 swapfield (overlays_before, struct Lisp_Overlay *);
2144 swapfield (overlays_after, struct Lisp_Overlay *);
2145 swapfield (overlay_center, ptrdiff_t);
2146 swapfield_ (undo_list, Lisp_Object);
2147 swapfield_ (mark, Lisp_Object);
2148 swapfield_ (enable_multibyte_characters, Lisp_Object);
2149 swapfield_ (bidi_display_reordering, Lisp_Object);
2150 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2151 /* FIXME: Not sure what we should do with these *_marker fields.
2152 Hopefully they're just nil anyway. */
2153 swapfield_ (pt_marker, Lisp_Object);
2154 swapfield_ (begv_marker, Lisp_Object);
2155 swapfield_ (zv_marker, Lisp_Object);
2156 BVAR (current_buffer, point_before_scroll) = Qnil;
2157 BVAR (other_buffer, point_before_scroll) = Qnil;
2159 current_buffer->text->modiff++; other_buffer->text->modiff++;
2160 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2161 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2162 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2163 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2164 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2165 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2167 struct Lisp_Marker *m;
2168 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2169 if (m->buffer == other_buffer)
2170 m->buffer = current_buffer;
2171 else
2172 /* Since there's no indirect buffer in sight, markers on
2173 BUF_MARKERS(buf) should either be for `buf' or dead. */
2174 eassert (!m->buffer);
2175 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2176 if (m->buffer == current_buffer)
2177 m->buffer = other_buffer;
2178 else
2179 /* Since there's no indirect buffer in sight, markers on
2180 BUF_MARKERS(buf) should either be for `buf' or dead. */
2181 eassert (!m->buffer);
2183 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2184 So since we just swapped the markers between the two buffers, we need
2185 to undo the effect of this swap for window markers. */
2186 Lisp_Object w = Fselected_window (), ws = Qnil;
2187 Lisp_Object buf1, buf2;
2188 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2190 while (NILP (Fmemq (w, ws)))
2192 ws = Fcons (w, ws);
2193 if (MARKERP (WVAR (XWINDOW (w), pointm))
2194 && (EQ (WVAR (XWINDOW (w), buffer), buf1)
2195 || EQ (WVAR (XWINDOW (w), buffer), buf2)))
2196 Fset_marker (WVAR (XWINDOW (w), pointm),
2197 make_number
2198 (BUF_BEGV (XBUFFER (WVAR (XWINDOW (w), buffer)))),
2199 WVAR (XWINDOW (w), buffer));
2200 w = Fnext_window (w, Qt, Qt);
2204 if (current_buffer->text->intervals)
2205 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2206 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2207 if (other_buffer->text->intervals)
2208 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2209 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2211 return Qnil;
2214 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2215 1, 1, 0,
2216 doc: /* Set the multibyte flag of the current buffer to FLAG.
2217 If FLAG is t, this makes the buffer a multibyte buffer.
2218 If FLAG is nil, this makes the buffer a single-byte buffer.
2219 In these cases, the buffer contents remain unchanged as a sequence of
2220 bytes but the contents viewed as characters do change.
2221 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2222 all eight-bit bytes to eight-bit characters.
2223 If the multibyte flag was really changed, undo information of the
2224 current buffer is cleared. */)
2225 (Lisp_Object flag)
2227 struct Lisp_Marker *tail, *markers;
2228 struct buffer *other;
2229 ptrdiff_t begv, zv;
2230 int narrowed = (BEG != BEGV || Z != ZV);
2231 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2232 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2233 struct gcpro gcpro1;
2235 if (current_buffer->base_buffer)
2236 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2238 /* Do nothing if nothing actually changes. */
2239 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2240 return flag;
2242 GCPRO1 (old_undo);
2244 /* Don't record these buffer changes. We will put a special undo entry
2245 instead. */
2246 BVAR (current_buffer, undo_list) = Qt;
2248 /* If the cached position is for this buffer, clear it out. */
2249 clear_charpos_cache (current_buffer);
2251 if (NILP (flag))
2252 begv = BEGV_BYTE, zv = ZV_BYTE;
2253 else
2254 begv = BEGV, zv = ZV;
2256 if (narrowed)
2257 Fwiden ();
2259 if (NILP (flag))
2261 ptrdiff_t pos, stop;
2262 unsigned char *p;
2264 /* Do this first, so it can use CHAR_TO_BYTE
2265 to calculate the old correspondences. */
2266 set_intervals_multibyte (0);
2268 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2270 Z = Z_BYTE;
2271 BEGV = BEGV_BYTE;
2272 ZV = ZV_BYTE;
2273 GPT = GPT_BYTE;
2274 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2277 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2278 tail->charpos = tail->bytepos;
2280 /* Convert multibyte form of 8-bit characters to unibyte. */
2281 pos = BEG;
2282 stop = GPT;
2283 p = BEG_ADDR;
2284 while (1)
2286 int c, bytes;
2288 if (pos == stop)
2290 if (pos == Z)
2291 break;
2292 p = GAP_END_ADDR;
2293 stop = Z;
2295 if (ASCII_BYTE_P (*p))
2296 p++, pos++;
2297 else if (CHAR_BYTE8_HEAD_P (*p))
2299 c = STRING_CHAR_AND_LENGTH (p, bytes);
2300 /* Delete all bytes for this 8-bit character but the
2301 last one, and change the last one to the character
2302 code. */
2303 bytes--;
2304 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2305 p = GAP_END_ADDR;
2306 *p++ = c;
2307 pos++;
2308 if (begv > pos)
2309 begv -= bytes;
2310 if (zv > pos)
2311 zv -= bytes;
2312 stop = Z;
2314 else
2316 bytes = BYTES_BY_CHAR_HEAD (*p);
2317 p += bytes, pos += bytes;
2320 if (narrowed)
2321 Fnarrow_to_region (make_number (begv), make_number (zv));
2323 else
2325 ptrdiff_t pt = PT;
2326 ptrdiff_t pos, stop;
2327 unsigned char *p, *pend;
2329 /* Be sure not to have a multibyte sequence striding over the GAP.
2330 Ex: We change this: "...abc\302 _GAP_ \241def..."
2331 to: "...abc _GAP_ \302\241def..." */
2333 if (EQ (flag, Qt)
2334 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2335 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2337 unsigned char *q = GPT_ADDR - 1;
2339 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2340 if (LEADING_CODE_P (*q))
2342 ptrdiff_t new_gpt = GPT_BYTE - (GPT_ADDR - q);
2344 move_gap_both (new_gpt, new_gpt);
2348 /* Make the buffer contents valid as multibyte by converting
2349 8-bit characters to multibyte form. */
2350 pos = BEG;
2351 stop = GPT;
2352 p = BEG_ADDR;
2353 pend = GPT_ADDR;
2354 while (1)
2356 int bytes;
2358 if (pos == stop)
2360 if (pos == Z)
2361 break;
2362 p = GAP_END_ADDR;
2363 pend = Z_ADDR;
2364 stop = Z;
2367 if (ASCII_BYTE_P (*p))
2368 p++, pos++;
2369 else if (EQ (flag, Qt)
2370 && ! CHAR_BYTE8_HEAD_P (*p)
2371 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2372 p += bytes, pos += bytes;
2373 else
2375 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2376 int c;
2378 c = BYTE8_TO_CHAR (*p);
2379 bytes = CHAR_STRING (c, tmp);
2380 *p = tmp[0];
2381 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2382 bytes--;
2383 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2384 /* Now the gap is after the just inserted data. */
2385 pos = GPT;
2386 p = GAP_END_ADDR;
2387 if (pos <= begv)
2388 begv += bytes;
2389 if (pos <= zv)
2390 zv += bytes;
2391 if (pos <= pt)
2392 pt += bytes;
2393 pend = Z_ADDR;
2394 stop = Z;
2398 if (pt != PT)
2399 TEMP_SET_PT (pt);
2401 if (narrowed)
2402 Fnarrow_to_region (make_number (begv), make_number (zv));
2404 /* Do this first, so that chars_in_text asks the right question.
2405 set_intervals_multibyte needs it too. */
2406 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2408 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2409 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2411 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2413 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2414 if (BEGV_BYTE > GPT_BYTE)
2415 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2416 else
2417 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2419 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2420 if (ZV_BYTE > GPT_BYTE)
2421 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2422 else
2423 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2426 ptrdiff_t byte = advance_to_char_boundary (PT_BYTE);
2427 ptrdiff_t position;
2429 if (byte > GPT_BYTE)
2430 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2431 else
2432 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2433 TEMP_SET_PT_BOTH (position, byte);
2436 tail = markers = BUF_MARKERS (current_buffer);
2438 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2439 getting confused by the markers that have not yet been updated.
2440 It is also a signal that it should never create a marker. */
2441 BUF_MARKERS (current_buffer) = NULL;
2443 for (; tail; tail = tail->next)
2445 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2446 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2449 /* Make sure no markers were put on the chain
2450 while the chain value was incorrect. */
2451 if (BUF_MARKERS (current_buffer))
2452 abort ();
2454 BUF_MARKERS (current_buffer) = markers;
2456 /* Do this last, so it can calculate the new correspondences
2457 between chars and bytes. */
2458 set_intervals_multibyte (1);
2461 if (!EQ (old_undo, Qt))
2463 /* Represent all the above changes by a special undo entry. */
2464 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2465 intern ("set-buffer-multibyte"),
2466 NILP (flag) ? Qt : Qnil),
2467 old_undo);
2470 UNGCPRO;
2472 /* Changing the multibyteness of a buffer means that all windows
2473 showing that buffer must be updated thoroughly. */
2474 current_buffer->prevent_redisplay_optimizations_p = 1;
2475 ++windows_or_buffers_changed;
2477 /* Copy this buffer's new multibyte status
2478 into all of its indirect buffers. */
2479 FOR_EACH_BUFFER (other)
2480 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2482 BVAR (other, enable_multibyte_characters)
2483 = BVAR (current_buffer, enable_multibyte_characters);
2484 other->prevent_redisplay_optimizations_p = 1;
2487 /* Restore the modifiedness of the buffer. */
2488 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2489 Fset_buffer_modified_p (Qnil);
2491 /* Update coding systems of this buffer's process (if any). */
2493 Lisp_Object process;
2495 process = Fget_buffer_process (Fcurrent_buffer ());
2496 if (PROCESSP (process))
2497 setup_process_coding_systems (process);
2500 return flag;
2503 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2504 Skill_all_local_variables, 0, 0, 0,
2505 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2506 Most local variable bindings are eliminated so that the default values
2507 become effective once more. Also, the syntax table is set from
2508 `standard-syntax-table', the local keymap is set to nil,
2509 and the abbrev table from `fundamental-mode-abbrev-table'.
2510 This function also forces redisplay of the mode line.
2512 Every function to select a new major mode starts by
2513 calling this function.
2515 As a special exception, local variables whose names have
2516 a non-nil `permanent-local' property are not eliminated by this function.
2518 The first thing this function does is run
2519 the normal hook `change-major-mode-hook'. */)
2520 (void)
2522 Frun_hooks (1, &Qchange_major_mode_hook);
2524 /* Make sure none of the bindings in local_var_alist
2525 remain swapped in, in their symbols. */
2527 swap_out_buffer_local_variables (current_buffer);
2529 /* Actually eliminate all local bindings of this buffer. */
2531 reset_buffer_local_variables (current_buffer, 0);
2533 /* Force mode-line redisplay. Useful here because all major mode
2534 commands call this function. */
2535 update_mode_lines++;
2537 return Qnil;
2540 /* Make sure no local variables remain set up with buffer B
2541 for their current values. */
2543 static void
2544 swap_out_buffer_local_variables (struct buffer *b)
2546 Lisp_Object oalist, alist, buffer;
2548 XSETBUFFER (buffer, b);
2549 oalist = BVAR (b, local_var_alist);
2551 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2553 Lisp_Object sym = XCAR (XCAR (alist));
2554 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2555 /* Need not do anything if some other buffer's binding is
2556 now cached. */
2557 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2559 /* Symbol is set up for this buffer's old local value:
2560 swap it out! */
2561 swap_in_global_binding (XSYMBOL (sym));
2566 /* Find all the overlays in the current buffer that contain position POS.
2567 Return the number found, and store them in a vector in *VEC_PTR.
2568 Store in *LEN_PTR the size allocated for the vector.
2569 Store in *NEXT_PTR the next position after POS where an overlay starts,
2570 or ZV if there are no more overlays between POS and ZV.
2571 Store in *PREV_PTR the previous position before POS where an overlay ends,
2572 or where an overlay starts which ends at or after POS;
2573 or BEGV if there are no such overlays from BEGV to POS.
2574 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2576 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2577 when this function is called.
2579 If EXTEND is non-zero, we make the vector bigger if necessary.
2580 If EXTEND is zero, we never extend the vector,
2581 and we store only as many overlays as will fit.
2582 But we still return the total number of overlays.
2584 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2585 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2586 default (BEGV or ZV). */
2588 ptrdiff_t
2589 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2590 ptrdiff_t *len_ptr,
2591 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr, int change_req)
2593 Lisp_Object overlay, start, end;
2594 struct Lisp_Overlay *tail;
2595 ptrdiff_t idx = 0;
2596 ptrdiff_t len = *len_ptr;
2597 Lisp_Object *vec = *vec_ptr;
2598 ptrdiff_t next = ZV;
2599 ptrdiff_t prev = BEGV;
2600 int inhibit_storing = 0;
2602 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2604 ptrdiff_t startpos, endpos;
2606 XSETMISC (overlay, tail);
2608 start = OVERLAY_START (overlay);
2609 end = OVERLAY_END (overlay);
2610 endpos = OVERLAY_POSITION (end);
2611 if (endpos < pos)
2613 if (prev < endpos)
2614 prev = endpos;
2615 break;
2617 startpos = OVERLAY_POSITION (start);
2618 /* This one ends at or after POS
2619 so its start counts for PREV_PTR if it's before POS. */
2620 if (prev < startpos && startpos < pos)
2621 prev = startpos;
2622 if (endpos == pos)
2623 continue;
2624 if (startpos <= pos)
2626 if (idx == len)
2628 /* The supplied vector is full.
2629 Either make it bigger, or don't store any more in it. */
2630 if (extend)
2632 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2633 sizeof *vec);
2634 *vec_ptr = vec;
2635 len = *len_ptr;
2637 else
2638 inhibit_storing = 1;
2641 if (!inhibit_storing)
2642 vec[idx] = overlay;
2643 /* Keep counting overlays even if we can't return them all. */
2644 idx++;
2646 else if (startpos < next)
2647 next = startpos;
2650 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2652 ptrdiff_t startpos, endpos;
2654 XSETMISC (overlay, tail);
2656 start = OVERLAY_START (overlay);
2657 end = OVERLAY_END (overlay);
2658 startpos = OVERLAY_POSITION (start);
2659 if (pos < startpos)
2661 if (startpos < next)
2662 next = startpos;
2663 break;
2665 endpos = OVERLAY_POSITION (end);
2666 if (pos < endpos)
2668 if (idx == len)
2670 if (extend)
2672 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2673 sizeof *vec);
2674 *vec_ptr = vec;
2675 len = *len_ptr;
2677 else
2678 inhibit_storing = 1;
2681 if (!inhibit_storing)
2682 vec[idx] = overlay;
2683 idx++;
2685 if (startpos < pos && startpos > prev)
2686 prev = startpos;
2688 else if (endpos < pos && endpos > prev)
2689 prev = endpos;
2690 else if (endpos == pos && startpos > prev
2691 && (!change_req || startpos < pos))
2692 prev = startpos;
2695 if (next_ptr)
2696 *next_ptr = next;
2697 if (prev_ptr)
2698 *prev_ptr = prev;
2699 return idx;
2702 /* Find all the overlays in the current buffer that overlap the range
2703 BEG-END, or are empty at BEG, or are empty at END provided END
2704 denotes the position at the end of the current buffer.
2706 Return the number found, and store them in a vector in *VEC_PTR.
2707 Store in *LEN_PTR the size allocated for the vector.
2708 Store in *NEXT_PTR the next position after POS where an overlay starts,
2709 or ZV if there are no more overlays.
2710 Store in *PREV_PTR the previous position before POS where an overlay ends,
2711 or BEGV if there are no previous overlays.
2712 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2714 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2715 when this function is called.
2717 If EXTEND is non-zero, we make the vector bigger if necessary.
2718 If EXTEND is zero, we never extend the vector,
2719 and we store only as many overlays as will fit.
2720 But we still return the total number of overlays. */
2722 static ptrdiff_t
2723 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2724 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2725 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr)
2727 Lisp_Object overlay, ostart, oend;
2728 struct Lisp_Overlay *tail;
2729 ptrdiff_t idx = 0;
2730 ptrdiff_t len = *len_ptr;
2731 Lisp_Object *vec = *vec_ptr;
2732 ptrdiff_t next = ZV;
2733 ptrdiff_t prev = BEGV;
2734 int inhibit_storing = 0;
2735 int end_is_Z = end == Z;
2737 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2739 ptrdiff_t startpos, endpos;
2741 XSETMISC (overlay, tail);
2743 ostart = OVERLAY_START (overlay);
2744 oend = OVERLAY_END (overlay);
2745 endpos = OVERLAY_POSITION (oend);
2746 if (endpos < beg)
2748 if (prev < endpos)
2749 prev = endpos;
2750 break;
2752 startpos = OVERLAY_POSITION (ostart);
2753 /* Count an interval if it overlaps the range, is empty at the
2754 start of the range, or is empty at END provided END denotes the
2755 end of the buffer. */
2756 if ((beg < endpos && startpos < end)
2757 || (startpos == endpos
2758 && (beg == endpos || (end_is_Z && endpos == end))))
2760 if (idx == len)
2762 /* The supplied vector is full.
2763 Either make it bigger, or don't store any more in it. */
2764 if (extend)
2766 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2767 sizeof *vec);
2768 *vec_ptr = vec;
2769 len = *len_ptr;
2771 else
2772 inhibit_storing = 1;
2775 if (!inhibit_storing)
2776 vec[idx] = overlay;
2777 /* Keep counting overlays even if we can't return them all. */
2778 idx++;
2780 else if (startpos < next)
2781 next = startpos;
2784 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2786 ptrdiff_t startpos, endpos;
2788 XSETMISC (overlay, tail);
2790 ostart = OVERLAY_START (overlay);
2791 oend = OVERLAY_END (overlay);
2792 startpos = OVERLAY_POSITION (ostart);
2793 if (end < startpos)
2795 if (startpos < next)
2796 next = startpos;
2797 break;
2799 endpos = OVERLAY_POSITION (oend);
2800 /* Count an interval if it overlaps the range, is empty at the
2801 start of the range, or is empty at END provided END denotes the
2802 end of the buffer. */
2803 if ((beg < endpos && startpos < end)
2804 || (startpos == endpos
2805 && (beg == endpos || (end_is_Z && endpos == end))))
2807 if (idx == len)
2809 if (extend)
2811 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2812 sizeof *vec);
2813 *vec_ptr = vec;
2814 len = *len_ptr;
2816 else
2817 inhibit_storing = 1;
2820 if (!inhibit_storing)
2821 vec[idx] = overlay;
2822 idx++;
2824 else if (endpos < beg && endpos > prev)
2825 prev = endpos;
2828 if (next_ptr)
2829 *next_ptr = next;
2830 if (prev_ptr)
2831 *prev_ptr = prev;
2832 return idx;
2836 /* Return non-zero if there exists an overlay with a non-nil
2837 `mouse-face' property overlapping OVERLAY. */
2840 mouse_face_overlay_overlaps (Lisp_Object overlay)
2842 ptrdiff_t start = OVERLAY_POSITION (OVERLAY_START (overlay));
2843 ptrdiff_t end = OVERLAY_POSITION (OVERLAY_END (overlay));
2844 ptrdiff_t n, i, size;
2845 Lisp_Object *v, tem;
2847 size = 10;
2848 v = alloca (size * sizeof *v);
2849 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2850 if (n > size)
2852 v = alloca (n * sizeof *v);
2853 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2856 for (i = 0; i < n; ++i)
2857 if (!EQ (v[i], overlay)
2858 && (tem = Foverlay_get (overlay, Qmouse_face),
2859 !NILP (tem)))
2860 break;
2862 return i < n;
2867 /* Fast function to just test if we're at an overlay boundary. */
2869 overlay_touches_p (ptrdiff_t pos)
2871 Lisp_Object overlay;
2872 struct Lisp_Overlay *tail;
2874 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2876 ptrdiff_t endpos;
2878 XSETMISC (overlay ,tail);
2879 eassert (OVERLAYP (overlay));
2881 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2882 if (endpos < pos)
2883 break;
2884 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2885 return 1;
2888 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2890 ptrdiff_t startpos;
2892 XSETMISC (overlay, tail);
2893 eassert (OVERLAYP (overlay));
2895 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2896 if (pos < startpos)
2897 break;
2898 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2899 return 1;
2901 return 0;
2904 struct sortvec
2906 Lisp_Object overlay;
2907 ptrdiff_t beg, end;
2908 EMACS_INT priority;
2911 static int
2912 compare_overlays (const void *v1, const void *v2)
2914 const struct sortvec *s1 = (const struct sortvec *) v1;
2915 const struct sortvec *s2 = (const struct sortvec *) v2;
2916 if (s1->priority != s2->priority)
2917 return s1->priority < s2->priority ? -1 : 1;
2918 if (s1->beg != s2->beg)
2919 return s1->beg < s2->beg ? -1 : 1;
2920 if (s1->end != s2->end)
2921 return s2->end < s1->end ? -1 : 1;
2922 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
2923 between "equal" overlays. The result can still change between
2924 invocations of Emacs, but it won't change in the middle of
2925 `find_field' (bug#6830). */
2926 if (XHASH (s1->overlay) != XHASH (s2->overlay))
2927 return XHASH (s1->overlay) < XHASH (s2->overlay) ? -1 : 1;
2928 return 0;
2931 /* Sort an array of overlays by priority. The array is modified in place.
2932 The return value is the new size; this may be smaller than the original
2933 size if some of the overlays were invalid or were window-specific. */
2934 ptrdiff_t
2935 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2937 ptrdiff_t i, j;
2938 struct sortvec *sortvec = alloca (noverlays * sizeof *sortvec);
2940 /* Put the valid and relevant overlays into sortvec. */
2942 for (i = 0, j = 0; i < noverlays; i++)
2944 Lisp_Object tem;
2945 Lisp_Object overlay;
2947 overlay = overlay_vec[i];
2948 if (OVERLAYP (overlay)
2949 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2950 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2952 /* If we're interested in a specific window, then ignore
2953 overlays that are limited to some other window. */
2954 if (w)
2956 Lisp_Object window;
2958 window = Foverlay_get (overlay, Qwindow);
2959 if (WINDOWP (window) && XWINDOW (window) != w)
2960 continue;
2963 /* This overlay is good and counts: put it into sortvec. */
2964 sortvec[j].overlay = overlay;
2965 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2966 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2967 tem = Foverlay_get (overlay, Qpriority);
2968 if (INTEGERP (tem))
2969 sortvec[j].priority = XINT (tem);
2970 else
2971 sortvec[j].priority = 0;
2972 j++;
2975 noverlays = j;
2977 /* Sort the overlays into the proper order: increasing priority. */
2979 if (noverlays > 1)
2980 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2982 for (i = 0; i < noverlays; i++)
2983 overlay_vec[i] = sortvec[i].overlay;
2984 return (noverlays);
2987 struct sortstr
2989 Lisp_Object string, string2;
2990 ptrdiff_t size;
2991 EMACS_INT priority;
2994 struct sortstrlist
2996 struct sortstr *buf; /* An array that expands as needed; never freed. */
2997 ptrdiff_t size; /* Allocated length of that array. */
2998 ptrdiff_t used; /* How much of the array is currently in use. */
2999 ptrdiff_t bytes; /* Total length of the strings in buf. */
3002 /* Buffers for storing information about the overlays touching a given
3003 position. These could be automatic variables in overlay_strings, but
3004 it's more efficient to hold onto the memory instead of repeatedly
3005 allocating and freeing it. */
3006 static struct sortstrlist overlay_heads, overlay_tails;
3007 static unsigned char *overlay_str_buf;
3009 /* Allocated length of overlay_str_buf. */
3010 static ptrdiff_t overlay_str_len;
3012 /* A comparison function suitable for passing to qsort. */
3013 static int
3014 cmp_for_strings (const void *as1, const void *as2)
3016 struct sortstr *s1 = (struct sortstr *)as1;
3017 struct sortstr *s2 = (struct sortstr *)as2;
3018 if (s1->size != s2->size)
3019 return s2->size < s1->size ? -1 : 1;
3020 if (s1->priority != s2->priority)
3021 return s1->priority < s2->priority ? -1 : 1;
3022 return 0;
3025 static void
3026 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
3027 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
3029 ptrdiff_t nbytes;
3031 if (ssl->used == ssl->size)
3032 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
3033 ssl->buf[ssl->used].string = str;
3034 ssl->buf[ssl->used].string2 = str2;
3035 ssl->buf[ssl->used].size = size;
3036 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3037 ssl->used++;
3039 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3040 nbytes = SCHARS (str);
3041 else if (! STRING_MULTIBYTE (str))
3042 nbytes = count_size_as_multibyte (SDATA (str),
3043 SBYTES (str));
3044 else
3045 nbytes = SBYTES (str);
3047 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
3048 memory_full (SIZE_MAX);
3049 ssl->bytes += nbytes;
3051 if (STRINGP (str2))
3053 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3054 nbytes = SCHARS (str2);
3055 else if (! STRING_MULTIBYTE (str2))
3056 nbytes = count_size_as_multibyte (SDATA (str2),
3057 SBYTES (str2));
3058 else
3059 nbytes = SBYTES (str2);
3061 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
3062 memory_full (SIZE_MAX);
3063 ssl->bytes += nbytes;
3067 /* Return the concatenation of the strings associated with overlays that
3068 begin or end at POS, ignoring overlays that are specific to a window
3069 other than W. The strings are concatenated in the appropriate order:
3070 shorter overlays nest inside longer ones, and higher priority inside
3071 lower. Normally all of the after-strings come first, but zero-sized
3072 overlays have their after-strings ride along with the before-strings
3073 because it would look strange to print them inside-out.
3075 Returns the string length, and stores the contents indirectly through
3076 PSTR, if that variable is non-null. The string may be overwritten by
3077 subsequent calls. */
3079 ptrdiff_t
3080 overlay_strings (ptrdiff_t pos, struct window *w, unsigned char **pstr)
3082 Lisp_Object overlay, window, str;
3083 struct Lisp_Overlay *ov;
3084 ptrdiff_t startpos, endpos;
3085 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3087 overlay_heads.used = overlay_heads.bytes = 0;
3088 overlay_tails.used = overlay_tails.bytes = 0;
3089 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3091 XSETMISC (overlay, ov);
3092 eassert (OVERLAYP (overlay));
3094 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3095 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3096 if (endpos < pos)
3097 break;
3098 if (endpos != pos && startpos != pos)
3099 continue;
3100 window = Foverlay_get (overlay, Qwindow);
3101 if (WINDOWP (window) && XWINDOW (window) != w)
3102 continue;
3103 if (startpos == pos
3104 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3105 record_overlay_string (&overlay_heads, str,
3106 (startpos == endpos
3107 ? Foverlay_get (overlay, Qafter_string)
3108 : Qnil),
3109 Foverlay_get (overlay, Qpriority),
3110 endpos - startpos);
3111 else if (endpos == pos
3112 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3113 record_overlay_string (&overlay_tails, str, Qnil,
3114 Foverlay_get (overlay, Qpriority),
3115 endpos - startpos);
3117 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3119 XSETMISC (overlay, ov);
3120 eassert (OVERLAYP (overlay));
3122 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3123 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3124 if (startpos > pos)
3125 break;
3126 if (endpos != pos && startpos != pos)
3127 continue;
3128 window = Foverlay_get (overlay, Qwindow);
3129 if (WINDOWP (window) && XWINDOW (window) != w)
3130 continue;
3131 if (startpos == pos
3132 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3133 record_overlay_string (&overlay_heads, str,
3134 (startpos == endpos
3135 ? Foverlay_get (overlay, Qafter_string)
3136 : Qnil),
3137 Foverlay_get (overlay, Qpriority),
3138 endpos - startpos);
3139 else if (endpos == pos
3140 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3141 record_overlay_string (&overlay_tails, str, Qnil,
3142 Foverlay_get (overlay, Qpriority),
3143 endpos - startpos);
3145 if (overlay_tails.used > 1)
3146 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3147 cmp_for_strings);
3148 if (overlay_heads.used > 1)
3149 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3150 cmp_for_strings);
3151 if (overlay_heads.bytes || overlay_tails.bytes)
3153 Lisp_Object tem;
3154 ptrdiff_t i;
3155 unsigned char *p;
3156 ptrdiff_t total;
3158 if (INT_ADD_OVERFLOW (overlay_heads.bytes, overlay_tails.bytes))
3159 memory_full (SIZE_MAX);
3160 total = overlay_heads.bytes + overlay_tails.bytes;
3161 if (total > overlay_str_len)
3162 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3163 total - overlay_str_len, -1, 1);
3165 p = overlay_str_buf;
3166 for (i = overlay_tails.used; --i >= 0;)
3168 ptrdiff_t nbytes;
3169 tem = overlay_tails.buf[i].string;
3170 nbytes = copy_text (SDATA (tem), p,
3171 SBYTES (tem),
3172 STRING_MULTIBYTE (tem), multibyte);
3173 p += nbytes;
3175 for (i = 0; i < overlay_heads.used; ++i)
3177 ptrdiff_t nbytes;
3178 tem = overlay_heads.buf[i].string;
3179 nbytes = copy_text (SDATA (tem), p,
3180 SBYTES (tem),
3181 STRING_MULTIBYTE (tem), multibyte);
3182 p += nbytes;
3183 tem = overlay_heads.buf[i].string2;
3184 if (STRINGP (tem))
3186 nbytes = copy_text (SDATA (tem), p,
3187 SBYTES (tem),
3188 STRING_MULTIBYTE (tem), multibyte);
3189 p += nbytes;
3192 if (p != overlay_str_buf + total)
3193 abort ();
3194 if (pstr)
3195 *pstr = overlay_str_buf;
3196 return total;
3198 return 0;
3201 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3203 void
3204 recenter_overlay_lists (struct buffer *buf, ptrdiff_t pos)
3206 Lisp_Object overlay, beg, end;
3207 struct Lisp_Overlay *prev, *tail, *next;
3209 /* See if anything in overlays_before should move to overlays_after. */
3211 /* We don't strictly need prev in this loop; it should always be nil.
3212 But we use it for symmetry and in case that should cease to be true
3213 with some future change. */
3214 prev = NULL;
3215 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3217 next = tail->next;
3218 XSETMISC (overlay, tail);
3219 eassert (OVERLAYP (overlay));
3221 beg = OVERLAY_START (overlay);
3222 end = OVERLAY_END (overlay);
3224 if (OVERLAY_POSITION (end) > pos)
3226 /* OVERLAY needs to be moved. */
3227 ptrdiff_t where = OVERLAY_POSITION (beg);
3228 struct Lisp_Overlay *other, *other_prev;
3230 /* Splice the cons cell TAIL out of overlays_before. */
3231 if (prev)
3232 prev->next = next;
3233 else
3234 buf->overlays_before = next;
3236 /* Search thru overlays_after for where to put it. */
3237 other_prev = NULL;
3238 for (other = buf->overlays_after; other;
3239 other_prev = other, other = other->next)
3241 Lisp_Object otherbeg, otheroverlay;
3243 XSETMISC (otheroverlay, other);
3244 eassert (OVERLAYP (otheroverlay));
3246 otherbeg = OVERLAY_START (otheroverlay);
3247 if (OVERLAY_POSITION (otherbeg) >= where)
3248 break;
3251 /* Add TAIL to overlays_after before OTHER. */
3252 tail->next = other;
3253 if (other_prev)
3254 other_prev->next = tail;
3255 else
3256 buf->overlays_after = tail;
3257 tail = prev;
3259 else
3260 /* We've reached the things that should stay in overlays_before.
3261 All the rest of overlays_before must end even earlier,
3262 so stop now. */
3263 break;
3266 /* See if anything in overlays_after should be in overlays_before. */
3267 prev = NULL;
3268 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3270 next = tail->next;
3271 XSETMISC (overlay, tail);
3272 eassert (OVERLAYP (overlay));
3274 beg = OVERLAY_START (overlay);
3275 end = OVERLAY_END (overlay);
3277 /* Stop looking, when we know that nothing further
3278 can possibly end before POS. */
3279 if (OVERLAY_POSITION (beg) > pos)
3280 break;
3282 if (OVERLAY_POSITION (end) <= pos)
3284 /* OVERLAY needs to be moved. */
3285 ptrdiff_t where = OVERLAY_POSITION (end);
3286 struct Lisp_Overlay *other, *other_prev;
3288 /* Splice the cons cell TAIL out of overlays_after. */
3289 if (prev)
3290 prev->next = next;
3291 else
3292 buf->overlays_after = next;
3294 /* Search thru overlays_before for where to put it. */
3295 other_prev = NULL;
3296 for (other = buf->overlays_before; other;
3297 other_prev = other, other = other->next)
3299 Lisp_Object otherend, otheroverlay;
3301 XSETMISC (otheroverlay, other);
3302 eassert (OVERLAYP (otheroverlay));
3304 otherend = OVERLAY_END (otheroverlay);
3305 if (OVERLAY_POSITION (otherend) <= where)
3306 break;
3309 /* Add TAIL to overlays_before before OTHER. */
3310 tail->next = other;
3311 if (other_prev)
3312 other_prev->next = tail;
3313 else
3314 buf->overlays_before = tail;
3315 tail = prev;
3319 buf->overlay_center = pos;
3322 void
3323 adjust_overlays_for_insert (ptrdiff_t pos, ptrdiff_t length)
3325 /* After an insertion, the lists are still sorted properly,
3326 but we may need to update the value of the overlay center. */
3327 if (current_buffer->overlay_center >= pos)
3328 current_buffer->overlay_center += length;
3331 void
3332 adjust_overlays_for_delete (ptrdiff_t pos, ptrdiff_t length)
3334 if (current_buffer->overlay_center < pos)
3335 /* The deletion was to our right. No change needed; the before- and
3336 after-lists are still consistent. */
3338 else if (current_buffer->overlay_center - pos > length)
3339 /* The deletion was to our left. We need to adjust the center value
3340 to account for the change in position, but the lists are consistent
3341 given the new value. */
3342 current_buffer->overlay_center -= length;
3343 else
3344 /* We're right in the middle. There might be things on the after-list
3345 that now belong on the before-list. Recentering will move them,
3346 and also update the center point. */
3347 recenter_overlay_lists (current_buffer, pos);
3350 /* Fix up overlays that were garbled as a result of permuting markers
3351 in the range START through END. Any overlay with at least one
3352 endpoint in this range will need to be unlinked from the overlay
3353 list and reinserted in its proper place.
3354 Such an overlay might even have negative size at this point.
3355 If so, we'll make the overlay empty. */
3356 void
3357 fix_start_end_in_overlays (register ptrdiff_t start, register ptrdiff_t end)
3359 Lisp_Object overlay;
3360 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3361 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3362 /* These are either nil, indicating that before_list or after_list
3363 should be assigned, or the cons cell the cdr of which should be
3364 assigned. */
3365 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3366 /* 'Parent', likewise, indicates a cons cell or
3367 current_buffer->overlays_before or overlays_after, depending
3368 which loop we're in. */
3369 struct Lisp_Overlay *tail, *parent;
3370 ptrdiff_t startpos, endpos;
3372 /* This algorithm shifts links around instead of consing and GCing.
3373 The loop invariant is that before_list (resp. after_list) is a
3374 well-formed list except that its last element, the CDR of beforep
3375 (resp. afterp) if beforep (afterp) isn't nil or before_list
3376 (after_list) if it is, is still uninitialized. So it's not a bug
3377 that before_list isn't initialized, although it may look
3378 strange. */
3379 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3381 XSETMISC (overlay, tail);
3383 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3384 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3386 /* If the overlay is backwards, make it empty. */
3387 if (endpos < startpos)
3389 startpos = endpos;
3390 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3391 Qnil);
3394 if (endpos < start)
3395 break;
3397 if (endpos < end
3398 || (startpos >= start && startpos < end))
3400 /* Add it to the end of the wrong list. Later on,
3401 recenter_overlay_lists will move it to the right place. */
3402 if (endpos < current_buffer->overlay_center)
3404 if (!afterp)
3405 after_list = tail;
3406 else
3407 afterp->next = tail;
3408 afterp = tail;
3410 else
3412 if (!beforep)
3413 before_list = tail;
3414 else
3415 beforep->next = tail;
3416 beforep = tail;
3418 if (!parent)
3419 current_buffer->overlays_before = tail->next;
3420 else
3421 parent->next = tail->next;
3422 tail = tail->next;
3424 else
3425 parent = tail, tail = parent->next;
3427 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3429 XSETMISC (overlay, tail);
3431 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3432 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3434 /* If the overlay is backwards, make it empty. */
3435 if (endpos < startpos)
3437 startpos = endpos;
3438 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3439 Qnil);
3442 if (startpos >= end)
3443 break;
3445 if (startpos >= start
3446 || (endpos >= start && endpos < end))
3448 if (endpos < current_buffer->overlay_center)
3450 if (!afterp)
3451 after_list = tail;
3452 else
3453 afterp->next = tail;
3454 afterp = tail;
3456 else
3458 if (!beforep)
3459 before_list = tail;
3460 else
3461 beforep->next = tail;
3462 beforep = tail;
3464 if (!parent)
3465 current_buffer->overlays_after = tail->next;
3466 else
3467 parent->next = tail->next;
3468 tail = tail->next;
3470 else
3471 parent = tail, tail = parent->next;
3474 /* Splice the constructed (wrong) lists into the buffer's lists,
3475 and let the recenter function make it sane again. */
3476 if (beforep)
3478 beforep->next = current_buffer->overlays_before;
3479 current_buffer->overlays_before = before_list;
3481 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3483 if (afterp)
3485 afterp->next = current_buffer->overlays_after;
3486 current_buffer->overlays_after = after_list;
3488 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3491 /* We have two types of overlay: the one whose ending marker is
3492 after-insertion-marker (this is the usual case) and the one whose
3493 ending marker is before-insertion-marker. When `overlays_before'
3494 contains overlays of the latter type and the former type in this
3495 order and both overlays end at inserting position, inserting a text
3496 increases only the ending marker of the latter type, which results
3497 in incorrect ordering of `overlays_before'.
3499 This function fixes ordering of overlays in the slot
3500 `overlays_before' of the buffer *BP. Before the insertion, `point'
3501 was at PREV, and now is at POS. */
3503 void
3504 fix_overlays_before (struct buffer *bp, ptrdiff_t prev, ptrdiff_t pos)
3506 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3507 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3508 Lisp_Object tem;
3509 ptrdiff_t end IF_LINT (= 0);
3511 /* After the insertion, the several overlays may be in incorrect
3512 order. The possibility is that, in the list `overlays_before',
3513 an overlay which ends at POS appears after an overlay which ends
3514 at PREV. Since POS is greater than PREV, we must fix the
3515 ordering of these overlays, by moving overlays ends at POS before
3516 the overlays ends at PREV. */
3518 /* At first, find a place where disordered overlays should be linked
3519 in. It is where an overlay which end before POS exists. (i.e. an
3520 overlay whose ending marker is after-insertion-marker if disorder
3521 exists). */
3522 while (tail
3523 && (XSETMISC (tem, tail),
3524 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3526 parent = tail;
3527 tail = tail->next;
3530 /* If we don't find such an overlay,
3531 or the found one ends before PREV,
3532 or the found one is the last one in the list,
3533 we don't have to fix anything. */
3534 if (!tail || end < prev || !tail->next)
3535 return;
3537 right_pair = parent;
3538 parent = tail;
3539 tail = tail->next;
3541 /* Now, end position of overlays in the list TAIL should be before
3542 or equal to PREV. In the loop, an overlay which ends at POS is
3543 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3544 we found an overlay which ends before PREV, the remaining
3545 overlays are in correct order. */
3546 while (tail)
3548 XSETMISC (tem, tail);
3549 end = OVERLAY_POSITION (OVERLAY_END (tem));
3551 if (end == pos)
3552 { /* This overlay is disordered. */
3553 struct Lisp_Overlay *found = tail;
3555 /* Unlink the found overlay. */
3556 tail = found->next;
3557 parent->next = tail;
3558 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3559 and link it into the right place. */
3560 if (!right_pair)
3562 found->next = bp->overlays_before;
3563 bp->overlays_before = found;
3565 else
3567 found->next = right_pair->next;
3568 right_pair->next = found;
3571 else if (end == prev)
3573 parent = tail;
3574 tail = tail->next;
3576 else /* No more disordered overlay. */
3577 break;
3581 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3582 doc: /* Return t if OBJECT is an overlay. */)
3583 (Lisp_Object object)
3585 return (OVERLAYP (object) ? Qt : Qnil);
3588 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3589 doc: /* Create a new overlay with range BEG to END in BUFFER.
3590 If omitted, BUFFER defaults to the current buffer.
3591 BEG and END may be integers or markers.
3592 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3593 for the front of the overlay advance when text is inserted there
3594 \(which means the text *is not* included in the overlay).
3595 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3596 for the rear of the overlay advance when text is inserted there
3597 \(which means the text *is* included in the overlay). */)
3598 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3600 Lisp_Object overlay;
3601 struct buffer *b;
3603 if (NILP (buffer))
3604 XSETBUFFER (buffer, current_buffer);
3605 else
3606 CHECK_BUFFER (buffer);
3607 if (MARKERP (beg)
3608 && ! EQ (Fmarker_buffer (beg), buffer))
3609 error ("Marker points into wrong buffer");
3610 if (MARKERP (end)
3611 && ! EQ (Fmarker_buffer (end), buffer))
3612 error ("Marker points into wrong buffer");
3614 CHECK_NUMBER_COERCE_MARKER (beg);
3615 CHECK_NUMBER_COERCE_MARKER (end);
3617 if (XINT (beg) > XINT (end))
3619 Lisp_Object temp;
3620 temp = beg; beg = end; end = temp;
3623 b = XBUFFER (buffer);
3625 beg = Fset_marker (Fmake_marker (), beg, buffer);
3626 end = Fset_marker (Fmake_marker (), end, buffer);
3628 if (!NILP (front_advance))
3629 XMARKER (beg)->insertion_type = 1;
3630 if (!NILP (rear_advance))
3631 XMARKER (end)->insertion_type = 1;
3633 overlay = build_overlay (beg, end, Qnil);
3635 /* Put the new overlay on the wrong list. */
3636 end = OVERLAY_END (overlay);
3637 if (OVERLAY_POSITION (end) < b->overlay_center)
3639 if (b->overlays_after)
3640 XOVERLAY (overlay)->next = b->overlays_after;
3641 b->overlays_after = XOVERLAY (overlay);
3643 else
3645 if (b->overlays_before)
3646 XOVERLAY (overlay)->next = b->overlays_before;
3647 b->overlays_before = XOVERLAY (overlay);
3650 /* This puts it in the right list, and in the right order. */
3651 recenter_overlay_lists (b, b->overlay_center);
3653 /* We don't need to redisplay the region covered by the overlay, because
3654 the overlay has no properties at the moment. */
3656 return overlay;
3659 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3661 static void
3662 modify_overlay (struct buffer *buf, ptrdiff_t start, ptrdiff_t end)
3664 if (start > end)
3666 ptrdiff_t temp = start;
3667 start = end;
3668 end = temp;
3671 BUF_COMPUTE_UNCHANGED (buf, start, end);
3673 /* If this is a buffer not in the selected window,
3674 we must do other windows. */
3675 if (buf != XBUFFER (WVAR (XWINDOW (selected_window), buffer)))
3676 windows_or_buffers_changed = 1;
3677 /* If multiple windows show this buffer, we must do other windows. */
3678 else if (buffer_shared > 1)
3679 windows_or_buffers_changed = 1;
3680 /* If we modify an overlay at the end of the buffer, we cannot
3681 be sure that window end is still valid. */
3682 else if (end >= ZV && start <= ZV)
3683 windows_or_buffers_changed = 1;
3685 ++BUF_OVERLAY_MODIFF (buf);
3688 /* Remove OVERLAY from LIST. */
3690 static struct Lisp_Overlay *
3691 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3693 register struct Lisp_Overlay *tail, **prev = &list;
3695 for (tail = list; tail; prev = &tail->next, tail = *prev)
3696 if (tail == overlay)
3698 *prev = overlay->next;
3699 overlay->next = NULL;
3700 break;
3702 return list;
3705 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3706 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3707 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3708 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3709 buffer. */)
3710 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3712 struct buffer *b, *ob = 0;
3713 Lisp_Object obuffer;
3714 ptrdiff_t count = SPECPDL_INDEX ();
3715 ptrdiff_t n_beg, n_end, o_beg IF_LINT (= 0), o_end IF_LINT (= 0);
3717 CHECK_OVERLAY (overlay);
3718 if (NILP (buffer))
3719 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3720 if (NILP (buffer))
3721 XSETBUFFER (buffer, current_buffer);
3722 CHECK_BUFFER (buffer);
3724 if (NILP (Fbuffer_live_p (buffer)))
3725 error ("Attempt to move overlay to a dead buffer");
3727 if (MARKERP (beg)
3728 && ! EQ (Fmarker_buffer (beg), buffer))
3729 error ("Marker points into wrong buffer");
3730 if (MARKERP (end)
3731 && ! EQ (Fmarker_buffer (end), buffer))
3732 error ("Marker points into wrong buffer");
3734 CHECK_NUMBER_COERCE_MARKER (beg);
3735 CHECK_NUMBER_COERCE_MARKER (end);
3737 if (XINT (beg) > XINT (end))
3739 Lisp_Object temp;
3740 temp = beg; beg = end; end = temp;
3743 specbind (Qinhibit_quit, Qt);
3745 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3746 b = XBUFFER (buffer);
3748 if (!NILP (obuffer))
3750 ob = XBUFFER (obuffer);
3752 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3753 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3755 ob->overlays_before =
3756 unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3757 ob->overlays_after =
3758 unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3759 eassert (XOVERLAY (overlay)->next == NULL);
3762 /* Set the overlay boundaries, which may clip them. */
3763 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3764 Fset_marker (OVERLAY_END (overlay), end, buffer);
3766 n_beg = marker_position (OVERLAY_START (overlay));
3767 n_end = marker_position (OVERLAY_END (overlay));
3769 /* If the overlay has changed buffers, do a thorough redisplay. */
3770 if (!EQ (buffer, obuffer))
3772 /* Redisplay where the overlay was. */
3773 if (ob)
3774 modify_overlay (ob, o_beg, o_end);
3776 /* Redisplay where the overlay is going to be. */
3777 modify_overlay (b, n_beg, n_end);
3779 else
3780 /* Redisplay the area the overlay has just left, or just enclosed. */
3782 if (o_beg == n_beg)
3783 modify_overlay (b, o_end, n_end);
3784 else if (o_end == n_end)
3785 modify_overlay (b, o_beg, n_beg);
3786 else
3787 modify_overlay (b, min (o_beg, n_beg), max (o_end, n_end));
3790 /* Delete the overlay if it is empty after clipping and has the
3791 evaporate property. */
3792 if (n_beg == n_end && !NILP (Foverlay_get (overlay, Qevaporate)))
3793 return unbind_to (count, Fdelete_overlay (overlay));
3795 /* Put the overlay into the new buffer's overlay lists, first on the
3796 wrong list. */
3797 if (n_end < b->overlay_center)
3799 XOVERLAY (overlay)->next = b->overlays_after;
3800 b->overlays_after = XOVERLAY (overlay);
3802 else
3804 XOVERLAY (overlay)->next = b->overlays_before;
3805 b->overlays_before = XOVERLAY (overlay);
3808 /* This puts it in the right list, and in the right order. */
3809 recenter_overlay_lists (b, b->overlay_center);
3811 return unbind_to (count, overlay);
3814 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3815 doc: /* Delete the overlay OVERLAY from its buffer. */)
3816 (Lisp_Object overlay)
3818 Lisp_Object buffer;
3819 struct buffer *b;
3820 ptrdiff_t count = SPECPDL_INDEX ();
3822 CHECK_OVERLAY (overlay);
3824 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3825 if (NILP (buffer))
3826 return Qnil;
3828 b = XBUFFER (buffer);
3829 specbind (Qinhibit_quit, Qt);
3831 b->overlays_before
3832 = unchain_overlay (b->overlays_before, XOVERLAY (overlay));
3833 b->overlays_after
3834 = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3835 eassert (XOVERLAY (overlay)->next == NULL);
3837 drop_overlay (b, XOVERLAY (overlay));
3839 /* When deleting an overlay with before or after strings, turn off
3840 display optimizations for the affected buffer, on the basis that
3841 these strings may contain newlines. This is easier to do than to
3842 check for that situation during redisplay. */
3843 if (!windows_or_buffers_changed
3844 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3845 || !NILP (Foverlay_get (overlay, Qafter_string))))
3846 b->prevent_redisplay_optimizations_p = 1;
3848 return unbind_to (count, Qnil);
3851 /* Overlay dissection functions. */
3853 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3854 doc: /* Return the position at which OVERLAY starts. */)
3855 (Lisp_Object overlay)
3857 CHECK_OVERLAY (overlay);
3859 return (Fmarker_position (OVERLAY_START (overlay)));
3862 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3863 doc: /* Return the position at which OVERLAY ends. */)
3864 (Lisp_Object overlay)
3866 CHECK_OVERLAY (overlay);
3868 return (Fmarker_position (OVERLAY_END (overlay)));
3871 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3872 doc: /* Return the buffer OVERLAY belongs to.
3873 Return nil if OVERLAY has been deleted. */)
3874 (Lisp_Object overlay)
3876 CHECK_OVERLAY (overlay);
3878 return Fmarker_buffer (OVERLAY_START (overlay));
3881 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3882 doc: /* Return a list of the properties on OVERLAY.
3883 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3884 OVERLAY. */)
3885 (Lisp_Object overlay)
3887 CHECK_OVERLAY (overlay);
3889 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3893 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3894 doc: /* Return a list of the overlays that contain the character at POS. */)
3895 (Lisp_Object pos)
3897 ptrdiff_t len, noverlays;
3898 Lisp_Object *overlay_vec;
3899 Lisp_Object result;
3901 CHECK_NUMBER_COERCE_MARKER (pos);
3903 len = 10;
3904 /* We can't use alloca here because overlays_at can call xrealloc. */
3905 overlay_vec = xmalloc (len * sizeof *overlay_vec);
3907 /* Put all the overlays we want in a vector in overlay_vec.
3908 Store the length in len. */
3909 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3910 0, 0, 0);
3912 /* Make a list of them all. */
3913 result = Flist (noverlays, overlay_vec);
3915 xfree (overlay_vec);
3916 return result;
3919 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3920 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3921 Overlap means that at least one character is contained within the overlay
3922 and also contained within the specified region.
3923 Empty overlays are included in the result if they are located at BEG,
3924 between BEG and END, or at END provided END denotes the position at the
3925 end of the buffer. */)
3926 (Lisp_Object beg, Lisp_Object end)
3928 ptrdiff_t len, noverlays;
3929 Lisp_Object *overlay_vec;
3930 Lisp_Object result;
3932 CHECK_NUMBER_COERCE_MARKER (beg);
3933 CHECK_NUMBER_COERCE_MARKER (end);
3935 len = 10;
3936 overlay_vec = xmalloc (len * sizeof *overlay_vec);
3938 /* Put all the overlays we want in a vector in overlay_vec.
3939 Store the length in len. */
3940 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3941 NULL, NULL);
3943 /* Make a list of them all. */
3944 result = Flist (noverlays, overlay_vec);
3946 xfree (overlay_vec);
3947 return result;
3950 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3951 1, 1, 0,
3952 doc: /* Return the next position after POS where an overlay starts or ends.
3953 If there are no overlay boundaries from POS to (point-max),
3954 the value is (point-max). */)
3955 (Lisp_Object pos)
3957 ptrdiff_t i, len, noverlays;
3958 ptrdiff_t endpos;
3959 Lisp_Object *overlay_vec;
3961 CHECK_NUMBER_COERCE_MARKER (pos);
3963 len = 10;
3964 overlay_vec = xmalloc (len * sizeof *overlay_vec);
3966 /* Put all the overlays we want in a vector in overlay_vec.
3967 Store the length in len.
3968 endpos gets the position where the next overlay starts. */
3969 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3970 &endpos, 0, 1);
3972 /* If any of these overlays ends before endpos,
3973 use its ending point instead. */
3974 for (i = 0; i < noverlays; i++)
3976 Lisp_Object oend;
3977 ptrdiff_t oendpos;
3979 oend = OVERLAY_END (overlay_vec[i]);
3980 oendpos = OVERLAY_POSITION (oend);
3981 if (oendpos < endpos)
3982 endpos = oendpos;
3985 xfree (overlay_vec);
3986 return make_number (endpos);
3989 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3990 Sprevious_overlay_change, 1, 1, 0,
3991 doc: /* Return the previous position before POS where an overlay starts or ends.
3992 If there are no overlay boundaries from (point-min) to POS,
3993 the value is (point-min). */)
3994 (Lisp_Object pos)
3996 ptrdiff_t prevpos;
3997 Lisp_Object *overlay_vec;
3998 ptrdiff_t len;
4000 CHECK_NUMBER_COERCE_MARKER (pos);
4002 /* At beginning of buffer, we know the answer;
4003 avoid bug subtracting 1 below. */
4004 if (XINT (pos) == BEGV)
4005 return pos;
4007 len = 10;
4008 overlay_vec = xmalloc (len * sizeof *overlay_vec);
4010 /* Put all the overlays we want in a vector in overlay_vec.
4011 Store the length in len.
4012 prevpos gets the position of the previous change. */
4013 overlays_at (XINT (pos), 1, &overlay_vec, &len,
4014 0, &prevpos, 1);
4016 xfree (overlay_vec);
4017 return make_number (prevpos);
4020 /* These functions are for debugging overlays. */
4022 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4023 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4024 The car has all the overlays before the overlay center;
4025 the cdr has all the overlays after the overlay center.
4026 Recentering overlays moves overlays between these lists.
4027 The lists you get are copies, so that changing them has no effect.
4028 However, the overlays you get are the real objects that the buffer uses. */)
4029 (void)
4031 struct Lisp_Overlay *ol;
4032 Lisp_Object before = Qnil, after = Qnil, tmp;
4033 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4035 XSETMISC (tmp, ol);
4036 before = Fcons (tmp, before);
4038 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4040 XSETMISC (tmp, ol);
4041 after = Fcons (tmp, after);
4043 return Fcons (Fnreverse (before), Fnreverse (after));
4046 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4047 doc: /* Recenter the overlays of the current buffer around position POS.
4048 That makes overlay lookup faster for positions near POS (but perhaps slower
4049 for positions far away from POS). */)
4050 (Lisp_Object pos)
4052 ptrdiff_t p;
4053 CHECK_NUMBER_COERCE_MARKER (pos);
4055 p = clip_to_bounds (PTRDIFF_MIN, XINT (pos), PTRDIFF_MAX);
4056 recenter_overlay_lists (current_buffer, p);
4057 return Qnil;
4060 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4061 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4062 (Lisp_Object overlay, Lisp_Object prop)
4064 CHECK_OVERLAY (overlay);
4065 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4068 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4069 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4070 VALUE will be returned.*/)
4071 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4073 Lisp_Object tail, buffer;
4074 int changed;
4076 CHECK_OVERLAY (overlay);
4078 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4080 for (tail = XOVERLAY (overlay)->plist;
4081 CONSP (tail) && CONSP (XCDR (tail));
4082 tail = XCDR (XCDR (tail)))
4083 if (EQ (XCAR (tail), prop))
4085 changed = !EQ (XCAR (XCDR (tail)), value);
4086 XSETCAR (XCDR (tail), value);
4087 goto found;
4089 /* It wasn't in the list, so add it to the front. */
4090 changed = !NILP (value);
4091 XOVERLAY (overlay)->plist
4092 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4093 found:
4094 if (! NILP (buffer))
4096 if (changed)
4097 modify_overlay (XBUFFER (buffer),
4098 marker_position (OVERLAY_START (overlay)),
4099 marker_position (OVERLAY_END (overlay)));
4100 if (EQ (prop, Qevaporate) && ! NILP (value)
4101 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4102 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4103 Fdelete_overlay (overlay);
4106 return value;
4109 /* Subroutine of report_overlay_modification. */
4111 /* Lisp vector holding overlay hook functions to call.
4112 Vector elements come in pairs.
4113 Each even-index element is a list of hook functions.
4114 The following odd-index element is the overlay they came from.
4116 Before the buffer change, we fill in this vector
4117 as we call overlay hook functions.
4118 After the buffer change, we get the functions to call from this vector.
4119 This way we always call the same functions before and after the change. */
4120 static Lisp_Object last_overlay_modification_hooks;
4122 /* Number of elements actually used in last_overlay_modification_hooks. */
4123 static ptrdiff_t last_overlay_modification_hooks_used;
4125 /* Add one functionlist/overlay pair
4126 to the end of last_overlay_modification_hooks. */
4128 static void
4129 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4131 ptrdiff_t oldsize = ASIZE (last_overlay_modification_hooks);
4133 if (oldsize - 1 <= last_overlay_modification_hooks_used)
4134 last_overlay_modification_hooks =
4135 larger_vector (last_overlay_modification_hooks, 2, -1);
4136 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4137 functionlist); last_overlay_modification_hooks_used++;
4138 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4139 overlay); last_overlay_modification_hooks_used++;
4142 /* Run the modification-hooks of overlays that include
4143 any part of the text in START to END.
4144 If this change is an insertion, also
4145 run the insert-before-hooks of overlay starting at END,
4146 and the insert-after-hooks of overlay ending at START.
4148 This is called both before and after the modification.
4149 AFTER is nonzero when we call after the modification.
4151 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4152 When AFTER is nonzero, they are the start position,
4153 the position after the inserted new text,
4154 and the length of deleted or replaced old text. */
4156 void
4157 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4158 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4160 Lisp_Object prop, overlay;
4161 struct Lisp_Overlay *tail;
4162 /* 1 if this change is an insertion. */
4163 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4164 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4166 overlay = Qnil;
4167 tail = NULL;
4169 /* We used to run the functions as soon as we found them and only register
4170 them in last_overlay_modification_hooks for the purpose of the `after'
4171 case. But running elisp code as we traverse the list of overlays is
4172 painful because the list can be modified by the elisp code so we had to
4173 copy at several places. We now simply do a read-only traversal that
4174 only collects the functions to run and we run them afterwards. It's
4175 simpler, especially since all the code was already there. -stef */
4177 if (!after)
4179 /* We are being called before a change.
4180 Scan the overlays to find the functions to call. */
4181 last_overlay_modification_hooks_used = 0;
4182 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4184 ptrdiff_t startpos, endpos;
4185 Lisp_Object ostart, oend;
4187 XSETMISC (overlay, tail);
4189 ostart = OVERLAY_START (overlay);
4190 oend = OVERLAY_END (overlay);
4191 endpos = OVERLAY_POSITION (oend);
4192 if (XFASTINT (start) > endpos)
4193 break;
4194 startpos = OVERLAY_POSITION (ostart);
4195 if (insertion && (XFASTINT (start) == startpos
4196 || XFASTINT (end) == startpos))
4198 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4199 if (!NILP (prop))
4200 add_overlay_mod_hooklist (prop, overlay);
4202 if (insertion && (XFASTINT (start) == endpos
4203 || XFASTINT (end) == endpos))
4205 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4206 if (!NILP (prop))
4207 add_overlay_mod_hooklist (prop, overlay);
4209 /* Test for intersecting intervals. This does the right thing
4210 for both insertion and deletion. */
4211 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4213 prop = Foverlay_get (overlay, Qmodification_hooks);
4214 if (!NILP (prop))
4215 add_overlay_mod_hooklist (prop, overlay);
4219 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4221 ptrdiff_t startpos, endpos;
4222 Lisp_Object ostart, oend;
4224 XSETMISC (overlay, tail);
4226 ostart = OVERLAY_START (overlay);
4227 oend = OVERLAY_END (overlay);
4228 startpos = OVERLAY_POSITION (ostart);
4229 endpos = OVERLAY_POSITION (oend);
4230 if (XFASTINT (end) < startpos)
4231 break;
4232 if (insertion && (XFASTINT (start) == startpos
4233 || XFASTINT (end) == startpos))
4235 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4236 if (!NILP (prop))
4237 add_overlay_mod_hooklist (prop, overlay);
4239 if (insertion && (XFASTINT (start) == endpos
4240 || XFASTINT (end) == endpos))
4242 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4243 if (!NILP (prop))
4244 add_overlay_mod_hooklist (prop, overlay);
4246 /* Test for intersecting intervals. This does the right thing
4247 for both insertion and deletion. */
4248 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4250 prop = Foverlay_get (overlay, Qmodification_hooks);
4251 if (!NILP (prop))
4252 add_overlay_mod_hooklist (prop, overlay);
4257 GCPRO4 (overlay, arg1, arg2, arg3);
4259 /* Call the functions recorded in last_overlay_modification_hooks.
4260 First copy the vector contents, in case some of these hooks
4261 do subsequent modification of the buffer. */
4262 ptrdiff_t size = last_overlay_modification_hooks_used;
4263 Lisp_Object *copy = alloca (size * sizeof *copy);
4264 ptrdiff_t i;
4266 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4267 size * sizeof (Lisp_Object));
4268 gcpro1.var = copy;
4269 gcpro1.nvars = size;
4271 for (i = 0; i < size;)
4273 Lisp_Object prop_i, overlay_i;
4274 prop_i = copy[i++];
4275 overlay_i = copy[i++];
4276 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4279 UNGCPRO;
4282 static void
4283 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4284 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4286 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4288 GCPRO4 (list, arg1, arg2, arg3);
4290 while (CONSP (list))
4292 if (NILP (arg3))
4293 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4294 else
4295 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4296 list = XCDR (list);
4298 UNGCPRO;
4301 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4302 property is set. */
4303 void
4304 evaporate_overlays (ptrdiff_t pos)
4306 Lisp_Object overlay, hit_list;
4307 struct Lisp_Overlay *tail;
4309 hit_list = Qnil;
4310 if (pos <= current_buffer->overlay_center)
4311 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4313 ptrdiff_t endpos;
4314 XSETMISC (overlay, tail);
4315 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4316 if (endpos < pos)
4317 break;
4318 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4319 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4320 hit_list = Fcons (overlay, hit_list);
4322 else
4323 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4325 ptrdiff_t startpos;
4326 XSETMISC (overlay, tail);
4327 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4328 if (startpos > pos)
4329 break;
4330 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4331 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4332 hit_list = Fcons (overlay, hit_list);
4334 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4335 Fdelete_overlay (XCAR (hit_list));
4338 /* Somebody has tried to store a value with an unacceptable type
4339 in the slot with offset OFFSET. */
4341 void
4342 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4344 Lisp_Object predicate;
4346 switch (type)
4348 case_Lisp_Int: predicate = Qintegerp; break;
4349 case Lisp_String: predicate = Qstringp; break;
4350 case Lisp_Symbol: predicate = Qsymbolp; break;
4351 default: abort ();
4354 wrong_type_argument (predicate, newval);
4358 /***********************************************************************
4359 Allocation with mmap
4360 ***********************************************************************/
4362 #ifdef USE_MMAP_FOR_BUFFERS
4364 #include <sys/types.h>
4365 #include <sys/mman.h>
4367 #ifndef MAP_ANON
4368 #ifdef MAP_ANONYMOUS
4369 #define MAP_ANON MAP_ANONYMOUS
4370 #else
4371 #define MAP_ANON 0
4372 #endif
4373 #endif
4375 #ifndef MAP_FAILED
4376 #define MAP_FAILED ((void *) -1)
4377 #endif
4379 #include <stdio.h>
4381 #if MAP_ANON == 0
4382 #include <fcntl.h>
4383 #endif
4385 #include "coding.h"
4388 /* Memory is allocated in regions which are mapped using mmap(2).
4389 The current implementation lets the system select mapped
4390 addresses; we're not using MAP_FIXED in general, except when
4391 trying to enlarge regions.
4393 Each mapped region starts with a mmap_region structure, the user
4394 area starts after that structure, aligned to MEM_ALIGN.
4396 +-----------------------+
4397 | struct mmap_info + |
4398 | padding |
4399 +-----------------------+
4400 | user data |
4403 +-----------------------+ */
4405 struct mmap_region
4407 /* User-specified size. */
4408 size_t nbytes_specified;
4410 /* Number of bytes mapped */
4411 size_t nbytes_mapped;
4413 /* Pointer to the location holding the address of the memory
4414 allocated with the mmap'd block. The variable actually points
4415 after this structure. */
4416 void **var;
4418 /* Next and previous in list of all mmap'd regions. */
4419 struct mmap_region *next, *prev;
4422 /* Doubly-linked list of mmap'd regions. */
4424 static struct mmap_region *mmap_regions;
4426 /* File descriptor for mmap. If we don't have anonymous mapping,
4427 /dev/zero will be opened on it. */
4429 static int mmap_fd;
4431 /* Temporary storage for mmap_set_vars, see there. */
4433 static struct mmap_region *mmap_regions_1;
4434 static int mmap_fd_1;
4436 /* Page size on this system. */
4438 static int mmap_page_size;
4440 /* 1 means mmap has been initialized. */
4442 static int mmap_initialized_p;
4444 /* Value is X rounded up to the next multiple of N. */
4446 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4448 /* Size of mmap_region structure plus padding. */
4450 #define MMAP_REGION_STRUCT_SIZE \
4451 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4453 /* Given a pointer P to the start of the user-visible part of a mapped
4454 region, return a pointer to the start of the region. */
4456 #define MMAP_REGION(P) \
4457 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4459 /* Given a pointer P to the start of a mapped region, return a pointer
4460 to the start of the user-visible part of the region. */
4462 #define MMAP_USER_AREA(P) \
4463 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4465 #define MEM_ALIGN sizeof (double)
4467 /* Predicate returning true if part of the address range [START .. END]
4468 is currently mapped. Used to prevent overwriting an existing
4469 memory mapping.
4471 Default is to conservatively assume the address range is occupied by
4472 something else. This can be overridden by system configuration
4473 files if system-specific means to determine this exists. */
4475 #ifndef MMAP_ALLOCATED_P
4476 #define MMAP_ALLOCATED_P(start, end) 1
4477 #endif
4479 /* Perform necessary initializations for the use of mmap. */
4481 static void
4482 mmap_init (void)
4484 #if MAP_ANON == 0
4485 /* The value of mmap_fd is initially 0 in temacs, and -1
4486 in a dumped Emacs. */
4487 if (mmap_fd <= 0)
4489 /* No anonymous mmap -- we need the file descriptor. */
4490 mmap_fd = open ("/dev/zero", O_RDONLY);
4491 if (mmap_fd == -1)
4492 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4494 #endif /* MAP_ANON == 0 */
4496 if (mmap_initialized_p)
4497 return;
4498 mmap_initialized_p = 1;
4500 #if MAP_ANON != 0
4501 mmap_fd = -1;
4502 #endif
4504 mmap_page_size = getpagesize ();
4507 /* Return a region overlapping address range START...END, or null if
4508 none. END is not including, i.e. the last byte in the range
4509 is at END - 1. */
4511 static struct mmap_region *
4512 mmap_find (void *start, void *end)
4514 struct mmap_region *r;
4515 char *s = (char *) start, *e = (char *) end;
4517 for (r = mmap_regions; r; r = r->next)
4519 char *rstart = (char *) r;
4520 char *rend = rstart + r->nbytes_mapped;
4522 if (/* First byte of range, i.e. START, in this region? */
4523 (s >= rstart && s < rend)
4524 /* Last byte of range, i.e. END - 1, in this region? */
4525 || (e > rstart && e <= rend)
4526 /* First byte of this region in the range? */
4527 || (rstart >= s && rstart < e)
4528 /* Last byte of this region in the range? */
4529 || (rend > s && rend <= e))
4530 break;
4533 return r;
4537 /* Unmap a region. P is a pointer to the start of the user-araa of
4538 the region. Value is non-zero if successful. */
4540 static int
4541 mmap_free_1 (struct mmap_region *r)
4543 if (r->next)
4544 r->next->prev = r->prev;
4545 if (r->prev)
4546 r->prev->next = r->next;
4547 else
4548 mmap_regions = r->next;
4550 if (munmap (r, r->nbytes_mapped) == -1)
4552 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4553 return 0;
4556 return 1;
4560 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4561 Value is non-zero if successful. */
4563 static int
4564 mmap_enlarge (struct mmap_region *r, int npages)
4566 char *region_end = (char *) r + r->nbytes_mapped;
4567 size_t nbytes;
4568 int success = 0;
4570 if (npages < 0)
4572 /* Unmap pages at the end of the region. */
4573 nbytes = - npages * mmap_page_size;
4574 if (munmap (region_end - nbytes, nbytes) == -1)
4575 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4576 else
4578 r->nbytes_mapped -= nbytes;
4579 success = 1;
4582 else if (npages > 0)
4584 nbytes = npages * mmap_page_size;
4586 /* Try to map additional pages at the end of the region. We
4587 cannot do this if the address range is already occupied by
4588 something else because mmap deletes any previous mapping.
4589 I'm not sure this is worth doing, let's see. */
4590 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4592 void *p;
4594 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4595 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4596 if (p == MAP_FAILED)
4597 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4598 else if (p != region_end)
4600 /* Kernels are free to choose a different address. In
4601 that case, unmap what we've mapped above; we have
4602 no use for it. */
4603 if (munmap (p, nbytes) == -1)
4604 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4606 else
4608 r->nbytes_mapped += nbytes;
4609 success = 1;
4614 return success;
4618 /* Set or reset variables holding references to mapped regions. If
4619 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4620 non-zero, set all variables to the start of the user-areas
4621 of mapped regions.
4623 This function is called from Fdump_emacs to ensure that the dumped
4624 Emacs doesn't contain references to memory that won't be mapped
4625 when Emacs starts. */
4627 void
4628 mmap_set_vars (int restore_p)
4630 struct mmap_region *r;
4632 if (restore_p)
4634 mmap_regions = mmap_regions_1;
4635 mmap_fd = mmap_fd_1;
4636 for (r = mmap_regions; r; r = r->next)
4637 *r->var = MMAP_USER_AREA (r);
4639 else
4641 for (r = mmap_regions; r; r = r->next)
4642 *r->var = NULL;
4643 mmap_regions_1 = mmap_regions;
4644 mmap_regions = NULL;
4645 mmap_fd_1 = mmap_fd;
4646 mmap_fd = -1;
4651 /* Allocate a block of storage large enough to hold NBYTES bytes of
4652 data. A pointer to the data is returned in *VAR. VAR is thus the
4653 address of some variable which will use the data area.
4655 The allocation of 0 bytes is valid.
4657 If we can't allocate the necessary memory, set *VAR to null, and
4658 return null. */
4660 static void *
4661 mmap_alloc (void **var, size_t nbytes)
4663 void *p;
4664 size_t map;
4666 mmap_init ();
4668 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4669 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4670 mmap_fd, 0);
4672 if (p == MAP_FAILED)
4674 if (errno != ENOMEM)
4675 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4676 p = NULL;
4678 else
4680 struct mmap_region *r = (struct mmap_region *) p;
4682 r->nbytes_specified = nbytes;
4683 r->nbytes_mapped = map;
4684 r->var = var;
4685 r->prev = NULL;
4686 r->next = mmap_regions;
4687 if (r->next)
4688 r->next->prev = r;
4689 mmap_regions = r;
4691 p = MMAP_USER_AREA (p);
4694 return *var = p;
4698 /* Free a block of relocatable storage whose data is pointed to by
4699 PTR. Store 0 in *PTR to show there's no block allocated. */
4701 static void
4702 mmap_free (void **var)
4704 mmap_init ();
4706 if (*var)
4708 mmap_free_1 (MMAP_REGION (*var));
4709 *var = NULL;
4714 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4715 resize it to size NBYTES. Change *VAR to reflect the new block,
4716 and return this value. If more memory cannot be allocated, then
4717 leave *VAR unchanged, and return null. */
4719 static void *
4720 mmap_realloc (void **var, size_t nbytes)
4722 void *result;
4724 mmap_init ();
4726 if (*var == NULL)
4727 result = mmap_alloc (var, nbytes);
4728 else if (nbytes == 0)
4730 mmap_free (var);
4731 result = mmap_alloc (var, nbytes);
4733 else
4735 struct mmap_region *r = MMAP_REGION (*var);
4736 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4738 if (room < nbytes)
4740 /* Must enlarge. */
4741 void *old_ptr = *var;
4743 /* Try to map additional pages at the end of the region.
4744 If that fails, allocate a new region, copy data
4745 from the old region, then free it. */
4746 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4747 / mmap_page_size)))
4749 r->nbytes_specified = nbytes;
4750 *var = result = old_ptr;
4752 else if (mmap_alloc (var, nbytes))
4754 memcpy (*var, old_ptr, r->nbytes_specified);
4755 mmap_free_1 (MMAP_REGION (old_ptr));
4756 result = *var;
4757 r = MMAP_REGION (result);
4758 r->nbytes_specified = nbytes;
4760 else
4762 *var = old_ptr;
4763 result = NULL;
4766 else if (room - nbytes >= mmap_page_size)
4768 /* Shrinking by at least a page. Let's give some
4769 memory back to the system.
4771 The extra parens are to make the division happens first,
4772 on positive values, so we know it will round towards
4773 zero. */
4774 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4775 result = *var;
4776 r->nbytes_specified = nbytes;
4778 else
4780 /* Leave it alone. */
4781 result = *var;
4782 r->nbytes_specified = nbytes;
4786 return result;
4790 #endif /* USE_MMAP_FOR_BUFFERS */
4794 /***********************************************************************
4795 Buffer-text Allocation
4796 ***********************************************************************/
4798 /* Allocate NBYTES bytes for buffer B's text buffer. */
4800 static void
4801 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4803 void *p;
4805 BLOCK_INPUT;
4806 #if defined USE_MMAP_FOR_BUFFERS
4807 p = mmap_alloc ((void **) &b->text->beg, nbytes);
4808 #elif defined REL_ALLOC
4809 p = r_alloc ((void **) &b->text->beg, nbytes);
4810 #else
4811 p = xmalloc (nbytes);
4812 #endif
4814 if (p == NULL)
4816 UNBLOCK_INPUT;
4817 memory_full (nbytes);
4820 b->text->beg = (unsigned char *) p;
4821 UNBLOCK_INPUT;
4824 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4825 shrink it. */
4827 void
4828 enlarge_buffer_text (struct buffer *b, ptrdiff_t delta)
4830 void *p;
4831 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4832 + delta);
4833 BLOCK_INPUT;
4834 #if defined USE_MMAP_FOR_BUFFERS
4835 p = mmap_realloc ((void **) &b->text->beg, nbytes);
4836 #elif defined REL_ALLOC
4837 p = r_re_alloc ((void **) &b->text->beg, nbytes);
4838 #else
4839 p = xrealloc (b->text->beg, nbytes);
4840 #endif
4842 if (p == NULL)
4844 UNBLOCK_INPUT;
4845 memory_full (nbytes);
4848 BUF_BEG_ADDR (b) = (unsigned char *) p;
4849 UNBLOCK_INPUT;
4853 /* Free buffer B's text buffer. */
4855 static void
4856 free_buffer_text (struct buffer *b)
4858 BLOCK_INPUT;
4860 #if defined USE_MMAP_FOR_BUFFERS
4861 mmap_free ((void **) &b->text->beg);
4862 #elif defined REL_ALLOC
4863 r_alloc_free ((void **) &b->text->beg);
4864 #else
4865 xfree (b->text->beg);
4866 #endif
4868 BUF_BEG_ADDR (b) = NULL;
4869 UNBLOCK_INPUT;
4874 /***********************************************************************
4875 Initialization
4876 ***********************************************************************/
4878 void
4879 init_buffer_once (void)
4881 int idx;
4882 /* If you add, remove, or reorder Lisp_Objects in a struct buffer, make
4883 sure that this is still correct. Otherwise, mark_vectorlike may not
4884 trace all Lisp_Objects in buffer_defaults and buffer_local_symbols. */
4885 const int pvecsize
4886 = (offsetof (struct buffer, own_text) - sizeof (struct vectorlike_header))
4887 / sizeof (Lisp_Object);
4889 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4891 /* Make sure all markable slots in buffer_defaults
4892 are initialized reasonably, so mark_buffer won't choke. */
4893 reset_buffer (&buffer_defaults);
4894 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4895 reset_buffer_local_variables (&buffer_defaults, 1);
4896 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4897 reset_buffer (&buffer_local_symbols);
4898 reset_buffer_local_variables (&buffer_local_symbols, 1);
4899 /* Prevent GC from getting confused. */
4900 buffer_defaults.text = &buffer_defaults.own_text;
4901 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4902 /* No one will share the text with these buffers, but let's play it safe. */
4903 buffer_defaults.indirections = 0;
4904 buffer_local_symbols.indirections = 0;
4905 BUF_INTERVALS (&buffer_defaults) = 0;
4906 BUF_INTERVALS (&buffer_local_symbols) = 0;
4907 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, pvecsize);
4908 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4909 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, pvecsize);
4910 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4912 /* Set up the default values of various buffer slots. */
4913 /* Must do these before making the first buffer! */
4915 /* real setup is done in bindings.el */
4916 BVAR (&buffer_defaults, mode_line_format) = build_pure_c_string ("%-");
4917 BVAR (&buffer_defaults, header_line_format) = Qnil;
4918 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4919 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4920 BVAR (&buffer_defaults, case_fold_search) = Qt;
4921 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4922 BVAR (&buffer_defaults, selective_display) = Qnil;
4923 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4924 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4925 BVAR (&buffer_defaults, display_table) = Qnil;
4926 BVAR (&buffer_defaults, undo_list) = Qnil;
4927 BVAR (&buffer_defaults, mark_active) = Qnil;
4928 BVAR (&buffer_defaults, file_format) = Qnil;
4929 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4930 buffer_defaults.overlays_before = NULL;
4931 buffer_defaults.overlays_after = NULL;
4932 buffer_defaults.overlay_center = BEG;
4934 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4935 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4936 BVAR (&buffer_defaults, word_wrap) = Qnil;
4937 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4938 BVAR (&buffer_defaults, bidi_display_reordering) = Qt;
4939 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4940 BVAR (&buffer_defaults, cursor_type) = Qt;
4941 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4942 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4944 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4945 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4946 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4947 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4948 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4949 BVAR (&buffer_defaults, file_truename) = Qnil;
4950 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4951 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4952 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4953 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4954 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4955 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4956 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4957 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4958 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4959 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4960 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4961 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4962 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4963 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4964 BVAR (&buffer_defaults, display_time) = Qnil;
4966 /* Assign the local-flags to the slots that have default values.
4967 The local flag is a bit that is used in the buffer
4968 to say that it has its own local value for the slot.
4969 The local flag bits are in the local_var_flags slot of the buffer. */
4971 /* Nothing can work if this isn't true */
4972 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4974 /* 0 means not a lisp var, -1 means always local, else mask */
4975 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4976 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4977 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4978 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4979 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4980 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4981 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4982 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4983 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4984 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4985 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4986 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4987 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4988 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4989 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4990 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4991 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4992 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4993 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4995 idx = 1;
4996 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4997 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4998 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5009 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5010 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
5011 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5014 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5015 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5016 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5017 /* Make this one a permanent local. */
5018 buffer_permanent_local_flags[idx++] = 1;
5019 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5020 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5021 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5022 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5023 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5024 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5025 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5026 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5027 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5028 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5029 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5030 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5031 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5032 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5033 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5034 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5035 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5037 /* Need more room? */
5038 if (idx >= MAX_PER_BUFFER_VARS)
5039 abort ();
5040 last_per_buffer_idx = idx;
5042 Vbuffer_alist = Qnil;
5043 current_buffer = 0;
5044 all_buffers = 0;
5046 QSFundamental = build_pure_c_string ("Fundamental");
5048 Qfundamental_mode = intern_c_string ("fundamental-mode");
5049 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5051 Qmode_class = intern_c_string ("mode-class");
5053 Qprotected_field = intern_c_string ("protected-field");
5055 Qpermanent_local = intern_c_string ("permanent-local");
5057 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5058 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5060 /* super-magic invisible buffer */
5061 Vprin1_to_string_buffer = Fget_buffer_create (build_pure_c_string (" prin1"));
5062 Vbuffer_alist = Qnil;
5064 Fset_buffer (Fget_buffer_create (build_pure_c_string ("*scratch*")));
5066 inhibit_modification_hooks = 0;
5069 void
5070 init_buffer (void)
5072 char *pwd;
5073 Lisp_Object temp;
5074 ptrdiff_t len;
5076 #ifdef USE_MMAP_FOR_BUFFERS
5078 /* When using the ralloc implementation based on mmap(2), buffer
5079 text pointers will have been set to null in the dumped Emacs.
5080 Map new memory. */
5081 struct buffer *b;
5083 FOR_EACH_BUFFER (b)
5084 if (b->text->beg == NULL)
5085 enlarge_buffer_text (b, 0);
5087 #endif /* USE_MMAP_FOR_BUFFERS */
5089 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5090 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5091 Fset_buffer_multibyte (Qnil);
5093 pwd = get_current_dir_name ();
5095 if (!pwd)
5096 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5098 /* Maybe this should really use some standard subroutine
5099 whose definition is filename syntax dependent. */
5100 len = strlen (pwd);
5101 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5103 /* Grow buffer to add directory separator and '\0'. */
5104 pwd = realloc (pwd, len + 2);
5105 if (!pwd)
5106 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5107 pwd[len] = DIRECTORY_SEP;
5108 pwd[len + 1] = '\0';
5109 len++;
5112 BVAR (current_buffer, directory) = make_unibyte_string (pwd, len);
5113 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5114 /* At this moment, we still don't know how to decode the
5115 directory name. So, we keep the bytes in multibyte form so
5116 that ENCODE_FILE correctly gets the original bytes. */
5117 BVAR (current_buffer, directory)
5118 = string_to_multibyte (BVAR (current_buffer, directory));
5120 /* Add /: to the front of the name
5121 if it would otherwise be treated as magic. */
5122 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5123 if (! NILP (temp)
5124 /* If the default dir is just /, TEMP is non-nil
5125 because of the ange-ftp completion handler.
5126 However, it is not necessary to turn / into /:/.
5127 So avoid doing that. */
5128 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5129 BVAR (current_buffer, directory)
5130 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5132 temp = get_minibuffer (0);
5133 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5135 free (pwd);
5138 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5139 Object stored in the current buffer. address is the address of the slot
5140 in the buffer that is current now. */
5142 /* TYPE is nil for a general Lisp variable.
5143 An integer specifies a type; then only Lisp values
5144 with that type code are allowed (except that nil is allowed too).
5145 LNAME is the Lisp-level variable name.
5146 VNAME is the name of the buffer slot.
5147 DOC is a dummy where you write the doc string as a comment. */
5148 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5149 do { \
5150 static struct Lisp_Buffer_Objfwd bo_fwd; \
5151 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5152 } while (0)
5154 static void
5155 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5156 Lisp_Object *address, Lisp_Object type)
5158 struct Lisp_Symbol *sym;
5159 int offset;
5161 sym = XSYMBOL (intern (namestring));
5162 offset = (char *)address - (char *)current_buffer;
5164 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5165 bo_fwd->offset = offset;
5166 bo_fwd->slottype = type;
5167 sym->declared_special = 1;
5168 sym->redirect = SYMBOL_FORWARDED;
5170 /* I tried to do the job without a cast, but it seems impossible.
5171 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5172 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5174 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5176 if (PER_BUFFER_IDX (offset) == 0)
5177 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5178 slot of buffer_local_flags */
5179 abort ();
5183 /* initialize the buffer routines */
5184 void
5185 syms_of_buffer (void)
5187 staticpro (&last_overlay_modification_hooks);
5188 last_overlay_modification_hooks
5189 = Fmake_vector (make_number (10), Qnil);
5191 staticpro (&Vbuffer_defaults);
5192 staticpro (&Vbuffer_local_symbols);
5193 staticpro (&Qfundamental_mode);
5194 staticpro (&Qmode_class);
5195 staticpro (&QSFundamental);
5196 staticpro (&Vbuffer_alist);
5197 staticpro (&Qprotected_field);
5198 staticpro (&Qpermanent_local);
5199 staticpro (&Qkill_buffer_hook);
5201 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5202 DEFSYM (Qoverlayp, "overlayp");
5203 DEFSYM (Qevaporate, "evaporate");
5204 DEFSYM (Qmodification_hooks, "modification-hooks");
5205 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5206 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5207 DEFSYM (Qget_file_buffer, "get-file-buffer");
5208 DEFSYM (Qpriority, "priority");
5209 DEFSYM (Qbefore_string, "before-string");
5210 DEFSYM (Qafter_string, "after-string");
5211 DEFSYM (Qfirst_change_hook, "first-change-hook");
5212 DEFSYM (Qbefore_change_functions, "before-change-functions");
5213 DEFSYM (Qafter_change_functions, "after-change-functions");
5214 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5216 Fput (Qprotected_field, Qerror_conditions,
5217 listn (CONSTYPE_PURE, 2, Qprotected_field, Qerror));
5218 Fput (Qprotected_field, Qerror_message,
5219 build_pure_c_string ("Attempt to modify a protected field"));
5221 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5222 mode_line_format,
5223 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5224 This is the same as (default-value 'mode-line-format). */);
5226 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5227 header_line_format,
5228 doc: /* Default value of `header-line-format' for buffers that don't override it.
5229 This is the same as (default-value 'header-line-format). */);
5231 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5232 doc: /* Default value of `cursor-type' for buffers that don't override it.
5233 This is the same as (default-value 'cursor-type). */);
5235 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5236 extra_line_spacing,
5237 doc: /* Default value of `line-spacing' for buffers that don't override it.
5238 This is the same as (default-value 'line-spacing). */);
5240 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5241 cursor_in_non_selected_windows,
5242 doc: /* Default value of `cursor-in-non-selected-windows'.
5243 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5245 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5246 abbrev_mode,
5247 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5248 This is the same as (default-value 'abbrev-mode). */);
5250 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5251 ctl_arrow,
5252 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5253 This is the same as (default-value 'ctl-arrow). */);
5255 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5256 enable_multibyte_characters,
5257 doc: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5258 This is the same as (default-value 'enable-multibyte-characters). */);
5260 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5261 buffer_file_coding_system,
5262 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5263 This is the same as (default-value 'buffer-file-coding-system). */);
5265 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5266 truncate_lines,
5267 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5268 This is the same as (default-value 'truncate-lines). */);
5270 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5271 fill_column,
5272 doc: /* Default value of `fill-column' for buffers that do not override it.
5273 This is the same as (default-value 'fill-column). */);
5275 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5276 left_margin,
5277 doc: /* Default value of `left-margin' for buffers that do not override it.
5278 This is the same as (default-value 'left-margin). */);
5280 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5281 tab_width,
5282 doc: /* Default value of `tab-width' for buffers that do not override it.
5283 This is the same as (default-value 'tab-width). */);
5285 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5286 case_fold_search,
5287 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5288 This is the same as (default-value 'case-fold-search). */);
5290 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5291 left_margin_cols,
5292 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5293 This is the same as (default-value 'left-margin-width). */);
5295 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5296 right_margin_cols,
5297 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5298 This is the same as (default-value 'right-margin-width). */);
5300 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5301 left_fringe_width,
5302 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5303 This is the same as (default-value 'left-fringe-width). */);
5305 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5306 right_fringe_width,
5307 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5308 This is the same as (default-value 'right-fringe-width). */);
5310 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5311 fringes_outside_margins,
5312 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5313 This is the same as (default-value 'fringes-outside-margins). */);
5315 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5316 scroll_bar_width,
5317 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5318 This is the same as (default-value 'scroll-bar-width). */);
5320 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5321 vertical_scroll_bar_type,
5322 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5323 This is the same as (default-value 'vertical-scroll-bar). */);
5325 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5326 indicate_empty_lines,
5327 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5328 This is the same as (default-value 'indicate-empty-lines). */);
5330 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5331 indicate_buffer_boundaries,
5332 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5333 This is the same as (default-value 'indicate-buffer-boundaries). */);
5335 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5336 fringe_indicator_alist,
5337 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5338 This is the same as (default-value 'fringe-indicator-alist'). */);
5340 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5341 fringe_cursor_alist,
5342 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5343 This is the same as (default-value 'fringe-cursor-alist'). */);
5345 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5346 scroll_up_aggressively,
5347 doc: /* Default value of `scroll-up-aggressively'.
5348 This value applies in buffers that don't have their own local values.
5349 This is the same as (default-value 'scroll-up-aggressively). */);
5351 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5352 scroll_down_aggressively,
5353 doc: /* Default value of `scroll-down-aggressively'.
5354 This value applies in buffers that don't have their own local values.
5355 This is the same as (default-value 'scroll-down-aggressively). */);
5357 DEFVAR_PER_BUFFER ("header-line-format",
5358 &BVAR (current_buffer, header_line_format),
5359 Qnil,
5360 doc: /* Analogous to `mode-line-format', but controls the header line.
5361 The header line appears, optionally, at the top of a window;
5362 the mode line appears at the bottom. */);
5364 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5365 Qnil,
5366 doc: /* Template for displaying mode line for current buffer.
5368 The value may be nil, a string, a symbol or a list.
5370 A value of nil means don't display a mode line.
5372 For any symbol other than t or nil, the symbol's value is processed as
5373 a mode line construct. As a special exception, if that value is a
5374 string, the string is processed verbatim, without handling any
5375 %-constructs (see below). Also, unless the symbol has a non-nil
5376 `risky-local-variable' property, all properties in any strings, as
5377 well as all :eval and :propertize forms in the value, are ignored.
5379 A list whose car is a string or list is processed by processing each
5380 of the list elements recursively, as separate mode line constructs,
5381 and concatenating the results.
5383 A list of the form `(:eval FORM)' is processed by evaluating FORM and
5384 using the result as a mode line construct. Be careful--FORM should
5385 not load any files, because that can cause an infinite recursion.
5387 A list of the form `(:propertize ELT PROPS...)' is processed by
5388 processing ELT as the mode line construct, and adding the text
5389 properties PROPS to the result.
5391 A list whose car is a symbol is processed by examining the symbol's
5392 value, and, if that value is non-nil, processing the cadr of the list
5393 recursively; and if that value is nil, processing the caddr of the
5394 list recursively.
5396 A list whose car is an integer is processed by processing the cadr of
5397 the list, and padding (if the number is positive) or truncating (if
5398 negative) to the width specified by that number.
5400 A string is printed verbatim in the mode line except for %-constructs:
5401 %b -- print buffer name. %f -- print visited file name.
5402 %F -- print frame name.
5403 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5404 %& is like %*, but ignore read-only-ness.
5405 % means buffer is read-only and * means it is modified.
5406 For a modified read-only buffer, %* gives % and %+ gives *.
5407 %s -- print process status. %l -- print the current line number.
5408 %c -- print the current column number (this makes editing slower).
5409 To make the column number update correctly in all cases,
5410 `column-number-mode' must be non-nil.
5411 %i -- print the size of the buffer.
5412 %I -- like %i, but use k, M, G, etc., to abbreviate.
5413 %p -- print percent of buffer above top of window, or Top, Bot or All.
5414 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5415 or print Bottom or All.
5416 %n -- print Narrow if appropriate.
5417 %t -- visited file is text or binary (if OS supports this distinction).
5418 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5419 %Z -- like %z, but including the end-of-line format.
5420 %e -- print error message about full memory.
5421 %@ -- print @ or hyphen. @ means that default-directory is on a
5422 remote machine.
5423 %[ -- print one [ for each recursive editing level. %] similar.
5424 %% -- print %. %- -- print infinitely many dashes.
5425 Decimal digits after the % specify field width to which to pad. */);
5427 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5428 doc: /* Value of `major-mode' for new buffers. */);
5430 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5431 make_number (Lisp_Symbol),
5432 doc: /* Symbol for current buffer's major mode.
5433 The default value (normally `fundamental-mode') affects new buffers.
5434 A value of nil means to use the current buffer's major mode, provided
5435 it is not marked as "special".
5437 When a mode is used by default, `find-file' switches to it before it
5438 reads the contents into the buffer and before it finishes setting up
5439 the buffer. Thus, the mode and its hooks should not expect certain
5440 variables such as `buffer-read-only' and `buffer-file-coding-system'
5441 to be set up. */);
5443 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5444 Qnil,
5445 doc: /* Pretty name of current buffer's major mode.
5446 Usually a string, but can use any of the constructs for `mode-line-format',
5447 which see.
5448 Format with `format-mode-line' to produce a string value. */);
5450 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5451 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5453 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5454 doc: /* Non-nil if Abbrev mode is enabled.
5455 Use the command `abbrev-mode' to change this variable. */);
5457 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5458 Qnil,
5459 doc: /* Non-nil if searches and matches should ignore case. */);
5461 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5462 make_number (Lisp_Int0),
5463 doc: /* Column beyond which automatic line-wrapping should happen.
5464 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5466 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5467 make_number (Lisp_Int0),
5468 doc: /* Column for the default `indent-line-function' to indent to.
5469 Linefeed indents to this column in Fundamental mode. */);
5471 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5472 make_number (Lisp_Int0),
5473 doc: /* Distance between tab stops (for display of tab characters), in columns.
5474 This should be an integer greater than zero. */);
5476 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5477 doc: /* Non-nil means display control chars with uparrow.
5478 A value of nil means use backslash and octal digits.
5479 This variable does not apply to characters whose display is specified
5480 in the current display table (if there is one). */);
5482 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5483 &BVAR (current_buffer, enable_multibyte_characters),
5484 Qnil,
5485 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5486 Otherwise they are regarded as unibyte. This affects the display,
5487 file I/O and the behavior of various editing commands.
5489 This variable is buffer-local but you cannot set it directly;
5490 use the function `set-buffer-multibyte' to change a buffer's representation.
5491 See also Info node `(elisp)Text Representations'. */);
5492 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5494 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5495 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5496 doc: /* Coding system to be used for encoding the buffer contents on saving.
5497 This variable applies to saving the buffer, and also to `write-region'
5498 and other functions that use `write-region'.
5499 It does not apply to sending output to subprocesses, however.
5501 If this is nil, the buffer is saved without any code conversion
5502 unless some coding system is specified in `file-coding-system-alist'
5503 for the buffer file.
5505 If the text to be saved cannot be encoded as specified by this variable,
5506 an alternative encoding is selected by `select-safe-coding-system', which see.
5508 The variable `coding-system-for-write', if non-nil, overrides this variable.
5510 This variable is never applied to a way of decoding a file while reading it. */);
5512 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5513 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5514 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5516 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5517 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5518 doc: /* If non-nil, forces directionality of text paragraphs in the buffer.
5520 If this is nil (the default), the direction of each paragraph is
5521 determined by the first strong directional character of its text.
5522 The values of `right-to-left' and `left-to-right' override that.
5523 Any other value is treated as nil.
5525 This variable has no effect unless the buffer's value of
5526 \`bidi-display-reordering' is non-nil. */);
5528 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5529 doc: /* Non-nil means do not display continuation lines.
5530 Instead, give each line of text just one screen line.
5532 Note that this is overridden by the variable
5533 `truncate-partial-width-windows' if that variable is non-nil
5534 and this buffer is not full-frame width.
5536 Minibuffers set this variable to nil. */);
5538 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5539 doc: /* Non-nil means to use word-wrapping for continuation lines.
5540 When word-wrapping is on, continuation lines are wrapped at the space
5541 or tab character nearest to the right window edge.
5542 If nil, continuation lines are wrapped at the right screen edge.
5544 This variable has no effect if long lines are truncated (see
5545 `truncate-lines' and `truncate-partial-width-windows'). If you use
5546 word-wrapping, you might want to reduce the value of
5547 `truncate-partial-width-windows', since wrapping can make text readable
5548 in narrower windows.
5550 Instead of setting this variable directly, most users should use
5551 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5552 to t, and additionally redefines simple editing commands to act on
5553 visual lines rather than logical lines. See the documentation of
5554 `visual-line-mode'. */);
5556 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5557 make_number (Lisp_String),
5558 doc: /* Name of default directory of current buffer. Should end with slash.
5559 To interactively change the default directory, use command `cd'. */);
5561 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5562 Qnil,
5563 doc: /* Function called (if non-nil) to perform auto-fill.
5564 It is called after self-inserting any character specified in
5565 the `auto-fill-chars' table.
5566 NOTE: This variable is not a hook;
5567 its value may not be a list of functions. */);
5569 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5570 make_number (Lisp_String),
5571 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5573 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5574 make_number (Lisp_String),
5575 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5576 The truename of a file is calculated by `file-truename'
5577 and then abbreviated with `abbreviate-file-name'. */);
5579 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5580 &BVAR (current_buffer, auto_save_file_name),
5581 make_number (Lisp_String),
5582 doc: /* Name of file for auto-saving current buffer.
5583 If it is nil, that means don't auto-save this buffer. */);
5585 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5586 doc: /* Non-nil if this buffer is read-only. */);
5588 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5589 doc: /* Non-nil if this buffer's file has been backed up.
5590 Backing up is done before the first time the file is saved. */);
5592 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5593 make_number (Lisp_Int0),
5594 doc: /* Length of current buffer when last read in, saved or auto-saved.
5595 0 initially.
5596 -1 means auto-saving turned off until next real save.
5598 If you set this to -2, that means don't turn off auto-saving in this buffer
5599 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5600 you probably should set this to -2 in that buffer. */);
5602 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5603 Qnil,
5604 doc: /* Non-nil enables selective display.
5605 An integer N as value means display only lines
5606 that start with less than N columns of space.
5607 A value of t means that the character ^M makes itself and
5608 all the rest of the line invisible; also, when saving the buffer
5609 in a file, save the ^M as a newline. */);
5611 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5612 &BVAR (current_buffer, selective_display_ellipses),
5613 Qnil,
5614 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5616 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5617 doc: /* Non-nil if self-insertion should replace existing text.
5618 The value should be one of `overwrite-mode-textual',
5619 `overwrite-mode-binary', or nil.
5620 If it is `overwrite-mode-textual', self-insertion still
5621 inserts at the end of a line, and inserts when point is before a tab,
5622 until the tab is filled in.
5623 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5625 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5626 Qnil,
5627 doc: /* Display table that controls display of the contents of current buffer.
5629 If this variable is nil, the value of `standard-display-table' is used.
5630 Each window can have its own, overriding display table, see
5631 `set-window-display-table' and `window-display-table'.
5633 The display table is a char-table created with `make-display-table'.
5634 A char-table is an array indexed by character codes. Normal array
5635 primitives `aref' and `aset' can be used to access elements of a char-table.
5637 Each of the char-table elements control how to display the corresponding
5638 text character: the element at index C in the table says how to display
5639 the character whose code is C. Each element should be a vector of
5640 characters or nil. The value nil means display the character in the
5641 default fashion; otherwise, the characters from the vector are delivered
5642 to the screen instead of the original character.
5644 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5645 to display a capital Y instead of each X character.
5647 In addition, a char-table has six extra slots to control the display of:
5649 the end of a truncated screen line (extra-slot 0, a single character);
5650 the end of a continued line (extra-slot 1, a single character);
5651 the escape character used to display character codes in octal
5652 (extra-slot 2, a single character);
5653 the character used as an arrow for control characters (extra-slot 3,
5654 a single character);
5655 the decoration indicating the presence of invisible lines (extra-slot 4,
5656 a vector of characters);
5657 the character used to draw the border between side-by-side windows
5658 (extra-slot 5, a single character).
5660 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5662 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5663 Qnil,
5664 doc: /* Width of left marginal area for display of a buffer.
5665 A value of nil means no marginal area. */);
5667 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5668 Qnil,
5669 doc: /* Width of right marginal area for display of a buffer.
5670 A value of nil means no marginal area. */);
5672 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5673 Qnil,
5674 doc: /* Width of this buffer's left fringe (in pixels).
5675 A value of 0 means no left fringe is shown in this buffer's window.
5676 A value of nil means to use the left fringe width from the window's frame. */);
5678 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5679 Qnil,
5680 doc: /* Width of this buffer's right fringe (in pixels).
5681 A value of 0 means no right fringe is shown in this buffer's window.
5682 A value of nil means to use the right fringe width from the window's frame. */);
5684 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5685 Qnil,
5686 doc: /* Non-nil means to display fringes outside display margins.
5687 A value of nil means to display fringes between margins and buffer text. */);
5689 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5690 Qnil,
5691 doc: /* Width of this buffer's scroll bars in pixels.
5692 A value of nil means to use the scroll bar width from the window's frame. */);
5694 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5695 Qnil,
5696 doc: /* Position of this buffer's vertical scroll bar.
5697 The value takes effect whenever you tell a window to display this buffer;
5698 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5700 A value of `left' or `right' means put the vertical scroll bar at that side
5701 of the window; a value of nil means don't show any vertical scroll bars.
5702 A value of t (the default) means do whatever the window's frame specifies. */);
5704 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5705 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5706 doc: /* Visually indicate empty lines after the buffer end.
5707 If non-nil, a bitmap is displayed in the left fringe of a window on
5708 window-systems. */);
5710 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5711 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5712 doc: /* Visually indicate buffer boundaries and scrolling.
5713 If non-nil, the first and last line of the buffer are marked in the fringe
5714 of a window on window-systems with angle bitmaps, or if the window can be
5715 scrolled, the top and bottom line of the window are marked with up and down
5716 arrow bitmaps.
5718 If value is a symbol `left' or `right', both angle and arrow bitmaps
5719 are displayed in the left or right fringe, resp. Any other value
5720 that doesn't look like an alist means display the angle bitmaps in
5721 the left fringe but no arrows.
5723 You can exercise more precise control by using an alist as the
5724 value. Each alist element (INDICATOR . POSITION) specifies
5725 where to show one of the indicators. INDICATOR is one of `top',
5726 `bottom', `up', `down', or t, which specifies the default position,
5727 and POSITION is one of `left', `right', or nil, meaning do not show
5728 this indicator.
5730 For example, ((top . left) (t . right)) places the top angle bitmap in
5731 left fringe, the bottom angle bitmap in right fringe, and both arrow
5732 bitmaps in right fringe. To show just the angle bitmaps in the left
5733 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5735 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5736 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5737 doc: /* Mapping from logical to physical fringe indicator bitmaps.
5738 The value is an alist where each element (INDICATOR . BITMAPS)
5739 specifies the fringe bitmaps used to display a specific logical
5740 fringe indicator.
5742 INDICATOR specifies the logical indicator type which is one of the
5743 following symbols: `truncation' , `continuation', `overlay-arrow',
5744 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5746 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5747 the actual bitmap shown in the left or right fringe for the logical
5748 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5749 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5750 are used only for the `bottom' and `top-bottom' indicators when the
5751 last (only) line has no final newline. BITMAPS may also be a single
5752 symbol which is used in both left and right fringes. */);
5754 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5755 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5756 doc: /* Mapping from logical to physical fringe cursor bitmaps.
5757 The value is an alist where each element (CURSOR . BITMAP)
5758 specifies the fringe bitmaps used to display a specific logical
5759 cursor type in the fringe.
5761 CURSOR specifies the logical cursor type which is one of the following
5762 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5763 one is used to show a hollow cursor on narrow lines display lines
5764 where the normal hollow cursor will not fit.
5766 BITMAP is the corresponding fringe bitmap shown for the logical
5767 cursor type. */);
5769 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5770 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5771 doc: /* How far to scroll windows upward.
5772 If you move point off the bottom, the window scrolls automatically.
5773 This variable controls how far it scrolls. The value nil, the default,
5774 means scroll to center point. A fraction means scroll to put point
5775 that fraction of the window's height from the bottom of the window.
5776 When the value is 0.0, point goes at the bottom line, which in the
5777 simple case that you moved off with C-f means scrolling just one line.
5778 1.0 means point goes at the top, so that in that simple case, the
5779 window scrolls by a full window height. Meaningful values are
5780 between 0.0 and 1.0, inclusive. */);
5782 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5783 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5784 doc: /* How far to scroll windows downward.
5785 If you move point off the top, the window scrolls automatically.
5786 This variable controls how far it scrolls. The value nil, the default,
5787 means scroll to center point. A fraction means scroll to put point
5788 that fraction of the window's height from the top of the window.
5789 When the value is 0.0, point goes at the top line, which in the
5790 simple case that you moved off with C-b means scrolling just one line.
5791 1.0 means point goes at the bottom, so that in that simple case, the
5792 window scrolls by a full window height. Meaningful values are
5793 between 0.0 and 1.0, inclusive. */);
5795 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5796 "Don't ask.");
5799 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5800 doc: /* List of functions to call before each text change.
5801 Two arguments are passed to each function: the positions of
5802 the beginning and end of the range of old text to be changed.
5803 \(For an insertion, the beginning and end are at the same place.)
5804 No information is given about the length of the text after the change.
5806 Buffer changes made while executing the `before-change-functions'
5807 don't call any before-change or after-change functions.
5808 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5810 If an unhandled error happens in running these functions,
5811 the variable's value remains nil. That prevents the error
5812 from happening repeatedly and making Emacs nonfunctional. */);
5813 Vbefore_change_functions = Qnil;
5815 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5816 doc: /* List of functions to call after each text change.
5817 Three arguments are passed to each function: the positions of
5818 the beginning and end of the range of changed text,
5819 and the length in bytes of the pre-change text replaced by that range.
5820 \(For an insertion, the pre-change length is zero;
5821 for a deletion, that length is the number of bytes deleted,
5822 and the post-change beginning and end are at the same place.)
5824 Buffer changes made while executing the `after-change-functions'
5825 don't call any before-change or after-change functions.
5826 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5828 If an unhandled error happens in running these functions,
5829 the variable's value remains nil. That prevents the error
5830 from happening repeatedly and making Emacs nonfunctional. */);
5831 Vafter_change_functions = Qnil;
5833 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5834 doc: /* A list of functions to call before changing a buffer which is unmodified.
5835 The functions are run using the `run-hooks' function. */);
5836 Vfirst_change_hook = Qnil;
5838 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5839 doc: /* List of undo entries in current buffer.
5840 Recent changes come first; older changes follow newer.
5842 An entry (BEG . END) represents an insertion which begins at
5843 position BEG and ends at position END.
5845 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5846 from (abs POSITION). If POSITION is positive, point was at the front
5847 of the text being deleted; if negative, point was at the end.
5849 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
5850 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
5851 and is the visited file's modification time, as of that time. If the
5852 modification time of the most recent save is different, this entry is
5853 obsolete.
5855 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5856 was modified between BEG and END. PROPERTY is the property name,
5857 and VALUE is the old value.
5859 An entry (apply FUN-NAME . ARGS) means undo the change with
5860 \(apply FUN-NAME ARGS).
5862 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5863 in the active region. BEG and END is the range affected by this entry
5864 and DELTA is the number of bytes added or deleted in that range by
5865 this change.
5867 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5868 was adjusted in position by the offset DISTANCE (an integer).
5870 An entry of the form POSITION indicates that point was at the buffer
5871 location given by the integer. Undoing an entry of this form places
5872 point at POSITION.
5874 Entries with value `nil' mark undo boundaries. The undo command treats
5875 the changes between two undo boundaries as a single step to be undone.
5877 If the value of the variable is t, undo information is not recorded. */);
5879 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5880 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5882 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5883 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5885 Normally, the line-motion functions work by scanning the buffer for
5886 newlines. Columnar operations (like `move-to-column' and
5887 `compute-motion') also work by scanning the buffer, summing character
5888 widths as they go. This works well for ordinary text, but if the
5889 buffer's lines are very long (say, more than 500 characters), these
5890 motion functions will take longer to execute. Emacs may also take
5891 longer to update the display.
5893 If `cache-long-line-scans' is non-nil, these motion functions cache the
5894 results of their scans, and consult the cache to avoid rescanning
5895 regions of the buffer until the text is modified. The caches are most
5896 beneficial when they prevent the most searching---that is, when the
5897 buffer contains long lines and large regions of characters with the
5898 same, fixed screen width.
5900 When `cache-long-line-scans' is non-nil, processing short lines will
5901 become slightly slower (because of the overhead of consulting the
5902 cache), and the caches will use memory roughly proportional to the
5903 number of newlines and characters whose screen width varies.
5905 The caches require no explicit maintenance; their accuracy is
5906 maintained internally by the Emacs primitives. Enabling or disabling
5907 the cache should not affect the behavior of any of the motion
5908 functions; it should only affect their performance. */);
5910 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5911 doc: /* Value of point before the last series of scroll operations, or nil. */);
5913 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5914 doc: /* List of formats to use when saving this buffer.
5915 Formats are defined by `format-alist'. This variable is
5916 set when a file is visited. */);
5918 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5919 &BVAR (current_buffer, auto_save_file_format), Qnil,
5920 doc: /* Format in which to write auto-save files.
5921 Should be a list of symbols naming formats that are defined in `format-alist'.
5922 If it is t, which is the default, auto-save files are written in the
5923 same format as a regular save would use. */);
5925 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5926 &BVAR (current_buffer, invisibility_spec), Qnil,
5927 doc: /* Invisibility spec of this buffer.
5928 The default is t, which means that text is invisible
5929 if it has a non-nil `invisible' property.
5930 If the value is a list, a text character is invisible if its `invisible'
5931 property is an element in that list (or is a list with members in common).
5932 If an element is a cons cell of the form (PROP . ELLIPSIS),
5933 then characters with property value PROP are invisible,
5934 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5936 DEFVAR_PER_BUFFER ("buffer-display-count",
5937 &BVAR (current_buffer, display_count), Qnil,
5938 doc: /* A number incremented each time this buffer is displayed in a window.
5939 The function `set-window-buffer' increments it. */);
5941 DEFVAR_PER_BUFFER ("buffer-display-time",
5942 &BVAR (current_buffer, display_time), Qnil,
5943 doc: /* Time stamp updated each time this buffer is displayed in a window.
5944 The function `set-window-buffer' updates this variable
5945 to the value obtained by calling `current-time'.
5946 If the buffer has never been shown in a window, the value is nil. */);
5948 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5949 doc: /* Non-nil if Transient Mark mode is enabled.
5950 See the command `transient-mark-mode' for a description of this minor mode.
5952 Non-nil also enables highlighting of the region whenever the mark is active.
5953 The variable `highlight-nonselected-windows' controls whether to highlight
5954 all windows or just the selected window.
5956 Lisp programs may give this variable certain special values:
5958 - A value of `lambda' enables Transient Mark mode temporarily.
5959 It is disabled again after any subsequent action that would
5960 normally deactivate the mark (e.g. buffer modification).
5962 - A value of (only . OLDVAL) enables Transient Mark mode
5963 temporarily. After any subsequent point motion command that is
5964 not shift-translated, or any other action that would normally
5965 deactivate the mark (e.g. buffer modification), the value of
5966 `transient-mark-mode' is set to OLDVAL. */);
5967 Vtransient_mark_mode = Qnil;
5969 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5970 doc: /* Non-nil means disregard read-only status of buffers or characters.
5971 If the value is t, disregard `buffer-read-only' and all `read-only'
5972 text properties. If the value is a list, disregard `buffer-read-only'
5973 and disregard a `read-only' text property if the property value
5974 is a member of the list. */);
5975 Vinhibit_read_only = Qnil;
5977 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5978 doc: /* Cursor to use when this buffer is in the selected window.
5979 Values are interpreted as follows:
5981 t use the cursor specified for the frame
5982 nil don't display a cursor
5983 box display a filled box cursor
5984 hollow display a hollow box cursor
5985 bar display a vertical bar cursor with default width
5986 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5987 hbar display a horizontal bar cursor with default height
5988 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5989 ANYTHING ELSE display a hollow box cursor
5991 When the buffer is displayed in a non-selected window, the
5992 cursor's appearance is instead controlled by the variable
5993 `cursor-in-non-selected-windows'. */);
5995 DEFVAR_PER_BUFFER ("line-spacing",
5996 &BVAR (current_buffer, extra_line_spacing), Qnil,
5997 doc: /* Additional space to put between lines when displaying a buffer.
5998 The space is measured in pixels, and put below lines on graphic displays,
5999 see `display-graphic-p'.
6000 If value is a floating point number, it specifies the spacing relative
6001 to the default frame line height. A value of nil means add no extra space. */);
6003 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6004 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
6005 doc: /* Non-nil means show a cursor in non-selected windows.
6006 If nil, only shows a cursor in the selected window.
6007 If t, displays a cursor related to the usual cursor type
6008 \(a solid box becomes hollow, a bar becomes a narrower bar).
6009 You can also specify the cursor type as in the `cursor-type' variable.
6010 Use Custom to set this variable and update the display." */);
6012 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
6013 doc: /* List of functions called with no args to query before killing a buffer.
6014 The buffer being killed will be current while the functions are running.
6016 If any of them returns nil, the buffer is not killed. Functions run by
6017 this hook are supposed to not change the current buffer. */);
6018 Vkill_buffer_query_functions = Qnil;
6020 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
6021 doc: /* Normal hook run before changing the major mode of a buffer.
6022 The function `kill-all-local-variables' runs this before doing anything else. */);
6023 Vchange_major_mode_hook = Qnil;
6024 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
6026 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6027 doc: /* Hook run when the buffer list changes.
6028 Functions running this hook are `get-buffer-create',
6029 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6030 and `bury-buffer-internal'. */);
6031 Vbuffer_list_update_hook = Qnil;
6032 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
6034 defsubr (&Sbuffer_live_p);
6035 defsubr (&Sbuffer_list);
6036 defsubr (&Sget_buffer);
6037 defsubr (&Sget_file_buffer);
6038 defsubr (&Sget_buffer_create);
6039 defsubr (&Smake_indirect_buffer);
6040 defsubr (&Sgenerate_new_buffer_name);
6041 defsubr (&Sbuffer_name);
6042 defsubr (&Sbuffer_file_name);
6043 defsubr (&Sbuffer_base_buffer);
6044 defsubr (&Sbuffer_local_value);
6045 defsubr (&Sbuffer_local_variables);
6046 defsubr (&Sbuffer_modified_p);
6047 defsubr (&Sset_buffer_modified_p);
6048 defsubr (&Sbuffer_modified_tick);
6049 defsubr (&Sbuffer_chars_modified_tick);
6050 defsubr (&Srename_buffer);
6051 defsubr (&Sother_buffer);
6052 defsubr (&Sbuffer_enable_undo);
6053 defsubr (&Skill_buffer);
6054 defsubr (&Sbury_buffer_internal);
6055 defsubr (&Sset_buffer_major_mode);
6056 defsubr (&Scurrent_buffer);
6057 defsubr (&Sset_buffer);
6058 defsubr (&Sbarf_if_buffer_read_only);
6059 defsubr (&Serase_buffer);
6060 defsubr (&Sbuffer_swap_text);
6061 defsubr (&Sset_buffer_multibyte);
6062 defsubr (&Skill_all_local_variables);
6064 defsubr (&Soverlayp);
6065 defsubr (&Smake_overlay);
6066 defsubr (&Sdelete_overlay);
6067 defsubr (&Smove_overlay);
6068 defsubr (&Soverlay_start);
6069 defsubr (&Soverlay_end);
6070 defsubr (&Soverlay_buffer);
6071 defsubr (&Soverlay_properties);
6072 defsubr (&Soverlays_at);
6073 defsubr (&Soverlays_in);
6074 defsubr (&Snext_overlay_change);
6075 defsubr (&Sprevious_overlay_change);
6076 defsubr (&Soverlay_recenter);
6077 defsubr (&Soverlay_lists);
6078 defsubr (&Soverlay_get);
6079 defsubr (&Soverlay_put);
6080 defsubr (&Srestore_buffer_modified_p);
6083 void
6084 keys_of_buffer (void)
6086 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6087 initial_define_key (control_x_map, 'k', "kill-buffer");
6089 /* This must not be in syms_of_buffer, because Qdisabled is not
6090 initialized when that function gets called. */
6091 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);