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/>. */
22 #define BUFFER_INLINE EXTERN_INLINE
24 #include <sys/types.h>
26 #include <sys/param.h>
34 #include "intervals.h"
37 #include "character.h"
39 #include "region-cache.h"
41 #include "blockinput.h"
46 struct buffer
*current_buffer
; /* The current buffer. */
48 /* First buffer in chain of all buffers (in reverse order of creation).
49 Threaded through ->header.next.buffer. */
51 struct buffer
*all_buffers
;
53 /* This structure holds the default values of the buffer-local variables
54 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
55 The default value occupies the same slot in this structure
56 as an individual buffer's value occupies in that buffer.
57 Setting the default value also goes through the alist of buffers
58 and stores into each buffer that does not say it has a local value. */
60 struct buffer
alignas (GCALIGNMENT
) buffer_defaults
;
62 /* This structure marks which slots in a buffer have corresponding
63 default values in buffer_defaults.
64 Each such slot has a nonzero value in this structure.
65 The value has only one nonzero bit.
67 When a buffer has its own local value for a slot,
68 the entry for that slot (found in the same slot in this structure)
69 is turned on in the buffer's local_flags array.
71 If a slot in this structure is -1, then even though there may
72 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
73 and the corresponding slot in buffer_defaults is not used.
75 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
76 zero, that is a bug. */
78 struct buffer buffer_local_flags
;
80 /* This structure holds the names of symbols whose values may be
81 buffer-local. It is indexed and accessed in the same way as the above. */
83 struct buffer
alignas (GCALIGNMENT
) buffer_local_symbols
;
85 /* Return the symbol of the per-buffer variable at offset OFFSET in
86 the buffer structure. */
88 #define PER_BUFFER_SYMBOL(OFFSET) \
89 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
91 /* Maximum length of an overlay vector. */
92 #define OVERLAY_COUNT_MAX \
93 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
94 min (PTRDIFF_MAX, SIZE_MAX) / word_size))
96 /* Flags indicating which built-in buffer-local variables
97 are permanent locals. */
98 static char buffer_permanent_local_flags
[MAX_PER_BUFFER_VARS
];
100 /* Number of per-buffer variables used. */
102 int last_per_buffer_idx
;
104 static void call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
,
105 bool after
, Lisp_Object arg1
,
106 Lisp_Object arg2
, Lisp_Object arg3
);
107 static void swap_out_buffer_local_variables (struct buffer
*b
);
108 static void reset_buffer_local_variables (struct buffer
*, bool);
110 /* Alist of all buffer names vs the buffers. */
111 /* This used to be a variable, but is no longer,
112 to prevent lossage due to user rplac'ing this alist or its elements. */
113 Lisp_Object Vbuffer_alist
;
115 static Lisp_Object Qkill_buffer_query_functions
;
117 /* Hook run before changing a major mode. */
118 static Lisp_Object Qchange_major_mode_hook
;
120 Lisp_Object Qfirst_change_hook
;
121 Lisp_Object Qbefore_change_functions
;
122 Lisp_Object Qafter_change_functions
;
124 static Lisp_Object Qfundamental_mode
, Qmode_class
, Qpermanent_local
;
125 static Lisp_Object Qpermanent_local_hook
;
127 static Lisp_Object Qprotected_field
;
129 static Lisp_Object QSFundamental
; /* A string "Fundamental". */
131 static Lisp_Object Qkill_buffer_hook
;
132 static Lisp_Object Qbuffer_list_update_hook
;
134 static Lisp_Object Qget_file_buffer
;
136 static Lisp_Object Qoverlayp
;
138 Lisp_Object Qpriority
, Qbefore_string
, Qafter_string
;
140 static Lisp_Object Qevaporate
;
142 Lisp_Object Qmodification_hooks
;
143 Lisp_Object Qinsert_in_front_hooks
;
144 Lisp_Object Qinsert_behind_hooks
;
146 static void alloc_buffer_text (struct buffer
*, ptrdiff_t);
147 static void free_buffer_text (struct buffer
*b
);
148 static struct Lisp_Overlay
* copy_overlays (struct buffer
*, struct Lisp_Overlay
*);
149 static void modify_overlay (struct buffer
*, ptrdiff_t, ptrdiff_t);
150 static Lisp_Object
buffer_lisp_local_variables (struct buffer
*, bool);
152 /* These setters are used only in this file, so they can be private. */
154 bset_abbrev_mode (struct buffer
*b
, Lisp_Object val
)
156 b
->INTERNAL_FIELD (abbrev_mode
) = val
;
159 bset_abbrev_table (struct buffer
*b
, Lisp_Object val
)
161 b
->INTERNAL_FIELD (abbrev_table
) = val
;
164 bset_auto_fill_function (struct buffer
*b
, Lisp_Object val
)
166 b
->INTERNAL_FIELD (auto_fill_function
) = val
;
169 bset_auto_save_file_format (struct buffer
*b
, Lisp_Object val
)
171 b
->INTERNAL_FIELD (auto_save_file_format
) = val
;
174 bset_auto_save_file_name (struct buffer
*b
, Lisp_Object val
)
176 b
->INTERNAL_FIELD (auto_save_file_name
) = val
;
179 bset_backed_up (struct buffer
*b
, Lisp_Object val
)
181 b
->INTERNAL_FIELD (backed_up
) = val
;
184 bset_begv_marker (struct buffer
*b
, Lisp_Object val
)
186 b
->INTERNAL_FIELD (begv_marker
) = val
;
189 bset_bidi_display_reordering (struct buffer
*b
, Lisp_Object val
)
191 b
->INTERNAL_FIELD (bidi_display_reordering
) = val
;
194 bset_buffer_file_coding_system (struct buffer
*b
, Lisp_Object val
)
196 b
->INTERNAL_FIELD (buffer_file_coding_system
) = val
;
199 bset_cache_long_line_scans (struct buffer
*b
, Lisp_Object val
)
201 b
->INTERNAL_FIELD (cache_long_line_scans
) = val
;
204 bset_case_fold_search (struct buffer
*b
, Lisp_Object val
)
206 b
->INTERNAL_FIELD (case_fold_search
) = val
;
209 bset_ctl_arrow (struct buffer
*b
, Lisp_Object val
)
211 b
->INTERNAL_FIELD (ctl_arrow
) = val
;
214 bset_cursor_in_non_selected_windows (struct buffer
*b
, Lisp_Object val
)
216 b
->INTERNAL_FIELD (cursor_in_non_selected_windows
) = val
;
219 bset_cursor_type (struct buffer
*b
, Lisp_Object val
)
221 b
->INTERNAL_FIELD (cursor_type
) = val
;
224 bset_display_table (struct buffer
*b
, Lisp_Object val
)
226 b
->INTERNAL_FIELD (display_table
) = val
;
229 bset_extra_line_spacing (struct buffer
*b
, Lisp_Object val
)
231 b
->INTERNAL_FIELD (extra_line_spacing
) = val
;
234 bset_file_format (struct buffer
*b
, Lisp_Object val
)
236 b
->INTERNAL_FIELD (file_format
) = val
;
239 bset_file_truename (struct buffer
*b
, Lisp_Object val
)
241 b
->INTERNAL_FIELD (file_truename
) = val
;
244 bset_fringe_cursor_alist (struct buffer
*b
, Lisp_Object val
)
246 b
->INTERNAL_FIELD (fringe_cursor_alist
) = val
;
249 bset_fringe_indicator_alist (struct buffer
*b
, Lisp_Object val
)
251 b
->INTERNAL_FIELD (fringe_indicator_alist
) = val
;
254 bset_fringes_outside_margins (struct buffer
*b
, Lisp_Object val
)
256 b
->INTERNAL_FIELD (fringes_outside_margins
) = val
;
259 bset_header_line_format (struct buffer
*b
, Lisp_Object val
)
261 b
->INTERNAL_FIELD (header_line_format
) = val
;
264 bset_indicate_buffer_boundaries (struct buffer
*b
, Lisp_Object val
)
266 b
->INTERNAL_FIELD (indicate_buffer_boundaries
) = val
;
269 bset_indicate_empty_lines (struct buffer
*b
, Lisp_Object val
)
271 b
->INTERNAL_FIELD (indicate_empty_lines
) = val
;
274 bset_invisibility_spec (struct buffer
*b
, Lisp_Object val
)
276 b
->INTERNAL_FIELD (invisibility_spec
) = val
;
279 bset_left_fringe_width (struct buffer
*b
, Lisp_Object val
)
281 b
->INTERNAL_FIELD (left_fringe_width
) = val
;
284 bset_major_mode (struct buffer
*b
, Lisp_Object val
)
286 b
->INTERNAL_FIELD (major_mode
) = val
;
289 bset_mark (struct buffer
*b
, Lisp_Object val
)
291 b
->INTERNAL_FIELD (mark
) = val
;
294 bset_minor_modes (struct buffer
*b
, Lisp_Object val
)
296 b
->INTERNAL_FIELD (minor_modes
) = val
;
299 bset_mode_line_format (struct buffer
*b
, Lisp_Object val
)
301 b
->INTERNAL_FIELD (mode_line_format
) = val
;
304 bset_mode_name (struct buffer
*b
, Lisp_Object val
)
306 b
->INTERNAL_FIELD (mode_name
) = val
;
309 bset_name (struct buffer
*b
, Lisp_Object val
)
311 b
->INTERNAL_FIELD (name
) = val
;
314 bset_overwrite_mode (struct buffer
*b
, Lisp_Object val
)
316 b
->INTERNAL_FIELD (overwrite_mode
) = val
;
319 bset_pt_marker (struct buffer
*b
, Lisp_Object val
)
321 b
->INTERNAL_FIELD (pt_marker
) = val
;
324 bset_right_fringe_width (struct buffer
*b
, Lisp_Object val
)
326 b
->INTERNAL_FIELD (right_fringe_width
) = val
;
329 bset_save_length (struct buffer
*b
, Lisp_Object val
)
331 b
->INTERNAL_FIELD (save_length
) = val
;
334 bset_scroll_bar_width (struct buffer
*b
, Lisp_Object val
)
336 b
->INTERNAL_FIELD (scroll_bar_width
) = val
;
339 bset_scroll_down_aggressively (struct buffer
*b
, Lisp_Object val
)
341 b
->INTERNAL_FIELD (scroll_down_aggressively
) = val
;
344 bset_scroll_up_aggressively (struct buffer
*b
, Lisp_Object val
)
346 b
->INTERNAL_FIELD (scroll_up_aggressively
) = val
;
349 bset_selective_display (struct buffer
*b
, Lisp_Object val
)
351 b
->INTERNAL_FIELD (selective_display
) = val
;
354 bset_selective_display_ellipses (struct buffer
*b
, Lisp_Object val
)
356 b
->INTERNAL_FIELD (selective_display_ellipses
) = val
;
359 bset_vertical_scroll_bar_type (struct buffer
*b
, Lisp_Object val
)
361 b
->INTERNAL_FIELD (vertical_scroll_bar_type
) = val
;
364 bset_word_wrap (struct buffer
*b
, Lisp_Object val
)
366 b
->INTERNAL_FIELD (word_wrap
) = val
;
369 bset_zv_marker (struct buffer
*b
, Lisp_Object val
)
371 b
->INTERNAL_FIELD (zv_marker
) = val
;
374 /* For debugging; temporary. See set_buffer_internal. */
375 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
378 nsberror (Lisp_Object spec
)
381 error ("No buffer named %s", SDATA (spec
));
382 error ("Invalid buffer argument");
385 DEFUN ("buffer-live-p", Fbuffer_live_p
, Sbuffer_live_p
, 1, 1, 0,
386 doc
: /* Return non-nil if OBJECT is a buffer which has not been killed.
387 Value is nil if OBJECT is not a buffer or if it has been killed. */)
390 return ((BUFFERP (object
) && BUFFER_LIVE_P (XBUFFER (object
)))
394 DEFUN ("buffer-list", Fbuffer_list
, Sbuffer_list
, 0, 1, 0,
395 doc
: /* Return a list of all existing live buffers.
396 If the optional arg FRAME is a frame, we return the buffer list in the
397 proper order for that frame: the buffers show in FRAME come first,
398 followed by the rest of the buffers. */)
402 general
= Fmapcar (Qcdr
, Vbuffer_alist
);
406 Lisp_Object framelist
, prevlist
, tail
;
410 framelist
= Fcopy_sequence (XFRAME (frame
)->buffer_list
);
411 prevlist
= Fnreverse (Fcopy_sequence
412 (XFRAME (frame
)->buried_buffer_list
));
414 /* Remove from GENERAL any buffer that duplicates one in
415 FRAMELIST or PREVLIST. */
419 general
= Fdelq (XCAR (tail
), general
);
425 general
= Fdelq (XCAR (tail
), general
);
432 return Fnconc (3, args
);
438 /* Like Fassoc, but use Fstring_equal to compare
439 (which ignores text properties),
440 and don't ever QUIT. */
443 assoc_ignore_text_properties (register Lisp_Object key
, Lisp_Object list
)
445 register Lisp_Object tail
;
446 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
448 register Lisp_Object elt
, tem
;
450 tem
= Fstring_equal (Fcar (elt
), key
);
457 DEFUN ("get-buffer", Fget_buffer
, Sget_buffer
, 1, 1, 0,
458 doc
: /* Return the buffer named BUFFER-OR-NAME.
459 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
460 is a string and there is no buffer with that name, return nil. If
461 BUFFER-OR-NAME is a buffer, return it as given. */)
462 (register Lisp_Object buffer_or_name
)
464 if (BUFFERP (buffer_or_name
))
465 return buffer_or_name
;
466 CHECK_STRING (buffer_or_name
);
468 return Fcdr (assoc_ignore_text_properties (buffer_or_name
, Vbuffer_alist
));
471 DEFUN ("get-file-buffer", Fget_file_buffer
, Sget_file_buffer
, 1, 1, 0,
472 doc
: /* Return the buffer visiting file FILENAME (a string).
473 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
474 If there is no such live buffer, return nil.
475 See also `find-buffer-visiting'. */)
476 (register Lisp_Object filename
)
478 register Lisp_Object tail
, buf
, tem
;
481 CHECK_STRING (filename
);
482 filename
= Fexpand_file_name (filename
, Qnil
);
484 /* If the file name has special constructs in it,
485 call the corresponding file handler. */
486 handler
= Ffind_file_name_handler (filename
, Qget_file_buffer
);
489 Lisp_Object handled_buf
= call2 (handler
, Qget_file_buffer
,
491 return BUFFERP (handled_buf
) ? handled_buf
: Qnil
;
494 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
496 buf
= Fcdr (XCAR (tail
));
497 if (!BUFFERP (buf
)) continue;
498 if (!STRINGP (BVAR (XBUFFER (buf
), filename
))) continue;
499 tem
= Fstring_equal (BVAR (XBUFFER (buf
), filename
), filename
);
507 get_truename_buffer (register Lisp_Object filename
)
509 register Lisp_Object tail
, buf
, tem
;
511 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
513 buf
= Fcdr (XCAR (tail
));
514 if (!BUFFERP (buf
)) continue;
515 if (!STRINGP (BVAR (XBUFFER (buf
), file_truename
))) continue;
516 tem
= Fstring_equal (BVAR (XBUFFER (buf
), file_truename
), filename
);
523 DEFUN ("get-buffer-create", Fget_buffer_create
, Sget_buffer_create
, 1, 1, 0,
524 doc
: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
525 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
526 return that buffer. If no such buffer exists, create a new buffer with
527 that name and return it. If BUFFER-OR-NAME starts with a space, the new
528 buffer does not keep undo information.
530 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
531 even if it is dead. The return value is never nil. */)
532 (register Lisp_Object buffer_or_name
)
534 register Lisp_Object buffer
, name
;
535 register struct buffer
*b
;
537 buffer
= Fget_buffer (buffer_or_name
);
541 if (SCHARS (buffer_or_name
) == 0)
542 error ("Empty string for buffer name is not allowed");
544 b
= allocate_buffer ();
546 /* An ordinary buffer uses its own struct buffer_text. */
547 b
->text
= &b
->own_text
;
548 b
->base_buffer
= NULL
;
549 /* No one shares the text with us now. */
552 BUF_GAP_SIZE (b
) = 20;
554 /* We allocate extra 1-byte at the tail and keep it always '\0' for
555 anchoring a search. */
556 alloc_buffer_text (b
, BUF_GAP_SIZE (b
) + 1);
558 if (! BUF_BEG_ADDR (b
))
559 buffer_memory_full (BUF_GAP_SIZE (b
) + 1);
564 b
->pt_byte
= BEG_BYTE
;
565 b
->begv_byte
= BEG_BYTE
;
566 b
->zv_byte
= BEG_BYTE
;
569 BUF_GPT_BYTE (b
) = BEG_BYTE
;
572 BUF_Z_BYTE (b
) = BEG_BYTE
;
574 BUF_CHARS_MODIFF (b
) = 1;
575 BUF_OVERLAY_MODIFF (b
) = 1;
576 BUF_SAVE_MODIFF (b
) = 1;
577 set_buffer_intervals (b
, NULL
);
578 BUF_UNCHANGED_MODIFIED (b
) = 1;
579 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = 1;
580 BUF_END_UNCHANGED (b
) = 0;
581 BUF_BEG_UNCHANGED (b
) = 0;
582 *(BUF_GPT_ADDR (b
)) = *(BUF_Z_ADDR (b
)) = 0; /* Put an anchor '\0'. */
583 b
->text
->inhibit_shrinking
= 0;
585 b
->newline_cache
= 0;
586 b
->width_run_cache
= 0;
587 bset_width_table (b
, Qnil
);
588 b
->prevent_redisplay_optimizations_p
= 1;
590 /* An ordinary buffer normally doesn't need markers
591 to handle BEGV and ZV. */
592 bset_pt_marker (b
, Qnil
);
593 bset_begv_marker (b
, Qnil
);
594 bset_zv_marker (b
, Qnil
);
596 name
= Fcopy_sequence (buffer_or_name
);
597 set_string_intervals (name
, NULL
);
600 bset_undo_list (b
, SREF (name
, 0) != ' ' ? Qnil
: Qt
);
603 reset_buffer_local_variables (b
, 1);
605 bset_mark (b
, Fmake_marker ());
606 BUF_MARKERS (b
) = NULL
;
608 /* Put this in the alist of all live buffers. */
609 XSETBUFFER (buffer
, b
);
610 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buffer
), Qnil
));
611 /* And run buffer-list-update-hook. */
612 if (!NILP (Vrun_hooks
))
613 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
619 /* Return a list of overlays which is a copy of the overlay list
620 LIST, but for buffer B. */
622 static struct Lisp_Overlay
*
623 copy_overlays (struct buffer
*b
, struct Lisp_Overlay
*list
)
625 struct Lisp_Overlay
*result
= NULL
, *tail
= NULL
;
627 for (; list
; list
= list
->next
)
629 Lisp_Object overlay
, start
, end
;
630 struct Lisp_Marker
*m
;
632 eassert (MARKERP (list
->start
));
633 m
= XMARKER (list
->start
);
634 start
= build_marker (b
, m
->charpos
, m
->bytepos
);
635 XMARKER (start
)->insertion_type
= m
->insertion_type
;
637 eassert (MARKERP (list
->end
));
638 m
= XMARKER (list
->end
);
639 end
= build_marker (b
, m
->charpos
, m
->bytepos
);
640 XMARKER (end
)->insertion_type
= m
->insertion_type
;
642 overlay
= build_overlay (start
, end
, Fcopy_sequence (list
->plist
));
644 tail
= tail
->next
= XOVERLAY (overlay
);
646 result
= tail
= XOVERLAY (overlay
);
652 /* Set an appropriate overlay of B. */
655 set_buffer_overlays_before (struct buffer
*b
, struct Lisp_Overlay
*o
)
657 b
->overlays_before
= o
;
661 set_buffer_overlays_after (struct buffer
*b
, struct Lisp_Overlay
*o
)
663 b
->overlays_after
= o
;
666 /* Clone per-buffer values of buffer FROM.
668 Buffer TO gets the same per-buffer values as FROM, with the
669 following exceptions: (1) TO's name is left untouched, (2) markers
670 are copied and made to refer to TO, and (3) overlay lists are
674 clone_per_buffer_values (struct buffer
*from
, struct buffer
*to
)
678 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
682 /* Don't touch the `name' which should be unique for every buffer. */
683 if (offset
== PER_BUFFER_VAR_OFFSET (name
))
686 obj
= per_buffer_value (from
, offset
);
687 if (MARKERP (obj
) && XMARKER (obj
)->buffer
== from
)
689 struct Lisp_Marker
*m
= XMARKER (obj
);
691 obj
= build_marker (to
, m
->charpos
, m
->bytepos
);
692 XMARKER (obj
)->insertion_type
= m
->insertion_type
;
695 set_per_buffer_value (to
, offset
, obj
);
698 memcpy (to
->local_flags
, from
->local_flags
, sizeof to
->local_flags
);
700 set_buffer_overlays_before (to
, copy_overlays (to
, from
->overlays_before
));
701 set_buffer_overlays_after (to
, copy_overlays (to
, from
->overlays_after
));
703 /* Get (a copy of) the alist of Lisp-level local variables of FROM
704 and install that in TO. */
705 bset_local_var_alist (to
, buffer_lisp_local_variables (from
, 1));
709 /* If buffer B has markers to record PT, BEGV and ZV when it is not
710 current, update these markers. */
713 record_buffer_markers (struct buffer
*b
)
715 if (! NILP (BVAR (b
, pt_marker
)))
719 eassert (!NILP (BVAR (b
, begv_marker
)));
720 eassert (!NILP (BVAR (b
, zv_marker
)));
722 XSETBUFFER (buffer
, b
);
723 set_marker_both (BVAR (b
, pt_marker
), buffer
, b
->pt
, b
->pt_byte
);
724 set_marker_both (BVAR (b
, begv_marker
), buffer
, b
->begv
, b
->begv_byte
);
725 set_marker_both (BVAR (b
, zv_marker
), buffer
, b
->zv
, b
->zv_byte
);
730 /* If buffer B has markers to record PT, BEGV and ZV when it is not
731 current, fetch these values into B->begv etc. */
734 fetch_buffer_markers (struct buffer
*b
)
736 if (! NILP (BVAR (b
, pt_marker
)))
740 eassert (!NILP (BVAR (b
, begv_marker
)));
741 eassert (!NILP (BVAR (b
, zv_marker
)));
743 m
= BVAR (b
, pt_marker
);
744 SET_BUF_PT_BOTH (b
, marker_position (m
), marker_byte_position (m
));
746 m
= BVAR (b
, begv_marker
);
747 SET_BUF_BEGV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
749 m
= BVAR (b
, zv_marker
);
750 SET_BUF_ZV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
755 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer
, Smake_indirect_buffer
,
757 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
758 doc
: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
759 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
760 NAME should be a string which is not the name of an existing buffer.
761 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
762 such as major and minor modes, in the indirect buffer.
763 CLONE nil means the indirect buffer's state is reset to default values. */)
764 (Lisp_Object base_buffer
, Lisp_Object name
, Lisp_Object clone
)
766 Lisp_Object buf
, tem
;
770 buf
= Fget_buffer (name
);
772 error ("Buffer name `%s' is in use", SDATA (name
));
775 base_buffer
= Fget_buffer (base_buffer
);
776 if (NILP (base_buffer
))
777 error ("No such buffer: `%s'", SDATA (tem
));
778 if (!BUFFER_LIVE_P (XBUFFER (base_buffer
)))
779 error ("Base buffer has been killed");
781 if (SCHARS (name
) == 0)
782 error ("Empty string for buffer name is not allowed");
784 b
= allocate_buffer ();
786 /* No double indirection - if base buffer is indirect,
787 new buffer becomes an indirect to base's base. */
788 b
->base_buffer
= (XBUFFER (base_buffer
)->base_buffer
789 ? XBUFFER (base_buffer
)->base_buffer
790 : XBUFFER (base_buffer
));
792 /* Use the base buffer's text object. */
793 b
->text
= b
->base_buffer
->text
;
794 /* We have no own text. */
795 b
->indirections
= -1;
796 /* Notify base buffer that we share the text now. */
797 b
->base_buffer
->indirections
++;
799 b
->pt
= b
->base_buffer
->pt
;
800 b
->begv
= b
->base_buffer
->begv
;
801 b
->zv
= b
->base_buffer
->zv
;
802 b
->pt_byte
= b
->base_buffer
->pt_byte
;
803 b
->begv_byte
= b
->base_buffer
->begv_byte
;
804 b
->zv_byte
= b
->base_buffer
->zv_byte
;
806 b
->newline_cache
= 0;
807 b
->width_run_cache
= 0;
808 bset_width_table (b
, Qnil
);
810 name
= Fcopy_sequence (name
);
811 set_string_intervals (name
, NULL
);
815 reset_buffer_local_variables (b
, 1);
817 /* Put this in the alist of all live buffers. */
819 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buf
), Qnil
));
821 bset_mark (b
, Fmake_marker ());
823 /* The multibyte status belongs to the base buffer. */
824 bset_enable_multibyte_characters
825 (b
, BVAR (b
->base_buffer
, enable_multibyte_characters
));
827 /* Make sure the base buffer has markers for its narrowing. */
828 if (NILP (BVAR (b
->base_buffer
, pt_marker
)))
830 eassert (NILP (BVAR (b
->base_buffer
, begv_marker
)));
831 eassert (NILP (BVAR (b
->base_buffer
, zv_marker
)));
833 bset_pt_marker (b
->base_buffer
,
834 build_marker (b
->base_buffer
, b
->base_buffer
->pt
,
835 b
->base_buffer
->pt_byte
));
837 bset_begv_marker (b
->base_buffer
,
838 build_marker (b
->base_buffer
, b
->base_buffer
->begv
,
839 b
->base_buffer
->begv_byte
));
841 bset_zv_marker (b
->base_buffer
,
842 build_marker (b
->base_buffer
, b
->base_buffer
->zv
,
843 b
->base_buffer
->zv_byte
));
845 XMARKER (BVAR (b
->base_buffer
, zv_marker
))->insertion_type
= 1;
850 /* Give the indirect buffer markers for its narrowing. */
851 bset_pt_marker (b
, build_marker (b
, b
->pt
, b
->pt_byte
));
852 bset_begv_marker (b
, build_marker (b
, b
->begv
, b
->begv_byte
));
853 bset_zv_marker (b
, build_marker (b
, b
->zv
, b
->zv_byte
));
854 XMARKER (BVAR (b
, zv_marker
))->insertion_type
= 1;
858 struct buffer
*old_b
= current_buffer
;
860 clone_per_buffer_values (b
->base_buffer
, b
);
861 bset_filename (b
, Qnil
);
862 bset_file_truename (b
, Qnil
);
863 bset_display_count (b
, make_number (0));
864 bset_backed_up (b
, Qnil
);
865 bset_auto_save_file_name (b
, Qnil
);
866 set_buffer_internal_1 (b
);
867 Fset (intern ("buffer-save-without-query"), Qnil
);
868 Fset (intern ("buffer-file-number"), Qnil
);
869 Fset (intern ("buffer-stale-function"), Qnil
);
870 set_buffer_internal_1 (old_b
);
873 /* Run buffer-list-update-hook. */
874 if (!NILP (Vrun_hooks
))
875 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
880 /* Mark OV as no longer associated with B. */
883 drop_overlay (struct buffer
*b
, struct Lisp_Overlay
*ov
)
885 eassert (b
== XBUFFER (Fmarker_buffer (ov
->start
)));
886 modify_overlay (b
, marker_position (ov
->start
),
887 marker_position (ov
->end
));
888 Fset_marker (ov
->start
, Qnil
, Qnil
);
889 Fset_marker (ov
->end
, Qnil
, Qnil
);
893 /* Delete all overlays of B and reset it's overlay lists. */
896 delete_all_overlays (struct buffer
*b
)
898 struct Lisp_Overlay
*ov
, *next
;
900 /* FIXME: Since each drop_overlay will scan BUF_MARKERS to unlink its
901 markers, we have an unneeded O(N^2) behavior here. */
902 for (ov
= b
->overlays_before
; ov
; ov
= next
)
904 drop_overlay (b
, ov
);
909 for (ov
= b
->overlays_after
; ov
; ov
= next
)
911 drop_overlay (b
, ov
);
916 set_buffer_overlays_before (b
, NULL
);
917 set_buffer_overlays_after (b
, NULL
);
920 /* Reinitialize everything about a buffer except its name and contents
922 If called on an already-initialized buffer, the list of overlays
923 should be deleted before calling this function, otherwise we end up
924 with overlays that claim to belong to the buffer but the buffer
925 claims it doesn't belong to it. */
928 reset_buffer (register struct buffer
*b
)
930 bset_filename (b
, Qnil
);
931 bset_file_truename (b
, Qnil
);
932 bset_directory (b
, current_buffer
? BVAR (current_buffer
, directory
) : Qnil
);
933 b
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
934 b
->modtime_size
= -1;
935 XSETFASTINT (BVAR (b
, save_length
), 0);
936 b
->last_window_start
= 1;
937 /* It is more conservative to start out "changed" than "unchanged". */
939 b
->prevent_redisplay_optimizations_p
= 1;
940 bset_backed_up (b
, Qnil
);
941 BUF_AUTOSAVE_MODIFF (b
) = 0;
942 b
->auto_save_failure_time
= 0;
943 bset_auto_save_file_name (b
, Qnil
);
944 bset_read_only (b
, Qnil
);
945 set_buffer_overlays_before (b
, NULL
);
946 set_buffer_overlays_after (b
, NULL
);
947 b
->overlay_center
= BEG
;
948 bset_mark_active (b
, Qnil
);
949 bset_point_before_scroll (b
, Qnil
);
950 bset_file_format (b
, Qnil
);
951 bset_auto_save_file_format (b
, Qt
);
952 bset_last_selected_window (b
, Qnil
);
953 bset_display_count (b
, make_number (0));
954 bset_display_time (b
, Qnil
);
955 bset_enable_multibyte_characters
956 (b
, BVAR (&buffer_defaults
, enable_multibyte_characters
));
957 bset_cursor_type (b
, BVAR (&buffer_defaults
, cursor_type
));
958 bset_extra_line_spacing (b
, BVAR (&buffer_defaults
, extra_line_spacing
));
960 b
->display_error_modiff
= 0;
963 /* Reset buffer B's local variables info.
964 Don't use this on a buffer that has already been in use;
965 it does not treat permanent locals consistently.
966 Instead, use Fkill_all_local_variables.
968 If PERMANENT_TOO, reset permanent buffer-local variables.
969 If not, preserve those. */
972 reset_buffer_local_variables (struct buffer
*b
, bool permanent_too
)
976 /* Reset the major mode to Fundamental, together with all the
977 things that depend on the major mode.
978 default-major-mode is handled at a higher level.
979 We ignore it here. */
980 bset_major_mode (b
, Qfundamental_mode
);
981 bset_keymap (b
, Qnil
);
982 bset_mode_name (b
, QSFundamental
);
983 bset_minor_modes (b
, Qnil
);
985 /* If the standard case table has been altered and invalidated,
986 fix up its insides first. */
987 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[0])
988 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[1])
989 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[2])))
990 Fset_standard_case_table (Vascii_downcase_table
);
992 bset_downcase_table (b
, Vascii_downcase_table
);
993 bset_upcase_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[0]);
994 bset_case_canon_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[1]);
995 bset_case_eqv_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[2]);
996 bset_invisibility_spec (b
, Qt
);
998 /* Reset all (or most) per-buffer variables to their defaults. */
1000 bset_local_var_alist (b
, Qnil
);
1003 Lisp_Object tmp
, prop
, last
= Qnil
;
1004 for (tmp
= BVAR (b
, local_var_alist
); CONSP (tmp
); tmp
= XCDR (tmp
))
1005 if (!NILP (prop
= Fget (XCAR (XCAR (tmp
)), Qpermanent_local
)))
1007 /* If permanent-local, keep it. */
1009 if (EQ (prop
, Qpermanent_local_hook
))
1011 /* This is a partially permanent hook variable.
1012 Preserve only the elements that want to be preserved. */
1013 Lisp_Object list
, newlist
;
1014 list
= XCDR (XCAR (tmp
));
1018 for (newlist
= Qnil
; CONSP (list
); list
= XCDR (list
))
1020 Lisp_Object elt
= XCAR (list
);
1021 /* Preserve element ELT if it's t,
1022 if it is a function with a `permanent-local-hook' property,
1023 or if it's not a symbol. */
1026 || !NILP (Fget (elt
, Qpermanent_local_hook
)))
1027 newlist
= Fcons (elt
, newlist
);
1029 XSETCDR (XCAR (tmp
), Fnreverse (newlist
));
1032 /* Delete this local variable. */
1033 else if (NILP (last
))
1034 bset_local_var_alist (b
, XCDR (tmp
));
1036 XSETCDR (last
, XCDR (tmp
));
1039 for (i
= 0; i
< last_per_buffer_idx
; ++i
)
1040 if (permanent_too
|| buffer_permanent_local_flags
[i
] == 0)
1041 SET_PER_BUFFER_VALUE_P (b
, i
, 0);
1043 /* For each slot that has a default value, copy that into the slot. */
1044 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1046 int idx
= PER_BUFFER_IDX (offset
);
1049 || buffer_permanent_local_flags
[idx
] == 0)))
1050 set_per_buffer_value (b
, offset
, per_buffer_default (offset
));
1054 /* We split this away from generate-new-buffer, because rename-buffer
1055 and set-visited-file-name ought to be able to use this to really
1056 rename the buffer properly. */
1058 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name
,
1059 Sgenerate_new_buffer_name
, 1, 2, 0,
1060 doc
: /* Return a string that is the name of no existing buffer based on NAME.
1061 If there is no live buffer named NAME, then return NAME.
1062 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
1063 \(starting at 2) until an unused name is found, and then return that name.
1064 Optional second argument IGNORE specifies a name that is okay to use (if
1065 it is in the sequence to be tried) even if a buffer with that name exists.
1067 If NAME begins with a space (i.e., a buffer that is not normally
1068 visible to users), then if buffer NAME already exists a random number
1069 is first appended to NAME, to speed up finding a non-existent buffer. */)
1070 (register Lisp_Object name
, Lisp_Object ignore
)
1072 register Lisp_Object gentemp
, tem
, tem2
;
1074 char number
[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
1076 CHECK_STRING (name
);
1078 tem
= Fstring_equal (name
, ignore
);
1081 tem
= Fget_buffer (name
);
1085 if (!strncmp (SSDATA (name
), " ", 1)) /* see bug#1229 */
1087 /* Note fileio.c:make_temp_name does random differently. */
1088 tem2
= concat2 (name
, make_formatted_string
1090 XFASTINT (Frandom (make_number (999999)))));
1091 tem
= Fget_buffer (tem2
);
1101 gentemp
= concat2 (tem2
, make_formatted_string
1102 (number
, "<%"pD
"d>", ++count
));
1103 tem
= Fstring_equal (gentemp
, ignore
);
1106 tem
= Fget_buffer (gentemp
);
1113 DEFUN ("buffer-name", Fbuffer_name
, Sbuffer_name
, 0, 1, 0,
1114 doc
: /* Return the name of BUFFER, as a string.
1115 BUFFER defaults to the current buffer.
1116 Return nil if BUFFER has been killed. */)
1117 (register Lisp_Object buffer
)
1120 return BVAR (current_buffer
, name
);
1121 CHECK_BUFFER (buffer
);
1122 return BVAR (XBUFFER (buffer
), name
);
1125 DEFUN ("buffer-file-name", Fbuffer_file_name
, Sbuffer_file_name
, 0, 1, 0,
1126 doc
: /* Return name of file BUFFER is visiting, or nil if none.
1127 No argument or nil as argument means use the current buffer. */)
1128 (register Lisp_Object buffer
)
1131 return BVAR (current_buffer
, filename
);
1132 CHECK_BUFFER (buffer
);
1133 return BVAR (XBUFFER (buffer
), filename
);
1136 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer
, Sbuffer_base_buffer
,
1138 doc
: /* Return the base buffer of indirect buffer BUFFER.
1139 If BUFFER is not indirect, return nil.
1140 BUFFER defaults to the current buffer. */)
1141 (register Lisp_Object buffer
)
1143 struct buffer
*base
;
1144 Lisp_Object base_buffer
;
1147 base
= current_buffer
->base_buffer
;
1150 CHECK_BUFFER (buffer
);
1151 base
= XBUFFER (buffer
)->base_buffer
;
1156 XSETBUFFER (base_buffer
, base
);
1160 DEFUN ("buffer-local-value", Fbuffer_local_value
,
1161 Sbuffer_local_value
, 2, 2, 0,
1162 doc
: /* Return the value of VARIABLE in BUFFER.
1163 If VARIABLE does not have a buffer-local binding in BUFFER, the value
1164 is the default binding of the variable. */)
1165 (register Lisp_Object variable
, register Lisp_Object buffer
)
1167 register Lisp_Object result
= buffer_local_value_1 (variable
, buffer
);
1169 if (EQ (result
, Qunbound
))
1170 xsignal1 (Qvoid_variable
, variable
);
1176 /* Like Fbuffer_local_value, but return Qunbound if the variable is
1180 buffer_local_value_1 (Lisp_Object variable
, Lisp_Object buffer
)
1182 register struct buffer
*buf
;
1183 register Lisp_Object result
;
1184 struct Lisp_Symbol
*sym
;
1186 CHECK_SYMBOL (variable
);
1187 CHECK_BUFFER (buffer
);
1188 buf
= XBUFFER (buffer
);
1189 sym
= XSYMBOL (variable
);
1192 switch (sym
->redirect
)
1194 case SYMBOL_VARALIAS
: sym
= indirect_variable (sym
); goto start
;
1195 case SYMBOL_PLAINVAL
: result
= SYMBOL_VAL (sym
); break;
1196 case SYMBOL_LOCALIZED
:
1197 { /* Look in local_var_alist. */
1198 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (sym
);
1199 XSETSYMBOL (variable
, sym
); /* Update In case of aliasing. */
1200 result
= Fassoc (variable
, BVAR (buf
, local_var_alist
));
1204 { /* What binding is loaded right now? */
1205 Lisp_Object current_alist_element
= blv
->valcell
;
1207 /* The value of the currently loaded binding is not
1208 stored in it, but rather in the realvalue slot.
1209 Store that value into the binding it belongs to
1210 in case that is the one we are about to use. */
1212 XSETCDR (current_alist_element
,
1213 do_symval_forwarding (blv
->fwd
));
1215 /* Now get the (perhaps updated) value out of the binding. */
1216 result
= XCDR (result
);
1219 result
= Fdefault_value (variable
);
1222 case SYMBOL_FORWARDED
:
1224 union Lisp_Fwd
*fwd
= SYMBOL_FWD (sym
);
1225 if (BUFFER_OBJFWDP (fwd
))
1226 result
= per_buffer_value (buf
, XBUFFER_OBJFWD (fwd
)->offset
);
1228 result
= Fdefault_value (variable
);
1231 default: emacs_abort ();
1237 /* Return an alist of the Lisp-level buffer-local bindings of
1238 buffer BUF. That is, don't include the variables maintained
1239 in special slots in the buffer object.
1240 If not CLONE, replace elements of the form (VAR . unbound)
1244 buffer_lisp_local_variables (struct buffer
*buf
, bool clone
)
1246 Lisp_Object result
= Qnil
;
1248 for (tail
= BVAR (buf
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
1250 Lisp_Object val
, elt
;
1254 /* Reference each variable in the alist in buf.
1255 If inquiring about the current buffer, this gets the current values,
1256 so store them into the alist so the alist is up to date.
1257 If inquiring about some other buffer, this swaps out any values
1258 for that buffer, making the alist up to date automatically. */
1259 val
= find_symbol_value (XCAR (elt
));
1260 /* Use the current buffer value only if buf is the current buffer. */
1261 if (buf
!= current_buffer
)
1264 result
= Fcons (!clone
&& EQ (val
, Qunbound
)
1266 : Fcons (XCAR (elt
), val
),
1273 DEFUN ("buffer-local-variables", Fbuffer_local_variables
,
1274 Sbuffer_local_variables
, 0, 1, 0,
1275 doc
: /* Return an alist of variables that are buffer-local in BUFFER.
1276 Most elements look like (SYMBOL . VALUE), describing one variable.
1277 For a symbol that is locally unbound, just the symbol appears in the value.
1278 Note that storing new VALUEs in these elements doesn't change the variables.
1279 No argument or nil as argument means use current buffer as BUFFER. */)
1280 (register Lisp_Object buffer
)
1282 register struct buffer
*buf
;
1283 register Lisp_Object result
;
1286 buf
= current_buffer
;
1289 CHECK_BUFFER (buffer
);
1290 buf
= XBUFFER (buffer
);
1293 result
= buffer_lisp_local_variables (buf
, 0);
1295 /* Add on all the variables stored in special slots. */
1299 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1301 idx
= PER_BUFFER_IDX (offset
);
1302 if ((idx
== -1 || PER_BUFFER_VALUE_P (buf
, idx
))
1303 && SYMBOLP (PER_BUFFER_SYMBOL (offset
)))
1305 Lisp_Object sym
= PER_BUFFER_SYMBOL (offset
);
1306 Lisp_Object val
= per_buffer_value (buf
, offset
);
1307 result
= Fcons (EQ (val
, Qunbound
) ? sym
: Fcons (sym
, val
),
1316 DEFUN ("buffer-modified-p", Fbuffer_modified_p
, Sbuffer_modified_p
,
1318 doc
: /* Return t if BUFFER was modified since its file was last read or saved.
1319 No argument or nil as argument means use current buffer as BUFFER. */)
1320 (register Lisp_Object buffer
)
1322 register struct buffer
*buf
;
1324 buf
= current_buffer
;
1327 CHECK_BUFFER (buffer
);
1328 buf
= XBUFFER (buffer
);
1331 return BUF_SAVE_MODIFF (buf
) < BUF_MODIFF (buf
) ? Qt
: Qnil
;
1334 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p
, Sset_buffer_modified_p
,
1336 doc
: /* Mark current buffer as modified or unmodified according to FLAG.
1337 A non-nil FLAG means mark the buffer modified. */)
1340 Lisp_Object fn
, buffer
, window
;
1342 #ifdef CLASH_DETECTION
1343 /* If buffer becoming modified, lock the file.
1344 If buffer becoming unmodified, unlock the file. */
1346 struct buffer
*b
= current_buffer
->base_buffer
1347 ? current_buffer
->base_buffer
1350 fn
= BVAR (b
, file_truename
);
1351 /* Test buffer-file-name so that binding it to nil is effective. */
1352 if (!NILP (fn
) && ! NILP (BVAR (b
, filename
)))
1354 bool already
= SAVE_MODIFF
< MODIFF
;
1355 if (!already
&& !NILP (flag
))
1357 else if (already
&& NILP (flag
))
1360 #endif /* CLASH_DETECTION */
1362 /* Here we have a problem. SAVE_MODIFF is used here to encode
1363 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1364 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1365 modify SAVE_MODIFF to affect one, we may affect the other
1367 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1368 if SAVE_MODIFF<auto_save_modified that means we risk changing
1369 recent-auto-save-p from t to nil.
1370 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1371 we risk changing recent-auto-save-p from nil to t. */
1372 SAVE_MODIFF
= (NILP (flag
)
1373 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1375 /* Let's try to preserve recent-auto-save-p. */
1376 : SAVE_MODIFF
< MODIFF
? SAVE_MODIFF
1377 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1378 we can either decrease SAVE_MODIFF and auto_save_modified
1379 or increase MODIFF. */
1382 /* Set update_mode_lines only if buffer is displayed in some window.
1383 Packages like jit-lock or lazy-lock preserve a buffer's modified
1384 state by recording/restoring the state around blocks of code.
1385 Setting update_mode_lines makes redisplay consider all windows
1386 (on all frames). Stealth fontification of buffers not displayed
1387 would incur additional redisplay costs if we'd set
1388 update_modes_lines unconditionally.
1390 Ideally, I think there should be another mechanism for fontifying
1391 buffers without "modifying" buffers, or redisplay should be
1392 smarter about updating the `*' in mode lines. --gerd */
1393 XSETBUFFER (buffer
, current_buffer
);
1394 window
= Fget_buffer_window (buffer
, Qt
);
1395 if (WINDOWP (window
))
1397 ++update_mode_lines
;
1398 current_buffer
->prevent_redisplay_optimizations_p
= 1;
1404 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p
,
1405 Srestore_buffer_modified_p
, 1, 1, 0,
1406 doc
: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1407 It is not ensured that mode lines will be updated to show the modified
1408 state of the current buffer. Use with care. */)
1411 #ifdef CLASH_DETECTION
1414 /* If buffer becoming modified, lock the file.
1415 If buffer becoming unmodified, unlock the file. */
1417 fn
= BVAR (current_buffer
, file_truename
);
1418 /* Test buffer-file-name so that binding it to nil is effective. */
1419 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1421 bool already
= SAVE_MODIFF
< MODIFF
;
1422 if (!already
&& !NILP (flag
))
1424 else if (already
&& NILP (flag
))
1427 #endif /* CLASH_DETECTION */
1429 SAVE_MODIFF
= NILP (flag
) ? MODIFF
: 0;
1433 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick
, Sbuffer_modified_tick
,
1435 doc
: /* Return BUFFER's tick counter, incremented for each change in text.
1436 Each buffer has a tick counter which is incremented each time the
1437 text in that buffer is changed. It wraps around occasionally.
1438 No argument or nil as argument means use current buffer as BUFFER. */)
1439 (register Lisp_Object buffer
)
1441 register struct buffer
*buf
;
1443 buf
= current_buffer
;
1446 CHECK_BUFFER (buffer
);
1447 buf
= XBUFFER (buffer
);
1450 return make_number (BUF_MODIFF (buf
));
1453 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick
,
1454 Sbuffer_chars_modified_tick
, 0, 1, 0,
1455 doc
: /* Return BUFFER's character-change tick counter.
1456 Each buffer has a character-change tick counter, which is set to the
1457 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1458 time text in that buffer is inserted or deleted. By comparing the
1459 values returned by two individual calls of `buffer-chars-modified-tick',
1460 you can tell whether a character change occurred in that buffer in
1461 between these calls. No argument or nil as argument means use current
1462 buffer as BUFFER. */)
1463 (register Lisp_Object buffer
)
1465 register struct buffer
*buf
;
1467 buf
= current_buffer
;
1470 CHECK_BUFFER (buffer
);
1471 buf
= XBUFFER (buffer
);
1474 return make_number (BUF_CHARS_MODIFF (buf
));
1477 DEFUN ("rename-buffer", Frename_buffer
, Srename_buffer
, 1, 2,
1478 "(list (read-string \"Rename buffer (to new name): \" \
1479 nil 'buffer-name-history (buffer-name (current-buffer))) \
1480 current-prefix-arg)",
1481 doc
: /* Change current buffer's name to NEWNAME (a string).
1482 If second arg UNIQUE is nil or omitted, it is an error if a
1483 buffer named NEWNAME already exists.
1484 If UNIQUE is non-nil, come up with a new name using
1485 `generate-new-buffer-name'.
1486 Interactively, you can set UNIQUE with a prefix argument.
1487 We return the name we actually gave the buffer.
1488 This does not change the name of the visited file (if any). */)
1489 (register Lisp_Object newname
, Lisp_Object unique
)
1491 register Lisp_Object tem
, buf
;
1493 CHECK_STRING (newname
);
1495 if (SCHARS (newname
) == 0)
1496 error ("Empty string is invalid as a buffer name");
1498 tem
= Fget_buffer (newname
);
1501 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1502 rename the buffer automatically so you can create another
1503 with the original name. It makes UNIQUE equivalent to
1504 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1505 if (NILP (unique
) && XBUFFER (tem
) == current_buffer
)
1506 return BVAR (current_buffer
, name
);
1508 newname
= Fgenerate_new_buffer_name (newname
, BVAR (current_buffer
, name
));
1510 error ("Buffer name `%s' is in use", SDATA (newname
));
1513 bset_name (current_buffer
, newname
);
1515 /* Catch redisplay's attention. Unless we do this, the mode lines for
1516 any windows displaying current_buffer will stay unchanged. */
1517 update_mode_lines
++;
1519 XSETBUFFER (buf
, current_buffer
);
1520 Fsetcar (Frassq (buf
, Vbuffer_alist
), newname
);
1521 if (NILP (BVAR (current_buffer
, filename
))
1522 && !NILP (BVAR (current_buffer
, auto_save_file_name
)))
1523 call0 (intern ("rename-auto-save-file"));
1525 /* Run buffer-list-update-hook. */
1526 if (!NILP (Vrun_hooks
))
1527 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1529 /* Refetch since that last call may have done GC. */
1530 return BVAR (current_buffer
, name
);
1533 DEFUN ("other-buffer", Fother_buffer
, Sother_buffer
, 0, 3, 0,
1534 doc
: /* Return most recently selected buffer other than BUFFER.
1535 Buffers not visible in windows are preferred to visible buffers, unless
1536 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1537 BUFFER unless it denotes a live buffer. If the optional third argument
1538 FRAME is non-nil, use that frame's buffer list instead of the selected
1539 frame's buffer list.
1541 The buffer is found by scanning the selected or specified frame's buffer
1542 list first, followed by the list of all buffers. If no other buffer
1543 exists, return the buffer `*scratch*' (creating it if necessary). */)
1544 (register Lisp_Object buffer
, Lisp_Object visible_ok
, Lisp_Object frame
)
1546 Lisp_Object tail
, buf
, pred
;
1547 Lisp_Object notsogood
= Qnil
;
1550 frame
= selected_frame
;
1552 CHECK_FRAME (frame
);
1554 pred
= frame_buffer_predicate (frame
);
1555 /* Consider buffers that have been seen in the frame first. */
1556 tail
= XFRAME (frame
)->buffer_list
;
1557 for (; CONSP (tail
); tail
= XCDR (tail
))
1560 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1561 && BUFFER_LIVE_P (XBUFFER (buf
))
1562 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' ')
1563 /* If the frame has a buffer_predicate, disregard buffers that
1564 don't fit the predicate. */
1565 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1567 if (!NILP (visible_ok
)
1568 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1570 else if (NILP (notsogood
))
1575 /* Consider alist of all buffers next. */
1576 tail
= Vbuffer_alist
;
1577 for (; CONSP (tail
); tail
= XCDR (tail
))
1579 buf
= Fcdr (XCAR (tail
));
1580 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1581 && BUFFER_LIVE_P (XBUFFER (buf
))
1582 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' ')
1583 /* If the frame has a buffer_predicate, disregard buffers that
1584 don't fit the predicate. */
1585 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1587 if (!NILP (visible_ok
)
1588 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1590 else if (NILP (notsogood
))
1595 if (!NILP (notsogood
))
1599 buf
= Fget_buffer (build_string ("*scratch*"));
1602 buf
= Fget_buffer_create (build_string ("*scratch*"));
1603 Fset_buffer_major_mode (buf
);
1609 /* The following function is a safe variant of Fother_buffer: It doesn't
1610 pay attention to any frame-local buffer lists, doesn't care about
1611 visibility of buffers, and doesn't evaluate any frame predicates. */
1614 other_buffer_safely (Lisp_Object buffer
)
1616 Lisp_Object tail
, buf
;
1618 tail
= Vbuffer_alist
;
1619 for (; CONSP (tail
); tail
= XCDR (tail
))
1621 buf
= Fcdr (XCAR (tail
));
1622 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1623 && BUFFER_LIVE_P (XBUFFER (buf
))
1624 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' '))
1628 buf
= Fget_buffer (build_string ("*scratch*"));
1631 buf
= Fget_buffer_create (build_string ("*scratch*"));
1632 Fset_buffer_major_mode (buf
);
1638 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo
, Sbuffer_enable_undo
,
1640 doc
: /* Start keeping undo information for buffer BUFFER.
1641 No argument or nil as argument means do this for the current buffer. */)
1642 (register Lisp_Object buffer
)
1644 Lisp_Object real_buffer
;
1647 XSETBUFFER (real_buffer
, current_buffer
);
1650 real_buffer
= Fget_buffer (buffer
);
1651 if (NILP (real_buffer
))
1655 if (EQ (BVAR (XBUFFER (real_buffer
), undo_list
), Qt
))
1656 bset_undo_list (XBUFFER (real_buffer
), Qnil
);
1661 /* Truncate undo list and shrink the gap of BUFFER. */
1664 compact_buffer (struct buffer
*buffer
)
1666 /* Verify indirection counters. */
1667 if (buffer
->base_buffer
)
1669 eassert (buffer
->indirections
== -1);
1670 eassert (buffer
->base_buffer
->indirections
> 0);
1673 eassert (buffer
->indirections
>= 0);
1675 /* Skip dead buffers, indirect buffers and buffers
1676 which aren't changed since last compaction. */
1677 if (!NILP (buffer
->INTERNAL_FIELD (name
))
1678 && (buffer
->base_buffer
== NULL
)
1679 && (buffer
->text
->compact
!= buffer
->text
->modiff
))
1681 /* If a buffer's undo list is Qt, that means that undo is
1682 turned off in that buffer. Calling truncate_undo_list on
1683 Qt tends to return NULL, which effectively turns undo back on.
1684 So don't call truncate_undo_list if undo_list is Qt. */
1685 if (!EQ (buffer
->INTERNAL_FIELD (undo_list
), Qt
))
1686 truncate_undo_list (buffer
);
1688 /* Shrink buffer gaps. */
1689 if (!buffer
->text
->inhibit_shrinking
)
1691 /* If a buffer's gap size is more than 10% of the buffer
1692 size, or larger than 2000 bytes, then shrink it
1693 accordingly. Keep a minimum size of 20 bytes. */
1694 int size
= min (2000, max (20, (buffer
->text
->z_byte
/ 10)));
1696 if (buffer
->text
->gap_size
> size
)
1698 struct buffer
*save_current
= current_buffer
;
1699 current_buffer
= buffer
;
1700 make_gap (-(buffer
->text
->gap_size
- size
));
1701 current_buffer
= save_current
;
1704 buffer
->text
->compact
= buffer
->text
->modiff
;
1708 DEFUN ("kill-buffer", Fkill_buffer
, Skill_buffer
, 0, 1, "bKill buffer: ",
1709 doc
: /* Kill the buffer specified by BUFFER-OR-NAME.
1710 The argument may be a buffer or the name of an existing buffer.
1711 Argument nil or omitted means kill the current buffer. Return t if the
1712 buffer is actually killed, nil otherwise.
1714 The functions in `kill-buffer-query-functions' are called with the
1715 buffer to be killed as the current buffer. If any of them returns nil,
1716 the buffer is not killed. The hook `kill-buffer-hook' is run before the
1717 buffer is actually killed. The buffer being killed will be current
1718 while the hook is running. Functions called by any of these hooks are
1719 supposed to not change the current buffer.
1721 Any processes that have this buffer as the `process-buffer' are killed
1722 with SIGHUP. This function calls `replace-buffer-in-windows' for
1723 cleaning up all windows currently displaying the buffer to be killed. */)
1724 (Lisp_Object buffer_or_name
)
1727 register struct buffer
*b
;
1728 register Lisp_Object tem
;
1729 register struct Lisp_Marker
*m
;
1730 struct gcpro gcpro1
;
1732 if (NILP (buffer_or_name
))
1733 buffer
= Fcurrent_buffer ();
1735 buffer
= Fget_buffer (buffer_or_name
);
1737 nsberror (buffer_or_name
);
1739 b
= XBUFFER (buffer
);
1741 /* Avoid trouble for buffer already dead. */
1742 if (!BUFFER_LIVE_P (b
))
1745 /* Query if the buffer is still modified. */
1746 if (INTERACTIVE
&& !NILP (BVAR (b
, filename
))
1747 && BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
1750 tem
= do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1751 BVAR (b
, name
), make_number (0)));
1757 /* Run hooks with the buffer to be killed the current buffer. */
1759 ptrdiff_t count
= SPECPDL_INDEX ();
1760 Lisp_Object arglist
[1];
1762 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1763 set_buffer_internal (b
);
1765 /* First run the query functions; if any query is answered no,
1766 don't kill the buffer. */
1767 arglist
[0] = Qkill_buffer_query_functions
;
1768 tem
= Frun_hook_with_args_until_failure (1, arglist
);
1770 return unbind_to (count
, Qnil
);
1772 /* Then run the hooks. */
1773 Frun_hooks (1, &Qkill_buffer_hook
);
1774 unbind_to (count
, Qnil
);
1777 /* If the hooks have killed the buffer, exit now. */
1778 if (!BUFFER_LIVE_P (b
))
1781 /* We have no more questions to ask. Verify that it is valid
1782 to kill the buffer. This must be done after the questions
1783 since anything can happen within do_yes_or_no_p. */
1785 /* Don't kill the minibuffer now current. */
1786 if (EQ (buffer
, XWINDOW (minibuf_window
)->buffer
))
1789 /* When we kill an ordinary buffer which shares it's buffer text
1790 with indirect buffer(s), we must kill indirect buffer(s) too.
1791 We do it at this stage so nothing terrible happens if they
1792 ask questions or their hooks get errors. */
1793 if (!b
->base_buffer
&& b
->indirections
> 0)
1795 struct buffer
*other
;
1799 FOR_EACH_BUFFER (other
)
1800 if (other
->base_buffer
== b
)
1803 XSETBUFFER (buf
, other
);
1809 /* Exit if we now have killed the base buffer (Bug#11665). */
1810 if (!BUFFER_LIVE_P (b
))
1814 /* Run replace_buffer_in_windows before making another buffer current
1815 since set-window-buffer-start-and-point will refuse to make another
1816 buffer current if the selected window does not show the current
1817 buffer. (Bug#10114) */
1818 replace_buffer_in_windows (buffer
);
1820 /* Exit if replacing the buffer in windows has killed our buffer. */
1821 if (!BUFFER_LIVE_P (b
))
1824 /* Make this buffer not be current. Exit if it is the sole visible
1826 if (b
== current_buffer
)
1828 tem
= Fother_buffer (buffer
, Qnil
, Qnil
);
1830 if (b
== current_buffer
)
1834 /* If the buffer now current is shown in the minibuffer and our buffer
1835 is the sole other buffer give up. */
1836 XSETBUFFER (tem
, current_buffer
);
1837 if (EQ (tem
, XWINDOW (minibuf_window
)->buffer
)
1838 && EQ (buffer
, Fother_buffer (buffer
, Qnil
, Qnil
)))
1841 /* Now there is no question: we can kill the buffer. */
1843 #ifdef CLASH_DETECTION
1844 /* Unlock this buffer's file, if it is locked. */
1846 #endif /* CLASH_DETECTION */
1849 kill_buffer_processes (buffer
);
1852 /* Killing buffer processes may run sentinels which may have killed
1854 if (!BUFFER_LIVE_P (b
))
1857 /* These may run Lisp code and into infinite loops (if someone
1858 insisted on circular lists) so allow quitting here. */
1859 frames_discard_buffer (buffer
);
1861 clear_charpos_cache (b
);
1863 tem
= Vinhibit_quit
;
1865 /* Remove the buffer from the list of all buffers. */
1866 Vbuffer_alist
= Fdelq (Frassq (buffer
, Vbuffer_alist
), Vbuffer_alist
);
1867 /* If replace_buffer_in_windows didn't do its job fix that now. */
1868 replace_buffer_in_windows_safely (buffer
);
1869 Vinhibit_quit
= tem
;
1871 /* Delete any auto-save file, if we saved it in this session.
1872 But not if the buffer is modified. */
1873 if (STRINGP (BVAR (b
, auto_save_file_name
))
1874 && BUF_AUTOSAVE_MODIFF (b
) != 0
1875 && BUF_SAVE_MODIFF (b
) < BUF_AUTOSAVE_MODIFF (b
)
1876 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
1877 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1880 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1881 if (! NILP (delete))
1882 internal_delete_file (BVAR (b
, auto_save_file_name
));
1885 /* Deleting an auto-save file could have killed our buffer. */
1886 if (!BUFFER_LIVE_P (b
))
1891 { /* Unchain all markers that belong to this indirect buffer.
1892 Don't unchain the markers that belong to the base buffer
1893 or its other indirect buffers. */
1894 struct Lisp_Marker
**mp
;
1895 for (mp
= &BUF_MARKERS (b
); *mp
; )
1897 struct Lisp_Marker
*m
= *mp
;
1907 /* Unchain all markers of this buffer and its indirect buffers.
1908 and leave them pointing nowhere. */
1909 for (m
= BUF_MARKERS (b
); m
; )
1911 struct Lisp_Marker
*next
= m
->next
;
1916 BUF_MARKERS (b
) = NULL
;
1917 set_buffer_intervals (b
, NULL
);
1919 /* Perhaps we should explicitly free the interval tree here... */
1921 /* Since we've unlinked the markers, the overlays can't be here any more
1923 b
->overlays_before
= NULL
;
1924 b
->overlays_after
= NULL
;
1926 /* Reset the local variables, so that this buffer's local values
1927 won't be protected from GC. They would be protected
1928 if they happened to remain cached in their symbols.
1929 This gets rid of them for certain. */
1930 swap_out_buffer_local_variables (b
);
1931 reset_buffer_local_variables (b
, 1);
1933 bset_name (b
, Qnil
);
1938 /* Notify our base buffer that we don't share the text anymore. */
1939 eassert (b
->indirections
== -1);
1940 b
->base_buffer
->indirections
--;
1941 eassert (b
->base_buffer
->indirections
>= 0);
1944 /* No one shares our buffer text, can free it. */
1945 free_buffer_text (b
);
1947 if (b
->newline_cache
)
1949 free_region_cache (b
->newline_cache
);
1950 b
->newline_cache
= 0;
1952 if (b
->width_run_cache
)
1954 free_region_cache (b
->width_run_cache
);
1955 b
->width_run_cache
= 0;
1957 bset_width_table (b
, Qnil
);
1959 bset_undo_list (b
, Qnil
);
1961 /* Run buffer-list-update-hook. */
1962 if (!NILP (Vrun_hooks
))
1963 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1968 /* Move association for BUFFER to the front of buffer (a)lists. Since
1969 we do this each time BUFFER is selected visibly, the more recently
1970 selected buffers are always closer to the front of those lists. This
1971 means that other_buffer is more likely to choose a relevant buffer.
1973 Note that this moves BUFFER to the front of the buffer lists of the
1974 selected frame even if BUFFER is not shown there. If BUFFER is not
1975 shown in the selected frame, consider the present behavior a feature.
1976 `select-window' gets this right since it shows BUFFER in the selected
1977 window when calling us. */
1980 record_buffer (Lisp_Object buffer
)
1982 Lisp_Object aelt
, aelt_cons
, tem
;
1983 register struct frame
*f
= XFRAME (selected_frame
);
1985 CHECK_BUFFER (buffer
);
1987 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1988 Don't allow quitting since this might leave the buffer list in an
1989 inconsistent state. */
1990 tem
= Vinhibit_quit
;
1992 aelt
= Frassq (buffer
, Vbuffer_alist
);
1993 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
1994 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
1995 XSETCDR (aelt_cons
, Vbuffer_alist
);
1996 Vbuffer_alist
= aelt_cons
;
1997 Vinhibit_quit
= tem
;
1999 /* Update buffer list of selected frame. */
2000 fset_buffer_list (f
, Fcons (buffer
, Fdelq (buffer
, f
->buffer_list
)));
2001 fset_buried_buffer_list (f
, Fdelq (buffer
, f
->buried_buffer_list
));
2003 /* Run buffer-list-update-hook. */
2004 if (!NILP (Vrun_hooks
))
2005 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
2009 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
2010 buffer is killed. For the selected frame's buffer list this moves
2011 BUFFER to its end even if it was never shown in that frame. If
2012 this happens we have a feature, hence `bury-buffer-internal' should be
2013 called only when BUFFER was shown in the selected frame. */
2015 DEFUN ("bury-buffer-internal", Fbury_buffer_internal
, Sbury_buffer_internal
,
2017 doc
: /* Move BUFFER to the end of the buffer list. */)
2018 (Lisp_Object buffer
)
2020 Lisp_Object aelt
, aelt_cons
, tem
;
2021 register struct frame
*f
= XFRAME (selected_frame
);
2023 CHECK_BUFFER (buffer
);
2025 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
2026 Don't allow quitting since this might leave the buffer list in an
2027 inconsistent state. */
2028 tem
= Vinhibit_quit
;
2030 aelt
= Frassq (buffer
, Vbuffer_alist
);
2031 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
2032 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
2033 XSETCDR (aelt_cons
, Qnil
);
2034 Vbuffer_alist
= nconc2 (Vbuffer_alist
, aelt_cons
);
2035 Vinhibit_quit
= tem
;
2037 /* Update buffer lists of selected frame. */
2038 fset_buffer_list (f
, Fdelq (buffer
, f
->buffer_list
));
2039 fset_buried_buffer_list
2040 (f
, Fcons (buffer
, Fdelq (buffer
, f
->buried_buffer_list
)));
2042 /* Run buffer-list-update-hook. */
2043 if (!NILP (Vrun_hooks
))
2044 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
2049 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode
, Sset_buffer_major_mode
, 1, 1, 0,
2050 doc
: /* Set an appropriate major mode for BUFFER.
2051 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
2052 according to `default-major-mode'.
2053 Use this function before selecting the buffer, since it may need to inspect
2054 the current buffer's major mode. */)
2055 (Lisp_Object buffer
)
2058 Lisp_Object function
;
2060 CHECK_BUFFER (buffer
);
2062 if (!BUFFER_LIVE_P (XBUFFER (buffer
)))
2063 error ("Attempt to set major mode for a dead buffer");
2065 if (strcmp (SSDATA (BVAR (XBUFFER (buffer
), name
)), "*scratch*") == 0)
2066 function
= find_symbol_value (intern ("initial-major-mode"));
2069 function
= BVAR (&buffer_defaults
, major_mode
);
2071 && NILP (Fget (BVAR (current_buffer
, major_mode
), Qmode_class
)))
2072 function
= BVAR (current_buffer
, major_mode
);
2075 if (NILP (function
) || EQ (function
, Qfundamental_mode
))
2078 count
= SPECPDL_INDEX ();
2080 /* To select a nonfundamental mode,
2081 select the buffer temporarily and then call the mode function. */
2083 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
2085 Fset_buffer (buffer
);
2088 return unbind_to (count
, Qnil
);
2091 DEFUN ("current-buffer", Fcurrent_buffer
, Scurrent_buffer
, 0, 0, 0,
2092 doc
: /* Return the current buffer as a Lisp object. */)
2095 register Lisp_Object buf
;
2096 XSETBUFFER (buf
, current_buffer
);
2100 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
2101 This is used by redisplay. */
2104 set_buffer_internal_1 (register struct buffer
*b
)
2106 register struct buffer
*old_buf
;
2107 register Lisp_Object tail
;
2109 #ifdef USE_MMAP_FOR_BUFFERS
2110 if (b
->text
->beg
== NULL
)
2111 enlarge_buffer_text (b
, 0);
2112 #endif /* USE_MMAP_FOR_BUFFERS */
2114 if (current_buffer
== b
)
2117 old_buf
= current_buffer
;
2119 last_known_column_point
= -1; /* invalidate indentation cache */
2123 /* Put the undo list back in the base buffer, so that it appears
2124 that an indirect buffer shares the undo list of its base. */
2125 if (old_buf
->base_buffer
)
2126 bset_undo_list (old_buf
->base_buffer
, BVAR (old_buf
, undo_list
));
2128 /* If the old current buffer has markers to record PT, BEGV and ZV
2129 when it is not current, update them now. */
2130 record_buffer_markers (old_buf
);
2133 /* Get the undo list from the base buffer, so that it appears
2134 that an indirect buffer shares the undo list of its base. */
2136 bset_undo_list (b
, BVAR (b
->base_buffer
, undo_list
));
2138 /* If the new current buffer has markers to record PT, BEGV and ZV
2139 when it is not current, fetch them now. */
2140 fetch_buffer_markers (b
);
2142 /* Look down buffer's list of local Lisp variables
2143 to find and update any that forward into C variables. */
2147 for (tail
= BVAR (b
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
2149 Lisp_Object var
= XCAR (XCAR (tail
));
2150 struct Lisp_Symbol
*sym
= XSYMBOL (var
);
2151 if (sym
->redirect
== SYMBOL_LOCALIZED
/* Just to be sure. */
2152 && SYMBOL_BLV (sym
)->fwd
)
2153 /* Just reference the variable
2154 to cause it to become set for this buffer. */
2155 Fsymbol_value (var
);
2158 /* Do the same with any others that were local to the previous buffer */
2159 while (b
!= old_buf
&& (b
= old_buf
, b
));
2162 /* Switch to buffer B temporarily for redisplay purposes.
2163 This avoids certain things that don't need to be done within redisplay. */
2166 set_buffer_temp (struct buffer
*b
)
2168 register struct buffer
*old_buf
;
2170 if (current_buffer
== b
)
2173 old_buf
= current_buffer
;
2176 /* If the old current buffer has markers to record PT, BEGV and ZV
2177 when it is not current, update them now. */
2178 record_buffer_markers (old_buf
);
2180 /* If the new current buffer has markers to record PT, BEGV and ZV
2181 when it is not current, fetch them now. */
2182 fetch_buffer_markers (b
);
2185 DEFUN ("set-buffer", Fset_buffer
, Sset_buffer
, 1, 1, 0,
2186 doc
: /* Make buffer BUFFER-OR-NAME current for editing operations.
2187 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
2188 also `with-current-buffer' when you want to make a buffer current
2189 temporarily. This function does not display the buffer, so its effect
2190 ends when the current command terminates. Use `switch-to-buffer' or
2191 `pop-to-buffer' to switch buffers permanently. */)
2192 (register Lisp_Object buffer_or_name
)
2194 register Lisp_Object buffer
;
2195 buffer
= Fget_buffer (buffer_or_name
);
2197 nsberror (buffer_or_name
);
2198 if (!BUFFER_LIVE_P (XBUFFER (buffer
)))
2199 error ("Selecting deleted buffer");
2200 set_buffer_internal (XBUFFER (buffer
));
2204 /* Set the current buffer to BUFFER provided if it is alive. */
2207 set_buffer_if_live (Lisp_Object buffer
)
2209 if (BUFFER_LIVE_P (XBUFFER (buffer
)))
2210 set_buffer_internal (XBUFFER (buffer
));
2214 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only
,
2215 Sbarf_if_buffer_read_only
, 0, 0, 0,
2216 doc
: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2219 if (!NILP (BVAR (current_buffer
, read_only
))
2220 && NILP (Vinhibit_read_only
))
2221 xsignal1 (Qbuffer_read_only
, Fcurrent_buffer ());
2225 DEFUN ("erase-buffer", Ferase_buffer
, Serase_buffer
, 0, 0, "*",
2226 doc
: /* Delete the entire contents of the current buffer.
2227 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2228 so the buffer is truly empty after this. */)
2235 current_buffer
->last_window_start
= 1;
2236 /* Prevent warnings, or suspension of auto saving, that would happen
2237 if future size is less than past size. Use of erase-buffer
2238 implies that the future text is not really related to the past text. */
2239 XSETFASTINT (BVAR (current_buffer
, save_length
), 0);
2244 validate_region (register Lisp_Object
*b
, register Lisp_Object
*e
)
2246 CHECK_NUMBER_COERCE_MARKER (*b
);
2247 CHECK_NUMBER_COERCE_MARKER (*e
);
2249 if (XINT (*b
) > XINT (*e
))
2252 tem
= *b
; *b
= *e
; *e
= tem
;
2255 if (! (BEGV
<= XINT (*b
) && XINT (*e
) <= ZV
))
2256 args_out_of_range (*b
, *e
);
2259 /* Advance BYTE_POS up to a character boundary
2260 and return the adjusted position. */
2263 advance_to_char_boundary (ptrdiff_t byte_pos
)
2267 if (byte_pos
== BEG
)
2268 /* Beginning of buffer is always a character boundary. */
2271 c
= FETCH_BYTE (byte_pos
);
2272 if (! CHAR_HEAD_P (c
))
2274 /* We should advance BYTE_POS only when C is a constituent of a
2275 multibyte sequence. */
2276 ptrdiff_t orig_byte_pos
= byte_pos
;
2281 c
= FETCH_BYTE (byte_pos
);
2283 while (! CHAR_HEAD_P (c
) && byte_pos
> BEG
);
2285 if (byte_pos
< orig_byte_pos
)
2286 byte_pos
= orig_byte_pos
;
2287 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2288 surely advance to the correct character boundary. If C is
2289 not, BYTE_POS was unchanged. */
2295 DEFUN ("buffer-swap-text", Fbuffer_swap_text
, Sbuffer_swap_text
,
2297 doc
: /* Swap the text between current buffer and BUFFER. */)
2298 (Lisp_Object buffer
)
2300 struct buffer
*other_buffer
;
2301 CHECK_BUFFER (buffer
);
2302 other_buffer
= XBUFFER (buffer
);
2304 if (!BUFFER_LIVE_P (other_buffer
))
2305 error ("Cannot swap a dead buffer's text");
2307 /* Actually, it probably works just fine.
2308 * if (other_buffer == current_buffer)
2309 * error ("Cannot swap a buffer's text with itself"); */
2311 /* Actually, this may be workable as well, tho probably only if they're
2313 if (other_buffer
->base_buffer
2314 || current_buffer
->base_buffer
)
2315 error ("Cannot swap indirect buffers's text");
2317 { /* This is probably harder to make work. */
2318 struct buffer
*other
;
2319 FOR_EACH_BUFFER (other
)
2320 if (other
->base_buffer
== other_buffer
2321 || other
->base_buffer
== current_buffer
)
2322 error ("One of the buffers to swap has indirect buffers");
2325 #define swapfield(field, type) \
2327 type tmp##field = other_buffer->field; \
2328 other_buffer->field = current_buffer->field; \
2329 current_buffer->field = tmp##field; \
2331 #define swapfield_(field, type) \
2333 type tmp##field = BVAR (other_buffer, field); \
2334 bset_##field (other_buffer, BVAR (current_buffer, field)); \
2335 bset_##field (current_buffer, tmp##field); \
2338 swapfield (own_text
, struct buffer_text
);
2339 eassert (current_buffer
->text
== ¤t_buffer
->own_text
);
2340 eassert (other_buffer
->text
== &other_buffer
->own_text
);
2342 r_alloc_reset_variable ((void **) ¤t_buffer
->own_text
.beg
,
2343 (void **) &other_buffer
->own_text
.beg
);
2344 r_alloc_reset_variable ((void **) &other_buffer
->own_text
.beg
,
2345 (void **) ¤t_buffer
->own_text
.beg
);
2346 #endif /* REL_ALLOC */
2348 swapfield (pt
, ptrdiff_t);
2349 swapfield (pt_byte
, ptrdiff_t);
2350 swapfield (begv
, ptrdiff_t);
2351 swapfield (begv_byte
, ptrdiff_t);
2352 swapfield (zv
, ptrdiff_t);
2353 swapfield (zv_byte
, ptrdiff_t);
2354 eassert (!current_buffer
->base_buffer
);
2355 eassert (!other_buffer
->base_buffer
);
2356 swapfield (indirections
, ptrdiff_t);
2357 current_buffer
->clip_changed
= 1; other_buffer
->clip_changed
= 1;
2358 swapfield (newline_cache
, struct region_cache
*);
2359 swapfield (width_run_cache
, struct region_cache
*);
2360 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2361 other_buffer
->prevent_redisplay_optimizations_p
= 1;
2362 swapfield (overlays_before
, struct Lisp_Overlay
*);
2363 swapfield (overlays_after
, struct Lisp_Overlay
*);
2364 swapfield (overlay_center
, ptrdiff_t);
2365 swapfield_ (undo_list
, Lisp_Object
);
2366 swapfield_ (mark
, Lisp_Object
);
2367 swapfield_ (enable_multibyte_characters
, Lisp_Object
);
2368 swapfield_ (bidi_display_reordering
, Lisp_Object
);
2369 swapfield_ (bidi_paragraph_direction
, Lisp_Object
);
2370 /* FIXME: Not sure what we should do with these *_marker fields.
2371 Hopefully they're just nil anyway. */
2372 swapfield_ (pt_marker
, Lisp_Object
);
2373 swapfield_ (begv_marker
, Lisp_Object
);
2374 swapfield_ (zv_marker
, Lisp_Object
);
2375 bset_point_before_scroll (current_buffer
, Qnil
);
2376 bset_point_before_scroll (other_buffer
, Qnil
);
2378 current_buffer
->text
->modiff
++; other_buffer
->text
->modiff
++;
2379 current_buffer
->text
->chars_modiff
++; other_buffer
->text
->chars_modiff
++;
2380 current_buffer
->text
->overlay_modiff
++; other_buffer
->text
->overlay_modiff
++;
2381 current_buffer
->text
->beg_unchanged
= current_buffer
->text
->gpt
;
2382 current_buffer
->text
->end_unchanged
= current_buffer
->text
->gpt
;
2383 other_buffer
->text
->beg_unchanged
= other_buffer
->text
->gpt
;
2384 other_buffer
->text
->end_unchanged
= other_buffer
->text
->gpt
;
2386 struct Lisp_Marker
*m
;
2387 for (m
= BUF_MARKERS (current_buffer
); m
; m
= m
->next
)
2388 if (m
->buffer
== other_buffer
)
2389 m
->buffer
= current_buffer
;
2391 /* Since there's no indirect buffer in sight, markers on
2392 BUF_MARKERS(buf) should either be for `buf' or dead. */
2393 eassert (!m
->buffer
);
2394 for (m
= BUF_MARKERS (other_buffer
); m
; m
= m
->next
)
2395 if (m
->buffer
== current_buffer
)
2396 m
->buffer
= other_buffer
;
2398 /* Since there's no indirect buffer in sight, markers on
2399 BUF_MARKERS(buf) should either be for `buf' or dead. */
2400 eassert (!m
->buffer
);
2402 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2403 So since we just swapped the markers between the two buffers, we need
2404 to undo the effect of this swap for window markers. */
2405 Lisp_Object w
= Fselected_window (), ws
= Qnil
;
2406 Lisp_Object buf1
, buf2
;
2407 XSETBUFFER (buf1
, current_buffer
); XSETBUFFER (buf2
, other_buffer
);
2409 while (NILP (Fmemq (w
, ws
)))
2412 if (MARKERP (XWINDOW (w
)->pointm
)
2413 && (EQ (XWINDOW (w
)->buffer
, buf1
)
2414 || EQ (XWINDOW (w
)->buffer
, buf2
)))
2415 Fset_marker (XWINDOW (w
)->pointm
,
2417 (BUF_BEGV (XBUFFER (XWINDOW (w
)->buffer
))),
2418 XWINDOW (w
)->buffer
);
2419 w
= Fnext_window (w
, Qt
, Qt
);
2423 if (current_buffer
->text
->intervals
)
2424 (eassert (EQ (current_buffer
->text
->intervals
->up
.obj
, buffer
)),
2425 XSETBUFFER (current_buffer
->text
->intervals
->up
.obj
, current_buffer
));
2426 if (other_buffer
->text
->intervals
)
2427 (eassert (EQ (other_buffer
->text
->intervals
->up
.obj
, Fcurrent_buffer ())),
2428 XSETBUFFER (other_buffer
->text
->intervals
->up
.obj
, other_buffer
));
2433 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte
, Sset_buffer_multibyte
,
2435 doc
: /* Set the multibyte flag of the current buffer to FLAG.
2436 If FLAG is t, this makes the buffer a multibyte buffer.
2437 If FLAG is nil, this makes the buffer a single-byte buffer.
2438 In these cases, the buffer contents remain unchanged as a sequence of
2439 bytes but the contents viewed as characters do change.
2440 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2441 all eight-bit bytes to eight-bit characters.
2442 If the multibyte flag was really changed, undo information of the
2443 current buffer is cleared. */)
2446 struct Lisp_Marker
*tail
, *markers
;
2447 struct buffer
*other
;
2449 bool narrowed
= (BEG
!= BEGV
|| Z
!= ZV
);
2450 bool modified_p
= !NILP (Fbuffer_modified_p (Qnil
));
2451 Lisp_Object old_undo
= BVAR (current_buffer
, undo_list
);
2452 struct gcpro gcpro1
;
2454 if (current_buffer
->base_buffer
)
2455 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2457 /* Do nothing if nothing actually changes. */
2458 if (NILP (flag
) == NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2463 /* Don't record these buffer changes. We will put a special undo entry
2465 bset_undo_list (current_buffer
, Qt
);
2467 /* If the cached position is for this buffer, clear it out. */
2468 clear_charpos_cache (current_buffer
);
2471 begv
= BEGV_BYTE
, zv
= ZV_BYTE
;
2473 begv
= BEGV
, zv
= ZV
;
2476 error ("Changing multibyteness in a narrowed buffer");
2480 ptrdiff_t pos
, stop
;
2483 /* Do this first, so it can use CHAR_TO_BYTE
2484 to calculate the old correspondences. */
2485 set_intervals_multibyte (0);
2487 bset_enable_multibyte_characters (current_buffer
, Qnil
);
2493 TEMP_SET_PT_BOTH (PT_BYTE
, PT_BYTE
);
2496 for (tail
= BUF_MARKERS (current_buffer
); tail
; tail
= tail
->next
)
2497 tail
->charpos
= tail
->bytepos
;
2499 /* Convert multibyte form of 8-bit characters to unibyte. */
2514 if (ASCII_BYTE_P (*p
))
2516 else if (CHAR_BYTE8_HEAD_P (*p
))
2518 c
= STRING_CHAR_AND_LENGTH (p
, bytes
);
2519 /* Delete all bytes for this 8-bit character but the
2520 last one, and change the last one to the character
2523 del_range_2 (pos
, pos
, pos
+ bytes
, pos
+ bytes
, 0);
2535 bytes
= BYTES_BY_CHAR_HEAD (*p
);
2536 p
+= bytes
, pos
+= bytes
;
2540 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2545 ptrdiff_t pos
, stop
;
2546 unsigned char *p
, *pend
;
2548 /* Be sure not to have a multibyte sequence striding over the GAP.
2549 Ex: We change this: "...abc\302 _GAP_ \241def..."
2550 to: "...abc _GAP_ \302\241def..." */
2553 && GPT_BYTE
> 1 && GPT_BYTE
< Z_BYTE
2554 && ! CHAR_HEAD_P (*(GAP_END_ADDR
)))
2556 unsigned char *q
= GPT_ADDR
- 1;
2558 while (! CHAR_HEAD_P (*q
) && q
> BEG_ADDR
) q
--;
2559 if (LEADING_CODE_P (*q
))
2561 ptrdiff_t new_gpt
= GPT_BYTE
- (GPT_ADDR
- q
);
2563 move_gap_both (new_gpt
, new_gpt
);
2567 /* Make the buffer contents valid as multibyte by converting
2568 8-bit characters to multibyte form. */
2586 if (ASCII_BYTE_P (*p
))
2588 else if (EQ (flag
, Qt
)
2589 && ! CHAR_BYTE8_HEAD_P (*p
)
2590 && (bytes
= MULTIBYTE_LENGTH (p
, pend
)) > 0)
2591 p
+= bytes
, pos
+= bytes
;
2594 unsigned char tmp
[MAX_MULTIBYTE_LENGTH
];
2597 c
= BYTE8_TO_CHAR (*p
);
2598 bytes
= CHAR_STRING (c
, tmp
);
2600 TEMP_SET_PT_BOTH (pos
+ 1, pos
+ 1);
2602 insert_1_both ((char *) tmp
+ 1, bytes
, bytes
, 1, 0, 0);
2603 /* Now the gap is after the just inserted data. */
2621 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2623 /* Do this first, so that chars_in_text asks the right question.
2624 set_intervals_multibyte needs it too. */
2625 bset_enable_multibyte_characters (current_buffer
, Qt
);
2627 GPT_BYTE
= advance_to_char_boundary (GPT_BYTE
);
2628 GPT
= chars_in_text (BEG_ADDR
, GPT_BYTE
- BEG_BYTE
) + BEG
;
2630 Z
= chars_in_text (GAP_END_ADDR
, Z_BYTE
- GPT_BYTE
) + GPT
;
2632 BEGV_BYTE
= advance_to_char_boundary (BEGV_BYTE
);
2633 if (BEGV_BYTE
> GPT_BYTE
)
2634 BEGV
= chars_in_text (GAP_END_ADDR
, BEGV_BYTE
- GPT_BYTE
) + GPT
;
2636 BEGV
= chars_in_text (BEG_ADDR
, BEGV_BYTE
- BEG_BYTE
) + BEG
;
2638 ZV_BYTE
= advance_to_char_boundary (ZV_BYTE
);
2639 if (ZV_BYTE
> GPT_BYTE
)
2640 ZV
= chars_in_text (GAP_END_ADDR
, ZV_BYTE
- GPT_BYTE
) + GPT
;
2642 ZV
= chars_in_text (BEG_ADDR
, ZV_BYTE
- BEG_BYTE
) + BEG
;
2645 ptrdiff_t byte
= advance_to_char_boundary (PT_BYTE
);
2648 if (byte
> GPT_BYTE
)
2649 position
= chars_in_text (GAP_END_ADDR
, byte
- GPT_BYTE
) + GPT
;
2651 position
= chars_in_text (BEG_ADDR
, byte
- BEG_BYTE
) + BEG
;
2652 TEMP_SET_PT_BOTH (position
, byte
);
2655 tail
= markers
= BUF_MARKERS (current_buffer
);
2657 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2658 getting confused by the markers that have not yet been updated.
2659 It is also a signal that it should never create a marker. */
2660 BUF_MARKERS (current_buffer
) = NULL
;
2662 for (; tail
; tail
= tail
->next
)
2664 tail
->bytepos
= advance_to_char_boundary (tail
->bytepos
);
2665 tail
->charpos
= BYTE_TO_CHAR (tail
->bytepos
);
2668 /* Make sure no markers were put on the chain
2669 while the chain value was incorrect. */
2670 if (BUF_MARKERS (current_buffer
))
2673 BUF_MARKERS (current_buffer
) = markers
;
2675 /* Do this last, so it can calculate the new correspondences
2676 between chars and bytes. */
2677 set_intervals_multibyte (1);
2680 if (!EQ (old_undo
, Qt
))
2682 /* Represent all the above changes by a special undo entry. */
2683 bset_undo_list (current_buffer
,
2684 Fcons (list3 (Qapply
,
2685 intern ("set-buffer-multibyte"),
2686 NILP (flag
) ? Qt
: Qnil
),
2692 /* Changing the multibyteness of a buffer means that all windows
2693 showing that buffer must be updated thoroughly. */
2694 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2695 ++windows_or_buffers_changed
;
2697 /* Copy this buffer's new multibyte status
2698 into all of its indirect buffers. */
2699 FOR_EACH_BUFFER (other
)
2700 if (other
->base_buffer
== current_buffer
&& BUFFER_LIVE_P (other
))
2702 BVAR (other
, enable_multibyte_characters
)
2703 = BVAR (current_buffer
, enable_multibyte_characters
);
2704 other
->prevent_redisplay_optimizations_p
= 1;
2707 /* Restore the modifiedness of the buffer. */
2708 if (!modified_p
&& !NILP (Fbuffer_modified_p (Qnil
)))
2709 Fset_buffer_modified_p (Qnil
);
2711 /* Update coding systems of this buffer's process (if any). */
2713 Lisp_Object process
;
2715 process
= Fget_buffer_process (Fcurrent_buffer ());
2716 if (PROCESSP (process
))
2717 setup_process_coding_systems (process
);
2723 DEFUN ("kill-all-local-variables", Fkill_all_local_variables
,
2724 Skill_all_local_variables
, 0, 0, 0,
2725 doc
: /* Switch to Fundamental mode by killing current buffer's local variables.
2726 Most local variable bindings are eliminated so that the default values
2727 become effective once more. Also, the syntax table is set from
2728 `standard-syntax-table', the local keymap is set to nil,
2729 and the abbrev table from `fundamental-mode-abbrev-table'.
2730 This function also forces redisplay of the mode line.
2732 Every function to select a new major mode starts by
2733 calling this function.
2735 As a special exception, local variables whose names have
2736 a non-nil `permanent-local' property are not eliminated by this function.
2738 The first thing this function does is run
2739 the normal hook `change-major-mode-hook'. */)
2742 Frun_hooks (1, &Qchange_major_mode_hook
);
2744 /* Make sure none of the bindings in local_var_alist
2745 remain swapped in, in their symbols. */
2747 swap_out_buffer_local_variables (current_buffer
);
2749 /* Actually eliminate all local bindings of this buffer. */
2751 reset_buffer_local_variables (current_buffer
, 0);
2753 /* Force mode-line redisplay. Useful here because all major mode
2754 commands call this function. */
2755 update_mode_lines
++;
2760 /* Make sure no local variables remain set up with buffer B
2761 for their current values. */
2764 swap_out_buffer_local_variables (struct buffer
*b
)
2766 Lisp_Object oalist
, alist
, buffer
;
2768 XSETBUFFER (buffer
, b
);
2769 oalist
= BVAR (b
, local_var_alist
);
2771 for (alist
= oalist
; CONSP (alist
); alist
= XCDR (alist
))
2773 Lisp_Object sym
= XCAR (XCAR (alist
));
2774 eassert (XSYMBOL (sym
)->redirect
== SYMBOL_LOCALIZED
);
2775 /* Need not do anything if some other buffer's binding is
2777 if (EQ (SYMBOL_BLV (XSYMBOL (sym
))->where
, buffer
))
2779 /* Symbol is set up for this buffer's old local value:
2781 swap_in_global_binding (XSYMBOL (sym
));
2786 /* Find all the overlays in the current buffer that contain position POS.
2787 Return the number found, and store them in a vector in *VEC_PTR.
2788 Store in *LEN_PTR the size allocated for the vector.
2789 Store in *NEXT_PTR the next position after POS where an overlay starts,
2790 or ZV if there are no more overlays between POS and ZV.
2791 Store in *PREV_PTR the previous position before POS where an overlay ends,
2792 or where an overlay starts which ends at or after POS;
2793 or BEGV if there are no such overlays from BEGV to POS.
2794 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2796 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2797 when this function is called.
2799 If EXTEND, make the vector bigger if necessary.
2800 If not, never extend the vector,
2801 and store only as many overlays as will fit.
2802 But still return the total number of overlays.
2804 If CHANGE_REQ, any position written into *PREV_PTR or
2805 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2806 default (BEGV or ZV). */
2809 overlays_at (EMACS_INT pos
, bool extend
, Lisp_Object
**vec_ptr
,
2811 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
, bool change_req
)
2813 Lisp_Object overlay
, start
, end
;
2814 struct Lisp_Overlay
*tail
;
2816 ptrdiff_t len
= *len_ptr
;
2817 Lisp_Object
*vec
= *vec_ptr
;
2818 ptrdiff_t next
= ZV
;
2819 ptrdiff_t prev
= BEGV
;
2820 bool inhibit_storing
= 0;
2822 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2824 ptrdiff_t startpos
, endpos
;
2826 XSETMISC (overlay
, tail
);
2828 start
= OVERLAY_START (overlay
);
2829 end
= OVERLAY_END (overlay
);
2830 endpos
= OVERLAY_POSITION (end
);
2837 startpos
= OVERLAY_POSITION (start
);
2838 /* This one ends at or after POS
2839 so its start counts for PREV_PTR if it's before POS. */
2840 if (prev
< startpos
&& startpos
< pos
)
2844 if (startpos
<= pos
)
2848 /* The supplied vector is full.
2849 Either make it bigger, or don't store any more in it. */
2852 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2858 inhibit_storing
= 1;
2861 if (!inhibit_storing
)
2863 /* Keep counting overlays even if we can't return them all. */
2866 else if (startpos
< next
)
2870 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2872 ptrdiff_t startpos
, endpos
;
2874 XSETMISC (overlay
, tail
);
2876 start
= OVERLAY_START (overlay
);
2877 end
= OVERLAY_END (overlay
);
2878 startpos
= OVERLAY_POSITION (start
);
2881 if (startpos
< next
)
2885 endpos
= OVERLAY_POSITION (end
);
2892 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2898 inhibit_storing
= 1;
2901 if (!inhibit_storing
)
2905 if (startpos
< pos
&& startpos
> prev
)
2908 else if (endpos
< pos
&& endpos
> prev
)
2910 else if (endpos
== pos
&& startpos
> prev
2911 && (!change_req
|| startpos
< pos
))
2922 /* Find all the overlays in the current buffer that overlap the range
2923 BEG-END, or are empty at BEG, or are empty at END provided END
2924 denotes the position at the end of the current buffer.
2926 Return the number found, and store them in a vector in *VEC_PTR.
2927 Store in *LEN_PTR the size allocated for the vector.
2928 Store in *NEXT_PTR the next position after POS where an overlay starts,
2929 or ZV if there are no more overlays.
2930 Store in *PREV_PTR the previous position before POS where an overlay ends,
2931 or BEGV if there are no previous overlays.
2932 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2934 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2935 when this function is called.
2937 If EXTEND, make the vector bigger if necessary.
2938 If not, never extend the vector,
2939 and store only as many overlays as will fit.
2940 But still return the total number of overlays. */
2943 overlays_in (EMACS_INT beg
, EMACS_INT end
, bool extend
,
2944 Lisp_Object
**vec_ptr
, ptrdiff_t *len_ptr
,
2945 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
)
2947 Lisp_Object overlay
, ostart
, oend
;
2948 struct Lisp_Overlay
*tail
;
2950 ptrdiff_t len
= *len_ptr
;
2951 Lisp_Object
*vec
= *vec_ptr
;
2952 ptrdiff_t next
= ZV
;
2953 ptrdiff_t prev
= BEGV
;
2954 bool inhibit_storing
= 0;
2955 bool end_is_Z
= end
== Z
;
2957 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2959 ptrdiff_t startpos
, endpos
;
2961 XSETMISC (overlay
, tail
);
2963 ostart
= OVERLAY_START (overlay
);
2964 oend
= OVERLAY_END (overlay
);
2965 endpos
= OVERLAY_POSITION (oend
);
2972 startpos
= OVERLAY_POSITION (ostart
);
2973 /* Count an interval if it overlaps the range, is empty at the
2974 start of the range, or is empty at END provided END denotes the
2975 end of the buffer. */
2976 if ((beg
< endpos
&& startpos
< end
)
2977 || (startpos
== endpos
2978 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
2982 /* The supplied vector is full.
2983 Either make it bigger, or don't store any more in it. */
2986 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2992 inhibit_storing
= 1;
2995 if (!inhibit_storing
)
2997 /* Keep counting overlays even if we can't return them all. */
3000 else if (startpos
< next
)
3004 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
3006 ptrdiff_t startpos
, endpos
;
3008 XSETMISC (overlay
, tail
);
3010 ostart
= OVERLAY_START (overlay
);
3011 oend
= OVERLAY_END (overlay
);
3012 startpos
= OVERLAY_POSITION (ostart
);
3015 if (startpos
< next
)
3019 endpos
= OVERLAY_POSITION (oend
);
3020 /* Count an interval if it overlaps the range, is empty at the
3021 start of the range, or is empty at END provided END denotes the
3022 end of the buffer. */
3023 if ((beg
< endpos
&& startpos
< end
)
3024 || (startpos
== endpos
3025 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
3031 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
3037 inhibit_storing
= 1;
3040 if (!inhibit_storing
)
3044 else if (endpos
< beg
&& endpos
> prev
)
3056 /* Return true if there exists an overlay with a non-nil
3057 `mouse-face' property overlapping OVERLAY. */
3060 mouse_face_overlay_overlaps (Lisp_Object overlay
)
3062 ptrdiff_t start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3063 ptrdiff_t end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3064 ptrdiff_t n
, i
, size
;
3065 Lisp_Object
*v
, tem
;
3068 v
= alloca (size
* sizeof *v
);
3069 n
= overlays_in (start
, end
, 0, &v
, &size
, NULL
, NULL
);
3072 v
= alloca (n
* sizeof *v
);
3073 overlays_in (start
, end
, 0, &v
, &n
, NULL
, NULL
);
3076 for (i
= 0; i
< n
; ++i
)
3077 if (!EQ (v
[i
], overlay
)
3078 && (tem
= Foverlay_get (overlay
, Qmouse_face
),
3087 /* Fast function to just test if we're at an overlay boundary. */
3089 overlay_touches_p (ptrdiff_t pos
)
3091 Lisp_Object overlay
;
3092 struct Lisp_Overlay
*tail
;
3094 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
3098 XSETMISC (overlay
,tail
);
3099 eassert (OVERLAYP (overlay
));
3101 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3104 if (endpos
== pos
|| OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
)
3108 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
3112 XSETMISC (overlay
, tail
);
3113 eassert (OVERLAYP (overlay
));
3115 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3118 if (startpos
== pos
|| OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
)
3126 Lisp_Object overlay
;
3132 compare_overlays (const void *v1
, const void *v2
)
3134 const struct sortvec
*s1
= (const struct sortvec
*) v1
;
3135 const struct sortvec
*s2
= (const struct sortvec
*) v2
;
3136 if (s1
->priority
!= s2
->priority
)
3137 return s1
->priority
< s2
->priority
? -1 : 1;
3138 if (s1
->beg
!= s2
->beg
)
3139 return s1
->beg
< s2
->beg
? -1 : 1;
3140 if (s1
->end
!= s2
->end
)
3141 return s2
->end
< s1
->end
? -1 : 1;
3142 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
3143 between "equal" overlays. The result can still change between
3144 invocations of Emacs, but it won't change in the middle of
3145 `find_field' (bug#6830). */
3146 if (XHASH (s1
->overlay
) != XHASH (s2
->overlay
))
3147 return XHASH (s1
->overlay
) < XHASH (s2
->overlay
) ? -1 : 1;
3151 /* Sort an array of overlays by priority. The array is modified in place.
3152 The return value is the new size; this may be smaller than the original
3153 size if some of the overlays were invalid or were window-specific. */
3155 sort_overlays (Lisp_Object
*overlay_vec
, ptrdiff_t noverlays
, struct window
*w
)
3158 struct sortvec
*sortvec
= alloca (noverlays
* sizeof *sortvec
);
3160 /* Put the valid and relevant overlays into sortvec. */
3162 for (i
= 0, j
= 0; i
< noverlays
; i
++)
3165 Lisp_Object overlay
;
3167 overlay
= overlay_vec
[i
];
3168 if (OVERLAYP (overlay
)
3169 && OVERLAY_POSITION (OVERLAY_START (overlay
)) > 0
3170 && OVERLAY_POSITION (OVERLAY_END (overlay
)) > 0)
3172 /* If we're interested in a specific window, then ignore
3173 overlays that are limited to some other window. */
3178 window
= Foverlay_get (overlay
, Qwindow
);
3179 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3183 /* This overlay is good and counts: put it into sortvec. */
3184 sortvec
[j
].overlay
= overlay
;
3185 sortvec
[j
].beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3186 sortvec
[j
].end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3187 tem
= Foverlay_get (overlay
, Qpriority
);
3189 sortvec
[j
].priority
= XINT (tem
);
3191 sortvec
[j
].priority
= 0;
3197 /* Sort the overlays into the proper order: increasing priority. */
3200 qsort (sortvec
, noverlays
, sizeof (struct sortvec
), compare_overlays
);
3202 for (i
= 0; i
< noverlays
; i
++)
3203 overlay_vec
[i
] = sortvec
[i
].overlay
;
3209 Lisp_Object string
, string2
;
3216 struct sortstr
*buf
; /* An array that expands as needed; never freed. */
3217 ptrdiff_t size
; /* Allocated length of that array. */
3218 ptrdiff_t used
; /* How much of the array is currently in use. */
3219 ptrdiff_t bytes
; /* Total length of the strings in buf. */
3222 /* Buffers for storing information about the overlays touching a given
3223 position. These could be automatic variables in overlay_strings, but
3224 it's more efficient to hold onto the memory instead of repeatedly
3225 allocating and freeing it. */
3226 static struct sortstrlist overlay_heads
, overlay_tails
;
3227 static unsigned char *overlay_str_buf
;
3229 /* Allocated length of overlay_str_buf. */
3230 static ptrdiff_t overlay_str_len
;
3232 /* A comparison function suitable for passing to qsort. */
3234 cmp_for_strings (const void *as1
, const void *as2
)
3236 struct sortstr
*s1
= (struct sortstr
*)as1
;
3237 struct sortstr
*s2
= (struct sortstr
*)as2
;
3238 if (s1
->size
!= s2
->size
)
3239 return s2
->size
< s1
->size
? -1 : 1;
3240 if (s1
->priority
!= s2
->priority
)
3241 return s1
->priority
< s2
->priority
? -1 : 1;
3246 record_overlay_string (struct sortstrlist
*ssl
, Lisp_Object str
,
3247 Lisp_Object str2
, Lisp_Object pri
, ptrdiff_t size
)
3251 if (ssl
->used
== ssl
->size
)
3252 ssl
->buf
= xpalloc (ssl
->buf
, &ssl
->size
, 5, -1, sizeof *ssl
->buf
);
3253 ssl
->buf
[ssl
->used
].string
= str
;
3254 ssl
->buf
[ssl
->used
].string2
= str2
;
3255 ssl
->buf
[ssl
->used
].size
= size
;
3256 ssl
->buf
[ssl
->used
].priority
= (INTEGERP (pri
) ? XINT (pri
) : 0);
3259 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3260 nbytes
= SCHARS (str
);
3261 else if (! STRING_MULTIBYTE (str
))
3262 nbytes
= count_size_as_multibyte (SDATA (str
),
3265 nbytes
= SBYTES (str
);
3267 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3268 memory_full (SIZE_MAX
);
3269 ssl
->bytes
+= nbytes
;
3273 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3274 nbytes
= SCHARS (str2
);
3275 else if (! STRING_MULTIBYTE (str2
))
3276 nbytes
= count_size_as_multibyte (SDATA (str2
),
3279 nbytes
= SBYTES (str2
);
3281 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3282 memory_full (SIZE_MAX
);
3283 ssl
->bytes
+= nbytes
;
3287 /* Return the concatenation of the strings associated with overlays that
3288 begin or end at POS, ignoring overlays that are specific to a window
3289 other than W. The strings are concatenated in the appropriate order:
3290 shorter overlays nest inside longer ones, and higher priority inside
3291 lower. Normally all of the after-strings come first, but zero-sized
3292 overlays have their after-strings ride along with the before-strings
3293 because it would look strange to print them inside-out.
3295 Returns the string length, and stores the contents indirectly through
3296 PSTR, if that variable is non-null. The string may be overwritten by
3297 subsequent calls. */
3300 overlay_strings (ptrdiff_t pos
, struct window
*w
, unsigned char **pstr
)
3302 Lisp_Object overlay
, window
, str
;
3303 struct Lisp_Overlay
*ov
;
3304 ptrdiff_t startpos
, endpos
;
3305 bool multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3307 overlay_heads
.used
= overlay_heads
.bytes
= 0;
3308 overlay_tails
.used
= overlay_tails
.bytes
= 0;
3309 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
3311 XSETMISC (overlay
, ov
);
3312 eassert (OVERLAYP (overlay
));
3314 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3315 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3318 if (endpos
!= pos
&& startpos
!= pos
)
3320 window
= Foverlay_get (overlay
, Qwindow
);
3321 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3324 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3325 record_overlay_string (&overlay_heads
, str
,
3327 ? Foverlay_get (overlay
, Qafter_string
)
3329 Foverlay_get (overlay
, Qpriority
),
3331 else if (endpos
== pos
3332 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3333 record_overlay_string (&overlay_tails
, str
, Qnil
,
3334 Foverlay_get (overlay
, Qpriority
),
3337 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
3339 XSETMISC (overlay
, ov
);
3340 eassert (OVERLAYP (overlay
));
3342 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3343 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3346 if (endpos
!= pos
&& startpos
!= pos
)
3348 window
= Foverlay_get (overlay
, Qwindow
);
3349 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3352 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3353 record_overlay_string (&overlay_heads
, str
,
3355 ? Foverlay_get (overlay
, Qafter_string
)
3357 Foverlay_get (overlay
, Qpriority
),
3359 else if (endpos
== pos
3360 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3361 record_overlay_string (&overlay_tails
, str
, Qnil
,
3362 Foverlay_get (overlay
, Qpriority
),
3365 if (overlay_tails
.used
> 1)
3366 qsort (overlay_tails
.buf
, overlay_tails
.used
, sizeof (struct sortstr
),
3368 if (overlay_heads
.used
> 1)
3369 qsort (overlay_heads
.buf
, overlay_heads
.used
, sizeof (struct sortstr
),
3371 if (overlay_heads
.bytes
|| overlay_tails
.bytes
)
3378 if (INT_ADD_OVERFLOW (overlay_heads
.bytes
, overlay_tails
.bytes
))
3379 memory_full (SIZE_MAX
);
3380 total
= overlay_heads
.bytes
+ overlay_tails
.bytes
;
3381 if (total
> overlay_str_len
)
3382 overlay_str_buf
= xpalloc (overlay_str_buf
, &overlay_str_len
,
3383 total
- overlay_str_len
, -1, 1);
3385 p
= overlay_str_buf
;
3386 for (i
= overlay_tails
.used
; --i
>= 0;)
3389 tem
= overlay_tails
.buf
[i
].string
;
3390 nbytes
= copy_text (SDATA (tem
), p
,
3392 STRING_MULTIBYTE (tem
), multibyte
);
3395 for (i
= 0; i
< overlay_heads
.used
; ++i
)
3398 tem
= overlay_heads
.buf
[i
].string
;
3399 nbytes
= copy_text (SDATA (tem
), p
,
3401 STRING_MULTIBYTE (tem
), multibyte
);
3403 tem
= overlay_heads
.buf
[i
].string2
;
3406 nbytes
= copy_text (SDATA (tem
), p
,
3408 STRING_MULTIBYTE (tem
), multibyte
);
3412 if (p
!= overlay_str_buf
+ total
)
3415 *pstr
= overlay_str_buf
;
3421 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3424 recenter_overlay_lists (struct buffer
*buf
, ptrdiff_t pos
)
3426 Lisp_Object overlay
, beg
, end
;
3427 struct Lisp_Overlay
*prev
, *tail
, *next
;
3429 /* See if anything in overlays_before should move to overlays_after. */
3431 /* We don't strictly need prev in this loop; it should always be nil.
3432 But we use it for symmetry and in case that should cease to be true
3433 with some future change. */
3435 for (tail
= buf
->overlays_before
; tail
; prev
= tail
, tail
= next
)
3438 XSETMISC (overlay
, tail
);
3439 eassert (OVERLAYP (overlay
));
3441 beg
= OVERLAY_START (overlay
);
3442 end
= OVERLAY_END (overlay
);
3444 if (OVERLAY_POSITION (end
) > pos
)
3446 /* OVERLAY needs to be moved. */
3447 ptrdiff_t where
= OVERLAY_POSITION (beg
);
3448 struct Lisp_Overlay
*other
, *other_prev
;
3450 /* Splice the cons cell TAIL out of overlays_before. */
3454 set_buffer_overlays_before (buf
, next
);
3456 /* Search thru overlays_after for where to put it. */
3458 for (other
= buf
->overlays_after
; other
;
3459 other_prev
= other
, other
= other
->next
)
3461 Lisp_Object otherbeg
, otheroverlay
;
3463 XSETMISC (otheroverlay
, other
);
3464 eassert (OVERLAYP (otheroverlay
));
3466 otherbeg
= OVERLAY_START (otheroverlay
);
3467 if (OVERLAY_POSITION (otherbeg
) >= where
)
3471 /* Add TAIL to overlays_after before OTHER. */
3474 other_prev
->next
= tail
;
3476 set_buffer_overlays_after (buf
, tail
);
3480 /* We've reached the things that should stay in overlays_before.
3481 All the rest of overlays_before must end even earlier,
3486 /* See if anything in overlays_after should be in overlays_before. */
3488 for (tail
= buf
->overlays_after
; tail
; prev
= tail
, tail
= next
)
3491 XSETMISC (overlay
, tail
);
3492 eassert (OVERLAYP (overlay
));
3494 beg
= OVERLAY_START (overlay
);
3495 end
= OVERLAY_END (overlay
);
3497 /* Stop looking, when we know that nothing further
3498 can possibly end before POS. */
3499 if (OVERLAY_POSITION (beg
) > pos
)
3502 if (OVERLAY_POSITION (end
) <= pos
)
3504 /* OVERLAY needs to be moved. */
3505 ptrdiff_t where
= OVERLAY_POSITION (end
);
3506 struct Lisp_Overlay
*other
, *other_prev
;
3508 /* Splice the cons cell TAIL out of overlays_after. */
3512 set_buffer_overlays_after (buf
, next
);
3514 /* Search thru overlays_before for where to put it. */
3516 for (other
= buf
->overlays_before
; other
;
3517 other_prev
= other
, other
= other
->next
)
3519 Lisp_Object otherend
, otheroverlay
;
3521 XSETMISC (otheroverlay
, other
);
3522 eassert (OVERLAYP (otheroverlay
));
3524 otherend
= OVERLAY_END (otheroverlay
);
3525 if (OVERLAY_POSITION (otherend
) <= where
)
3529 /* Add TAIL to overlays_before before OTHER. */
3532 other_prev
->next
= tail
;
3534 set_buffer_overlays_before (buf
, tail
);
3539 buf
->overlay_center
= pos
;
3543 adjust_overlays_for_insert (ptrdiff_t pos
, ptrdiff_t length
)
3545 /* After an insertion, the lists are still sorted properly,
3546 but we may need to update the value of the overlay center. */
3547 if (current_buffer
->overlay_center
>= pos
)
3548 current_buffer
->overlay_center
+= length
;
3552 adjust_overlays_for_delete (ptrdiff_t pos
, ptrdiff_t length
)
3554 if (current_buffer
->overlay_center
< pos
)
3555 /* The deletion was to our right. No change needed; the before- and
3556 after-lists are still consistent. */
3558 else if (current_buffer
->overlay_center
- pos
> length
)
3559 /* The deletion was to our left. We need to adjust the center value
3560 to account for the change in position, but the lists are consistent
3561 given the new value. */
3562 current_buffer
->overlay_center
-= length
;
3564 /* We're right in the middle. There might be things on the after-list
3565 that now belong on the before-list. Recentering will move them,
3566 and also update the center point. */
3567 recenter_overlay_lists (current_buffer
, pos
);
3570 /* Fix up overlays that were garbled as a result of permuting markers
3571 in the range START through END. Any overlay with at least one
3572 endpoint in this range will need to be unlinked from the overlay
3573 list and reinserted in its proper place.
3574 Such an overlay might even have negative size at this point.
3575 If so, we'll make the overlay empty. */
3577 fix_start_end_in_overlays (register ptrdiff_t start
, register ptrdiff_t end
)
3579 Lisp_Object overlay
;
3580 struct Lisp_Overlay
*before_list
IF_LINT (= NULL
);
3581 struct Lisp_Overlay
*after_list
IF_LINT (= NULL
);
3582 /* These are either nil, indicating that before_list or after_list
3583 should be assigned, or the cons cell the cdr of which should be
3585 struct Lisp_Overlay
*beforep
= NULL
, *afterp
= NULL
;
3586 /* 'Parent', likewise, indicates a cons cell or
3587 current_buffer->overlays_before or overlays_after, depending
3588 which loop we're in. */
3589 struct Lisp_Overlay
*tail
, *parent
;
3590 ptrdiff_t startpos
, endpos
;
3592 /* This algorithm shifts links around instead of consing and GCing.
3593 The loop invariant is that before_list (resp. after_list) is a
3594 well-formed list except that its last element, the CDR of beforep
3595 (resp. afterp) if beforep (afterp) isn't nil or before_list
3596 (after_list) if it is, is still uninitialized. So it's not a bug
3597 that before_list isn't initialized, although it may look
3599 for (parent
= NULL
, tail
= current_buffer
->overlays_before
; tail
;)
3601 XSETMISC (overlay
, tail
);
3603 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3604 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3606 /* If the overlay is backwards, make it empty. */
3607 if (endpos
< startpos
)
3610 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3618 || (startpos
>= start
&& startpos
< end
))
3620 /* Add it to the end of the wrong list. Later on,
3621 recenter_overlay_lists will move it to the right place. */
3622 if (endpos
< current_buffer
->overlay_center
)
3627 afterp
->next
= tail
;
3635 beforep
->next
= tail
;
3639 set_buffer_overlays_before (current_buffer
, tail
->next
);
3641 parent
->next
= tail
->next
;
3645 parent
= tail
, tail
= parent
->next
;
3647 for (parent
= NULL
, tail
= current_buffer
->overlays_after
; tail
;)
3649 XSETMISC (overlay
, tail
);
3651 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3652 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3654 /* If the overlay is backwards, make it empty. */
3655 if (endpos
< startpos
)
3658 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3662 if (startpos
>= end
)
3665 if (startpos
>= start
3666 || (endpos
>= start
&& endpos
< end
))
3668 if (endpos
< current_buffer
->overlay_center
)
3673 afterp
->next
= tail
;
3681 beforep
->next
= tail
;
3685 set_buffer_overlays_after (current_buffer
, tail
->next
);
3687 parent
->next
= tail
->next
;
3691 parent
= tail
, tail
= parent
->next
;
3694 /* Splice the constructed (wrong) lists into the buffer's lists,
3695 and let the recenter function make it sane again. */
3698 beforep
->next
= current_buffer
->overlays_before
;
3699 set_buffer_overlays_before (current_buffer
, before_list
);
3704 afterp
->next
= current_buffer
->overlays_after
;
3705 set_buffer_overlays_after (current_buffer
, after_list
);
3707 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3710 /* We have two types of overlay: the one whose ending marker is
3711 after-insertion-marker (this is the usual case) and the one whose
3712 ending marker is before-insertion-marker. When `overlays_before'
3713 contains overlays of the latter type and the former type in this
3714 order and both overlays end at inserting position, inserting a text
3715 increases only the ending marker of the latter type, which results
3716 in incorrect ordering of `overlays_before'.
3718 This function fixes ordering of overlays in the slot
3719 `overlays_before' of the buffer *BP. Before the insertion, `point'
3720 was at PREV, and now is at POS. */
3723 fix_overlays_before (struct buffer
*bp
, ptrdiff_t prev
, ptrdiff_t pos
)
3725 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3726 struct Lisp_Overlay
*tail
= bp
->overlays_before
, *parent
= NULL
, *right_pair
;
3728 ptrdiff_t end
IF_LINT (= 0);
3730 /* After the insertion, the several overlays may be in incorrect
3731 order. The possibility is that, in the list `overlays_before',
3732 an overlay which ends at POS appears after an overlay which ends
3733 at PREV. Since POS is greater than PREV, we must fix the
3734 ordering of these overlays, by moving overlays ends at POS before
3735 the overlays ends at PREV. */
3737 /* At first, find a place where disordered overlays should be linked
3738 in. It is where an overlay which end before POS exists. (i.e. an
3739 overlay whose ending marker is after-insertion-marker if disorder
3742 && (XSETMISC (tem
, tail
),
3743 (end
= OVERLAY_POSITION (OVERLAY_END (tem
))) >= pos
))
3749 /* If we don't find such an overlay,
3750 or the found one ends before PREV,
3751 or the found one is the last one in the list,
3752 we don't have to fix anything. */
3753 if (!tail
|| end
< prev
|| !tail
->next
)
3756 right_pair
= parent
;
3760 /* Now, end position of overlays in the list TAIL should be before
3761 or equal to PREV. In the loop, an overlay which ends at POS is
3762 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3763 we found an overlay which ends before PREV, the remaining
3764 overlays are in correct order. */
3767 XSETMISC (tem
, tail
);
3768 end
= OVERLAY_POSITION (OVERLAY_END (tem
));
3771 { /* This overlay is disordered. */
3772 struct Lisp_Overlay
*found
= tail
;
3774 /* Unlink the found overlay. */
3776 parent
->next
= tail
;
3777 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3778 and link it into the right place. */
3781 found
->next
= bp
->overlays_before
;
3782 set_buffer_overlays_before (bp
, found
);
3786 found
->next
= right_pair
->next
;
3787 right_pair
->next
= found
;
3790 else if (end
== prev
)
3795 else /* No more disordered overlay. */
3800 DEFUN ("overlayp", Foverlayp
, Soverlayp
, 1, 1, 0,
3801 doc
: /* Return t if OBJECT is an overlay. */)
3802 (Lisp_Object object
)
3804 return (OVERLAYP (object
) ? Qt
: Qnil
);
3807 DEFUN ("make-overlay", Fmake_overlay
, Smake_overlay
, 2, 5, 0,
3808 doc
: /* Create a new overlay with range BEG to END in BUFFER.
3809 If omitted, BUFFER defaults to the current buffer.
3810 BEG and END may be integers or markers.
3811 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3812 for the front of the overlay advance when text is inserted there
3813 \(which means the text *is not* included in the overlay).
3814 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3815 for the rear of the overlay advance when text is inserted there
3816 \(which means the text *is* included in the overlay). */)
3817 (Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
, Lisp_Object front_advance
, Lisp_Object rear_advance
)
3819 Lisp_Object overlay
;
3823 XSETBUFFER (buffer
, current_buffer
);
3825 CHECK_BUFFER (buffer
);
3827 && ! EQ (Fmarker_buffer (beg
), buffer
))
3828 error ("Marker points into wrong buffer");
3830 && ! EQ (Fmarker_buffer (end
), buffer
))
3831 error ("Marker points into wrong buffer");
3833 CHECK_NUMBER_COERCE_MARKER (beg
);
3834 CHECK_NUMBER_COERCE_MARKER (end
);
3836 if (XINT (beg
) > XINT (end
))
3839 temp
= beg
; beg
= end
; end
= temp
;
3842 b
= XBUFFER (buffer
);
3844 beg
= Fset_marker (Fmake_marker (), beg
, buffer
);
3845 end
= Fset_marker (Fmake_marker (), end
, buffer
);
3847 if (!NILP (front_advance
))
3848 XMARKER (beg
)->insertion_type
= 1;
3849 if (!NILP (rear_advance
))
3850 XMARKER (end
)->insertion_type
= 1;
3852 overlay
= build_overlay (beg
, end
, Qnil
);
3854 /* Put the new overlay on the wrong list. */
3855 end
= OVERLAY_END (overlay
);
3856 if (OVERLAY_POSITION (end
) < b
->overlay_center
)
3858 eassert (b
->overlays_after
|| (XOVERLAY (overlay
)->next
== NULL
));
3859 XOVERLAY (overlay
)->next
= b
->overlays_after
;
3860 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
3864 eassert (b
->overlays_before
|| (XOVERLAY (overlay
)->next
== NULL
));
3865 XOVERLAY (overlay
)->next
= b
->overlays_before
;
3866 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
3868 /* This puts it in the right list, and in the right order. */
3869 recenter_overlay_lists (b
, b
->overlay_center
);
3871 /* We don't need to redisplay the region covered by the overlay, because
3872 the overlay has no properties at the moment. */
3877 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3880 modify_overlay (struct buffer
*buf
, ptrdiff_t start
, ptrdiff_t end
)
3884 ptrdiff_t temp
= start
;
3889 BUF_COMPUTE_UNCHANGED (buf
, start
, end
);
3891 /* If this is a buffer not in the selected window,
3892 we must do other windows. */
3893 if (buf
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
3894 windows_or_buffers_changed
= 1;
3895 /* If multiple windows show this buffer, we must do other windows. */
3896 else if (buffer_shared
> 1)
3897 windows_or_buffers_changed
= 1;
3898 /* If we modify an overlay at the end of the buffer, we cannot
3899 be sure that window end is still valid. */
3900 else if (end
>= ZV
&& start
<= ZV
)
3901 windows_or_buffers_changed
= 1;
3903 ++BUF_OVERLAY_MODIFF (buf
);
3906 /* Remove OVERLAY from LIST. */
3908 static struct Lisp_Overlay
*
3909 unchain_overlay (struct Lisp_Overlay
*list
, struct Lisp_Overlay
*overlay
)
3911 register struct Lisp_Overlay
*tail
, **prev
= &list
;
3913 for (tail
= list
; tail
; prev
= &tail
->next
, tail
= *prev
)
3914 if (tail
== overlay
)
3916 *prev
= overlay
->next
;
3917 overlay
->next
= NULL
;
3923 /* Remove OVERLAY from both overlay lists of B. */
3926 unchain_both (struct buffer
*b
, Lisp_Object overlay
)
3928 struct Lisp_Overlay
*ov
= XOVERLAY (overlay
);
3930 set_buffer_overlays_before (b
, unchain_overlay (b
->overlays_before
, ov
));
3931 set_buffer_overlays_after (b
, unchain_overlay (b
->overlays_after
, ov
));
3932 eassert (XOVERLAY (overlay
)->next
== NULL
);
3935 DEFUN ("move-overlay", Fmove_overlay
, Smove_overlay
, 3, 4, 0,
3936 doc
: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3937 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3938 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3940 (Lisp_Object overlay
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
)
3942 struct buffer
*b
, *ob
= 0;
3943 Lisp_Object obuffer
;
3944 ptrdiff_t count
= SPECPDL_INDEX ();
3945 ptrdiff_t n_beg
, n_end
, o_beg
IF_LINT (= 0), o_end
IF_LINT (= 0);
3947 CHECK_OVERLAY (overlay
);
3949 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3951 XSETBUFFER (buffer
, current_buffer
);
3952 CHECK_BUFFER (buffer
);
3954 if (NILP (Fbuffer_live_p (buffer
)))
3955 error ("Attempt to move overlay to a dead buffer");
3958 && ! EQ (Fmarker_buffer (beg
), buffer
))
3959 error ("Marker points into wrong buffer");
3961 && ! EQ (Fmarker_buffer (end
), buffer
))
3962 error ("Marker points into wrong buffer");
3964 CHECK_NUMBER_COERCE_MARKER (beg
);
3965 CHECK_NUMBER_COERCE_MARKER (end
);
3967 if (XINT (beg
) > XINT (end
))
3970 temp
= beg
; beg
= end
; end
= temp
;
3973 specbind (Qinhibit_quit
, Qt
);
3975 obuffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3976 b
= XBUFFER (buffer
);
3978 if (!NILP (obuffer
))
3980 ob
= XBUFFER (obuffer
);
3982 o_beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3983 o_end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3985 unchain_both (ob
, overlay
);
3988 /* Set the overlay boundaries, which may clip them. */
3989 Fset_marker (OVERLAY_START (overlay
), beg
, buffer
);
3990 Fset_marker (OVERLAY_END (overlay
), end
, buffer
);
3992 n_beg
= marker_position (OVERLAY_START (overlay
));
3993 n_end
= marker_position (OVERLAY_END (overlay
));
3995 /* If the overlay has changed buffers, do a thorough redisplay. */
3996 if (!EQ (buffer
, obuffer
))
3998 /* Redisplay where the overlay was. */
4000 modify_overlay (ob
, o_beg
, o_end
);
4002 /* Redisplay where the overlay is going to be. */
4003 modify_overlay (b
, n_beg
, n_end
);
4006 /* Redisplay the area the overlay has just left, or just enclosed. */
4009 modify_overlay (b
, o_end
, n_end
);
4010 else if (o_end
== n_end
)
4011 modify_overlay (b
, o_beg
, n_beg
);
4013 modify_overlay (b
, min (o_beg
, n_beg
), max (o_end
, n_end
));
4016 /* Delete the overlay if it is empty after clipping and has the
4017 evaporate property. */
4018 if (n_beg
== n_end
&& !NILP (Foverlay_get (overlay
, Qevaporate
)))
4019 return unbind_to (count
, Fdelete_overlay (overlay
));
4021 /* Put the overlay into the new buffer's overlay lists, first on the
4023 if (n_end
< b
->overlay_center
)
4025 XOVERLAY (overlay
)->next
= b
->overlays_after
;
4026 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
4030 XOVERLAY (overlay
)->next
= b
->overlays_before
;
4031 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
4034 /* This puts it in the right list, and in the right order. */
4035 recenter_overlay_lists (b
, b
->overlay_center
);
4037 return unbind_to (count
, overlay
);
4040 DEFUN ("delete-overlay", Fdelete_overlay
, Sdelete_overlay
, 1, 1, 0,
4041 doc
: /* Delete the overlay OVERLAY from its buffer. */)
4042 (Lisp_Object overlay
)
4046 ptrdiff_t count
= SPECPDL_INDEX ();
4048 CHECK_OVERLAY (overlay
);
4050 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4054 b
= XBUFFER (buffer
);
4055 specbind (Qinhibit_quit
, Qt
);
4057 unchain_both (b
, overlay
);
4058 drop_overlay (b
, XOVERLAY (overlay
));
4060 /* When deleting an overlay with before or after strings, turn off
4061 display optimizations for the affected buffer, on the basis that
4062 these strings may contain newlines. This is easier to do than to
4063 check for that situation during redisplay. */
4064 if (!windows_or_buffers_changed
4065 && (!NILP (Foverlay_get (overlay
, Qbefore_string
))
4066 || !NILP (Foverlay_get (overlay
, Qafter_string
))))
4067 b
->prevent_redisplay_optimizations_p
= 1;
4069 return unbind_to (count
, Qnil
);
4072 DEFUN ("delete-all-overlays", Fdelete_all_overlays
, Sdelete_all_overlays
, 0, 1, 0,
4073 doc
: /* Delete all overlays of BUFFER.
4074 BUFFER omitted or nil means delete all overlays of the current
4076 (Lisp_Object buffer
)
4078 register struct buffer
*buf
;
4081 buf
= current_buffer
;
4084 CHECK_BUFFER (buffer
);
4085 buf
= XBUFFER (buffer
);
4088 delete_all_overlays (buf
);
4092 /* Overlay dissection functions. */
4094 DEFUN ("overlay-start", Foverlay_start
, Soverlay_start
, 1, 1, 0,
4095 doc
: /* Return the position at which OVERLAY starts. */)
4096 (Lisp_Object overlay
)
4098 CHECK_OVERLAY (overlay
);
4100 return (Fmarker_position (OVERLAY_START (overlay
)));
4103 DEFUN ("overlay-end", Foverlay_end
, Soverlay_end
, 1, 1, 0,
4104 doc
: /* Return the position at which OVERLAY ends. */)
4105 (Lisp_Object overlay
)
4107 CHECK_OVERLAY (overlay
);
4109 return (Fmarker_position (OVERLAY_END (overlay
)));
4112 DEFUN ("overlay-buffer", Foverlay_buffer
, Soverlay_buffer
, 1, 1, 0,
4113 doc
: /* Return the buffer OVERLAY belongs to.
4114 Return nil if OVERLAY has been deleted. */)
4115 (Lisp_Object overlay
)
4117 CHECK_OVERLAY (overlay
);
4119 return Fmarker_buffer (OVERLAY_START (overlay
));
4122 DEFUN ("overlay-properties", Foverlay_properties
, Soverlay_properties
, 1, 1, 0,
4123 doc
: /* Return a list of the properties on OVERLAY.
4124 This is a copy of OVERLAY's plist; modifying its conses has no effect on
4126 (Lisp_Object overlay
)
4128 CHECK_OVERLAY (overlay
);
4130 return Fcopy_sequence (XOVERLAY (overlay
)->plist
);
4134 DEFUN ("overlays-at", Foverlays_at
, Soverlays_at
, 1, 1, 0,
4135 doc
: /* Return a list of the overlays that contain the character at POS. */)
4138 ptrdiff_t len
, noverlays
;
4139 Lisp_Object
*overlay_vec
;
4142 CHECK_NUMBER_COERCE_MARKER (pos
);
4145 /* We can't use alloca here because overlays_at can call xrealloc. */
4146 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4148 /* Put all the overlays we want in a vector in overlay_vec.
4149 Store the length in len. */
4150 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4153 /* Make a list of them all. */
4154 result
= Flist (noverlays
, overlay_vec
);
4156 xfree (overlay_vec
);
4160 DEFUN ("overlays-in", Foverlays_in
, Soverlays_in
, 2, 2, 0,
4161 doc
: /* Return a list of the overlays that overlap the region BEG ... END.
4162 Overlap means that at least one character is contained within the overlay
4163 and also contained within the specified region.
4164 Empty overlays are included in the result if they are located at BEG,
4165 between BEG and END, or at END provided END denotes the position at the
4166 end of the buffer. */)
4167 (Lisp_Object beg
, Lisp_Object end
)
4169 ptrdiff_t len
, noverlays
;
4170 Lisp_Object
*overlay_vec
;
4173 CHECK_NUMBER_COERCE_MARKER (beg
);
4174 CHECK_NUMBER_COERCE_MARKER (end
);
4177 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4179 /* Put all the overlays we want in a vector in overlay_vec.
4180 Store the length in len. */
4181 noverlays
= overlays_in (XINT (beg
), XINT (end
), 1, &overlay_vec
, &len
,
4184 /* Make a list of them all. */
4185 result
= Flist (noverlays
, overlay_vec
);
4187 xfree (overlay_vec
);
4191 DEFUN ("next-overlay-change", Fnext_overlay_change
, Snext_overlay_change
,
4193 doc
: /* Return the next position after POS where an overlay starts or ends.
4194 If there are no overlay boundaries from POS to (point-max),
4195 the value is (point-max). */)
4198 ptrdiff_t i
, len
, noverlays
;
4200 Lisp_Object
*overlay_vec
;
4202 CHECK_NUMBER_COERCE_MARKER (pos
);
4205 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4207 /* Put all the overlays we want in a vector in overlay_vec.
4208 Store the length in len.
4209 endpos gets the position where the next overlay starts. */
4210 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4213 /* If any of these overlays ends before endpos,
4214 use its ending point instead. */
4215 for (i
= 0; i
< noverlays
; i
++)
4220 oend
= OVERLAY_END (overlay_vec
[i
]);
4221 oendpos
= OVERLAY_POSITION (oend
);
4222 if (oendpos
< endpos
)
4226 xfree (overlay_vec
);
4227 return make_number (endpos
);
4230 DEFUN ("previous-overlay-change", Fprevious_overlay_change
,
4231 Sprevious_overlay_change
, 1, 1, 0,
4232 doc
: /* Return the previous position before POS where an overlay starts or ends.
4233 If there are no overlay boundaries from (point-min) to POS,
4234 the value is (point-min). */)
4238 Lisp_Object
*overlay_vec
;
4241 CHECK_NUMBER_COERCE_MARKER (pos
);
4243 /* At beginning of buffer, we know the answer;
4244 avoid bug subtracting 1 below. */
4245 if (XINT (pos
) == BEGV
)
4249 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4251 /* Put all the overlays we want in a vector in overlay_vec.
4252 Store the length in len.
4253 prevpos gets the position of the previous change. */
4254 overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4257 xfree (overlay_vec
);
4258 return make_number (prevpos
);
4261 /* These functions are for debugging overlays. */
4263 DEFUN ("overlay-lists", Foverlay_lists
, Soverlay_lists
, 0, 0, 0,
4264 doc
: /* Return a pair of lists giving all the overlays of the current buffer.
4265 The car has all the overlays before the overlay center;
4266 the cdr has all the overlays after the overlay center.
4267 Recentering overlays moves overlays between these lists.
4268 The lists you get are copies, so that changing them has no effect.
4269 However, the overlays you get are the real objects that the buffer uses. */)
4272 struct Lisp_Overlay
*ol
;
4273 Lisp_Object before
= Qnil
, after
= Qnil
, tmp
;
4275 for (ol
= current_buffer
->overlays_before
; ol
; ol
= ol
->next
)
4278 before
= Fcons (tmp
, before
);
4280 for (ol
= current_buffer
->overlays_after
; ol
; ol
= ol
->next
)
4283 after
= Fcons (tmp
, after
);
4286 return Fcons (Fnreverse (before
), Fnreverse (after
));
4289 DEFUN ("overlay-recenter", Foverlay_recenter
, Soverlay_recenter
, 1, 1, 0,
4290 doc
: /* Recenter the overlays of the current buffer around position POS.
4291 That makes overlay lookup faster for positions near POS (but perhaps slower
4292 for positions far away from POS). */)
4296 CHECK_NUMBER_COERCE_MARKER (pos
);
4298 p
= clip_to_bounds (PTRDIFF_MIN
, XINT (pos
), PTRDIFF_MAX
);
4299 recenter_overlay_lists (current_buffer
, p
);
4303 DEFUN ("overlay-get", Foverlay_get
, Soverlay_get
, 2, 2, 0,
4304 doc
: /* Get the property of overlay OVERLAY with property name PROP. */)
4305 (Lisp_Object overlay
, Lisp_Object prop
)
4307 CHECK_OVERLAY (overlay
);
4308 return lookup_char_property (XOVERLAY (overlay
)->plist
, prop
, 0);
4311 DEFUN ("overlay-put", Foverlay_put
, Soverlay_put
, 3, 3, 0,
4312 doc
: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4313 VALUE will be returned.*/)
4314 (Lisp_Object overlay
, Lisp_Object prop
, Lisp_Object value
)
4316 Lisp_Object tail
, buffer
;
4319 CHECK_OVERLAY (overlay
);
4321 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4323 for (tail
= XOVERLAY (overlay
)->plist
;
4324 CONSP (tail
) && CONSP (XCDR (tail
));
4325 tail
= XCDR (XCDR (tail
)))
4326 if (EQ (XCAR (tail
), prop
))
4328 changed
= !EQ (XCAR (XCDR (tail
)), value
);
4329 XSETCAR (XCDR (tail
), value
);
4332 /* It wasn't in the list, so add it to the front. */
4333 changed
= !NILP (value
);
4335 (overlay
, Fcons (prop
, Fcons (value
, XOVERLAY (overlay
)->plist
)));
4337 if (! NILP (buffer
))
4340 modify_overlay (XBUFFER (buffer
),
4341 marker_position (OVERLAY_START (overlay
)),
4342 marker_position (OVERLAY_END (overlay
)));
4343 if (EQ (prop
, Qevaporate
) && ! NILP (value
)
4344 && (OVERLAY_POSITION (OVERLAY_START (overlay
))
4345 == OVERLAY_POSITION (OVERLAY_END (overlay
))))
4346 Fdelete_overlay (overlay
);
4352 /* Subroutine of report_overlay_modification. */
4354 /* Lisp vector holding overlay hook functions to call.
4355 Vector elements come in pairs.
4356 Each even-index element is a list of hook functions.
4357 The following odd-index element is the overlay they came from.
4359 Before the buffer change, we fill in this vector
4360 as we call overlay hook functions.
4361 After the buffer change, we get the functions to call from this vector.
4362 This way we always call the same functions before and after the change. */
4363 static Lisp_Object last_overlay_modification_hooks
;
4365 /* Number of elements actually used in last_overlay_modification_hooks. */
4366 static ptrdiff_t last_overlay_modification_hooks_used
;
4368 /* Add one functionlist/overlay pair
4369 to the end of last_overlay_modification_hooks. */
4372 add_overlay_mod_hooklist (Lisp_Object functionlist
, Lisp_Object overlay
)
4374 ptrdiff_t oldsize
= ASIZE (last_overlay_modification_hooks
);
4376 if (oldsize
- 1 <= last_overlay_modification_hooks_used
)
4377 last_overlay_modification_hooks
=
4378 larger_vector (last_overlay_modification_hooks
, 2, -1);
4379 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4380 functionlist
); last_overlay_modification_hooks_used
++;
4381 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4382 overlay
); last_overlay_modification_hooks_used
++;
4385 /* Run the modification-hooks of overlays that include
4386 any part of the text in START to END.
4387 If this change is an insertion, also
4388 run the insert-before-hooks of overlay starting at END,
4389 and the insert-after-hooks of overlay ending at START.
4391 This is called both before and after the modification.
4392 AFTER is true when we call after the modification.
4394 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4395 When AFTER is nonzero, they are the start position,
4396 the position after the inserted new text,
4397 and the length of deleted or replaced old text. */
4400 report_overlay_modification (Lisp_Object start
, Lisp_Object end
, bool after
,
4401 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4403 Lisp_Object prop
, overlay
;
4404 struct Lisp_Overlay
*tail
;
4405 /* True if this change is an insertion. */
4406 bool insertion
= (after
? XFASTINT (arg3
) == 0 : EQ (start
, end
));
4407 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4412 /* We used to run the functions as soon as we found them and only register
4413 them in last_overlay_modification_hooks for the purpose of the `after'
4414 case. But running elisp code as we traverse the list of overlays is
4415 painful because the list can be modified by the elisp code so we had to
4416 copy at several places. We now simply do a read-only traversal that
4417 only collects the functions to run and we run them afterwards. It's
4418 simpler, especially since all the code was already there. -stef */
4422 /* We are being called before a change.
4423 Scan the overlays to find the functions to call. */
4424 last_overlay_modification_hooks_used
= 0;
4425 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4427 ptrdiff_t startpos
, endpos
;
4428 Lisp_Object ostart
, oend
;
4430 XSETMISC (overlay
, tail
);
4432 ostart
= OVERLAY_START (overlay
);
4433 oend
= OVERLAY_END (overlay
);
4434 endpos
= OVERLAY_POSITION (oend
);
4435 if (XFASTINT (start
) > endpos
)
4437 startpos
= OVERLAY_POSITION (ostart
);
4438 if (insertion
&& (XFASTINT (start
) == startpos
4439 || XFASTINT (end
) == startpos
))
4441 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4443 add_overlay_mod_hooklist (prop
, overlay
);
4445 if (insertion
&& (XFASTINT (start
) == endpos
4446 || XFASTINT (end
) == endpos
))
4448 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4450 add_overlay_mod_hooklist (prop
, overlay
);
4452 /* Test for intersecting intervals. This does the right thing
4453 for both insertion and deletion. */
4454 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4456 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4458 add_overlay_mod_hooklist (prop
, overlay
);
4462 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4464 ptrdiff_t startpos
, endpos
;
4465 Lisp_Object ostart
, oend
;
4467 XSETMISC (overlay
, tail
);
4469 ostart
= OVERLAY_START (overlay
);
4470 oend
= OVERLAY_END (overlay
);
4471 startpos
= OVERLAY_POSITION (ostart
);
4472 endpos
= OVERLAY_POSITION (oend
);
4473 if (XFASTINT (end
) < startpos
)
4475 if (insertion
&& (XFASTINT (start
) == startpos
4476 || XFASTINT (end
) == startpos
))
4478 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4480 add_overlay_mod_hooklist (prop
, overlay
);
4482 if (insertion
&& (XFASTINT (start
) == endpos
4483 || XFASTINT (end
) == endpos
))
4485 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4487 add_overlay_mod_hooklist (prop
, overlay
);
4489 /* Test for intersecting intervals. This does the right thing
4490 for both insertion and deletion. */
4491 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4493 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4495 add_overlay_mod_hooklist (prop
, overlay
);
4500 GCPRO4 (overlay
, arg1
, arg2
, arg3
);
4502 /* Call the functions recorded in last_overlay_modification_hooks.
4503 First copy the vector contents, in case some of these hooks
4504 do subsequent modification of the buffer. */
4505 ptrdiff_t size
= last_overlay_modification_hooks_used
;
4506 Lisp_Object
*copy
= alloca (size
* sizeof *copy
);
4509 memcpy (copy
, XVECTOR (last_overlay_modification_hooks
)->contents
,
4512 gcpro1
.nvars
= size
;
4514 for (i
= 0; i
< size
;)
4516 Lisp_Object prop_i
, overlay_i
;
4518 overlay_i
= copy
[i
++];
4519 call_overlay_mod_hooks (prop_i
, overlay_i
, after
, arg1
, arg2
, arg3
);
4526 call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
, bool after
,
4527 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4529 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4531 GCPRO4 (list
, arg1
, arg2
, arg3
);
4533 while (CONSP (list
))
4536 call4 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
);
4538 call5 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
, arg3
);
4544 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4547 evaporate_overlays (ptrdiff_t pos
)
4549 Lisp_Object overlay
, hit_list
;
4550 struct Lisp_Overlay
*tail
;
4553 if (pos
<= current_buffer
->overlay_center
)
4554 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4557 XSETMISC (overlay
, tail
);
4558 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4561 if (endpos
== pos
&& OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
4562 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4563 hit_list
= Fcons (overlay
, hit_list
);
4566 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4569 XSETMISC (overlay
, tail
);
4570 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4573 if (startpos
== pos
&& OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
4574 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4575 hit_list
= Fcons (overlay
, hit_list
);
4577 for (; CONSP (hit_list
); hit_list
= XCDR (hit_list
))
4578 Fdelete_overlay (XCAR (hit_list
));
4581 /* Somebody has tried to store a value with an unacceptable type
4582 in the slot with offset OFFSET. */
4585 buffer_slot_type_mismatch (Lisp_Object newval
, int type
)
4587 Lisp_Object predicate
;
4591 case_Lisp_Int
: predicate
= Qintegerp
; break;
4592 case Lisp_String
: predicate
= Qstringp
; break;
4593 case Lisp_Symbol
: predicate
= Qsymbolp
; break;
4594 default: emacs_abort ();
4597 wrong_type_argument (predicate
, newval
);
4601 /***********************************************************************
4602 Allocation with mmap
4603 ***********************************************************************/
4605 #ifdef USE_MMAP_FOR_BUFFERS
4607 #include <sys/types.h>
4608 #include <sys/mman.h>
4611 #ifdef MAP_ANONYMOUS
4612 #define MAP_ANON MAP_ANONYMOUS
4619 #define MAP_FAILED ((void *) -1)
4631 /* Memory is allocated in regions which are mapped using mmap(2).
4632 The current implementation lets the system select mapped
4633 addresses; we're not using MAP_FIXED in general, except when
4634 trying to enlarge regions.
4636 Each mapped region starts with a mmap_region structure, the user
4637 area starts after that structure, aligned to MEM_ALIGN.
4639 +-----------------------+
4640 | struct mmap_info + |
4642 +-----------------------+
4646 +-----------------------+ */
4650 /* User-specified size. */
4651 size_t nbytes_specified
;
4653 /* Number of bytes mapped */
4654 size_t nbytes_mapped
;
4656 /* Pointer to the location holding the address of the memory
4657 allocated with the mmap'd block. The variable actually points
4658 after this structure. */
4661 /* Next and previous in list of all mmap'd regions. */
4662 struct mmap_region
*next
, *prev
;
4665 /* Doubly-linked list of mmap'd regions. */
4667 static struct mmap_region
*mmap_regions
;
4669 /* File descriptor for mmap. If we don't have anonymous mapping,
4670 /dev/zero will be opened on it. */
4674 /* Temporary storage for mmap_set_vars, see there. */
4676 static struct mmap_region
*mmap_regions_1
;
4677 static int mmap_fd_1
;
4679 /* Page size on this system. */
4681 static int mmap_page_size
;
4683 /* 1 means mmap has been initialized. */
4685 static bool mmap_initialized_p
;
4687 /* Value is X rounded up to the next multiple of N. */
4689 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4691 /* Size of mmap_region structure plus padding. */
4693 #define MMAP_REGION_STRUCT_SIZE \
4694 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4696 /* Given a pointer P to the start of the user-visible part of a mapped
4697 region, return a pointer to the start of the region. */
4699 #define MMAP_REGION(P) \
4700 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4702 /* Given a pointer P to the start of a mapped region, return a pointer
4703 to the start of the user-visible part of the region. */
4705 #define MMAP_USER_AREA(P) \
4706 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4708 #define MEM_ALIGN sizeof (double)
4710 /* Predicate returning true if part of the address range [START .. END]
4711 is currently mapped. Used to prevent overwriting an existing
4714 Default is to conservatively assume the address range is occupied by
4715 something else. This can be overridden by system configuration
4716 files if system-specific means to determine this exists. */
4718 #ifndef MMAP_ALLOCATED_P
4719 #define MMAP_ALLOCATED_P(start, end) 1
4722 /* Perform necessary initializations for the use of mmap. */
4728 /* The value of mmap_fd is initially 0 in temacs, and -1
4729 in a dumped Emacs. */
4732 /* No anonymous mmap -- we need the file descriptor. */
4733 mmap_fd
= open ("/dev/zero", O_RDONLY
);
4735 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno
));
4737 #endif /* MAP_ANON == 0 */
4739 if (mmap_initialized_p
)
4741 mmap_initialized_p
= 1;
4747 mmap_page_size
= getpagesize ();
4750 /* Return a region overlapping address range START...END, or null if
4751 none. END is not including, i.e. the last byte in the range
4754 static struct mmap_region
*
4755 mmap_find (void *start
, void *end
)
4757 struct mmap_region
*r
;
4758 char *s
= (char *) start
, *e
= (char *) end
;
4760 for (r
= mmap_regions
; r
; r
= r
->next
)
4762 char *rstart
= (char *) r
;
4763 char *rend
= rstart
+ r
->nbytes_mapped
;
4765 if (/* First byte of range, i.e. START, in this region? */
4766 (s
>= rstart
&& s
< rend
)
4767 /* Last byte of range, i.e. END - 1, in this region? */
4768 || (e
> rstart
&& e
<= rend
)
4769 /* First byte of this region in the range? */
4770 || (rstart
>= s
&& rstart
< e
)
4771 /* Last byte of this region in the range? */
4772 || (rend
> s
&& rend
<= e
))
4780 /* Unmap a region. P is a pointer to the start of the user-araa of
4784 mmap_free_1 (struct mmap_region
*r
)
4787 r
->next
->prev
= r
->prev
;
4789 r
->prev
->next
= r
->next
;
4791 mmap_regions
= r
->next
;
4793 if (munmap (r
, r
->nbytes_mapped
) == -1)
4794 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4798 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4799 Value is true if successful. */
4802 mmap_enlarge (struct mmap_region
*r
, int npages
)
4804 char *region_end
= (char *) r
+ r
->nbytes_mapped
;
4810 /* Unmap pages at the end of the region. */
4811 nbytes
= - npages
* mmap_page_size
;
4812 if (munmap (region_end
- nbytes
, nbytes
) == -1)
4813 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4816 r
->nbytes_mapped
-= nbytes
;
4820 else if (npages
> 0)
4822 nbytes
= npages
* mmap_page_size
;
4824 /* Try to map additional pages at the end of the region. We
4825 cannot do this if the address range is already occupied by
4826 something else because mmap deletes any previous mapping.
4827 I'm not sure this is worth doing, let's see. */
4828 if (!MMAP_ALLOCATED_P (region_end
, region_end
+ nbytes
))
4832 p
= mmap (region_end
, nbytes
, PROT_READ
| PROT_WRITE
,
4833 MAP_ANON
| MAP_PRIVATE
| MAP_FIXED
, mmap_fd
, 0);
4834 if (p
== MAP_FAILED
)
4835 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4836 else if (p
!= region_end
)
4838 /* Kernels are free to choose a different address. In
4839 that case, unmap what we've mapped above; we have
4841 if (munmap (p
, nbytes
) == -1)
4842 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4846 r
->nbytes_mapped
+= nbytes
;
4856 /* Set or reset variables holding references to mapped regions.
4857 If not RESTORE_P, set all variables to null. If RESTORE_P, set all
4858 variables to the start of the user-areas of mapped regions.
4860 This function is called from Fdump_emacs to ensure that the dumped
4861 Emacs doesn't contain references to memory that won't be mapped
4862 when Emacs starts. */
4865 mmap_set_vars (bool restore_p
)
4867 struct mmap_region
*r
;
4871 mmap_regions
= mmap_regions_1
;
4872 mmap_fd
= mmap_fd_1
;
4873 for (r
= mmap_regions
; r
; r
= r
->next
)
4874 *r
->var
= MMAP_USER_AREA (r
);
4878 for (r
= mmap_regions
; r
; r
= r
->next
)
4880 mmap_regions_1
= mmap_regions
;
4881 mmap_regions
= NULL
;
4882 mmap_fd_1
= mmap_fd
;
4888 /* Allocate a block of storage large enough to hold NBYTES bytes of
4889 data. A pointer to the data is returned in *VAR. VAR is thus the
4890 address of some variable which will use the data area.
4892 The allocation of 0 bytes is valid.
4894 If we can't allocate the necessary memory, set *VAR to null, and
4898 mmap_alloc (void **var
, size_t nbytes
)
4905 map
= ROUND (nbytes
+ MMAP_REGION_STRUCT_SIZE
, mmap_page_size
);
4906 p
= mmap (NULL
, map
, PROT_READ
| PROT_WRITE
, MAP_ANON
| MAP_PRIVATE
,
4909 if (p
== MAP_FAILED
)
4911 if (errno
!= ENOMEM
)
4912 fprintf (stderr
, "mmap: %s\n", emacs_strerror (errno
));
4917 struct mmap_region
*r
= (struct mmap_region
*) p
;
4919 r
->nbytes_specified
= nbytes
;
4920 r
->nbytes_mapped
= map
;
4923 r
->next
= mmap_regions
;
4928 p
= MMAP_USER_AREA (p
);
4935 /* Free a block of relocatable storage whose data is pointed to by
4936 PTR. Store 0 in *PTR to show there's no block allocated. */
4939 mmap_free (void **var
)
4945 mmap_free_1 (MMAP_REGION (*var
));
4951 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4952 resize it to size NBYTES. Change *VAR to reflect the new block,
4953 and return this value. If more memory cannot be allocated, then
4954 leave *VAR unchanged, and return null. */
4957 mmap_realloc (void **var
, size_t nbytes
)
4964 result
= mmap_alloc (var
, nbytes
);
4965 else if (nbytes
== 0)
4968 result
= mmap_alloc (var
, nbytes
);
4972 struct mmap_region
*r
= MMAP_REGION (*var
);
4973 size_t room
= r
->nbytes_mapped
- MMAP_REGION_STRUCT_SIZE
;
4978 void *old_ptr
= *var
;
4980 /* Try to map additional pages at the end of the region.
4981 If that fails, allocate a new region, copy data
4982 from the old region, then free it. */
4983 if (mmap_enlarge (r
, (ROUND (nbytes
- room
, mmap_page_size
)
4986 r
->nbytes_specified
= nbytes
;
4987 *var
= result
= old_ptr
;
4989 else if (mmap_alloc (var
, nbytes
))
4991 memcpy (*var
, old_ptr
, r
->nbytes_specified
);
4992 mmap_free_1 (MMAP_REGION (old_ptr
));
4994 r
= MMAP_REGION (result
);
4995 r
->nbytes_specified
= nbytes
;
5003 else if (room
- nbytes
>= mmap_page_size
)
5005 /* Shrinking by at least a page. Let's give some
5006 memory back to the system.
5008 The extra parens are to make the division happens first,
5009 on positive values, so we know it will round towards
5011 mmap_enlarge (r
, - ((room
- nbytes
) / mmap_page_size
));
5013 r
->nbytes_specified
= nbytes
;
5017 /* Leave it alone. */
5019 r
->nbytes_specified
= nbytes
;
5027 #endif /* USE_MMAP_FOR_BUFFERS */
5031 /***********************************************************************
5032 Buffer-text Allocation
5033 ***********************************************************************/
5035 /* Allocate NBYTES bytes for buffer B's text buffer. */
5038 alloc_buffer_text (struct buffer
*b
, ptrdiff_t nbytes
)
5043 #if defined USE_MMAP_FOR_BUFFERS
5044 p
= mmap_alloc ((void **) &b
->text
->beg
, nbytes
);
5045 #elif defined REL_ALLOC
5046 p
= r_alloc ((void **) &b
->text
->beg
, nbytes
);
5048 p
= xmalloc (nbytes
);
5054 memory_full (nbytes
);
5057 b
->text
->beg
= (unsigned char *) p
;
5061 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
5065 enlarge_buffer_text (struct buffer
*b
, ptrdiff_t delta
)
5068 ptrdiff_t nbytes
= (BUF_Z_BYTE (b
) - BUF_BEG_BYTE (b
) + BUF_GAP_SIZE (b
) + 1
5071 #if defined USE_MMAP_FOR_BUFFERS
5072 p
= mmap_realloc ((void **) &b
->text
->beg
, nbytes
);
5073 #elif defined REL_ALLOC
5074 p
= r_re_alloc ((void **) &b
->text
->beg
, nbytes
);
5076 p
= xrealloc (b
->text
->beg
, nbytes
);
5082 memory_full (nbytes
);
5085 BUF_BEG_ADDR (b
) = (unsigned char *) p
;
5090 /* Free buffer B's text buffer. */
5093 free_buffer_text (struct buffer
*b
)
5097 #if defined USE_MMAP_FOR_BUFFERS
5098 mmap_free ((void **) &b
->text
->beg
);
5099 #elif defined REL_ALLOC
5100 r_alloc_free ((void **) &b
->text
->beg
);
5102 xfree (b
->text
->beg
);
5105 BUF_BEG_ADDR (b
) = NULL
;
5111 /***********************************************************************
5113 ***********************************************************************/
5116 init_buffer_once (void)
5119 /* If you add, remove, or reorder Lisp_Objects in a struct buffer, make
5120 sure that this is still correct. Otherwise, mark_vectorlike may not
5121 trace all Lisp_Objects in buffer_defaults and buffer_local_symbols. */
5123 = (offsetof (struct buffer
, own_text
) - header_size
) / word_size
;
5125 memset (buffer_permanent_local_flags
, 0, sizeof buffer_permanent_local_flags
);
5127 /* Make sure all markable slots in buffer_defaults
5128 are initialized reasonably, so mark_buffer won't choke. */
5129 reset_buffer (&buffer_defaults
);
5130 eassert (EQ (BVAR (&buffer_defaults
, name
), make_number (0)));
5131 reset_buffer_local_variables (&buffer_defaults
, 1);
5132 eassert (EQ (BVAR (&buffer_local_symbols
, name
), make_number (0)));
5133 reset_buffer (&buffer_local_symbols
);
5134 reset_buffer_local_variables (&buffer_local_symbols
, 1);
5135 /* Prevent GC from getting confused. */
5136 buffer_defaults
.text
= &buffer_defaults
.own_text
;
5137 buffer_local_symbols
.text
= &buffer_local_symbols
.own_text
;
5138 /* No one will share the text with these buffers, but let's play it safe. */
5139 buffer_defaults
.indirections
= 0;
5140 buffer_local_symbols
.indirections
= 0;
5141 set_buffer_intervals (&buffer_defaults
, NULL
);
5142 set_buffer_intervals (&buffer_local_symbols
, NULL
);
5143 /* This is not strictly necessary, but let's make them initialized. */
5144 bset_name (&buffer_defaults
, build_pure_c_string (" *buffer-defaults*"));
5145 bset_name (&buffer_local_symbols
, build_pure_c_string (" *buffer-local-symbols*"));
5146 XSETPVECTYPESIZE (&buffer_defaults
, PVEC_BUFFER
, pvecsize
);
5147 XSETPVECTYPESIZE (&buffer_local_symbols
, PVEC_BUFFER
, pvecsize
);
5149 /* Set up the default values of various buffer slots. */
5150 /* Must do these before making the first buffer! */
5152 /* real setup is done in bindings.el */
5153 bset_mode_line_format (&buffer_defaults
, build_pure_c_string ("%-"));
5154 bset_header_line_format (&buffer_defaults
, Qnil
);
5155 bset_abbrev_mode (&buffer_defaults
, Qnil
);
5156 bset_overwrite_mode (&buffer_defaults
, Qnil
);
5157 bset_case_fold_search (&buffer_defaults
, Qt
);
5158 bset_auto_fill_function (&buffer_defaults
, Qnil
);
5159 bset_selective_display (&buffer_defaults
, Qnil
);
5160 bset_selective_display_ellipses (&buffer_defaults
, Qt
);
5161 bset_abbrev_table (&buffer_defaults
, Qnil
);
5162 bset_display_table (&buffer_defaults
, Qnil
);
5163 bset_undo_list (&buffer_defaults
, Qnil
);
5164 bset_mark_active (&buffer_defaults
, Qnil
);
5165 bset_file_format (&buffer_defaults
, Qnil
);
5166 bset_auto_save_file_format (&buffer_defaults
, Qt
);
5167 set_buffer_overlays_before (&buffer_defaults
, NULL
);
5168 set_buffer_overlays_after (&buffer_defaults
, NULL
);
5169 buffer_defaults
.overlay_center
= BEG
;
5171 XSETFASTINT (BVAR (&buffer_defaults
, tab_width
), 8);
5172 bset_truncate_lines (&buffer_defaults
, Qnil
);
5173 bset_word_wrap (&buffer_defaults
, Qnil
);
5174 bset_ctl_arrow (&buffer_defaults
, Qt
);
5175 bset_bidi_display_reordering (&buffer_defaults
, Qt
);
5176 bset_bidi_paragraph_direction (&buffer_defaults
, Qnil
);
5177 bset_cursor_type (&buffer_defaults
, Qt
);
5178 bset_extra_line_spacing (&buffer_defaults
, Qnil
);
5179 bset_cursor_in_non_selected_windows (&buffer_defaults
, Qt
);
5181 bset_enable_multibyte_characters (&buffer_defaults
, Qt
);
5182 bset_buffer_file_coding_system (&buffer_defaults
, Qnil
);
5183 XSETFASTINT (BVAR (&buffer_defaults
, fill_column
), 70);
5184 XSETFASTINT (BVAR (&buffer_defaults
, left_margin
), 0);
5185 bset_cache_long_line_scans (&buffer_defaults
, Qnil
);
5186 bset_file_truename (&buffer_defaults
, Qnil
);
5187 XSETFASTINT (BVAR (&buffer_defaults
, display_count
), 0);
5188 XSETFASTINT (BVAR (&buffer_defaults
, left_margin_cols
), 0);
5189 XSETFASTINT (BVAR (&buffer_defaults
, right_margin_cols
), 0);
5190 bset_left_fringe_width (&buffer_defaults
, Qnil
);
5191 bset_right_fringe_width (&buffer_defaults
, Qnil
);
5192 bset_fringes_outside_margins (&buffer_defaults
, Qnil
);
5193 bset_scroll_bar_width (&buffer_defaults
, Qnil
);
5194 bset_vertical_scroll_bar_type (&buffer_defaults
, Qt
);
5195 bset_indicate_empty_lines (&buffer_defaults
, Qnil
);
5196 bset_indicate_buffer_boundaries (&buffer_defaults
, Qnil
);
5197 bset_fringe_indicator_alist (&buffer_defaults
, Qnil
);
5198 bset_fringe_cursor_alist (&buffer_defaults
, Qnil
);
5199 bset_scroll_up_aggressively (&buffer_defaults
, Qnil
);
5200 bset_scroll_down_aggressively (&buffer_defaults
, Qnil
);
5201 bset_display_time (&buffer_defaults
, Qnil
);
5203 /* Assign the local-flags to the slots that have default values.
5204 The local flag is a bit that is used in the buffer
5205 to say that it has its own local value for the slot.
5206 The local flag bits are in the local_var_flags slot of the buffer. */
5208 /* Nothing can work if this isn't true */
5209 { verify (sizeof (EMACS_INT
) == word_size
); }
5211 /* 0 means not a lisp var, -1 means always local, else mask */
5212 memset (&buffer_local_flags
, 0, sizeof buffer_local_flags
);
5213 bset_filename (&buffer_local_flags
, make_number (-1));
5214 bset_directory (&buffer_local_flags
, make_number (-1));
5215 bset_backed_up (&buffer_local_flags
, make_number (-1));
5216 bset_save_length (&buffer_local_flags
, make_number (-1));
5217 bset_auto_save_file_name (&buffer_local_flags
, make_number (-1));
5218 bset_read_only (&buffer_local_flags
, make_number (-1));
5219 bset_major_mode (&buffer_local_flags
, make_number (-1));
5220 bset_mode_name (&buffer_local_flags
, make_number (-1));
5221 bset_undo_list (&buffer_local_flags
, make_number (-1));
5222 bset_mark_active (&buffer_local_flags
, make_number (-1));
5223 bset_point_before_scroll (&buffer_local_flags
, make_number (-1));
5224 bset_file_truename (&buffer_local_flags
, make_number (-1));
5225 bset_invisibility_spec (&buffer_local_flags
, make_number (-1));
5226 bset_file_format (&buffer_local_flags
, make_number (-1));
5227 bset_auto_save_file_format (&buffer_local_flags
, make_number (-1));
5228 bset_display_count (&buffer_local_flags
, make_number (-1));
5229 bset_display_time (&buffer_local_flags
, make_number (-1));
5230 bset_enable_multibyte_characters (&buffer_local_flags
, make_number (-1));
5233 XSETFASTINT (BVAR (&buffer_local_flags
, mode_line_format
), idx
); ++idx
;
5234 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_mode
), idx
); ++idx
;
5235 XSETFASTINT (BVAR (&buffer_local_flags
, overwrite_mode
), idx
); ++idx
;
5236 XSETFASTINT (BVAR (&buffer_local_flags
, case_fold_search
), idx
); ++idx
;
5237 XSETFASTINT (BVAR (&buffer_local_flags
, auto_fill_function
), idx
); ++idx
;
5238 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display
), idx
); ++idx
;
5239 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display_ellipses
), idx
); ++idx
;
5240 XSETFASTINT (BVAR (&buffer_local_flags
, tab_width
), idx
); ++idx
;
5241 XSETFASTINT (BVAR (&buffer_local_flags
, truncate_lines
), idx
); ++idx
;
5242 XSETFASTINT (BVAR (&buffer_local_flags
, word_wrap
), idx
); ++idx
;
5243 XSETFASTINT (BVAR (&buffer_local_flags
, ctl_arrow
), idx
); ++idx
;
5244 XSETFASTINT (BVAR (&buffer_local_flags
, fill_column
), idx
); ++idx
;
5245 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin
), idx
); ++idx
;
5246 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_table
), idx
); ++idx
;
5247 XSETFASTINT (BVAR (&buffer_local_flags
, display_table
), idx
); ++idx
;
5248 XSETFASTINT (BVAR (&buffer_local_flags
, syntax_table
), idx
); ++idx
;
5249 XSETFASTINT (BVAR (&buffer_local_flags
, cache_long_line_scans
), idx
); ++idx
;
5250 XSETFASTINT (BVAR (&buffer_local_flags
, category_table
), idx
); ++idx
;
5251 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_display_reordering
), idx
); ++idx
;
5252 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_paragraph_direction
), idx
); ++idx
;
5253 XSETFASTINT (BVAR (&buffer_local_flags
, buffer_file_coding_system
), idx
);
5254 /* Make this one a permanent local. */
5255 buffer_permanent_local_flags
[idx
++] = 1;
5256 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin_cols
), idx
); ++idx
;
5257 XSETFASTINT (BVAR (&buffer_local_flags
, right_margin_cols
), idx
); ++idx
;
5258 XSETFASTINT (BVAR (&buffer_local_flags
, left_fringe_width
), idx
); ++idx
;
5259 XSETFASTINT (BVAR (&buffer_local_flags
, right_fringe_width
), idx
); ++idx
;
5260 XSETFASTINT (BVAR (&buffer_local_flags
, fringes_outside_margins
), idx
); ++idx
;
5261 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_bar_width
), idx
); ++idx
;
5262 XSETFASTINT (BVAR (&buffer_local_flags
, vertical_scroll_bar_type
), idx
); ++idx
;
5263 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_empty_lines
), idx
); ++idx
;
5264 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_buffer_boundaries
), idx
); ++idx
;
5265 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_indicator_alist
), idx
); ++idx
;
5266 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_cursor_alist
), idx
); ++idx
;
5267 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_up_aggressively
), idx
); ++idx
;
5268 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_down_aggressively
), idx
); ++idx
;
5269 XSETFASTINT (BVAR (&buffer_local_flags
, header_line_format
), idx
); ++idx
;
5270 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_type
), idx
); ++idx
;
5271 XSETFASTINT (BVAR (&buffer_local_flags
, extra_line_spacing
), idx
); ++idx
;
5272 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_in_non_selected_windows
), idx
); ++idx
;
5274 /* Need more room? */
5275 if (idx
>= MAX_PER_BUFFER_VARS
)
5277 last_per_buffer_idx
= idx
;
5279 Vbuffer_alist
= Qnil
;
5283 QSFundamental
= build_pure_c_string ("Fundamental");
5285 Qfundamental_mode
= intern_c_string ("fundamental-mode");
5286 bset_major_mode (&buffer_defaults
, Qfundamental_mode
);
5288 Qmode_class
= intern_c_string ("mode-class");
5290 Qprotected_field
= intern_c_string ("protected-field");
5292 Qpermanent_local
= intern_c_string ("permanent-local");
5294 Qkill_buffer_hook
= intern_c_string ("kill-buffer-hook");
5295 Fput (Qkill_buffer_hook
, Qpermanent_local
, Qt
);
5297 /* super-magic invisible buffer */
5298 Vprin1_to_string_buffer
= Fget_buffer_create (build_pure_c_string (" prin1"));
5299 Vbuffer_alist
= Qnil
;
5301 Fset_buffer (Fget_buffer_create (build_pure_c_string ("*scratch*")));
5303 inhibit_modification_hooks
= 0;
5313 #ifdef USE_MMAP_FOR_BUFFERS
5315 /* When using the ralloc implementation based on mmap(2), buffer
5316 text pointers will have been set to null in the dumped Emacs.
5321 if (b
->text
->beg
== NULL
)
5322 enlarge_buffer_text (b
, 0);
5324 #endif /* USE_MMAP_FOR_BUFFERS */
5326 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5327 if (NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5328 Fset_buffer_multibyte (Qnil
);
5330 pwd
= get_current_dir_name ();
5333 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5335 /* Maybe this should really use some standard subroutine
5336 whose definition is filename syntax dependent. */
5338 if (!(IS_DIRECTORY_SEP (pwd
[len
- 1])))
5340 /* Grow buffer to add directory separator and '\0'. */
5341 pwd
= realloc (pwd
, len
+ 2);
5343 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5344 pwd
[len
] = DIRECTORY_SEP
;
5345 pwd
[len
+ 1] = '\0';
5349 bset_directory (current_buffer
, make_unibyte_string (pwd
, len
));
5350 if (! NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5351 /* At this moment, we still don't know how to decode the
5352 directory name. So, we keep the bytes in multibyte form so
5353 that ENCODE_FILE correctly gets the original bytes. */
5355 (current_buffer
, string_to_multibyte (BVAR (current_buffer
, directory
)));
5357 /* Add /: to the front of the name
5358 if it would otherwise be treated as magic. */
5359 temp
= Ffind_file_name_handler (BVAR (current_buffer
, directory
), Qt
);
5361 /* If the default dir is just /, TEMP is non-nil
5362 because of the ange-ftp completion handler.
5363 However, it is not necessary to turn / into /:/.
5364 So avoid doing that. */
5365 && strcmp ("/", SSDATA (BVAR (current_buffer
, directory
))))
5368 concat2 (build_string ("/:"), BVAR (current_buffer
, directory
)));
5370 temp
= get_minibuffer (0);
5371 bset_directory (XBUFFER (temp
), BVAR (current_buffer
, directory
));
5376 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5377 Object stored in the current buffer. address is the address of the slot
5378 in the buffer that is current now. */
5380 /* TYPE is nil for a general Lisp variable.
5381 An integer specifies a type; then only Lisp values
5382 with that type code are allowed (except that nil is allowed too).
5383 LNAME is the Lisp-level variable name.
5384 VNAME is the name of the buffer slot.
5385 DOC is a dummy where you write the doc string as a comment. */
5386 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5388 static struct Lisp_Buffer_Objfwd bo_fwd; \
5389 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5393 defvar_per_buffer (struct Lisp_Buffer_Objfwd
*bo_fwd
, const char *namestring
,
5394 Lisp_Object
*address
, Lisp_Object type
)
5396 struct Lisp_Symbol
*sym
;
5399 sym
= XSYMBOL (intern (namestring
));
5400 offset
= (char *)address
- (char *)current_buffer
;
5402 bo_fwd
->type
= Lisp_Fwd_Buffer_Obj
;
5403 bo_fwd
->offset
= offset
;
5404 bo_fwd
->slottype
= type
;
5405 sym
->declared_special
= 1;
5406 sym
->redirect
= SYMBOL_FORWARDED
;
5408 /* I tried to do the job without a cast, but it seems impossible.
5409 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5410 SET_SYMBOL_FWD (sym
, (union Lisp_Fwd
*)bo_fwd
);
5412 XSETSYMBOL (PER_BUFFER_SYMBOL (offset
), sym
);
5414 if (PER_BUFFER_IDX (offset
) == 0)
5415 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5416 slot of buffer_local_flags */
5421 /* initialize the buffer routines */
5423 syms_of_buffer (void)
5425 staticpro (&last_overlay_modification_hooks
);
5426 last_overlay_modification_hooks
5427 = Fmake_vector (make_number (10), Qnil
);
5429 staticpro (&Qfundamental_mode
);
5430 staticpro (&Qmode_class
);
5431 staticpro (&QSFundamental
);
5432 staticpro (&Vbuffer_alist
);
5433 staticpro (&Qprotected_field
);
5434 staticpro (&Qpermanent_local
);
5435 staticpro (&Qkill_buffer_hook
);
5437 DEFSYM (Qpermanent_local_hook
, "permanent-local-hook");
5438 DEFSYM (Qoverlayp
, "overlayp");
5439 DEFSYM (Qevaporate
, "evaporate");
5440 DEFSYM (Qmodification_hooks
, "modification-hooks");
5441 DEFSYM (Qinsert_in_front_hooks
, "insert-in-front-hooks");
5442 DEFSYM (Qinsert_behind_hooks
, "insert-behind-hooks");
5443 DEFSYM (Qget_file_buffer
, "get-file-buffer");
5444 DEFSYM (Qpriority
, "priority");
5445 DEFSYM (Qbefore_string
, "before-string");
5446 DEFSYM (Qafter_string
, "after-string");
5447 DEFSYM (Qfirst_change_hook
, "first-change-hook");
5448 DEFSYM (Qbefore_change_functions
, "before-change-functions");
5449 DEFSYM (Qafter_change_functions
, "after-change-functions");
5450 DEFSYM (Qkill_buffer_query_functions
, "kill-buffer-query-functions");
5452 Fput (Qprotected_field
, Qerror_conditions
,
5453 listn (CONSTYPE_PURE
, 2, Qprotected_field
, Qerror
));
5454 Fput (Qprotected_field
, Qerror_message
,
5455 build_pure_c_string ("Attempt to modify a protected field"));
5457 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5459 doc
: /* Default value of `mode-line-format' for buffers that don't override it.
5460 This is the same as (default-value 'mode-line-format). */);
5462 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5464 doc
: /* Default value of `header-line-format' for buffers that don't override it.
5465 This is the same as (default-value 'header-line-format). */);
5467 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type
,
5468 doc
: /* Default value of `cursor-type' for buffers that don't override it.
5469 This is the same as (default-value 'cursor-type). */);
5471 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5473 doc
: /* Default value of `line-spacing' for buffers that don't override it.
5474 This is the same as (default-value 'line-spacing). */);
5476 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5477 cursor_in_non_selected_windows
,
5478 doc
: /* Default value of `cursor-in-non-selected-windows'.
5479 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5481 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5483 doc
: /* Default value of `abbrev-mode' for buffers that do not override it.
5484 This is the same as (default-value 'abbrev-mode). */);
5486 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5488 doc
: /* Default value of `ctl-arrow' for buffers that do not override it.
5489 This is the same as (default-value 'ctl-arrow). */);
5491 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5492 enable_multibyte_characters
,
5493 doc
: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5494 This is the same as (default-value 'enable-multibyte-characters). */);
5496 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5497 buffer_file_coding_system
,
5498 doc
: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5499 This is the same as (default-value 'buffer-file-coding-system). */);
5501 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5503 doc
: /* Default value of `truncate-lines' for buffers that do not override it.
5504 This is the same as (default-value 'truncate-lines). */);
5506 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5508 doc
: /* Default value of `fill-column' for buffers that do not override it.
5509 This is the same as (default-value 'fill-column). */);
5511 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5513 doc
: /* Default value of `left-margin' for buffers that do not override it.
5514 This is the same as (default-value 'left-margin). */);
5516 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5518 doc
: /* Default value of `tab-width' for buffers that do not override it.
5519 This is the same as (default-value 'tab-width). */);
5521 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5523 doc
: /* Default value of `case-fold-search' for buffers that don't override it.
5524 This is the same as (default-value 'case-fold-search). */);
5526 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5528 doc
: /* Default value of `left-margin-width' for buffers that don't override it.
5529 This is the same as (default-value 'left-margin-width). */);
5531 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5533 doc
: /* Default value of `right-margin-width' for buffers that don't override it.
5534 This is the same as (default-value 'right-margin-width). */);
5536 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5538 doc
: /* Default value of `left-fringe-width' for buffers that don't override it.
5539 This is the same as (default-value 'left-fringe-width). */);
5541 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5543 doc
: /* Default value of `right-fringe-width' for buffers that don't override it.
5544 This is the same as (default-value 'right-fringe-width). */);
5546 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5547 fringes_outside_margins
,
5548 doc
: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5549 This is the same as (default-value 'fringes-outside-margins). */);
5551 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5553 doc
: /* Default value of `scroll-bar-width' for buffers that don't override it.
5554 This is the same as (default-value 'scroll-bar-width). */);
5556 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5557 vertical_scroll_bar_type
,
5558 doc
: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5559 This is the same as (default-value 'vertical-scroll-bar). */);
5561 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5562 indicate_empty_lines
,
5563 doc
: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5564 This is the same as (default-value 'indicate-empty-lines). */);
5566 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5567 indicate_buffer_boundaries
,
5568 doc
: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5569 This is the same as (default-value 'indicate-buffer-boundaries). */);
5571 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5572 fringe_indicator_alist
,
5573 doc
: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5574 This is the same as (default-value 'fringe-indicator-alist'). */);
5576 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5577 fringe_cursor_alist
,
5578 doc
: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5579 This is the same as (default-value 'fringe-cursor-alist'). */);
5581 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5582 scroll_up_aggressively
,
5583 doc
: /* Default value of `scroll-up-aggressively'.
5584 This value applies in buffers that don't have their own local values.
5585 This is the same as (default-value 'scroll-up-aggressively). */);
5587 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5588 scroll_down_aggressively
,
5589 doc
: /* Default value of `scroll-down-aggressively'.
5590 This value applies in buffers that don't have their own local values.
5591 This is the same as (default-value 'scroll-down-aggressively). */);
5593 DEFVAR_PER_BUFFER ("header-line-format",
5594 &BVAR (current_buffer
, header_line_format
),
5596 doc
: /* Analogous to `mode-line-format', but controls the header line.
5597 The header line appears, optionally, at the top of a window;
5598 the mode line appears at the bottom. */);
5600 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer
, mode_line_format
),
5602 doc
: /* Template for displaying mode line for current buffer.
5604 The value may be nil, a string, a symbol or a list.
5606 A value of nil means don't display a mode line.
5608 For any symbol other than t or nil, the symbol's value is processed as
5609 a mode line construct. As a special exception, if that value is a
5610 string, the string is processed verbatim, without handling any
5611 %-constructs (see below). Also, unless the symbol has a non-nil
5612 `risky-local-variable' property, all properties in any strings, as
5613 well as all :eval and :propertize forms in the value, are ignored.
5615 A list whose car is a string or list is processed by processing each
5616 of the list elements recursively, as separate mode line constructs,
5617 and concatenating the results.
5619 A list of the form `(:eval FORM)' is processed by evaluating FORM and
5620 using the result as a mode line construct. Be careful--FORM should
5621 not load any files, because that can cause an infinite recursion.
5623 A list of the form `(:propertize ELT PROPS...)' is processed by
5624 processing ELT as the mode line construct, and adding the text
5625 properties PROPS to the result.
5627 A list whose car is a symbol is processed by examining the symbol's
5628 value, and, if that value is non-nil, processing the cadr of the list
5629 recursively; and if that value is nil, processing the caddr of the
5632 A list whose car is an integer is processed by processing the cadr of
5633 the list, and padding (if the number is positive) or truncating (if
5634 negative) to the width specified by that number.
5636 A string is printed verbatim in the mode line except for %-constructs:
5637 %b -- print buffer name. %f -- print visited file name.
5638 %F -- print frame name.
5639 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5640 %& is like %*, but ignore read-only-ness.
5641 % means buffer is read-only and * means it is modified.
5642 For a modified read-only buffer, %* gives % and %+ gives *.
5643 %s -- print process status. %l -- print the current line number.
5644 %c -- print the current column number (this makes editing slower).
5645 To make the column number update correctly in all cases,
5646 `column-number-mode' must be non-nil.
5647 %i -- print the size of the buffer.
5648 %I -- like %i, but use k, M, G, etc., to abbreviate.
5649 %p -- print percent of buffer above top of window, or Top, Bot or All.
5650 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5651 or print Bottom or All.
5652 %n -- print Narrow if appropriate.
5653 %t -- visited file is text or binary (if OS supports this distinction).
5654 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5655 %Z -- like %z, but including the end-of-line format.
5656 %e -- print error message about full memory.
5657 %@ -- print @ or hyphen. @ means that default-directory is on a
5659 %[ -- print one [ for each recursive editing level. %] similar.
5660 %% -- print %. %- -- print infinitely many dashes.
5661 Decimal digits after the % specify field width to which to pad. */);
5663 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode
,
5664 doc
: /* Value of `major-mode' for new buffers. */);
5666 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer
, major_mode
),
5667 make_number (Lisp_Symbol
),
5668 doc
: /* Symbol for current buffer's major mode.
5669 The default value (normally `fundamental-mode') affects new buffers.
5670 A value of nil means to use the current buffer's major mode, provided
5671 it is not marked as "special".
5673 When a mode is used by default, `find-file' switches to it before it
5674 reads the contents into the buffer and before it finishes setting up
5675 the buffer. Thus, the mode and its hooks should not expect certain
5676 variables such as `buffer-read-only' and `buffer-file-coding-system'
5679 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer
, mode_name
),
5681 doc
: /* Pretty name of current buffer's major mode.
5682 Usually a string, but can use any of the constructs for `mode-line-format',
5684 Format with `format-mode-line' to produce a string value. */);
5686 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer
, abbrev_table
), Qnil
,
5687 doc
: /* Local (mode-specific) abbrev table of current buffer. */);
5689 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer
, abbrev_mode
), Qnil
,
5690 doc
: /* Non-nil if Abbrev mode is enabled.
5691 Use the command `abbrev-mode' to change this variable. */);
5693 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer
, case_fold_search
),
5695 doc
: /* Non-nil if searches and matches should ignore case. */);
5697 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer
, fill_column
),
5698 make_number (Lisp_Int0
),
5699 doc
: /* Column beyond which automatic line-wrapping should happen.
5700 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5702 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer
, left_margin
),
5703 make_number (Lisp_Int0
),
5704 doc
: /* Column for the default `indent-line-function' to indent to.
5705 Linefeed indents to this column in Fundamental mode. */);
5707 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer
, tab_width
),
5708 make_number (Lisp_Int0
),
5709 doc
: /* Distance between tab stops (for display of tab characters), in columns.
5710 This should be an integer greater than zero. */);
5712 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer
, ctl_arrow
), Qnil
,
5713 doc
: /* Non-nil means display control chars with uparrow.
5714 A value of nil means use backslash and octal digits.
5715 This variable does not apply to characters whose display is specified
5716 in the current display table (if there is one). */);
5718 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5719 &BVAR (current_buffer
, enable_multibyte_characters
),
5721 doc
: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5722 Otherwise they are regarded as unibyte. This affects the display,
5723 file I/O and the behavior of various editing commands.
5725 This variable is buffer-local but you cannot set it directly;
5726 use the function `set-buffer-multibyte' to change a buffer's representation.
5727 See also Info node `(elisp)Text Representations'. */);
5728 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant
= 1;
5730 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5731 &BVAR (current_buffer
, buffer_file_coding_system
), Qnil
,
5732 doc
: /* Coding system to be used for encoding the buffer contents on saving.
5733 This variable applies to saving the buffer, and also to `write-region'
5734 and other functions that use `write-region'.
5735 It does not apply to sending output to subprocesses, however.
5737 If this is nil, the buffer is saved without any code conversion
5738 unless some coding system is specified in `file-coding-system-alist'
5739 for the buffer file.
5741 If the text to be saved cannot be encoded as specified by this variable,
5742 an alternative encoding is selected by `select-safe-coding-system', which see.
5744 The variable `coding-system-for-write', if non-nil, overrides this variable.
5746 This variable is never applied to a way of decoding a file while reading it. */);
5748 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5749 &BVAR (current_buffer
, bidi_display_reordering
), Qnil
,
5750 doc
: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5752 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5753 &BVAR (current_buffer
, bidi_paragraph_direction
), Qnil
,
5754 doc
: /* If non-nil, forces directionality of text paragraphs in the buffer.
5756 If this is nil (the default), the direction of each paragraph is
5757 determined by the first strong directional character of its text.
5758 The values of `right-to-left' and `left-to-right' override that.
5759 Any other value is treated as nil.
5761 This variable has no effect unless the buffer's value of
5762 \`bidi-display-reordering' is non-nil. */);
5764 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer
, truncate_lines
), Qnil
,
5765 doc
: /* Non-nil means do not display continuation lines.
5766 Instead, give each line of text just one screen line.
5768 Note that this is overridden by the variable
5769 `truncate-partial-width-windows' if that variable is non-nil
5770 and this buffer is not full-frame width.
5772 Minibuffers set this variable to nil. */);
5774 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer
, word_wrap
), Qnil
,
5775 doc
: /* Non-nil means to use word-wrapping for continuation lines.
5776 When word-wrapping is on, continuation lines are wrapped at the space
5777 or tab character nearest to the right window edge.
5778 If nil, continuation lines are wrapped at the right screen edge.
5780 This variable has no effect if long lines are truncated (see
5781 `truncate-lines' and `truncate-partial-width-windows'). If you use
5782 word-wrapping, you might want to reduce the value of
5783 `truncate-partial-width-windows', since wrapping can make text readable
5784 in narrower windows.
5786 Instead of setting this variable directly, most users should use
5787 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5788 to t, and additionally redefines simple editing commands to act on
5789 visual lines rather than logical lines. See the documentation of
5790 `visual-line-mode'. */);
5792 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer
, directory
),
5793 make_number (Lisp_String
),
5794 doc
: /* Name of default directory of current buffer. Should end with slash.
5795 To interactively change the default directory, use command `cd'. */);
5797 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer
, auto_fill_function
),
5799 doc
: /* Function called (if non-nil) to perform auto-fill.
5800 It is called after self-inserting any character specified in
5801 the `auto-fill-chars' table.
5802 NOTE: This variable is not a hook;
5803 its value may not be a list of functions. */);
5805 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer
, filename
),
5806 make_number (Lisp_String
),
5807 doc
: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5809 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer
, file_truename
),
5810 make_number (Lisp_String
),
5811 doc
: /* Abbreviated truename of file visited in current buffer, or nil if none.
5812 The truename of a file is calculated by `file-truename'
5813 and then abbreviated with `abbreviate-file-name'. */);
5815 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5816 &BVAR (current_buffer
, auto_save_file_name
),
5817 make_number (Lisp_String
),
5818 doc
: /* Name of file for auto-saving current buffer.
5819 If it is nil, that means don't auto-save this buffer. */);
5821 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer
, read_only
), Qnil
,
5822 doc
: /* Non-nil if this buffer is read-only. */);
5824 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer
, backed_up
), Qnil
,
5825 doc
: /* Non-nil if this buffer's file has been backed up.
5826 Backing up is done before the first time the file is saved. */);
5828 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer
, save_length
),
5829 make_number (Lisp_Int0
),
5830 doc
: /* Length of current buffer when last read in, saved or auto-saved.
5832 -1 means auto-saving turned off until next real save.
5834 If you set this to -2, that means don't turn off auto-saving in this buffer
5835 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5836 you probably should set this to -2 in that buffer. */);
5838 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer
, selective_display
),
5840 doc
: /* Non-nil enables selective display.
5841 An integer N as value means display only lines
5842 that start with less than N columns of space.
5843 A value of t means that the character ^M makes itself and
5844 all the rest of the line invisible; also, when saving the buffer
5845 in a file, save the ^M as a newline. */);
5847 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5848 &BVAR (current_buffer
, selective_display_ellipses
),
5850 doc
: /* Non-nil means display ... on previous line when a line is invisible. */);
5852 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer
, overwrite_mode
), Qnil
,
5853 doc
: /* Non-nil if self-insertion should replace existing text.
5854 The value should be one of `overwrite-mode-textual',
5855 `overwrite-mode-binary', or nil.
5856 If it is `overwrite-mode-textual', self-insertion still
5857 inserts at the end of a line, and inserts when point is before a tab,
5858 until the tab is filled in.
5859 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5861 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer
, display_table
),
5863 doc
: /* Display table that controls display of the contents of current buffer.
5865 If this variable is nil, the value of `standard-display-table' is used.
5866 Each window can have its own, overriding display table, see
5867 `set-window-display-table' and `window-display-table'.
5869 The display table is a char-table created with `make-display-table'.
5870 A char-table is an array indexed by character codes. Normal array
5871 primitives `aref' and `aset' can be used to access elements of a char-table.
5873 Each of the char-table elements control how to display the corresponding
5874 text character: the element at index C in the table says how to display
5875 the character whose code is C. Each element should be a vector of
5876 characters or nil. The value nil means display the character in the
5877 default fashion; otherwise, the characters from the vector are delivered
5878 to the screen instead of the original character.
5880 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5881 to display a capital Y instead of each X character.
5883 In addition, a char-table has six extra slots to control the display of:
5885 the end of a truncated screen line (extra-slot 0, a single character);
5886 the end of a continued line (extra-slot 1, a single character);
5887 the escape character used to display character codes in octal
5888 (extra-slot 2, a single character);
5889 the character used as an arrow for control characters (extra-slot 3,
5890 a single character);
5891 the decoration indicating the presence of invisible lines (extra-slot 4,
5892 a vector of characters);
5893 the character used to draw the border between side-by-side windows
5894 (extra-slot 5, a single character).
5896 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5898 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer
, left_margin_cols
),
5900 doc
: /* Width of left marginal area for display of a buffer.
5901 A value of nil means no marginal area. */);
5903 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer
, right_margin_cols
),
5905 doc
: /* Width of right marginal area for display of a buffer.
5906 A value of nil means no marginal area. */);
5908 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer
, left_fringe_width
),
5910 doc
: /* Width of this buffer's left fringe (in pixels).
5911 A value of 0 means no left fringe is shown in this buffer's window.
5912 A value of nil means to use the left fringe width from the window's frame. */);
5914 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer
, right_fringe_width
),
5916 doc
: /* Width of this buffer's right fringe (in pixels).
5917 A value of 0 means no right fringe is shown in this buffer's window.
5918 A value of nil means to use the right fringe width from the window's frame. */);
5920 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer
, fringes_outside_margins
),
5922 doc
: /* Non-nil means to display fringes outside display margins.
5923 A value of nil means to display fringes between margins and buffer text. */);
5925 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer
, scroll_bar_width
),
5927 doc
: /* Width of this buffer's scroll bars in pixels.
5928 A value of nil means to use the scroll bar width from the window's frame. */);
5930 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer
, vertical_scroll_bar_type
),
5932 doc
: /* Position of this buffer's vertical scroll bar.
5933 The value takes effect whenever you tell a window to display this buffer;
5934 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5936 A value of `left' or `right' means put the vertical scroll bar at that side
5937 of the window; a value of nil means don't show any vertical scroll bars.
5938 A value of t (the default) means do whatever the window's frame specifies. */);
5940 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5941 &BVAR (current_buffer
, indicate_empty_lines
), Qnil
,
5942 doc
: /* Visually indicate empty lines after the buffer end.
5943 If non-nil, a bitmap is displayed in the left fringe of a window on
5944 window-systems. */);
5946 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5947 &BVAR (current_buffer
, indicate_buffer_boundaries
), Qnil
,
5948 doc
: /* Visually indicate buffer boundaries and scrolling.
5949 If non-nil, the first and last line of the buffer are marked in the fringe
5950 of a window on window-systems with angle bitmaps, or if the window can be
5951 scrolled, the top and bottom line of the window are marked with up and down
5954 If value is a symbol `left' or `right', both angle and arrow bitmaps
5955 are displayed in the left or right fringe, resp. Any other value
5956 that doesn't look like an alist means display the angle bitmaps in
5957 the left fringe but no arrows.
5959 You can exercise more precise control by using an alist as the
5960 value. Each alist element (INDICATOR . POSITION) specifies
5961 where to show one of the indicators. INDICATOR is one of `top',
5962 `bottom', `up', `down', or t, which specifies the default position,
5963 and POSITION is one of `left', `right', or nil, meaning do not show
5966 For example, ((top . left) (t . right)) places the top angle bitmap in
5967 left fringe, the bottom angle bitmap in right fringe, and both arrow
5968 bitmaps in right fringe. To show just the angle bitmaps in the left
5969 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5971 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5972 &BVAR (current_buffer
, fringe_indicator_alist
), Qnil
,
5973 doc
: /* Mapping from logical to physical fringe indicator bitmaps.
5974 The value is an alist where each element (INDICATOR . BITMAPS)
5975 specifies the fringe bitmaps used to display a specific logical
5978 INDICATOR specifies the logical indicator type which is one of the
5979 following symbols: `truncation' , `continuation', `overlay-arrow',
5980 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5982 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5983 the actual bitmap shown in the left or right fringe for the logical
5984 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5985 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5986 are used only for the `bottom' and `top-bottom' indicators when the
5987 last (only) line has no final newline. BITMAPS may also be a single
5988 symbol which is used in both left and right fringes. */);
5990 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5991 &BVAR (current_buffer
, fringe_cursor_alist
), Qnil
,
5992 doc
: /* Mapping from logical to physical fringe cursor bitmaps.
5993 The value is an alist where each element (CURSOR . BITMAP)
5994 specifies the fringe bitmaps used to display a specific logical
5995 cursor type in the fringe.
5997 CURSOR specifies the logical cursor type which is one of the following
5998 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5999 one is used to show a hollow cursor on narrow lines display lines
6000 where the normal hollow cursor will not fit.
6002 BITMAP is the corresponding fringe bitmap shown for the logical
6005 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
6006 &BVAR (current_buffer
, scroll_up_aggressively
), Qnil
,
6007 doc
: /* How far to scroll windows upward.
6008 If you move point off the bottom, the window scrolls automatically.
6009 This variable controls how far it scrolls. The value nil, the default,
6010 means scroll to center point. A fraction means scroll to put point
6011 that fraction of the window's height from the bottom of the window.
6012 When the value is 0.0, point goes at the bottom line, which in the
6013 simple case that you moved off with C-f means scrolling just one line.
6014 1.0 means point goes at the top, so that in that simple case, the
6015 window scrolls by a full window height. Meaningful values are
6016 between 0.0 and 1.0, inclusive. */);
6018 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
6019 &BVAR (current_buffer
, scroll_down_aggressively
), Qnil
,
6020 doc
: /* How far to scroll windows downward.
6021 If you move point off the top, the window scrolls automatically.
6022 This variable controls how far it scrolls. The value nil, the default,
6023 means scroll to center point. A fraction means scroll to put point
6024 that fraction of the window's height from the top of the window.
6025 When the value is 0.0, point goes at the top line, which in the
6026 simple case that you moved off with C-b means scrolling just one line.
6027 1.0 means point goes at the bottom, so that in that simple case, the
6028 window scrolls by a full window height. Meaningful values are
6029 between 0.0 and 1.0, inclusive. */);
6031 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
6035 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions
,
6036 doc
: /* List of functions to call before each text change.
6037 Two arguments are passed to each function: the positions of
6038 the beginning and end of the range of old text to be changed.
6039 \(For an insertion, the beginning and end are at the same place.)
6040 No information is given about the length of the text after the change.
6042 Buffer changes made while executing the `before-change-functions'
6043 don't call any before-change or after-change functions.
6044 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6046 If an unhandled error happens in running these functions,
6047 the variable's value remains nil. That prevents the error
6048 from happening repeatedly and making Emacs nonfunctional. */);
6049 Vbefore_change_functions
= Qnil
;
6051 DEFVAR_LISP ("after-change-functions", Vafter_change_functions
,
6052 doc
: /* List of functions to call after each text change.
6053 Three arguments are passed to each function: the positions of
6054 the beginning and end of the range of changed text,
6055 and the length in bytes of the pre-change text replaced by that range.
6056 \(For an insertion, the pre-change length is zero;
6057 for a deletion, that length is the number of bytes deleted,
6058 and the post-change beginning and end are at the same place.)
6060 Buffer changes made while executing the `after-change-functions'
6061 don't call any before-change or after-change functions.
6062 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6064 If an unhandled error happens in running these functions,
6065 the variable's value remains nil. That prevents the error
6066 from happening repeatedly and making Emacs nonfunctional. */);
6067 Vafter_change_functions
= Qnil
;
6069 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook
,
6070 doc
: /* A list of functions to call before changing a buffer which is unmodified.
6071 The functions are run using the `run-hooks' function. */);
6072 Vfirst_change_hook
= Qnil
;
6074 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer
, undo_list
), Qnil
,
6075 doc
: /* List of undo entries in current buffer.
6076 Recent changes come first; older changes follow newer.
6078 An entry (BEG . END) represents an insertion which begins at
6079 position BEG and ends at position END.
6081 An entry (TEXT . POSITION) represents the deletion of the string TEXT
6082 from (abs POSITION). If POSITION is positive, point was at the front
6083 of the text being deleted; if negative, point was at the end.
6085 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
6086 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
6087 and is the visited file's modification time, as of that time. If the
6088 modification time of the most recent save is different, this entry is
6091 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
6092 was modified between BEG and END. PROPERTY is the property name,
6093 and VALUE is the old value.
6095 An entry (apply FUN-NAME . ARGS) means undo the change with
6096 \(apply FUN-NAME ARGS).
6098 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
6099 in the active region. BEG and END is the range affected by this entry
6100 and DELTA is the number of bytes added or deleted in that range by
6103 An entry (MARKER . DISTANCE) indicates that the marker MARKER
6104 was adjusted in position by the offset DISTANCE (an integer).
6106 An entry of the form POSITION indicates that point was at the buffer
6107 location given by the integer. Undoing an entry of this form places
6110 Entries with value `nil' mark undo boundaries. The undo command treats
6111 the changes between two undo boundaries as a single step to be undone.
6113 If the value of the variable is t, undo information is not recorded. */);
6115 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer
, mark_active
), Qnil
,
6116 doc
: /* Non-nil means the mark and region are currently active in this buffer. */);
6118 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer
, cache_long_line_scans
), Qnil
,
6119 doc
: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
6121 Normally, the line-motion functions work by scanning the buffer for
6122 newlines. Columnar operations (like `move-to-column' and
6123 `compute-motion') also work by scanning the buffer, summing character
6124 widths as they go. This works well for ordinary text, but if the
6125 buffer's lines are very long (say, more than 500 characters), these
6126 motion functions will take longer to execute. Emacs may also take
6127 longer to update the display.
6129 If `cache-long-line-scans' is non-nil, these motion functions cache the
6130 results of their scans, and consult the cache to avoid rescanning
6131 regions of the buffer until the text is modified. The caches are most
6132 beneficial when they prevent the most searching---that is, when the
6133 buffer contains long lines and large regions of characters with the
6134 same, fixed screen width.
6136 When `cache-long-line-scans' is non-nil, processing short lines will
6137 become slightly slower (because of the overhead of consulting the
6138 cache), and the caches will use memory roughly proportional to the
6139 number of newlines and characters whose screen width varies.
6141 The caches require no explicit maintenance; their accuracy is
6142 maintained internally by the Emacs primitives. Enabling or disabling
6143 the cache should not affect the behavior of any of the motion
6144 functions; it should only affect their performance. */);
6146 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer
, point_before_scroll
), Qnil
,
6147 doc
: /* Value of point before the last series of scroll operations, or nil. */);
6149 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer
, file_format
), Qnil
,
6150 doc
: /* List of formats to use when saving this buffer.
6151 Formats are defined by `format-alist'. This variable is
6152 set when a file is visited. */);
6154 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6155 &BVAR (current_buffer
, auto_save_file_format
), Qnil
,
6156 doc
: /* Format in which to write auto-save files.
6157 Should be a list of symbols naming formats that are defined in `format-alist'.
6158 If it is t, which is the default, auto-save files are written in the
6159 same format as a regular save would use. */);
6161 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6162 &BVAR (current_buffer
, invisibility_spec
), Qnil
,
6163 doc
: /* Invisibility spec of this buffer.
6164 The default is t, which means that text is invisible
6165 if it has a non-nil `invisible' property.
6166 If the value is a list, a text character is invisible if its `invisible'
6167 property is an element in that list (or is a list with members in common).
6168 If an element is a cons cell of the form (PROP . ELLIPSIS),
6169 then characters with property value PROP are invisible,
6170 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
6172 DEFVAR_PER_BUFFER ("buffer-display-count",
6173 &BVAR (current_buffer
, display_count
), Qnil
,
6174 doc
: /* A number incremented each time this buffer is displayed in a window.
6175 The function `set-window-buffer' increments it. */);
6177 DEFVAR_PER_BUFFER ("buffer-display-time",
6178 &BVAR (current_buffer
, display_time
), Qnil
,
6179 doc
: /* Time stamp updated each time this buffer is displayed in a window.
6180 The function `set-window-buffer' updates this variable
6181 to the value obtained by calling `current-time'.
6182 If the buffer has never been shown in a window, the value is nil. */);
6184 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode
,
6185 doc
: /* Non-nil if Transient Mark mode is enabled.
6186 See the command `transient-mark-mode' for a description of this minor mode.
6188 Non-nil also enables highlighting of the region whenever the mark is active.
6189 The variable `highlight-nonselected-windows' controls whether to highlight
6190 all windows or just the selected window.
6192 Lisp programs may give this variable certain special values:
6194 - A value of `lambda' enables Transient Mark mode temporarily.
6195 It is disabled again after any subsequent action that would
6196 normally deactivate the mark (e.g. buffer modification).
6198 - A value of (only . OLDVAL) enables Transient Mark mode
6199 temporarily. After any subsequent point motion command that is
6200 not shift-translated, or any other action that would normally
6201 deactivate the mark (e.g. buffer modification), the value of
6202 `transient-mark-mode' is set to OLDVAL. */);
6203 Vtransient_mark_mode
= Qnil
;
6205 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only
,
6206 doc
: /* Non-nil means disregard read-only status of buffers or characters.
6207 If the value is t, disregard `buffer-read-only' and all `read-only'
6208 text properties. If the value is a list, disregard `buffer-read-only'
6209 and disregard a `read-only' text property if the property value
6210 is a member of the list. */);
6211 Vinhibit_read_only
= Qnil
;
6213 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer
, cursor_type
), Qnil
,
6214 doc
: /* Cursor to use when this buffer is in the selected window.
6215 Values are interpreted as follows:
6217 t use the cursor specified for the frame
6218 nil don't display a cursor
6219 box display a filled box cursor
6220 hollow display a hollow box cursor
6221 bar display a vertical bar cursor with default width
6222 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6223 hbar display a horizontal bar cursor with default height
6224 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6225 ANYTHING ELSE display a hollow box cursor
6227 When the buffer is displayed in a non-selected window, the
6228 cursor's appearance is instead controlled by the variable
6229 `cursor-in-non-selected-windows'. */);
6231 DEFVAR_PER_BUFFER ("line-spacing",
6232 &BVAR (current_buffer
, extra_line_spacing
), Qnil
,
6233 doc
: /* Additional space to put between lines when displaying a buffer.
6234 The space is measured in pixels, and put below lines on graphic displays,
6235 see `display-graphic-p'.
6236 If value is a floating point number, it specifies the spacing relative
6237 to the default frame line height. A value of nil means add no extra space. */);
6239 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6240 &BVAR (current_buffer
, cursor_in_non_selected_windows
), Qnil
,
6241 doc
: /* Non-nil means show a cursor in non-selected windows.
6242 If nil, only shows a cursor in the selected window.
6243 If t, displays a cursor related to the usual cursor type
6244 \(a solid box becomes hollow, a bar becomes a narrower bar).
6245 You can also specify the cursor type as in the `cursor-type' variable.
6246 Use Custom to set this variable and update the display." */);
6248 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions
,
6249 doc
: /* List of functions called with no args to query before killing a buffer.
6250 The buffer being killed will be current while the functions are running.
6252 If any of them returns nil, the buffer is not killed. Functions run by
6253 this hook are supposed to not change the current buffer. */);
6254 Vkill_buffer_query_functions
= Qnil
;
6256 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook
,
6257 doc
: /* Normal hook run before changing the major mode of a buffer.
6258 The function `kill-all-local-variables' runs this before doing anything else. */);
6259 Vchange_major_mode_hook
= Qnil
;
6260 DEFSYM (Qchange_major_mode_hook
, "change-major-mode-hook");
6262 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook
,
6263 doc
: /* Hook run when the buffer list changes.
6264 Functions running this hook are `get-buffer-create',
6265 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6266 and `bury-buffer-internal'. */);
6267 Vbuffer_list_update_hook
= Qnil
;
6268 DEFSYM (Qbuffer_list_update_hook
, "buffer-list-update-hook");
6270 defsubr (&Sbuffer_live_p
);
6271 defsubr (&Sbuffer_list
);
6272 defsubr (&Sget_buffer
);
6273 defsubr (&Sget_file_buffer
);
6274 defsubr (&Sget_buffer_create
);
6275 defsubr (&Smake_indirect_buffer
);
6276 defsubr (&Sgenerate_new_buffer_name
);
6277 defsubr (&Sbuffer_name
);
6278 defsubr (&Sbuffer_file_name
);
6279 defsubr (&Sbuffer_base_buffer
);
6280 defsubr (&Sbuffer_local_value
);
6281 defsubr (&Sbuffer_local_variables
);
6282 defsubr (&Sbuffer_modified_p
);
6283 defsubr (&Sset_buffer_modified_p
);
6284 defsubr (&Sbuffer_modified_tick
);
6285 defsubr (&Sbuffer_chars_modified_tick
);
6286 defsubr (&Srename_buffer
);
6287 defsubr (&Sother_buffer
);
6288 defsubr (&Sbuffer_enable_undo
);
6289 defsubr (&Skill_buffer
);
6290 defsubr (&Sbury_buffer_internal
);
6291 defsubr (&Sset_buffer_major_mode
);
6292 defsubr (&Scurrent_buffer
);
6293 defsubr (&Sset_buffer
);
6294 defsubr (&Sbarf_if_buffer_read_only
);
6295 defsubr (&Serase_buffer
);
6296 defsubr (&Sbuffer_swap_text
);
6297 defsubr (&Sset_buffer_multibyte
);
6298 defsubr (&Skill_all_local_variables
);
6300 defsubr (&Soverlayp
);
6301 defsubr (&Smake_overlay
);
6302 defsubr (&Sdelete_overlay
);
6303 defsubr (&Sdelete_all_overlays
);
6304 defsubr (&Smove_overlay
);
6305 defsubr (&Soverlay_start
);
6306 defsubr (&Soverlay_end
);
6307 defsubr (&Soverlay_buffer
);
6308 defsubr (&Soverlay_properties
);
6309 defsubr (&Soverlays_at
);
6310 defsubr (&Soverlays_in
);
6311 defsubr (&Snext_overlay_change
);
6312 defsubr (&Sprevious_overlay_change
);
6313 defsubr (&Soverlay_recenter
);
6314 defsubr (&Soverlay_lists
);
6315 defsubr (&Soverlay_get
);
6316 defsubr (&Soverlay_put
);
6317 defsubr (&Srestore_buffer_modified_p
);
6321 keys_of_buffer (void)
6323 initial_define_key (control_x_map
, 'b', "switch-to-buffer");
6324 initial_define_key (control_x_map
, 'k', "kill-buffer");
6326 /* This must not be in syms_of_buffer, because Qdisabled is not
6327 initialized when that function gets called. */
6328 Fput (intern_c_string ("erase-buffer"), Qdisabled
, Qt
);