1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #define BUFFER_INLINE EXTERN_INLINE
25 #include <sys/types.h>
27 #include <sys/param.h>
35 #include "intervals.h"
38 #include "character.h"
40 #include "region-cache.h"
42 #include "blockinput.h"
47 /* First buffer in chain of all buffers (in reverse order of creation).
48 Threaded through ->header.next.buffer. */
50 struct buffer
*all_buffers
;
52 /* This structure holds the default values of the buffer-local variables
53 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
54 The default value occupies the same slot in this structure
55 as an individual buffer's value occupies in that buffer.
56 Setting the default value also goes through the alist of buffers
57 and stores into each buffer that does not say it has a local value. */
59 struct buffer
alignas (GCALIGNMENT
) buffer_defaults
;
61 /* This structure marks which slots in a buffer have corresponding
62 default values in buffer_defaults.
63 Each such slot has a nonzero value in this structure.
64 The value has only one nonzero bit.
66 When a buffer has its own local value for a slot,
67 the entry for that slot (found in the same slot in this structure)
68 is turned on in the buffer's local_flags array.
70 If a slot in this structure is -1, then even though there may
71 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
72 and the corresponding slot in buffer_defaults is not used.
74 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
75 zero, that is a bug. */
77 struct buffer buffer_local_flags
;
79 /* This structure holds the names of symbols whose values may be
80 buffer-local. It is indexed and accessed in the same way as the above. */
82 struct buffer
alignas (GCALIGNMENT
) buffer_local_symbols
;
84 /* Return the symbol of the per-buffer variable at offset OFFSET in
85 the buffer structure. */
87 #define PER_BUFFER_SYMBOL(OFFSET) \
88 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
90 /* Maximum length of an overlay vector. */
91 #define OVERLAY_COUNT_MAX \
92 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
93 min (PTRDIFF_MAX, SIZE_MAX) / word_size))
95 /* Flags indicating which built-in buffer-local variables
96 are permanent locals. */
97 static char buffer_permanent_local_flags
[MAX_PER_BUFFER_VARS
];
99 /* Number of per-buffer variables used. */
101 int last_per_buffer_idx
;
103 static void call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
,
104 bool after
, Lisp_Object arg1
,
105 Lisp_Object arg2
, Lisp_Object arg3
);
106 static void swap_out_buffer_local_variables (struct buffer
*b
);
107 static void reset_buffer_local_variables (struct buffer
*, bool);
109 /* Alist of all buffer names vs the buffers. */
110 /* This used to be a variable, but is no longer,
111 to prevent lossage due to user rplac'ing this alist or its elements. */
112 Lisp_Object Vbuffer_alist
;
114 static Lisp_Object Qkill_buffer_query_functions
;
116 /* Hook run before changing a major mode. */
117 static Lisp_Object Qchange_major_mode_hook
;
119 Lisp_Object Qfirst_change_hook
;
120 Lisp_Object Qbefore_change_functions
;
121 Lisp_Object Qafter_change_functions
;
123 static Lisp_Object Qfundamental_mode
, Qmode_class
, Qpermanent_local
;
124 static Lisp_Object Qpermanent_local_hook
;
126 static Lisp_Object Qprotected_field
;
128 static Lisp_Object QSFundamental
; /* A string "Fundamental". */
130 static Lisp_Object Qkill_buffer_hook
;
131 static Lisp_Object Qbuffer_list_update_hook
;
133 static Lisp_Object Qget_file_buffer
;
135 static Lisp_Object Qoverlayp
;
137 Lisp_Object Qpriority
, Qbefore_string
, Qafter_string
;
139 static Lisp_Object Qevaporate
;
141 Lisp_Object Qmodification_hooks
;
142 Lisp_Object Qinsert_in_front_hooks
;
143 Lisp_Object Qinsert_behind_hooks
;
145 static void alloc_buffer_text (struct buffer
*, ptrdiff_t);
146 static void free_buffer_text (struct buffer
*b
);
147 static struct Lisp_Overlay
* copy_overlays (struct buffer
*, struct Lisp_Overlay
*);
148 static void modify_overlay (struct buffer
*, ptrdiff_t, ptrdiff_t);
149 static Lisp_Object
buffer_lisp_local_variables (struct buffer
*, bool);
152 CHECK_OVERLAY (Lisp_Object x
)
154 CHECK_TYPE (OVERLAYP (x
), Qoverlayp
, x
);
157 /* These setters are used only in this file, so they can be private. */
159 bset_abbrev_mode (struct buffer
*b
, Lisp_Object val
)
161 b
->INTERNAL_FIELD (abbrev_mode
) = val
;
164 bset_abbrev_table (struct buffer
*b
, Lisp_Object val
)
166 b
->INTERNAL_FIELD (abbrev_table
) = val
;
169 bset_auto_fill_function (struct buffer
*b
, Lisp_Object val
)
171 b
->INTERNAL_FIELD (auto_fill_function
) = val
;
174 bset_auto_save_file_format (struct buffer
*b
, Lisp_Object val
)
176 b
->INTERNAL_FIELD (auto_save_file_format
) = val
;
179 bset_auto_save_file_name (struct buffer
*b
, Lisp_Object val
)
181 b
->INTERNAL_FIELD (auto_save_file_name
) = val
;
184 bset_backed_up (struct buffer
*b
, Lisp_Object val
)
186 b
->INTERNAL_FIELD (backed_up
) = val
;
189 bset_begv_marker (struct buffer
*b
, Lisp_Object val
)
191 b
->INTERNAL_FIELD (begv_marker
) = val
;
194 bset_bidi_display_reordering (struct buffer
*b
, Lisp_Object val
)
196 b
->INTERNAL_FIELD (bidi_display_reordering
) = val
;
199 bset_buffer_file_coding_system (struct buffer
*b
, Lisp_Object val
)
201 b
->INTERNAL_FIELD (buffer_file_coding_system
) = val
;
204 bset_cache_long_line_scans (struct buffer
*b
, Lisp_Object val
)
206 b
->INTERNAL_FIELD (cache_long_line_scans
) = val
;
209 bset_case_fold_search (struct buffer
*b
, Lisp_Object val
)
211 b
->INTERNAL_FIELD (case_fold_search
) = val
;
214 bset_ctl_arrow (struct buffer
*b
, Lisp_Object val
)
216 b
->INTERNAL_FIELD (ctl_arrow
) = val
;
219 bset_cursor_in_non_selected_windows (struct buffer
*b
, Lisp_Object val
)
221 b
->INTERNAL_FIELD (cursor_in_non_selected_windows
) = val
;
224 bset_cursor_type (struct buffer
*b
, Lisp_Object val
)
226 b
->INTERNAL_FIELD (cursor_type
) = val
;
229 bset_display_table (struct buffer
*b
, Lisp_Object val
)
231 b
->INTERNAL_FIELD (display_table
) = val
;
234 bset_extra_line_spacing (struct buffer
*b
, Lisp_Object val
)
236 b
->INTERNAL_FIELD (extra_line_spacing
) = val
;
239 bset_file_format (struct buffer
*b
, Lisp_Object val
)
241 b
->INTERNAL_FIELD (file_format
) = val
;
244 bset_file_truename (struct buffer
*b
, Lisp_Object val
)
246 b
->INTERNAL_FIELD (file_truename
) = val
;
249 bset_fringe_cursor_alist (struct buffer
*b
, Lisp_Object val
)
251 b
->INTERNAL_FIELD (fringe_cursor_alist
) = val
;
254 bset_fringe_indicator_alist (struct buffer
*b
, Lisp_Object val
)
256 b
->INTERNAL_FIELD (fringe_indicator_alist
) = val
;
259 bset_fringes_outside_margins (struct buffer
*b
, Lisp_Object val
)
261 b
->INTERNAL_FIELD (fringes_outside_margins
) = val
;
264 bset_header_line_format (struct buffer
*b
, Lisp_Object val
)
266 b
->INTERNAL_FIELD (header_line_format
) = val
;
269 bset_indicate_buffer_boundaries (struct buffer
*b
, Lisp_Object val
)
271 b
->INTERNAL_FIELD (indicate_buffer_boundaries
) = val
;
274 bset_indicate_empty_lines (struct buffer
*b
, Lisp_Object val
)
276 b
->INTERNAL_FIELD (indicate_empty_lines
) = val
;
279 bset_invisibility_spec (struct buffer
*b
, Lisp_Object val
)
281 b
->INTERNAL_FIELD (invisibility_spec
) = val
;
284 bset_left_fringe_width (struct buffer
*b
, Lisp_Object val
)
286 b
->INTERNAL_FIELD (left_fringe_width
) = val
;
289 bset_major_mode (struct buffer
*b
, Lisp_Object val
)
291 b
->INTERNAL_FIELD (major_mode
) = val
;
294 bset_mark (struct buffer
*b
, Lisp_Object val
)
296 b
->INTERNAL_FIELD (mark
) = val
;
299 bset_minor_modes (struct buffer
*b
, Lisp_Object val
)
301 b
->INTERNAL_FIELD (minor_modes
) = val
;
304 bset_mode_line_format (struct buffer
*b
, Lisp_Object val
)
306 b
->INTERNAL_FIELD (mode_line_format
) = val
;
309 bset_mode_name (struct buffer
*b
, Lisp_Object val
)
311 b
->INTERNAL_FIELD (mode_name
) = val
;
314 bset_name (struct buffer
*b
, Lisp_Object val
)
316 b
->INTERNAL_FIELD (name
) = val
;
319 bset_overwrite_mode (struct buffer
*b
, Lisp_Object val
)
321 b
->INTERNAL_FIELD (overwrite_mode
) = val
;
324 bset_pt_marker (struct buffer
*b
, Lisp_Object val
)
326 b
->INTERNAL_FIELD (pt_marker
) = val
;
329 bset_right_fringe_width (struct buffer
*b
, Lisp_Object val
)
331 b
->INTERNAL_FIELD (right_fringe_width
) = val
;
334 bset_save_length (struct buffer
*b
, Lisp_Object val
)
336 b
->INTERNAL_FIELD (save_length
) = val
;
339 bset_scroll_bar_width (struct buffer
*b
, Lisp_Object val
)
341 b
->INTERNAL_FIELD (scroll_bar_width
) = val
;
344 bset_scroll_down_aggressively (struct buffer
*b
, Lisp_Object val
)
346 b
->INTERNAL_FIELD (scroll_down_aggressively
) = val
;
349 bset_scroll_up_aggressively (struct buffer
*b
, Lisp_Object val
)
351 b
->INTERNAL_FIELD (scroll_up_aggressively
) = val
;
354 bset_selective_display (struct buffer
*b
, Lisp_Object val
)
356 b
->INTERNAL_FIELD (selective_display
) = val
;
359 bset_selective_display_ellipses (struct buffer
*b
, Lisp_Object val
)
361 b
->INTERNAL_FIELD (selective_display_ellipses
) = val
;
364 bset_vertical_scroll_bar_type (struct buffer
*b
, Lisp_Object val
)
366 b
->INTERNAL_FIELD (vertical_scroll_bar_type
) = val
;
369 bset_word_wrap (struct buffer
*b
, Lisp_Object val
)
371 b
->INTERNAL_FIELD (word_wrap
) = val
;
374 bset_zv_marker (struct buffer
*b
, Lisp_Object val
)
376 b
->INTERNAL_FIELD (zv_marker
) = val
;
380 nsberror (Lisp_Object spec
)
383 error ("No buffer named %s", SDATA (spec
));
384 error ("Invalid buffer argument");
387 DEFUN ("buffer-live-p", Fbuffer_live_p
, Sbuffer_live_p
, 1, 1, 0,
388 doc
: /* Return non-nil if OBJECT is a buffer which has not been killed.
389 Value is nil if OBJECT is not a buffer or if it has been killed. */)
392 return ((BUFFERP (object
) && BUFFER_LIVE_P (XBUFFER (object
)))
396 DEFUN ("buffer-list", Fbuffer_list
, Sbuffer_list
, 0, 1, 0,
397 doc
: /* Return a list of all existing live buffers.
398 If the optional arg FRAME is a frame, we return the buffer list in the
399 proper order for that frame: the buffers show in FRAME come first,
400 followed by the rest of the buffers. */)
404 general
= Fmapcar (Qcdr
, Vbuffer_alist
);
408 Lisp_Object framelist
, prevlist
, tail
;
411 framelist
= Fcopy_sequence (XFRAME (frame
)->buffer_list
);
412 prevlist
= Fnreverse (Fcopy_sequence
413 (XFRAME (frame
)->buried_buffer_list
));
415 /* Remove from GENERAL any buffer that duplicates one in
416 FRAMELIST or PREVLIST. */
420 general
= Fdelq (XCAR (tail
), general
);
426 general
= Fdelq (XCAR (tail
), general
);
433 return Fnconc (3, args
);
439 /* Like Fassoc, but use Fstring_equal to compare
440 (which ignores text properties),
441 and don't ever QUIT. */
444 assoc_ignore_text_properties (register Lisp_Object key
, Lisp_Object list
)
446 register Lisp_Object tail
;
447 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
449 register Lisp_Object elt
, tem
;
451 tem
= Fstring_equal (Fcar (elt
), key
);
458 DEFUN ("get-buffer", Fget_buffer
, Sget_buffer
, 1, 1, 0,
459 doc
: /* Return the buffer named BUFFER-OR-NAME.
460 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
461 is a string and there is no buffer with that name, return nil. If
462 BUFFER-OR-NAME is a buffer, return it as given. */)
463 (register Lisp_Object buffer_or_name
)
465 if (BUFFERP (buffer_or_name
))
466 return buffer_or_name
;
467 CHECK_STRING (buffer_or_name
);
469 return Fcdr (assoc_ignore_text_properties (buffer_or_name
, Vbuffer_alist
));
472 DEFUN ("get-file-buffer", Fget_file_buffer
, Sget_file_buffer
, 1, 1, 0,
473 doc
: /* Return the buffer visiting file FILENAME (a string).
474 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
475 If there is no such live buffer, return nil.
476 See also `find-buffer-visiting'. */)
477 (register Lisp_Object filename
)
479 register Lisp_Object tail
, buf
, tem
;
482 CHECK_STRING (filename
);
483 filename
= Fexpand_file_name (filename
, Qnil
);
485 /* If the file name has special constructs in it,
486 call the corresponding file handler. */
487 handler
= Ffind_file_name_handler (filename
, Qget_file_buffer
);
490 Lisp_Object handled_buf
= call2 (handler
, Qget_file_buffer
,
492 return BUFFERP (handled_buf
) ? handled_buf
: Qnil
;
495 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
497 buf
= Fcdr (XCAR (tail
));
498 if (!BUFFERP (buf
)) continue;
499 if (!STRINGP (BVAR (XBUFFER (buf
), filename
))) continue;
500 tem
= Fstring_equal (BVAR (XBUFFER (buf
), filename
), filename
);
508 get_truename_buffer (register Lisp_Object filename
)
510 register Lisp_Object tail
, buf
, tem
;
512 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
514 buf
= Fcdr (XCAR (tail
));
515 if (!BUFFERP (buf
)) continue;
516 if (!STRINGP (BVAR (XBUFFER (buf
), file_truename
))) continue;
517 tem
= Fstring_equal (BVAR (XBUFFER (buf
), file_truename
), filename
);
524 DEFUN ("get-buffer-create", Fget_buffer_create
, Sget_buffer_create
, 1, 1, 0,
525 doc
: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
526 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
527 return that buffer. If no such buffer exists, create a new buffer with
528 that name and return it. If BUFFER-OR-NAME starts with a space, the new
529 buffer does not keep undo information.
531 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
532 even if it is dead. The return value is never nil. */)
533 (register Lisp_Object buffer_or_name
)
535 register Lisp_Object buffer
, name
;
536 register struct buffer
*b
;
538 buffer
= Fget_buffer (buffer_or_name
);
542 if (SCHARS (buffer_or_name
) == 0)
543 error ("Empty string for buffer name is not allowed");
545 b
= allocate_buffer ();
547 /* An ordinary buffer uses its own struct buffer_text. */
548 b
->text
= &b
->own_text
;
549 b
->base_buffer
= NULL
;
550 /* No one shares the text with us now. */
552 /* No one shows us now. */
555 BUF_GAP_SIZE (b
) = 20;
557 /* We allocate extra 1-byte at the tail and keep it always '\0' for
558 anchoring a search. */
559 alloc_buffer_text (b
, BUF_GAP_SIZE (b
) + 1);
561 if (! BUF_BEG_ADDR (b
))
562 buffer_memory_full (BUF_GAP_SIZE (b
) + 1);
567 b
->pt_byte
= BEG_BYTE
;
568 b
->begv_byte
= BEG_BYTE
;
569 b
->zv_byte
= BEG_BYTE
;
572 BUF_GPT_BYTE (b
) = BEG_BYTE
;
575 BUF_Z_BYTE (b
) = BEG_BYTE
;
577 BUF_CHARS_MODIFF (b
) = 1;
578 BUF_OVERLAY_MODIFF (b
) = 1;
579 BUF_SAVE_MODIFF (b
) = 1;
581 set_buffer_intervals (b
, NULL
);
582 BUF_UNCHANGED_MODIFIED (b
) = 1;
583 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = 1;
584 BUF_END_UNCHANGED (b
) = 0;
585 BUF_BEG_UNCHANGED (b
) = 0;
586 *(BUF_GPT_ADDR (b
)) = *(BUF_Z_ADDR (b
)) = 0; /* Put an anchor '\0'. */
587 b
->text
->inhibit_shrinking
= 0;
589 b
->newline_cache
= 0;
590 b
->width_run_cache
= 0;
591 bset_width_table (b
, Qnil
);
592 b
->prevent_redisplay_optimizations_p
= 1;
594 /* An ordinary buffer normally doesn't need markers
595 to handle BEGV and ZV. */
596 bset_pt_marker (b
, Qnil
);
597 bset_begv_marker (b
, Qnil
);
598 bset_zv_marker (b
, Qnil
);
600 name
= Fcopy_sequence (buffer_or_name
);
601 set_string_intervals (name
, NULL
);
604 bset_undo_list (b
, SREF (name
, 0) != ' ' ? Qnil
: Qt
);
607 reset_buffer_local_variables (b
, 1);
609 bset_mark (b
, Fmake_marker ());
610 BUF_MARKERS (b
) = NULL
;
612 /* Put this in the alist of all live buffers. */
613 XSETBUFFER (buffer
, b
);
614 Vbuffer_alist
= nconc2 (Vbuffer_alist
, list1 (Fcons (name
, buffer
)));
615 /* And run buffer-list-update-hook. */
616 if (!NILP (Vrun_hooks
))
617 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
623 /* Return a list of overlays which is a copy of the overlay list
624 LIST, but for buffer B. */
626 static struct Lisp_Overlay
*
627 copy_overlays (struct buffer
*b
, struct Lisp_Overlay
*list
)
629 struct Lisp_Overlay
*result
= NULL
, *tail
= NULL
;
631 for (; list
; list
= list
->next
)
633 Lisp_Object overlay
, start
, end
;
634 struct Lisp_Marker
*m
;
636 eassert (MARKERP (list
->start
));
637 m
= XMARKER (list
->start
);
638 start
= build_marker (b
, m
->charpos
, m
->bytepos
);
639 XMARKER (start
)->insertion_type
= m
->insertion_type
;
641 eassert (MARKERP (list
->end
));
642 m
= XMARKER (list
->end
);
643 end
= build_marker (b
, m
->charpos
, m
->bytepos
);
644 XMARKER (end
)->insertion_type
= m
->insertion_type
;
646 overlay
= build_overlay (start
, end
, Fcopy_sequence (list
->plist
));
648 tail
= tail
->next
= XOVERLAY (overlay
);
650 result
= tail
= XOVERLAY (overlay
);
656 /* Set an appropriate overlay of B. */
659 set_buffer_overlays_before (struct buffer
*b
, struct Lisp_Overlay
*o
)
661 b
->overlays_before
= o
;
665 set_buffer_overlays_after (struct buffer
*b
, struct Lisp_Overlay
*o
)
667 b
->overlays_after
= o
;
670 /* Clone per-buffer values of buffer FROM.
672 Buffer TO gets the same per-buffer values as FROM, with the
673 following exceptions: (1) TO's name is left untouched, (2) markers
674 are copied and made to refer to TO, and (3) overlay lists are
678 clone_per_buffer_values (struct buffer
*from
, struct buffer
*to
)
682 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
686 /* Don't touch the `name' which should be unique for every buffer. */
687 if (offset
== PER_BUFFER_VAR_OFFSET (name
))
690 obj
= per_buffer_value (from
, offset
);
691 if (MARKERP (obj
) && XMARKER (obj
)->buffer
== from
)
693 struct Lisp_Marker
*m
= XMARKER (obj
);
695 obj
= build_marker (to
, m
->charpos
, m
->bytepos
);
696 XMARKER (obj
)->insertion_type
= m
->insertion_type
;
699 set_per_buffer_value (to
, offset
, obj
);
702 memcpy (to
->local_flags
, from
->local_flags
, sizeof to
->local_flags
);
704 set_buffer_overlays_before (to
, copy_overlays (to
, from
->overlays_before
));
705 set_buffer_overlays_after (to
, copy_overlays (to
, from
->overlays_after
));
707 /* Get (a copy of) the alist of Lisp-level local variables of FROM
708 and install that in TO. */
709 bset_local_var_alist (to
, buffer_lisp_local_variables (from
, 1));
713 /* If buffer B has markers to record PT, BEGV and ZV when it is not
714 current, update these markers. */
717 record_buffer_markers (struct buffer
*b
)
719 if (! NILP (BVAR (b
, pt_marker
)))
723 eassert (!NILP (BVAR (b
, begv_marker
)));
724 eassert (!NILP (BVAR (b
, zv_marker
)));
726 XSETBUFFER (buffer
, b
);
727 set_marker_both (BVAR (b
, pt_marker
), buffer
, b
->pt
, b
->pt_byte
);
728 set_marker_both (BVAR (b
, begv_marker
), buffer
, b
->begv
, b
->begv_byte
);
729 set_marker_both (BVAR (b
, zv_marker
), buffer
, b
->zv
, b
->zv_byte
);
734 /* If buffer B has markers to record PT, BEGV and ZV when it is not
735 current, fetch these values into B->begv etc. */
738 fetch_buffer_markers (struct buffer
*b
)
740 if (! NILP (BVAR (b
, pt_marker
)))
744 eassert (!NILP (BVAR (b
, begv_marker
)));
745 eassert (!NILP (BVAR (b
, zv_marker
)));
747 m
= BVAR (b
, pt_marker
);
748 SET_BUF_PT_BOTH (b
, marker_position (m
), marker_byte_position (m
));
750 m
= BVAR (b
, begv_marker
);
751 SET_BUF_BEGV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
753 m
= BVAR (b
, zv_marker
);
754 SET_BUF_ZV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
759 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer
, Smake_indirect_buffer
,
761 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
762 doc
: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
763 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
764 NAME should be a string which is not the name of an existing buffer.
765 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
766 such as major and minor modes, in the indirect buffer.
767 CLONE nil means the indirect buffer's state is reset to default values. */)
768 (Lisp_Object base_buffer
, Lisp_Object name
, Lisp_Object clone
)
770 Lisp_Object buf
, tem
;
774 buf
= Fget_buffer (name
);
776 error ("Buffer name `%s' is in use", SDATA (name
));
779 base_buffer
= Fget_buffer (base_buffer
);
780 if (NILP (base_buffer
))
781 error ("No such buffer: `%s'", SDATA (tem
));
782 if (!BUFFER_LIVE_P (XBUFFER (base_buffer
)))
783 error ("Base buffer has been killed");
785 if (SCHARS (name
) == 0)
786 error ("Empty string for buffer name is not allowed");
788 b
= allocate_buffer ();
790 /* No double indirection - if base buffer is indirect,
791 new buffer becomes an indirect to base's base. */
792 b
->base_buffer
= (XBUFFER (base_buffer
)->base_buffer
793 ? XBUFFER (base_buffer
)->base_buffer
794 : XBUFFER (base_buffer
));
796 /* Use the base buffer's text object. */
797 b
->text
= b
->base_buffer
->text
;
798 /* We have no own text. */
799 b
->indirections
= -1;
800 /* Notify base buffer that we share the text now. */
801 b
->base_buffer
->indirections
++;
802 /* Always -1 for an indirect buffer. */
803 b
->window_count
= -1;
805 b
->pt
= b
->base_buffer
->pt
;
806 b
->begv
= b
->base_buffer
->begv
;
807 b
->zv
= b
->base_buffer
->zv
;
808 b
->pt_byte
= b
->base_buffer
->pt_byte
;
809 b
->begv_byte
= b
->base_buffer
->begv_byte
;
810 b
->zv_byte
= b
->base_buffer
->zv_byte
;
812 b
->newline_cache
= 0;
813 b
->width_run_cache
= 0;
814 bset_width_table (b
, Qnil
);
816 name
= Fcopy_sequence (name
);
817 set_string_intervals (name
, NULL
);
821 reset_buffer_local_variables (b
, 1);
823 /* Put this in the alist of all live buffers. */
825 Vbuffer_alist
= nconc2 (Vbuffer_alist
, list1 (Fcons (name
, buf
)));
827 bset_mark (b
, Fmake_marker ());
829 /* The multibyte status belongs to the base buffer. */
830 bset_enable_multibyte_characters
831 (b
, BVAR (b
->base_buffer
, enable_multibyte_characters
));
833 /* Make sure the base buffer has markers for its narrowing. */
834 if (NILP (BVAR (b
->base_buffer
, pt_marker
)))
836 eassert (NILP (BVAR (b
->base_buffer
, begv_marker
)));
837 eassert (NILP (BVAR (b
->base_buffer
, zv_marker
)));
839 bset_pt_marker (b
->base_buffer
,
840 build_marker (b
->base_buffer
, b
->base_buffer
->pt
,
841 b
->base_buffer
->pt_byte
));
843 bset_begv_marker (b
->base_buffer
,
844 build_marker (b
->base_buffer
, b
->base_buffer
->begv
,
845 b
->base_buffer
->begv_byte
));
847 bset_zv_marker (b
->base_buffer
,
848 build_marker (b
->base_buffer
, b
->base_buffer
->zv
,
849 b
->base_buffer
->zv_byte
));
851 XMARKER (BVAR (b
->base_buffer
, zv_marker
))->insertion_type
= 1;
856 /* Give the indirect buffer markers for its narrowing. */
857 bset_pt_marker (b
, build_marker (b
, b
->pt
, b
->pt_byte
));
858 bset_begv_marker (b
, build_marker (b
, b
->begv
, b
->begv_byte
));
859 bset_zv_marker (b
, build_marker (b
, b
->zv
, b
->zv_byte
));
860 XMARKER (BVAR (b
, zv_marker
))->insertion_type
= 1;
864 struct buffer
*old_b
= current_buffer
;
866 clone_per_buffer_values (b
->base_buffer
, b
);
867 bset_filename (b
, Qnil
);
868 bset_file_truename (b
, Qnil
);
869 bset_display_count (b
, make_number (0));
870 bset_backed_up (b
, Qnil
);
871 bset_auto_save_file_name (b
, Qnil
);
872 set_buffer_internal_1 (b
);
873 Fset (intern ("buffer-save-without-query"), Qnil
);
874 Fset (intern ("buffer-file-number"), Qnil
);
875 Fset (intern ("buffer-stale-function"), Qnil
);
876 set_buffer_internal_1 (old_b
);
879 /* Run buffer-list-update-hook. */
880 if (!NILP (Vrun_hooks
))
881 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
886 /* Mark OV as no longer associated with B. */
889 drop_overlay (struct buffer
*b
, struct Lisp_Overlay
*ov
)
891 eassert (b
== XBUFFER (Fmarker_buffer (ov
->start
)));
892 modify_overlay (b
, marker_position (ov
->start
),
893 marker_position (ov
->end
));
894 Fset_marker (ov
->start
, Qnil
, Qnil
);
895 Fset_marker (ov
->end
, Qnil
, Qnil
);
899 /* Delete all overlays of B and reset it's overlay lists. */
902 delete_all_overlays (struct buffer
*b
)
904 struct Lisp_Overlay
*ov
, *next
;
906 /* FIXME: Since each drop_overlay will scan BUF_MARKERS to unlink its
907 markers, we have an unneeded O(N^2) behavior here. */
908 for (ov
= b
->overlays_before
; ov
; ov
= next
)
910 drop_overlay (b
, ov
);
915 for (ov
= b
->overlays_after
; ov
; ov
= next
)
917 drop_overlay (b
, ov
);
922 set_buffer_overlays_before (b
, NULL
);
923 set_buffer_overlays_after (b
, NULL
);
926 /* Reinitialize everything about a buffer except its name and contents
928 If called on an already-initialized buffer, the list of overlays
929 should be deleted before calling this function, otherwise we end up
930 with overlays that claim to belong to the buffer but the buffer
931 claims it doesn't belong to it. */
934 reset_buffer (register struct buffer
*b
)
936 bset_filename (b
, Qnil
);
937 bset_file_truename (b
, Qnil
);
938 bset_directory (b
, current_buffer
? BVAR (current_buffer
, directory
) : Qnil
);
939 b
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
940 b
->modtime_size
= -1;
941 XSETFASTINT (BVAR (b
, save_length
), 0);
942 b
->last_window_start
= 1;
943 /* It is more conservative to start out "changed" than "unchanged". */
945 b
->prevent_redisplay_optimizations_p
= 1;
946 bset_backed_up (b
, Qnil
);
947 BUF_AUTOSAVE_MODIFF (b
) = 0;
948 b
->auto_save_failure_time
= 0;
949 bset_auto_save_file_name (b
, Qnil
);
950 bset_read_only (b
, Qnil
);
951 set_buffer_overlays_before (b
, NULL
);
952 set_buffer_overlays_after (b
, NULL
);
953 b
->overlay_center
= BEG
;
954 bset_mark_active (b
, Qnil
);
955 bset_point_before_scroll (b
, Qnil
);
956 bset_file_format (b
, Qnil
);
957 bset_auto_save_file_format (b
, Qt
);
958 bset_last_selected_window (b
, Qnil
);
959 bset_display_count (b
, make_number (0));
960 bset_display_time (b
, Qnil
);
961 bset_enable_multibyte_characters
962 (b
, BVAR (&buffer_defaults
, enable_multibyte_characters
));
963 bset_cursor_type (b
, BVAR (&buffer_defaults
, cursor_type
));
964 bset_extra_line_spacing (b
, BVAR (&buffer_defaults
, extra_line_spacing
));
966 b
->display_error_modiff
= 0;
969 /* Reset buffer B's local variables info.
970 Don't use this on a buffer that has already been in use;
971 it does not treat permanent locals consistently.
972 Instead, use Fkill_all_local_variables.
974 If PERMANENT_TOO, reset permanent buffer-local variables.
975 If not, preserve those. */
978 reset_buffer_local_variables (struct buffer
*b
, bool permanent_too
)
982 /* Reset the major mode to Fundamental, together with all the
983 things that depend on the major mode.
984 default-major-mode is handled at a higher level.
985 We ignore it here. */
986 bset_major_mode (b
, Qfundamental_mode
);
987 bset_keymap (b
, Qnil
);
988 bset_mode_name (b
, QSFundamental
);
989 bset_minor_modes (b
, Qnil
);
991 /* If the standard case table has been altered and invalidated,
992 fix up its insides first. */
993 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[0])
994 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[1])
995 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[2])))
996 Fset_standard_case_table (Vascii_downcase_table
);
998 bset_downcase_table (b
, Vascii_downcase_table
);
999 bset_upcase_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[0]);
1000 bset_case_canon_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[1]);
1001 bset_case_eqv_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[2]);
1002 bset_invisibility_spec (b
, Qt
);
1004 /* Reset all (or most) per-buffer variables to their defaults. */
1006 bset_local_var_alist (b
, Qnil
);
1009 Lisp_Object tmp
, prop
, last
= Qnil
;
1010 for (tmp
= BVAR (b
, local_var_alist
); CONSP (tmp
); tmp
= XCDR (tmp
))
1011 if (!NILP (prop
= Fget (XCAR (XCAR (tmp
)), Qpermanent_local
)))
1013 /* If permanent-local, keep it. */
1015 if (EQ (prop
, Qpermanent_local_hook
))
1017 /* This is a partially permanent hook variable.
1018 Preserve only the elements that want to be preserved. */
1019 Lisp_Object list
, newlist
;
1020 list
= XCDR (XCAR (tmp
));
1024 for (newlist
= Qnil
; CONSP (list
); list
= XCDR (list
))
1026 Lisp_Object elt
= XCAR (list
);
1027 /* Preserve element ELT if it's t,
1028 if it is a function with a `permanent-local-hook' property,
1029 or if it's not a symbol. */
1032 || !NILP (Fget (elt
, Qpermanent_local_hook
)))
1033 newlist
= Fcons (elt
, newlist
);
1035 XSETCDR (XCAR (tmp
), Fnreverse (newlist
));
1038 /* Delete this local variable. */
1039 else if (NILP (last
))
1040 bset_local_var_alist (b
, XCDR (tmp
));
1042 XSETCDR (last
, XCDR (tmp
));
1045 for (i
= 0; i
< last_per_buffer_idx
; ++i
)
1046 if (permanent_too
|| buffer_permanent_local_flags
[i
] == 0)
1047 SET_PER_BUFFER_VALUE_P (b
, i
, 0);
1049 /* For each slot that has a default value, copy that into the slot. */
1050 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1052 int idx
= PER_BUFFER_IDX (offset
);
1055 || buffer_permanent_local_flags
[idx
] == 0)))
1056 set_per_buffer_value (b
, offset
, per_buffer_default (offset
));
1060 /* We split this away from generate-new-buffer, because rename-buffer
1061 and set-visited-file-name ought to be able to use this to really
1062 rename the buffer properly. */
1064 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name
,
1065 Sgenerate_new_buffer_name
, 1, 2, 0,
1066 doc
: /* Return a string that is the name of no existing buffer based on NAME.
1067 If there is no live buffer named NAME, then return NAME.
1068 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
1069 \(starting at 2) until an unused name is found, and then return that name.
1070 Optional second argument IGNORE specifies a name that is okay to use (if
1071 it is in the sequence to be tried) even if a buffer with that name exists.
1073 If NAME begins with a space (i.e., a buffer that is not normally
1074 visible to users), then if buffer NAME already exists a random number
1075 is first appended to NAME, to speed up finding a non-existent buffer. */)
1076 (register Lisp_Object name
, Lisp_Object ignore
)
1078 register Lisp_Object gentemp
, tem
, tem2
;
1080 char number
[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
1082 CHECK_STRING (name
);
1084 tem
= Fstring_equal (name
, ignore
);
1087 tem
= Fget_buffer (name
);
1091 if (!strncmp (SSDATA (name
), " ", 1)) /* see bug#1229 */
1093 /* Note fileio.c:make_temp_name does random differently. */
1094 tem2
= concat2 (name
, make_formatted_string
1096 XFASTINT (Frandom (make_number (999999)))));
1097 tem
= Fget_buffer (tem2
);
1107 gentemp
= concat2 (tem2
, make_formatted_string
1108 (number
, "<%"pD
"d>", ++count
));
1109 tem
= Fstring_equal (gentemp
, ignore
);
1112 tem
= Fget_buffer (gentemp
);
1119 DEFUN ("buffer-name", Fbuffer_name
, Sbuffer_name
, 0, 1, 0,
1120 doc
: /* Return the name of BUFFER, as a string.
1121 BUFFER defaults to the current buffer.
1122 Return nil if BUFFER has been killed. */)
1123 (register Lisp_Object buffer
)
1126 return BVAR (current_buffer
, name
);
1127 CHECK_BUFFER (buffer
);
1128 return BVAR (XBUFFER (buffer
), name
);
1131 DEFUN ("buffer-file-name", Fbuffer_file_name
, Sbuffer_file_name
, 0, 1, 0,
1132 doc
: /* Return name of file BUFFER is visiting, or nil if none.
1133 No argument or nil as argument means use the current buffer. */)
1134 (register Lisp_Object buffer
)
1137 return BVAR (current_buffer
, filename
);
1138 CHECK_BUFFER (buffer
);
1139 return BVAR (XBUFFER (buffer
), filename
);
1142 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer
, Sbuffer_base_buffer
,
1144 doc
: /* Return the base buffer of indirect buffer BUFFER.
1145 If BUFFER is not indirect, return nil.
1146 BUFFER defaults to the current buffer. */)
1147 (register Lisp_Object buffer
)
1149 struct buffer
*base
;
1150 Lisp_Object base_buffer
;
1153 base
= current_buffer
->base_buffer
;
1156 CHECK_BUFFER (buffer
);
1157 base
= XBUFFER (buffer
)->base_buffer
;
1162 XSETBUFFER (base_buffer
, base
);
1166 DEFUN ("buffer-local-value", Fbuffer_local_value
,
1167 Sbuffer_local_value
, 2, 2, 0,
1168 doc
: /* Return the value of VARIABLE in BUFFER.
1169 If VARIABLE does not have a buffer-local binding in BUFFER, the value
1170 is the default binding of the variable. */)
1171 (register Lisp_Object variable
, register Lisp_Object buffer
)
1173 register Lisp_Object result
= buffer_local_value_1 (variable
, buffer
);
1175 if (EQ (result
, Qunbound
))
1176 xsignal1 (Qvoid_variable
, variable
);
1182 /* Like Fbuffer_local_value, but return Qunbound if the variable is
1186 buffer_local_value_1 (Lisp_Object variable
, Lisp_Object buffer
)
1188 register struct buffer
*buf
;
1189 register Lisp_Object result
;
1190 struct Lisp_Symbol
*sym
;
1192 CHECK_SYMBOL (variable
);
1193 CHECK_BUFFER (buffer
);
1194 buf
= XBUFFER (buffer
);
1195 sym
= XSYMBOL (variable
);
1198 switch (sym
->redirect
)
1200 case SYMBOL_VARALIAS
: sym
= indirect_variable (sym
); goto start
;
1201 case SYMBOL_PLAINVAL
: result
= SYMBOL_VAL (sym
); break;
1202 case SYMBOL_LOCALIZED
:
1203 { /* Look in local_var_alist. */
1204 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (sym
);
1205 XSETSYMBOL (variable
, sym
); /* Update In case of aliasing. */
1206 result
= Fassoc (variable
, BVAR (buf
, local_var_alist
));
1210 { /* What binding is loaded right now? */
1211 Lisp_Object current_alist_element
= blv
->valcell
;
1213 /* The value of the currently loaded binding is not
1214 stored in it, but rather in the realvalue slot.
1215 Store that value into the binding it belongs to
1216 in case that is the one we are about to use. */
1218 XSETCDR (current_alist_element
,
1219 do_symval_forwarding (blv
->fwd
));
1221 /* Now get the (perhaps updated) value out of the binding. */
1222 result
= XCDR (result
);
1225 result
= Fdefault_value (variable
);
1228 case SYMBOL_FORWARDED
:
1230 union Lisp_Fwd
*fwd
= SYMBOL_FWD (sym
);
1231 if (BUFFER_OBJFWDP (fwd
))
1232 result
= per_buffer_value (buf
, XBUFFER_OBJFWD (fwd
)->offset
);
1234 result
= Fdefault_value (variable
);
1237 default: emacs_abort ();
1243 /* Return an alist of the Lisp-level buffer-local bindings of
1244 buffer BUF. That is, don't include the variables maintained
1245 in special slots in the buffer object.
1246 If not CLONE, replace elements of the form (VAR . unbound)
1250 buffer_lisp_local_variables (struct buffer
*buf
, bool clone
)
1252 Lisp_Object result
= Qnil
;
1254 for (tail
= BVAR (buf
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
1256 Lisp_Object val
, elt
;
1260 /* Reference each variable in the alist in buf.
1261 If inquiring about the current buffer, this gets the current values,
1262 so store them into the alist so the alist is up to date.
1263 If inquiring about some other buffer, this swaps out any values
1264 for that buffer, making the alist up to date automatically. */
1265 val
= find_symbol_value (XCAR (elt
));
1266 /* Use the current buffer value only if buf is the current buffer. */
1267 if (buf
!= current_buffer
)
1270 result
= Fcons (!clone
&& EQ (val
, Qunbound
)
1272 : Fcons (XCAR (elt
), val
),
1279 DEFUN ("buffer-local-variables", Fbuffer_local_variables
,
1280 Sbuffer_local_variables
, 0, 1, 0,
1281 doc
: /* Return an alist of variables that are buffer-local in BUFFER.
1282 Most elements look like (SYMBOL . VALUE), describing one variable.
1283 For a symbol that is locally unbound, just the symbol appears in the value.
1284 Note that storing new VALUEs in these elements doesn't change the variables.
1285 No argument or nil as argument means use current buffer as BUFFER. */)
1286 (register Lisp_Object buffer
)
1288 register struct buffer
*buf
;
1289 register Lisp_Object result
;
1292 buf
= current_buffer
;
1295 CHECK_BUFFER (buffer
);
1296 buf
= XBUFFER (buffer
);
1299 result
= buffer_lisp_local_variables (buf
, 0);
1301 /* Add on all the variables stored in special slots. */
1305 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1307 idx
= PER_BUFFER_IDX (offset
);
1308 if ((idx
== -1 || PER_BUFFER_VALUE_P (buf
, idx
))
1309 && SYMBOLP (PER_BUFFER_SYMBOL (offset
)))
1311 Lisp_Object sym
= PER_BUFFER_SYMBOL (offset
);
1312 Lisp_Object val
= per_buffer_value (buf
, offset
);
1313 result
= Fcons (EQ (val
, Qunbound
) ? sym
: Fcons (sym
, val
),
1322 DEFUN ("buffer-modified-p", Fbuffer_modified_p
, Sbuffer_modified_p
,
1324 doc
: /* Return t if BUFFER was modified since its file was last read or saved.
1325 No argument or nil as argument means use current buffer as BUFFER. */)
1326 (register Lisp_Object buffer
)
1328 register struct buffer
*buf
;
1330 buf
= current_buffer
;
1333 CHECK_BUFFER (buffer
);
1334 buf
= XBUFFER (buffer
);
1337 return BUF_SAVE_MODIFF (buf
) < BUF_MODIFF (buf
) ? Qt
: Qnil
;
1340 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p
, Sset_buffer_modified_p
,
1342 doc
: /* Mark current buffer as modified or unmodified according to FLAG.
1343 A non-nil FLAG means mark the buffer modified. */)
1348 #ifdef CLASH_DETECTION
1349 /* If buffer becoming modified, lock the file.
1350 If buffer becoming unmodified, unlock the file. */
1352 struct buffer
*b
= current_buffer
->base_buffer
1353 ? current_buffer
->base_buffer
1356 fn
= BVAR (b
, file_truename
);
1357 /* Test buffer-file-name so that binding it to nil is effective. */
1358 if (!NILP (fn
) && ! NILP (BVAR (b
, filename
)))
1360 bool already
= SAVE_MODIFF
< MODIFF
;
1361 if (!already
&& !NILP (flag
))
1363 else if (already
&& NILP (flag
))
1366 #endif /* CLASH_DETECTION */
1368 /* Here we have a problem. SAVE_MODIFF is used here to encode
1369 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1370 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1371 modify SAVE_MODIFF to affect one, we may affect the other
1373 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1374 if SAVE_MODIFF<auto_save_modified that means we risk changing
1375 recent-auto-save-p from t to nil.
1376 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1377 we risk changing recent-auto-save-p from nil to t. */
1378 SAVE_MODIFF
= (NILP (flag
)
1379 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1381 /* Let's try to preserve recent-auto-save-p. */
1382 : SAVE_MODIFF
< MODIFF
? SAVE_MODIFF
1383 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1384 we can either decrease SAVE_MODIFF and auto_save_modified
1385 or increase MODIFF. */
1388 /* Set update_mode_lines only if buffer is displayed in some window.
1389 Packages like jit-lock or lazy-lock preserve a buffer's modified
1390 state by recording/restoring the state around blocks of code.
1391 Setting update_mode_lines makes redisplay consider all windows
1392 (on all frames). Stealth fontification of buffers not displayed
1393 would incur additional redisplay costs if we'd set
1394 update_modes_lines unconditionally.
1396 Ideally, I think there should be another mechanism for fontifying
1397 buffers without "modifying" buffers, or redisplay should be
1398 smarter about updating the `*' in mode lines. --gerd */
1399 if (buffer_window_count (current_buffer
))
1401 ++update_mode_lines
;
1402 current_buffer
->prevent_redisplay_optimizations_p
= 1;
1408 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p
,
1409 Srestore_buffer_modified_p
, 1, 1, 0,
1410 doc
: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1411 It is not ensured that mode lines will be updated to show the modified
1412 state of the current buffer. Use with care. */)
1415 #ifdef CLASH_DETECTION
1418 /* If buffer becoming modified, lock the file.
1419 If buffer becoming unmodified, unlock the file. */
1421 fn
= BVAR (current_buffer
, file_truename
);
1422 /* Test buffer-file-name so that binding it to nil is effective. */
1423 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1425 bool already
= SAVE_MODIFF
< MODIFF
;
1426 if (!already
&& !NILP (flag
))
1428 else if (already
&& NILP (flag
))
1431 #endif /* CLASH_DETECTION */
1433 SAVE_MODIFF
= NILP (flag
) ? MODIFF
: 0;
1437 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick
, Sbuffer_modified_tick
,
1439 doc
: /* Return BUFFER's tick counter, incremented for each change in text.
1440 Each buffer has a tick counter which is incremented each time the
1441 text in that buffer is changed. It wraps around occasionally.
1442 No argument or nil as argument means use current buffer as BUFFER. */)
1443 (register Lisp_Object buffer
)
1445 register struct buffer
*buf
;
1447 buf
= current_buffer
;
1450 CHECK_BUFFER (buffer
);
1451 buf
= XBUFFER (buffer
);
1454 return make_number (BUF_MODIFF (buf
));
1457 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick
,
1458 Sbuffer_chars_modified_tick
, 0, 1, 0,
1459 doc
: /* Return BUFFER's character-change tick counter.
1460 Each buffer has a character-change tick counter, which is set to the
1461 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1462 time text in that buffer is inserted or deleted. By comparing the
1463 values returned by two individual calls of `buffer-chars-modified-tick',
1464 you can tell whether a character change occurred in that buffer in
1465 between these calls. No argument or nil as argument means use current
1466 buffer as BUFFER. */)
1467 (register Lisp_Object buffer
)
1469 register struct buffer
*buf
;
1471 buf
= current_buffer
;
1474 CHECK_BUFFER (buffer
);
1475 buf
= XBUFFER (buffer
);
1478 return make_number (BUF_CHARS_MODIFF (buf
));
1481 DEFUN ("rename-buffer", Frename_buffer
, Srename_buffer
, 1, 2,
1482 "(list (read-string \"Rename buffer (to new name): \" \
1483 nil 'buffer-name-history (buffer-name (current-buffer))) \
1484 current-prefix-arg)",
1485 doc
: /* Change current buffer's name to NEWNAME (a string).
1486 If second arg UNIQUE is nil or omitted, it is an error if a
1487 buffer named NEWNAME already exists.
1488 If UNIQUE is non-nil, come up with a new name using
1489 `generate-new-buffer-name'.
1490 Interactively, you can set UNIQUE with a prefix argument.
1491 We return the name we actually gave the buffer.
1492 This does not change the name of the visited file (if any). */)
1493 (register Lisp_Object newname
, Lisp_Object unique
)
1495 register Lisp_Object tem
, buf
;
1497 CHECK_STRING (newname
);
1499 if (SCHARS (newname
) == 0)
1500 error ("Empty string is invalid as a buffer name");
1502 tem
= Fget_buffer (newname
);
1505 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1506 rename the buffer automatically so you can create another
1507 with the original name. It makes UNIQUE equivalent to
1508 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1509 if (NILP (unique
) && XBUFFER (tem
) == current_buffer
)
1510 return BVAR (current_buffer
, name
);
1512 newname
= Fgenerate_new_buffer_name (newname
, BVAR (current_buffer
, name
));
1514 error ("Buffer name `%s' is in use", SDATA (newname
));
1517 bset_name (current_buffer
, newname
);
1519 /* Catch redisplay's attention. Unless we do this, the mode lines for
1520 any windows displaying current_buffer will stay unchanged. */
1521 update_mode_lines
++;
1523 XSETBUFFER (buf
, current_buffer
);
1524 Fsetcar (Frassq (buf
, Vbuffer_alist
), newname
);
1525 if (NILP (BVAR (current_buffer
, filename
))
1526 && !NILP (BVAR (current_buffer
, auto_save_file_name
)))
1527 call0 (intern ("rename-auto-save-file"));
1529 /* Run buffer-list-update-hook. */
1530 if (!NILP (Vrun_hooks
))
1531 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1533 /* Refetch since that last call may have done GC. */
1534 return BVAR (current_buffer
, name
);
1537 /* True if B can be used as 'other-than-BUFFER' buffer. */
1540 candidate_buffer (Lisp_Object b
, Lisp_Object buffer
)
1542 return (BUFFERP (b
) && !EQ (b
, buffer
)
1543 && BUFFER_LIVE_P (XBUFFER (b
))
1544 && !BUFFER_HIDDEN_P (XBUFFER (b
)));
1547 DEFUN ("other-buffer", Fother_buffer
, Sother_buffer
, 0, 3, 0,
1548 doc
: /* Return most recently selected buffer other than BUFFER.
1549 Buffers not visible in windows are preferred to visible buffers, unless
1550 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1551 BUFFER unless it denotes a live buffer. If the optional third argument
1552 FRAME is non-nil, use that frame's buffer list instead of the selected
1553 frame's buffer list.
1555 The buffer is found by scanning the selected or specified frame's buffer
1556 list first, followed by the list of all buffers. If no other buffer
1557 exists, return the buffer `*scratch*' (creating it if necessary). */)
1558 (register Lisp_Object buffer
, Lisp_Object visible_ok
, Lisp_Object frame
)
1560 struct frame
*f
= decode_any_frame (frame
);
1561 Lisp_Object tail
= f
->buffer_list
, pred
= f
->buffer_predicate
;
1562 Lisp_Object buf
, notsogood
= Qnil
;
1564 /* Consider buffers that have been seen in the frame first. */
1565 for (; CONSP (tail
); tail
= XCDR (tail
))
1568 if (candidate_buffer (buf
, buffer
)
1569 /* If the frame has a buffer_predicate, disregard buffers that
1570 don't fit the predicate. */
1571 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1573 if (!NILP (visible_ok
)
1574 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1576 else if (NILP (notsogood
))
1581 /* Consider alist of all buffers next. */
1582 tail
= Vbuffer_alist
;
1583 for (; CONSP (tail
); tail
= XCDR (tail
))
1585 buf
= Fcdr (XCAR (tail
));
1586 if (candidate_buffer (buf
, buffer
)
1587 /* If the frame has a buffer_predicate, disregard buffers that
1588 don't fit the predicate. */
1589 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1591 if (!NILP (visible_ok
)
1592 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1594 else if (NILP (notsogood
))
1599 if (!NILP (notsogood
))
1603 buf
= Fget_buffer (build_string ("*scratch*"));
1606 buf
= Fget_buffer_create (build_string ("*scratch*"));
1607 Fset_buffer_major_mode (buf
);
1613 /* The following function is a safe variant of Fother_buffer: It doesn't
1614 pay attention to any frame-local buffer lists, doesn't care about
1615 visibility of buffers, and doesn't evaluate any frame predicates. */
1618 other_buffer_safely (Lisp_Object buffer
)
1620 Lisp_Object tail
, buf
;
1622 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
1624 buf
= Fcdr (XCAR (tail
));
1625 if (candidate_buffer (buf
, buffer
))
1629 buf
= Fget_buffer (build_string ("*scratch*"));
1632 buf
= Fget_buffer_create (build_string ("*scratch*"));
1633 Fset_buffer_major_mode (buf
);
1639 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo
, Sbuffer_enable_undo
,
1641 doc
: /* Start keeping undo information for buffer BUFFER.
1642 No argument or nil as argument means do this for the current buffer. */)
1643 (register Lisp_Object buffer
)
1645 Lisp_Object real_buffer
;
1648 XSETBUFFER (real_buffer
, current_buffer
);
1651 real_buffer
= Fget_buffer (buffer
);
1652 if (NILP (real_buffer
))
1656 if (EQ (BVAR (XBUFFER (real_buffer
), undo_list
), Qt
))
1657 bset_undo_list (XBUFFER (real_buffer
), Qnil
);
1662 /* Truncate undo list and shrink the gap of BUFFER. */
1665 compact_buffer (struct buffer
*buffer
)
1667 BUFFER_CHECK_INDIRECTION (buffer
);
1669 /* Skip dead buffers, indirect buffers and buffers
1670 which aren't changed since last compaction. */
1671 if (BUFFER_LIVE_P (buffer
)
1672 && (buffer
->base_buffer
== NULL
)
1673 && (BUF_COMPACT (buffer
) != BUF_MODIFF (buffer
)))
1675 /* If a buffer's undo list is Qt, that means that undo is
1676 turned off in that buffer. Calling truncate_undo_list on
1677 Qt tends to return NULL, which effectively turns undo back on.
1678 So don't call truncate_undo_list if undo_list is Qt. */
1679 if (!EQ (buffer
->INTERNAL_FIELD (undo_list
), Qt
))
1680 truncate_undo_list (buffer
);
1682 /* Shrink buffer gaps. */
1683 if (!buffer
->text
->inhibit_shrinking
)
1685 /* If a buffer's gap size is more than 10% of the buffer
1686 size, or larger than GAP_BYTES_DFL bytes, then shrink it
1687 accordingly. Keep a minimum size of GAP_BYTES_MIN bytes. */
1688 ptrdiff_t size
= clip_to_bounds (GAP_BYTES_MIN
,
1689 BUF_Z_BYTE (buffer
) / 10,
1691 if (BUF_GAP_SIZE (buffer
) > size
)
1692 make_gap_1 (buffer
, -(BUF_GAP_SIZE (buffer
) - size
));
1694 BUF_COMPACT (buffer
) = BUF_MODIFF (buffer
);
1698 DEFUN ("kill-buffer", Fkill_buffer
, Skill_buffer
, 0, 1, "bKill buffer: ",
1699 doc
: /* Kill the buffer specified by BUFFER-OR-NAME.
1700 The argument may be a buffer or the name of an existing buffer.
1701 Argument nil or omitted means kill the current buffer. Return t if the
1702 buffer is actually killed, nil otherwise.
1704 The functions in `kill-buffer-query-functions' are called with the
1705 buffer to be killed as the current buffer. If any of them returns nil,
1706 the buffer is not killed. The hook `kill-buffer-hook' is run before the
1707 buffer is actually killed. The buffer being killed will be current
1708 while the hook is running. Functions called by any of these hooks are
1709 supposed to not change the current buffer.
1711 Any processes that have this buffer as the `process-buffer' are killed
1712 with SIGHUP. This function calls `replace-buffer-in-windows' for
1713 cleaning up all windows currently displaying the buffer to be killed. */)
1714 (Lisp_Object buffer_or_name
)
1717 register struct buffer
*b
;
1718 register Lisp_Object tem
;
1719 register struct Lisp_Marker
*m
;
1720 struct gcpro gcpro1
;
1722 if (NILP (buffer_or_name
))
1723 buffer
= Fcurrent_buffer ();
1725 buffer
= Fget_buffer (buffer_or_name
);
1727 nsberror (buffer_or_name
);
1729 b
= XBUFFER (buffer
);
1731 /* Avoid trouble for buffer already dead. */
1732 if (!BUFFER_LIVE_P (b
))
1735 if (thread_check_current_buffer (b
))
1738 /* Run hooks with the buffer to be killed the current buffer. */
1740 ptrdiff_t count
= SPECPDL_INDEX ();
1741 Lisp_Object arglist
[1];
1743 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1744 set_buffer_internal (b
);
1746 /* First run the query functions; if any query is answered no,
1747 don't kill the buffer. */
1748 arglist
[0] = Qkill_buffer_query_functions
;
1749 tem
= Frun_hook_with_args_until_failure (1, arglist
);
1751 return unbind_to (count
, Qnil
);
1753 /* Query if the buffer is still modified. */
1754 if (INTERACTIVE
&& !NILP (BVAR (b
, filename
))
1755 && BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
1758 tem
= do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1759 BVAR (b
, name
), make_number (0)));
1762 return unbind_to (count
, Qnil
);
1765 /* If the hooks have killed the buffer, exit now. */
1766 if (!BUFFER_LIVE_P (b
))
1767 return unbind_to (count
, Qt
);
1769 /* Then run the hooks. */
1770 Frun_hooks (1, &Qkill_buffer_hook
);
1771 unbind_to (count
, Qnil
);
1774 /* If the hooks have killed the buffer, exit now. */
1775 if (!BUFFER_LIVE_P (b
))
1778 /* We have no more questions to ask. Verify that it is valid
1779 to kill the buffer. This must be done after the questions
1780 since anything can happen within do_yes_or_no_p. */
1782 /* Don't kill the minibuffer now current. */
1783 if (EQ (buffer
, XWINDOW (minibuf_window
)->contents
))
1786 /* When we kill an ordinary buffer which shares it's buffer text
1787 with indirect buffer(s), we must kill indirect buffer(s) too.
1788 We do it at this stage so nothing terrible happens if they
1789 ask questions or their hooks get errors. */
1790 if (!b
->base_buffer
&& b
->indirections
> 0)
1792 struct buffer
*other
;
1796 FOR_EACH_BUFFER (other
)
1797 if (other
->base_buffer
== b
)
1800 XSETBUFFER (buf
, other
);
1806 /* Exit if we now have killed the base buffer (Bug#11665). */
1807 if (!BUFFER_LIVE_P (b
))
1811 /* Run replace_buffer_in_windows before making another buffer current
1812 since set-window-buffer-start-and-point will refuse to make another
1813 buffer current if the selected window does not show the current
1814 buffer. (Bug#10114) */
1815 replace_buffer_in_windows (buffer
);
1817 /* Exit if replacing the buffer in windows has killed our buffer. */
1818 if (!BUFFER_LIVE_P (b
))
1821 /* Make this buffer not be current. Exit if it is the sole visible
1823 if (b
== current_buffer
)
1825 tem
= Fother_buffer (buffer
, Qnil
, Qnil
);
1827 if (b
== current_buffer
)
1831 /* If the buffer now current is shown in the minibuffer and our buffer
1832 is the sole other buffer give up. */
1833 XSETBUFFER (tem
, current_buffer
);
1834 if (EQ (tem
, XWINDOW (minibuf_window
)->contents
)
1835 && EQ (buffer
, Fother_buffer (buffer
, Qnil
, Qnil
)))
1838 /* Now there is no question: we can kill the buffer. */
1840 #ifdef CLASH_DETECTION
1841 /* Unlock this buffer's file, if it is locked. */
1843 #endif /* CLASH_DETECTION */
1846 kill_buffer_processes (buffer
);
1849 /* Killing buffer processes may run sentinels which may have killed
1851 if (!BUFFER_LIVE_P (b
))
1854 /* These may run Lisp code and into infinite loops (if someone
1855 insisted on circular lists) so allow quitting here. */
1856 frames_discard_buffer (buffer
);
1858 clear_charpos_cache (b
);
1860 tem
= Vinhibit_quit
;
1862 /* Remove the buffer from the list of all buffers. */
1863 Vbuffer_alist
= Fdelq (Frassq (buffer
, Vbuffer_alist
), Vbuffer_alist
);
1864 /* If replace_buffer_in_windows didn't do its job fix that now. */
1865 replace_buffer_in_windows_safely (buffer
);
1866 Vinhibit_quit
= tem
;
1868 /* Delete any auto-save file, if we saved it in this session.
1869 But not if the buffer is modified. */
1870 if (STRINGP (BVAR (b
, auto_save_file_name
))
1871 && BUF_AUTOSAVE_MODIFF (b
) != 0
1872 && BUF_SAVE_MODIFF (b
) < BUF_AUTOSAVE_MODIFF (b
)
1873 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
1874 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1877 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1878 if (! NILP (delete))
1879 internal_delete_file (BVAR (b
, auto_save_file_name
));
1882 /* Deleting an auto-save file could have killed our buffer. */
1883 if (!BUFFER_LIVE_P (b
))
1888 /* Unchain all markers that belong to this indirect buffer.
1889 Don't unchain the markers that belong to the base buffer
1890 or its other indirect buffers. */
1891 struct Lisp_Marker
**mp
= &BUF_MARKERS (b
);
1905 /* Unchain all markers of this buffer and its indirect buffers.
1906 and leave them pointing nowhere. */
1907 for (m
= BUF_MARKERS (b
); m
; )
1909 struct Lisp_Marker
*next
= m
->next
;
1914 BUF_MARKERS (b
) = NULL
;
1915 set_buffer_intervals (b
, NULL
);
1917 /* Perhaps we should explicitly free the interval tree here... */
1919 /* Since we've unlinked the markers, the overlays can't be here any more
1921 b
->overlays_before
= NULL
;
1922 b
->overlays_after
= NULL
;
1924 /* Reset the local variables, so that this buffer's local values
1925 won't be protected from GC. They would be protected
1926 if they happened to remain cached in their symbols.
1927 This gets rid of them for certain. */
1928 swap_out_buffer_local_variables (b
);
1929 reset_buffer_local_variables (b
, 1);
1931 bset_name (b
, Qnil
);
1936 /* Notify our base buffer that we don't share the text anymore. */
1937 eassert (b
->indirections
== -1);
1938 b
->base_buffer
->indirections
--;
1939 eassert (b
->base_buffer
->indirections
>= 0);
1940 /* Make sure that we wasn't confused. */
1941 eassert (b
->window_count
== -1);
1945 /* Make sure that no one shows us. */
1946 eassert (b
->window_count
== 0);
1947 /* No one shares our buffer text, can free it. */
1948 free_buffer_text (b
);
1951 if (b
->newline_cache
)
1953 free_region_cache (b
->newline_cache
);
1954 b
->newline_cache
= 0;
1956 if (b
->width_run_cache
)
1958 free_region_cache (b
->width_run_cache
);
1959 b
->width_run_cache
= 0;
1961 bset_width_table (b
, Qnil
);
1963 bset_undo_list (b
, Qnil
);
1965 /* Run buffer-list-update-hook. */
1966 if (!NILP (Vrun_hooks
))
1967 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1972 /* Move association for BUFFER to the front of buffer (a)lists. Since
1973 we do this each time BUFFER is selected visibly, the more recently
1974 selected buffers are always closer to the front of those lists. This
1975 means that other_buffer is more likely to choose a relevant buffer.
1977 Note that this moves BUFFER to the front of the buffer lists of the
1978 selected frame even if BUFFER is not shown there. If BUFFER is not
1979 shown in the selected frame, consider the present behavior a feature.
1980 `select-window' gets this right since it shows BUFFER in the selected
1981 window when calling us. */
1984 record_buffer (Lisp_Object buffer
)
1986 Lisp_Object aelt
, aelt_cons
, tem
;
1987 register struct frame
*f
= XFRAME (selected_frame
);
1989 CHECK_BUFFER (buffer
);
1991 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1992 Don't allow quitting since this might leave the buffer list in an
1993 inconsistent state. */
1994 tem
= Vinhibit_quit
;
1996 aelt
= Frassq (buffer
, Vbuffer_alist
);
1997 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
1998 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
1999 XSETCDR (aelt_cons
, Vbuffer_alist
);
2000 Vbuffer_alist
= aelt_cons
;
2001 Vinhibit_quit
= tem
;
2003 /* Update buffer list of selected frame. */
2004 fset_buffer_list (f
, Fcons (buffer
, Fdelq (buffer
, f
->buffer_list
)));
2005 fset_buried_buffer_list (f
, Fdelq (buffer
, f
->buried_buffer_list
));
2007 /* Run buffer-list-update-hook. */
2008 if (!NILP (Vrun_hooks
))
2009 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
2013 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
2014 buffer is killed. For the selected frame's buffer list this moves
2015 BUFFER to its end even if it was never shown in that frame. If
2016 this happens we have a feature, hence `bury-buffer-internal' should be
2017 called only when BUFFER was shown in the selected frame. */
2019 DEFUN ("bury-buffer-internal", Fbury_buffer_internal
, Sbury_buffer_internal
,
2021 doc
: /* Move BUFFER to the end of the buffer list. */)
2022 (Lisp_Object buffer
)
2024 Lisp_Object aelt
, aelt_cons
, tem
;
2025 register struct frame
*f
= XFRAME (selected_frame
);
2027 CHECK_BUFFER (buffer
);
2029 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
2030 Don't allow quitting since this might leave the buffer list in an
2031 inconsistent state. */
2032 tem
= Vinhibit_quit
;
2034 aelt
= Frassq (buffer
, Vbuffer_alist
);
2035 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
2036 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
2037 XSETCDR (aelt_cons
, Qnil
);
2038 Vbuffer_alist
= nconc2 (Vbuffer_alist
, aelt_cons
);
2039 Vinhibit_quit
= tem
;
2041 /* Update buffer lists of selected frame. */
2042 fset_buffer_list (f
, Fdelq (buffer
, f
->buffer_list
));
2043 fset_buried_buffer_list
2044 (f
, Fcons (buffer
, Fdelq (buffer
, f
->buried_buffer_list
)));
2046 /* Run buffer-list-update-hook. */
2047 if (!NILP (Vrun_hooks
))
2048 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
2053 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode
, Sset_buffer_major_mode
, 1, 1, 0,
2054 doc
: /* Set an appropriate major mode for BUFFER.
2055 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
2056 according to the default value of `major-mode'.
2057 Use this function before selecting the buffer, since it may need to inspect
2058 the current buffer's major mode. */)
2059 (Lisp_Object buffer
)
2062 Lisp_Object function
;
2064 CHECK_BUFFER (buffer
);
2066 if (!BUFFER_LIVE_P (XBUFFER (buffer
)))
2067 error ("Attempt to set major mode for a dead buffer");
2069 if (strcmp (SSDATA (BVAR (XBUFFER (buffer
), name
)), "*scratch*") == 0)
2070 function
= find_symbol_value (intern ("initial-major-mode"));
2073 function
= BVAR (&buffer_defaults
, major_mode
);
2075 && NILP (Fget (BVAR (current_buffer
, major_mode
), Qmode_class
)))
2076 function
= BVAR (current_buffer
, major_mode
);
2079 if (NILP (function
) || EQ (function
, Qfundamental_mode
))
2082 count
= SPECPDL_INDEX ();
2084 /* To select a nonfundamental mode,
2085 select the buffer temporarily and then call the mode function. */
2087 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
2089 Fset_buffer (buffer
);
2092 return unbind_to (count
, Qnil
);
2095 DEFUN ("current-buffer", Fcurrent_buffer
, Scurrent_buffer
, 0, 0, 0,
2096 doc
: /* Return the current buffer as a Lisp object. */)
2099 register Lisp_Object buf
;
2100 XSETBUFFER (buf
, current_buffer
);
2104 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
2105 This is used by redisplay. */
2108 set_buffer_internal_1 (register struct buffer
*b
)
2110 register struct buffer
*old_buf
;
2111 register Lisp_Object tail
;
2113 #ifdef USE_MMAP_FOR_BUFFERS
2114 if (b
->text
->beg
== NULL
)
2115 enlarge_buffer_text (b
, 0);
2116 #endif /* USE_MMAP_FOR_BUFFERS */
2118 if (current_buffer
== b
)
2121 BUFFER_CHECK_INDIRECTION (b
);
2123 old_buf
= current_buffer
;
2125 last_known_column_point
= -1; /* invalidate indentation cache */
2129 /* Put the undo list back in the base buffer, so that it appears
2130 that an indirect buffer shares the undo list of its base. */
2131 if (old_buf
->base_buffer
)
2132 bset_undo_list (old_buf
->base_buffer
, BVAR (old_buf
, undo_list
));
2134 /* If the old current buffer has markers to record PT, BEGV and ZV
2135 when it is not current, update them now. */
2136 record_buffer_markers (old_buf
);
2139 /* Get the undo list from the base buffer, so that it appears
2140 that an indirect buffer shares the undo list of its base. */
2142 bset_undo_list (b
, BVAR (b
->base_buffer
, undo_list
));
2144 /* If the new current buffer has markers to record PT, BEGV and ZV
2145 when it is not current, fetch them now. */
2146 fetch_buffer_markers (b
);
2148 /* Look down buffer's list of local Lisp variables
2149 to find and update any that forward into C variables. */
2153 for (tail
= BVAR (b
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
2155 Lisp_Object var
= XCAR (XCAR (tail
));
2156 struct Lisp_Symbol
*sym
= XSYMBOL (var
);
2157 if (sym
->redirect
== SYMBOL_LOCALIZED
/* Just to be sure. */
2158 && SYMBOL_BLV (sym
)->fwd
)
2159 /* Just reference the variable
2160 to cause it to become set for this buffer. */
2161 Fsymbol_value (var
);
2164 /* Do the same with any others that were local to the previous buffer */
2165 while (b
!= old_buf
&& (b
= old_buf
, b
));
2168 /* Switch to buffer B temporarily for redisplay purposes.
2169 This avoids certain things that don't need to be done within redisplay. */
2172 set_buffer_temp (struct buffer
*b
)
2174 register struct buffer
*old_buf
;
2176 if (current_buffer
== b
)
2179 old_buf
= current_buffer
;
2182 /* If the old current buffer has markers to record PT, BEGV and ZV
2183 when it is not current, update them now. */
2184 record_buffer_markers (old_buf
);
2186 /* If the new current buffer has markers to record PT, BEGV and ZV
2187 when it is not current, fetch them now. */
2188 fetch_buffer_markers (b
);
2191 DEFUN ("set-buffer", Fset_buffer
, Sset_buffer
, 1, 1, 0,
2192 doc
: /* Make buffer BUFFER-OR-NAME current for editing operations.
2193 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
2194 also `with-current-buffer' when you want to make a buffer current
2195 temporarily. This function does not display the buffer, so its effect
2196 ends when the current command terminates. Use `switch-to-buffer' or
2197 `pop-to-buffer' to switch buffers permanently. */)
2198 (register Lisp_Object buffer_or_name
)
2200 register Lisp_Object buffer
;
2201 buffer
= Fget_buffer (buffer_or_name
);
2203 nsberror (buffer_or_name
);
2204 if (!BUFFER_LIVE_P (XBUFFER (buffer
)))
2205 error ("Selecting deleted buffer");
2206 set_buffer_internal (XBUFFER (buffer
));
2211 restore_buffer (Lisp_Object buffer_or_name
)
2213 Fset_buffer (buffer_or_name
);
2216 /* Set the current buffer to BUFFER provided if it is alive. */
2219 set_buffer_if_live (Lisp_Object buffer
)
2221 if (BUFFER_LIVE_P (XBUFFER (buffer
)))
2222 set_buffer_internal (XBUFFER (buffer
));
2225 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only
,
2226 Sbarf_if_buffer_read_only
, 0, 0, 0,
2227 doc
: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2230 if (!NILP (BVAR (current_buffer
, read_only
))
2231 && NILP (Vinhibit_read_only
))
2232 xsignal1 (Qbuffer_read_only
, Fcurrent_buffer ());
2236 DEFUN ("erase-buffer", Ferase_buffer
, Serase_buffer
, 0, 0, "*",
2237 doc
: /* Delete the entire contents of the current buffer.
2238 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2239 so the buffer is truly empty after this. */)
2246 current_buffer
->last_window_start
= 1;
2247 /* Prevent warnings, or suspension of auto saving, that would happen
2248 if future size is less than past size. Use of erase-buffer
2249 implies that the future text is not really related to the past text. */
2250 XSETFASTINT (BVAR (current_buffer
, save_length
), 0);
2255 validate_region (register Lisp_Object
*b
, register Lisp_Object
*e
)
2257 CHECK_NUMBER_COERCE_MARKER (*b
);
2258 CHECK_NUMBER_COERCE_MARKER (*e
);
2260 if (XINT (*b
) > XINT (*e
))
2263 tem
= *b
; *b
= *e
; *e
= tem
;
2266 if (! (BEGV
<= XINT (*b
) && XINT (*e
) <= ZV
))
2267 args_out_of_range (*b
, *e
);
2270 /* Advance BYTE_POS up to a character boundary
2271 and return the adjusted position. */
2274 advance_to_char_boundary (ptrdiff_t byte_pos
)
2278 if (byte_pos
== BEG
)
2279 /* Beginning of buffer is always a character boundary. */
2282 c
= FETCH_BYTE (byte_pos
);
2283 if (! CHAR_HEAD_P (c
))
2285 /* We should advance BYTE_POS only when C is a constituent of a
2286 multibyte sequence. */
2287 ptrdiff_t orig_byte_pos
= byte_pos
;
2292 c
= FETCH_BYTE (byte_pos
);
2294 while (! CHAR_HEAD_P (c
) && byte_pos
> BEG
);
2296 if (byte_pos
< orig_byte_pos
)
2297 byte_pos
= orig_byte_pos
;
2298 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2299 surely advance to the correct character boundary. If C is
2300 not, BYTE_POS was unchanged. */
2306 DEFUN ("buffer-swap-text", Fbuffer_swap_text
, Sbuffer_swap_text
,
2308 doc
: /* Swap the text between current buffer and BUFFER. */)
2309 (Lisp_Object buffer
)
2311 struct buffer
*other_buffer
;
2312 CHECK_BUFFER (buffer
);
2313 other_buffer
= XBUFFER (buffer
);
2315 if (!BUFFER_LIVE_P (other_buffer
))
2316 error ("Cannot swap a dead buffer's text");
2318 /* Actually, it probably works just fine.
2319 * if (other_buffer == current_buffer)
2320 * error ("Cannot swap a buffer's text with itself"); */
2322 /* Actually, this may be workable as well, tho probably only if they're
2324 if (other_buffer
->base_buffer
2325 || current_buffer
->base_buffer
)
2326 error ("Cannot swap indirect buffers's text");
2328 { /* This is probably harder to make work. */
2329 struct buffer
*other
;
2330 FOR_EACH_BUFFER (other
)
2331 if (other
->base_buffer
== other_buffer
2332 || other
->base_buffer
== current_buffer
)
2333 error ("One of the buffers to swap has indirect buffers");
2336 #define swapfield(field, type) \
2338 type tmp##field = other_buffer->field; \
2339 other_buffer->field = current_buffer->field; \
2340 current_buffer->field = tmp##field; \
2342 #define swapfield_(field, type) \
2344 type tmp##field = BVAR (other_buffer, field); \
2345 bset_##field (other_buffer, BVAR (current_buffer, field)); \
2346 bset_##field (current_buffer, tmp##field); \
2349 swapfield (own_text
, struct buffer_text
);
2350 eassert (current_buffer
->text
== ¤t_buffer
->own_text
);
2351 eassert (other_buffer
->text
== &other_buffer
->own_text
);
2353 r_alloc_reset_variable ((void **) ¤t_buffer
->own_text
.beg
,
2354 (void **) &other_buffer
->own_text
.beg
);
2355 r_alloc_reset_variable ((void **) &other_buffer
->own_text
.beg
,
2356 (void **) ¤t_buffer
->own_text
.beg
);
2357 #endif /* REL_ALLOC */
2359 swapfield (pt
, ptrdiff_t);
2360 swapfield (pt_byte
, ptrdiff_t);
2361 swapfield (begv
, ptrdiff_t);
2362 swapfield (begv_byte
, ptrdiff_t);
2363 swapfield (zv
, ptrdiff_t);
2364 swapfield (zv_byte
, ptrdiff_t);
2365 eassert (!current_buffer
->base_buffer
);
2366 eassert (!other_buffer
->base_buffer
);
2367 swapfield (indirections
, ptrdiff_t);
2368 current_buffer
->clip_changed
= 1; other_buffer
->clip_changed
= 1;
2369 swapfield (newline_cache
, struct region_cache
*);
2370 swapfield (width_run_cache
, struct region_cache
*);
2371 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2372 other_buffer
->prevent_redisplay_optimizations_p
= 1;
2373 swapfield (overlays_before
, struct Lisp_Overlay
*);
2374 swapfield (overlays_after
, struct Lisp_Overlay
*);
2375 swapfield (overlay_center
, ptrdiff_t);
2376 swapfield_ (undo_list
, Lisp_Object
);
2377 swapfield_ (mark
, Lisp_Object
);
2378 swapfield_ (enable_multibyte_characters
, Lisp_Object
);
2379 swapfield_ (bidi_display_reordering
, Lisp_Object
);
2380 swapfield_ (bidi_paragraph_direction
, Lisp_Object
);
2381 /* FIXME: Not sure what we should do with these *_marker fields.
2382 Hopefully they're just nil anyway. */
2383 swapfield_ (pt_marker
, Lisp_Object
);
2384 swapfield_ (begv_marker
, Lisp_Object
);
2385 swapfield_ (zv_marker
, Lisp_Object
);
2386 bset_point_before_scroll (current_buffer
, Qnil
);
2387 bset_point_before_scroll (other_buffer
, Qnil
);
2389 current_buffer
->text
->modiff
++; other_buffer
->text
->modiff
++;
2390 current_buffer
->text
->chars_modiff
++; other_buffer
->text
->chars_modiff
++;
2391 current_buffer
->text
->overlay_modiff
++; other_buffer
->text
->overlay_modiff
++;
2392 current_buffer
->text
->beg_unchanged
= current_buffer
->text
->gpt
;
2393 current_buffer
->text
->end_unchanged
= current_buffer
->text
->gpt
;
2394 other_buffer
->text
->beg_unchanged
= other_buffer
->text
->gpt
;
2395 other_buffer
->text
->end_unchanged
= other_buffer
->text
->gpt
;
2397 struct Lisp_Marker
*m
;
2398 for (m
= BUF_MARKERS (current_buffer
); m
; m
= m
->next
)
2399 if (m
->buffer
== other_buffer
)
2400 m
->buffer
= current_buffer
;
2402 /* Since there's no indirect buffer in sight, markers on
2403 BUF_MARKERS(buf) should either be for `buf' or dead. */
2404 eassert (!m
->buffer
);
2405 for (m
= BUF_MARKERS (other_buffer
); m
; m
= m
->next
)
2406 if (m
->buffer
== current_buffer
)
2407 m
->buffer
= other_buffer
;
2409 /* Since there's no indirect buffer in sight, markers on
2410 BUF_MARKERS(buf) should either be for `buf' or dead. */
2411 eassert (!m
->buffer
);
2413 { /* Some of the C code expects that both window markers of a
2414 live window points to that window's buffer. So since we
2415 just swapped the markers between the two buffers, we need
2416 to undo the effect of this swap for window markers. */
2417 Lisp_Object w
= Fselected_window (), ws
= Qnil
;
2418 Lisp_Object buf1
, buf2
;
2419 XSETBUFFER (buf1
, current_buffer
); XSETBUFFER (buf2
, other_buffer
);
2421 while (NILP (Fmemq (w
, ws
)))
2424 if (MARKERP (XWINDOW (w
)->pointm
)
2425 && (EQ (XWINDOW (w
)->contents
, buf1
)
2426 || EQ (XWINDOW (w
)->contents
, buf2
)))
2427 Fset_marker (XWINDOW (w
)->pointm
,
2429 (BUF_BEGV (XBUFFER (XWINDOW (w
)->contents
))),
2430 XWINDOW (w
)->contents
);
2431 if (MARKERP (XWINDOW (w
)->start
)
2432 && (EQ (XWINDOW (w
)->contents
, buf1
)
2433 || EQ (XWINDOW (w
)->contents
, buf2
)))
2434 Fset_marker (XWINDOW (w
)->start
,
2436 (XBUFFER (XWINDOW (w
)->contents
)->last_window_start
),
2437 XWINDOW (w
)->contents
);
2438 w
= Fnext_window (w
, Qt
, Qt
);
2442 if (current_buffer
->text
->intervals
)
2443 (eassert (EQ (current_buffer
->text
->intervals
->up
.obj
, buffer
)),
2444 XSETBUFFER (current_buffer
->text
->intervals
->up
.obj
, current_buffer
));
2445 if (other_buffer
->text
->intervals
)
2446 (eassert (EQ (other_buffer
->text
->intervals
->up
.obj
, Fcurrent_buffer ())),
2447 XSETBUFFER (other_buffer
->text
->intervals
->up
.obj
, other_buffer
));
2452 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte
, Sset_buffer_multibyte
,
2454 doc
: /* Set the multibyte flag of the current buffer to FLAG.
2455 If FLAG is t, this makes the buffer a multibyte buffer.
2456 If FLAG is nil, this makes the buffer a single-byte buffer.
2457 In these cases, the buffer contents remain unchanged as a sequence of
2458 bytes but the contents viewed as characters do change.
2459 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2460 all eight-bit bytes to eight-bit characters.
2461 If the multibyte flag was really changed, undo information of the
2462 current buffer is cleared. */)
2465 struct Lisp_Marker
*tail
, *markers
;
2466 struct buffer
*other
;
2468 bool narrowed
= (BEG
!= BEGV
|| Z
!= ZV
);
2469 bool modified_p
= !NILP (Fbuffer_modified_p (Qnil
));
2470 Lisp_Object old_undo
= BVAR (current_buffer
, undo_list
);
2471 struct gcpro gcpro1
;
2473 if (current_buffer
->base_buffer
)
2474 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2476 /* Do nothing if nothing actually changes. */
2477 if (NILP (flag
) == NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2482 /* Don't record these buffer changes. We will put a special undo entry
2484 bset_undo_list (current_buffer
, Qt
);
2486 /* If the cached position is for this buffer, clear it out. */
2487 clear_charpos_cache (current_buffer
);
2490 begv
= BEGV_BYTE
, zv
= ZV_BYTE
;
2492 begv
= BEGV
, zv
= ZV
;
2495 error ("Changing multibyteness in a narrowed buffer");
2499 ptrdiff_t pos
, stop
;
2502 /* Do this first, so it can use CHAR_TO_BYTE
2503 to calculate the old correspondences. */
2504 set_intervals_multibyte (0);
2506 bset_enable_multibyte_characters (current_buffer
, Qnil
);
2512 TEMP_SET_PT_BOTH (PT_BYTE
, PT_BYTE
);
2515 for (tail
= BUF_MARKERS (current_buffer
); tail
; tail
= tail
->next
)
2516 tail
->charpos
= tail
->bytepos
;
2518 /* Convert multibyte form of 8-bit characters to unibyte. */
2533 if (ASCII_BYTE_P (*p
))
2535 else if (CHAR_BYTE8_HEAD_P (*p
))
2537 c
= STRING_CHAR_AND_LENGTH (p
, bytes
);
2538 /* Delete all bytes for this 8-bit character but the
2539 last one, and change the last one to the character
2542 del_range_2 (pos
, pos
, pos
+ bytes
, pos
+ bytes
, 0);
2554 bytes
= BYTES_BY_CHAR_HEAD (*p
);
2555 p
+= bytes
, pos
+= bytes
;
2559 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2564 ptrdiff_t pos
, stop
;
2565 unsigned char *p
, *pend
;
2567 /* Be sure not to have a multibyte sequence striding over the GAP.
2568 Ex: We change this: "...abc\302 _GAP_ \241def..."
2569 to: "...abc _GAP_ \302\241def..." */
2572 && GPT_BYTE
> 1 && GPT_BYTE
< Z_BYTE
2573 && ! CHAR_HEAD_P (*(GAP_END_ADDR
)))
2575 unsigned char *q
= GPT_ADDR
- 1;
2577 while (! CHAR_HEAD_P (*q
) && q
> BEG_ADDR
) q
--;
2578 if (LEADING_CODE_P (*q
))
2580 ptrdiff_t new_gpt
= GPT_BYTE
- (GPT_ADDR
- q
);
2582 move_gap_both (new_gpt
, new_gpt
);
2586 /* Make the buffer contents valid as multibyte by converting
2587 8-bit characters to multibyte form. */
2605 if (ASCII_BYTE_P (*p
))
2607 else if (EQ (flag
, Qt
)
2608 && ! CHAR_BYTE8_HEAD_P (*p
)
2609 && (bytes
= MULTIBYTE_LENGTH (p
, pend
)) > 0)
2610 p
+= bytes
, pos
+= bytes
;
2613 unsigned char tmp
[MAX_MULTIBYTE_LENGTH
];
2616 c
= BYTE8_TO_CHAR (*p
);
2617 bytes
= CHAR_STRING (c
, tmp
);
2619 TEMP_SET_PT_BOTH (pos
+ 1, pos
+ 1);
2621 insert_1_both ((char *) tmp
+ 1, bytes
, bytes
, 1, 0, 0);
2622 /* Now the gap is after the just inserted data. */
2640 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2642 /* Do this first, so that chars_in_text asks the right question.
2643 set_intervals_multibyte needs it too. */
2644 bset_enable_multibyte_characters (current_buffer
, Qt
);
2646 GPT_BYTE
= advance_to_char_boundary (GPT_BYTE
);
2647 GPT
= chars_in_text (BEG_ADDR
, GPT_BYTE
- BEG_BYTE
) + BEG
;
2649 Z
= chars_in_text (GAP_END_ADDR
, Z_BYTE
- GPT_BYTE
) + GPT
;
2651 BEGV_BYTE
= advance_to_char_boundary (BEGV_BYTE
);
2652 if (BEGV_BYTE
> GPT_BYTE
)
2653 BEGV
= chars_in_text (GAP_END_ADDR
, BEGV_BYTE
- GPT_BYTE
) + GPT
;
2655 BEGV
= chars_in_text (BEG_ADDR
, BEGV_BYTE
- BEG_BYTE
) + BEG
;
2657 ZV_BYTE
= advance_to_char_boundary (ZV_BYTE
);
2658 if (ZV_BYTE
> GPT_BYTE
)
2659 ZV
= chars_in_text (GAP_END_ADDR
, ZV_BYTE
- GPT_BYTE
) + GPT
;
2661 ZV
= chars_in_text (BEG_ADDR
, ZV_BYTE
- BEG_BYTE
) + BEG
;
2664 ptrdiff_t byte
= advance_to_char_boundary (PT_BYTE
);
2667 if (byte
> GPT_BYTE
)
2668 position
= chars_in_text (GAP_END_ADDR
, byte
- GPT_BYTE
) + GPT
;
2670 position
= chars_in_text (BEG_ADDR
, byte
- BEG_BYTE
) + BEG
;
2671 TEMP_SET_PT_BOTH (position
, byte
);
2674 tail
= markers
= BUF_MARKERS (current_buffer
);
2676 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2677 getting confused by the markers that have not yet been updated.
2678 It is also a signal that it should never create a marker. */
2679 BUF_MARKERS (current_buffer
) = NULL
;
2681 for (; tail
; tail
= tail
->next
)
2683 tail
->bytepos
= advance_to_char_boundary (tail
->bytepos
);
2684 tail
->charpos
= BYTE_TO_CHAR (tail
->bytepos
);
2687 /* Make sure no markers were put on the chain
2688 while the chain value was incorrect. */
2689 if (BUF_MARKERS (current_buffer
))
2692 BUF_MARKERS (current_buffer
) = markers
;
2694 /* Do this last, so it can calculate the new correspondences
2695 between chars and bytes. */
2696 set_intervals_multibyte (1);
2699 if (!EQ (old_undo
, Qt
))
2701 /* Represent all the above changes by a special undo entry. */
2702 bset_undo_list (current_buffer
,
2703 Fcons (list3 (Qapply
,
2704 intern ("set-buffer-multibyte"),
2705 NILP (flag
) ? Qt
: Qnil
),
2711 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2713 /* If buffer is shown in a window, let redisplay consider other windows. */
2714 if (buffer_window_count (current_buffer
))
2715 ++windows_or_buffers_changed
;
2717 /* Copy this buffer's new multibyte status
2718 into all of its indirect buffers. */
2719 FOR_EACH_BUFFER (other
)
2720 if (other
->base_buffer
== current_buffer
&& BUFFER_LIVE_P (other
))
2722 BVAR (other
, enable_multibyte_characters
)
2723 = BVAR (current_buffer
, enable_multibyte_characters
);
2724 other
->prevent_redisplay_optimizations_p
= 1;
2727 /* Restore the modifiedness of the buffer. */
2728 if (!modified_p
&& !NILP (Fbuffer_modified_p (Qnil
)))
2729 Fset_buffer_modified_p (Qnil
);
2731 /* Update coding systems of this buffer's process (if any). */
2733 Lisp_Object process
;
2735 process
= Fget_buffer_process (Fcurrent_buffer ());
2736 if (PROCESSP (process
))
2737 setup_process_coding_systems (process
);
2743 DEFUN ("kill-all-local-variables", Fkill_all_local_variables
,
2744 Skill_all_local_variables
, 0, 0, 0,
2745 doc
: /* Switch to Fundamental mode by killing current buffer's local variables.
2746 Most local variable bindings are eliminated so that the default values
2747 become effective once more. Also, the syntax table is set from
2748 `standard-syntax-table', the local keymap is set to nil,
2749 and the abbrev table from `fundamental-mode-abbrev-table'.
2750 This function also forces redisplay of the mode line.
2752 Every function to select a new major mode starts by
2753 calling this function.
2755 As a special exception, local variables whose names have
2756 a non-nil `permanent-local' property are not eliminated by this function.
2758 The first thing this function does is run
2759 the normal hook `change-major-mode-hook'. */)
2762 Frun_hooks (1, &Qchange_major_mode_hook
);
2764 /* Make sure none of the bindings in local_var_alist
2765 remain swapped in, in their symbols. */
2767 swap_out_buffer_local_variables (current_buffer
);
2769 /* Actually eliminate all local bindings of this buffer. */
2771 reset_buffer_local_variables (current_buffer
, 0);
2773 /* Force mode-line redisplay. Useful here because all major mode
2774 commands call this function. */
2775 update_mode_lines
++;
2780 /* Make sure no local variables remain set up with buffer B
2781 for their current values. */
2784 swap_out_buffer_local_variables (struct buffer
*b
)
2786 Lisp_Object oalist
, alist
, buffer
;
2788 XSETBUFFER (buffer
, b
);
2789 oalist
= BVAR (b
, local_var_alist
);
2791 for (alist
= oalist
; CONSP (alist
); alist
= XCDR (alist
))
2793 Lisp_Object sym
= XCAR (XCAR (alist
));
2794 eassert (XSYMBOL (sym
)->redirect
== SYMBOL_LOCALIZED
);
2795 /* Need not do anything if some other buffer's binding is
2797 if (EQ (SYMBOL_BLV (XSYMBOL (sym
))->where
, buffer
))
2799 /* Symbol is set up for this buffer's old local value:
2801 swap_in_global_binding (XSYMBOL (sym
));
2806 /* Find all the overlays in the current buffer that contain position POS.
2807 Return the number found, and store them in a vector in *VEC_PTR.
2808 Store in *LEN_PTR the size allocated for the vector.
2809 Store in *NEXT_PTR the next position after POS where an overlay starts,
2810 or ZV if there are no more overlays between POS and ZV.
2811 Store in *PREV_PTR the previous position before POS where an overlay ends,
2812 or where an overlay starts which ends at or after POS;
2813 or BEGV if there are no such overlays from BEGV to POS.
2814 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2816 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2817 when this function is called.
2819 If EXTEND, make the vector bigger if necessary.
2820 If not, never extend the vector,
2821 and store only as many overlays as will fit.
2822 But still return the total number of overlays.
2824 If CHANGE_REQ, any position written into *PREV_PTR or
2825 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2826 default (BEGV or ZV). */
2829 overlays_at (EMACS_INT pos
, bool extend
, Lisp_Object
**vec_ptr
,
2831 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
, bool change_req
)
2833 Lisp_Object overlay
, start
, end
;
2834 struct Lisp_Overlay
*tail
;
2836 ptrdiff_t len
= *len_ptr
;
2837 Lisp_Object
*vec
= *vec_ptr
;
2838 ptrdiff_t next
= ZV
;
2839 ptrdiff_t prev
= BEGV
;
2840 bool inhibit_storing
= 0;
2842 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2844 ptrdiff_t startpos
, endpos
;
2846 XSETMISC (overlay
, tail
);
2848 start
= OVERLAY_START (overlay
);
2849 end
= OVERLAY_END (overlay
);
2850 endpos
= OVERLAY_POSITION (end
);
2857 startpos
= OVERLAY_POSITION (start
);
2858 /* This one ends at or after POS
2859 so its start counts for PREV_PTR if it's before POS. */
2860 if (prev
< startpos
&& startpos
< pos
)
2864 if (startpos
<= pos
)
2868 /* The supplied vector is full.
2869 Either make it bigger, or don't store any more in it. */
2872 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2878 inhibit_storing
= 1;
2881 if (!inhibit_storing
)
2883 /* Keep counting overlays even if we can't return them all. */
2886 else if (startpos
< next
)
2890 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2892 ptrdiff_t startpos
, endpos
;
2894 XSETMISC (overlay
, tail
);
2896 start
= OVERLAY_START (overlay
);
2897 end
= OVERLAY_END (overlay
);
2898 startpos
= OVERLAY_POSITION (start
);
2901 if (startpos
< next
)
2905 endpos
= OVERLAY_POSITION (end
);
2912 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2918 inhibit_storing
= 1;
2921 if (!inhibit_storing
)
2925 if (startpos
< pos
&& startpos
> prev
)
2928 else if (endpos
< pos
&& endpos
> prev
)
2930 else if (endpos
== pos
&& startpos
> prev
2931 && (!change_req
|| startpos
< pos
))
2942 /* Find all the overlays in the current buffer that overlap the range
2943 BEG-END, or are empty at BEG, or are empty at END provided END
2944 denotes the position at the end of the current buffer.
2946 Return the number found, and store them in a vector in *VEC_PTR.
2947 Store in *LEN_PTR the size allocated for the vector.
2948 Store in *NEXT_PTR the next position after POS where an overlay starts,
2949 or ZV if there are no more overlays.
2950 Store in *PREV_PTR the previous position before POS where an overlay ends,
2951 or BEGV if there are no previous overlays.
2952 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2954 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2955 when this function is called.
2957 If EXTEND, make the vector bigger if necessary.
2958 If not, never extend the vector,
2959 and store only as many overlays as will fit.
2960 But still return the total number of overlays. */
2963 overlays_in (EMACS_INT beg
, EMACS_INT end
, bool extend
,
2964 Lisp_Object
**vec_ptr
, ptrdiff_t *len_ptr
,
2965 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
)
2967 Lisp_Object overlay
, ostart
, oend
;
2968 struct Lisp_Overlay
*tail
;
2970 ptrdiff_t len
= *len_ptr
;
2971 Lisp_Object
*vec
= *vec_ptr
;
2972 ptrdiff_t next
= ZV
;
2973 ptrdiff_t prev
= BEGV
;
2974 bool inhibit_storing
= 0;
2975 bool end_is_Z
= end
== Z
;
2977 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2979 ptrdiff_t startpos
, endpos
;
2981 XSETMISC (overlay
, tail
);
2983 ostart
= OVERLAY_START (overlay
);
2984 oend
= OVERLAY_END (overlay
);
2985 endpos
= OVERLAY_POSITION (oend
);
2992 startpos
= OVERLAY_POSITION (ostart
);
2993 /* Count an interval if it overlaps the range, is empty at the
2994 start of the range, or is empty at END provided END denotes the
2995 end of the buffer. */
2996 if ((beg
< endpos
&& startpos
< end
)
2997 || (startpos
== endpos
2998 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
3002 /* The supplied vector is full.
3003 Either make it bigger, or don't store any more in it. */
3006 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
3012 inhibit_storing
= 1;
3015 if (!inhibit_storing
)
3017 /* Keep counting overlays even if we can't return them all. */
3020 else if (startpos
< next
)
3024 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
3026 ptrdiff_t startpos
, endpos
;
3028 XSETMISC (overlay
, tail
);
3030 ostart
= OVERLAY_START (overlay
);
3031 oend
= OVERLAY_END (overlay
);
3032 startpos
= OVERLAY_POSITION (ostart
);
3035 if (startpos
< next
)
3039 endpos
= OVERLAY_POSITION (oend
);
3040 /* Count an interval if it overlaps the range, is empty at the
3041 start of the range, or is empty at END provided END denotes the
3042 end of the buffer. */
3043 if ((beg
< endpos
&& startpos
< end
)
3044 || (startpos
== endpos
3045 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
3051 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
3057 inhibit_storing
= 1;
3060 if (!inhibit_storing
)
3064 else if (endpos
< beg
&& endpos
> prev
)
3076 /* Return true if there exists an overlay with a non-nil
3077 `mouse-face' property overlapping OVERLAY. */
3080 mouse_face_overlay_overlaps (Lisp_Object overlay
)
3082 ptrdiff_t start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3083 ptrdiff_t end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3084 ptrdiff_t n
, i
, size
;
3085 Lisp_Object
*v
, tem
;
3088 v
= alloca (size
* sizeof *v
);
3089 n
= overlays_in (start
, end
, 0, &v
, &size
, NULL
, NULL
);
3092 v
= alloca (n
* sizeof *v
);
3093 overlays_in (start
, end
, 0, &v
, &n
, NULL
, NULL
);
3096 for (i
= 0; i
< n
; ++i
)
3097 if (!EQ (v
[i
], overlay
)
3098 && (tem
= Foverlay_get (overlay
, Qmouse_face
),
3107 /* Fast function to just test if we're at an overlay boundary. */
3109 overlay_touches_p (ptrdiff_t pos
)
3111 Lisp_Object overlay
;
3112 struct Lisp_Overlay
*tail
;
3114 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
3118 XSETMISC (overlay
,tail
);
3119 eassert (OVERLAYP (overlay
));
3121 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3124 if (endpos
== pos
|| OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
)
3128 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
3132 XSETMISC (overlay
, tail
);
3133 eassert (OVERLAYP (overlay
));
3135 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3138 if (startpos
== pos
|| OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
)
3146 Lisp_Object overlay
;
3152 compare_overlays (const void *v1
, const void *v2
)
3154 const struct sortvec
*s1
= (const struct sortvec
*) v1
;
3155 const struct sortvec
*s2
= (const struct sortvec
*) v2
;
3156 if (s1
->priority
!= s2
->priority
)
3157 return s1
->priority
< s2
->priority
? -1 : 1;
3158 if (s1
->beg
!= s2
->beg
)
3159 return s1
->beg
< s2
->beg
? -1 : 1;
3160 if (s1
->end
!= s2
->end
)
3161 return s2
->end
< s1
->end
? -1 : 1;
3162 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
3163 between "equal" overlays. The result can still change between
3164 invocations of Emacs, but it won't change in the middle of
3165 `find_field' (bug#6830). */
3166 if (!EQ (s1
->overlay
, s2
->overlay
))
3167 return XLI (s1
->overlay
) < XLI (s2
->overlay
) ? -1 : 1;
3171 /* Sort an array of overlays by priority. The array is modified in place.
3172 The return value is the new size; this may be smaller than the original
3173 size if some of the overlays were invalid or were window-specific. */
3175 sort_overlays (Lisp_Object
*overlay_vec
, ptrdiff_t noverlays
, struct window
*w
)
3179 struct sortvec
*sortvec
;
3181 SAFE_NALLOCA (sortvec
, 1, noverlays
);
3183 /* Put the valid and relevant overlays into sortvec. */
3185 for (i
= 0, j
= 0; i
< noverlays
; i
++)
3188 Lisp_Object overlay
;
3190 overlay
= overlay_vec
[i
];
3191 if (OVERLAYP (overlay
)
3192 && OVERLAY_POSITION (OVERLAY_START (overlay
)) > 0
3193 && OVERLAY_POSITION (OVERLAY_END (overlay
)) > 0)
3195 /* If we're interested in a specific window, then ignore
3196 overlays that are limited to some other window. */
3201 window
= Foverlay_get (overlay
, Qwindow
);
3202 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3206 /* This overlay is good and counts: put it into sortvec. */
3207 sortvec
[j
].overlay
= overlay
;
3208 sortvec
[j
].beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3209 sortvec
[j
].end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3210 tem
= Foverlay_get (overlay
, Qpriority
);
3212 sortvec
[j
].priority
= XINT (tem
);
3214 sortvec
[j
].priority
= 0;
3220 /* Sort the overlays into the proper order: increasing priority. */
3223 qsort (sortvec
, noverlays
, sizeof (struct sortvec
), compare_overlays
);
3225 for (i
= 0; i
< noverlays
; i
++)
3226 overlay_vec
[i
] = sortvec
[i
].overlay
;
3234 Lisp_Object string
, string2
;
3241 struct sortstr
*buf
; /* An array that expands as needed; never freed. */
3242 ptrdiff_t size
; /* Allocated length of that array. */
3243 ptrdiff_t used
; /* How much of the array is currently in use. */
3244 ptrdiff_t bytes
; /* Total length of the strings in buf. */
3247 /* Buffers for storing information about the overlays touching a given
3248 position. These could be automatic variables in overlay_strings, but
3249 it's more efficient to hold onto the memory instead of repeatedly
3250 allocating and freeing it. */
3251 static struct sortstrlist overlay_heads
, overlay_tails
;
3252 static unsigned char *overlay_str_buf
;
3254 /* Allocated length of overlay_str_buf. */
3255 static ptrdiff_t overlay_str_len
;
3257 /* A comparison function suitable for passing to qsort. */
3259 cmp_for_strings (const void *as1
, const void *as2
)
3261 struct sortstr
*s1
= (struct sortstr
*)as1
;
3262 struct sortstr
*s2
= (struct sortstr
*)as2
;
3263 if (s1
->size
!= s2
->size
)
3264 return s2
->size
< s1
->size
? -1 : 1;
3265 if (s1
->priority
!= s2
->priority
)
3266 return s1
->priority
< s2
->priority
? -1 : 1;
3271 record_overlay_string (struct sortstrlist
*ssl
, Lisp_Object str
,
3272 Lisp_Object str2
, Lisp_Object pri
, ptrdiff_t size
)
3276 if (ssl
->used
== ssl
->size
)
3277 ssl
->buf
= xpalloc (ssl
->buf
, &ssl
->size
, 5, -1, sizeof *ssl
->buf
);
3278 ssl
->buf
[ssl
->used
].string
= str
;
3279 ssl
->buf
[ssl
->used
].string2
= str2
;
3280 ssl
->buf
[ssl
->used
].size
= size
;
3281 ssl
->buf
[ssl
->used
].priority
= (INTEGERP (pri
) ? XINT (pri
) : 0);
3284 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3285 nbytes
= SCHARS (str
);
3286 else if (! STRING_MULTIBYTE (str
))
3287 nbytes
= count_size_as_multibyte (SDATA (str
),
3290 nbytes
= SBYTES (str
);
3292 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3293 memory_full (SIZE_MAX
);
3294 ssl
->bytes
+= nbytes
;
3298 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3299 nbytes
= SCHARS (str2
);
3300 else if (! STRING_MULTIBYTE (str2
))
3301 nbytes
= count_size_as_multibyte (SDATA (str2
),
3304 nbytes
= SBYTES (str2
);
3306 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3307 memory_full (SIZE_MAX
);
3308 ssl
->bytes
+= nbytes
;
3312 /* Return the concatenation of the strings associated with overlays that
3313 begin or end at POS, ignoring overlays that are specific to a window
3314 other than W. The strings are concatenated in the appropriate order:
3315 shorter overlays nest inside longer ones, and higher priority inside
3316 lower. Normally all of the after-strings come first, but zero-sized
3317 overlays have their after-strings ride along with the before-strings
3318 because it would look strange to print them inside-out.
3320 Returns the string length, and stores the contents indirectly through
3321 PSTR, if that variable is non-null. The string may be overwritten by
3322 subsequent calls. */
3325 overlay_strings (ptrdiff_t pos
, struct window
*w
, unsigned char **pstr
)
3327 Lisp_Object overlay
, window
, str
;
3328 struct Lisp_Overlay
*ov
;
3329 ptrdiff_t startpos
, endpos
;
3330 bool multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3332 overlay_heads
.used
= overlay_heads
.bytes
= 0;
3333 overlay_tails
.used
= overlay_tails
.bytes
= 0;
3334 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
3336 XSETMISC (overlay
, ov
);
3337 eassert (OVERLAYP (overlay
));
3339 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3340 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3343 if (endpos
!= pos
&& startpos
!= pos
)
3345 window
= Foverlay_get (overlay
, Qwindow
);
3346 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3349 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3350 record_overlay_string (&overlay_heads
, str
,
3352 ? Foverlay_get (overlay
, Qafter_string
)
3354 Foverlay_get (overlay
, Qpriority
),
3356 else if (endpos
== pos
3357 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3358 record_overlay_string (&overlay_tails
, str
, Qnil
,
3359 Foverlay_get (overlay
, Qpriority
),
3362 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
3364 XSETMISC (overlay
, ov
);
3365 eassert (OVERLAYP (overlay
));
3367 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3368 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3371 if (endpos
!= pos
&& startpos
!= pos
)
3373 window
= Foverlay_get (overlay
, Qwindow
);
3374 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3377 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3378 record_overlay_string (&overlay_heads
, str
,
3380 ? Foverlay_get (overlay
, Qafter_string
)
3382 Foverlay_get (overlay
, Qpriority
),
3384 else if (endpos
== pos
3385 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3386 record_overlay_string (&overlay_tails
, str
, Qnil
,
3387 Foverlay_get (overlay
, Qpriority
),
3390 if (overlay_tails
.used
> 1)
3391 qsort (overlay_tails
.buf
, overlay_tails
.used
, sizeof (struct sortstr
),
3393 if (overlay_heads
.used
> 1)
3394 qsort (overlay_heads
.buf
, overlay_heads
.used
, sizeof (struct sortstr
),
3396 if (overlay_heads
.bytes
|| overlay_tails
.bytes
)
3403 if (INT_ADD_OVERFLOW (overlay_heads
.bytes
, overlay_tails
.bytes
))
3404 memory_full (SIZE_MAX
);
3405 total
= overlay_heads
.bytes
+ overlay_tails
.bytes
;
3406 if (total
> overlay_str_len
)
3407 overlay_str_buf
= xpalloc (overlay_str_buf
, &overlay_str_len
,
3408 total
- overlay_str_len
, -1, 1);
3410 p
= overlay_str_buf
;
3411 for (i
= overlay_tails
.used
; --i
>= 0;)
3414 tem
= overlay_tails
.buf
[i
].string
;
3415 nbytes
= copy_text (SDATA (tem
), p
,
3417 STRING_MULTIBYTE (tem
), multibyte
);
3420 for (i
= 0; i
< overlay_heads
.used
; ++i
)
3423 tem
= overlay_heads
.buf
[i
].string
;
3424 nbytes
= copy_text (SDATA (tem
), p
,
3426 STRING_MULTIBYTE (tem
), multibyte
);
3428 tem
= overlay_heads
.buf
[i
].string2
;
3431 nbytes
= copy_text (SDATA (tem
), p
,
3433 STRING_MULTIBYTE (tem
), multibyte
);
3437 if (p
!= overlay_str_buf
+ total
)
3440 *pstr
= overlay_str_buf
;
3446 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3449 recenter_overlay_lists (struct buffer
*buf
, ptrdiff_t pos
)
3451 Lisp_Object overlay
, beg
, end
;
3452 struct Lisp_Overlay
*prev
, *tail
, *next
;
3454 /* See if anything in overlays_before should move to overlays_after. */
3456 /* We don't strictly need prev in this loop; it should always be nil.
3457 But we use it for symmetry and in case that should cease to be true
3458 with some future change. */
3460 for (tail
= buf
->overlays_before
; tail
; prev
= tail
, tail
= next
)
3463 XSETMISC (overlay
, tail
);
3464 eassert (OVERLAYP (overlay
));
3466 beg
= OVERLAY_START (overlay
);
3467 end
= OVERLAY_END (overlay
);
3469 if (OVERLAY_POSITION (end
) > pos
)
3471 /* OVERLAY needs to be moved. */
3472 ptrdiff_t where
= OVERLAY_POSITION (beg
);
3473 struct Lisp_Overlay
*other
, *other_prev
;
3475 /* Splice the cons cell TAIL out of overlays_before. */
3479 set_buffer_overlays_before (buf
, next
);
3481 /* Search thru overlays_after for where to put it. */
3483 for (other
= buf
->overlays_after
; other
;
3484 other_prev
= other
, other
= other
->next
)
3486 Lisp_Object otherbeg
, otheroverlay
;
3488 XSETMISC (otheroverlay
, other
);
3489 eassert (OVERLAYP (otheroverlay
));
3491 otherbeg
= OVERLAY_START (otheroverlay
);
3492 if (OVERLAY_POSITION (otherbeg
) >= where
)
3496 /* Add TAIL to overlays_after before OTHER. */
3499 other_prev
->next
= tail
;
3501 set_buffer_overlays_after (buf
, tail
);
3505 /* We've reached the things that should stay in overlays_before.
3506 All the rest of overlays_before must end even earlier,
3511 /* See if anything in overlays_after should be in overlays_before. */
3513 for (tail
= buf
->overlays_after
; tail
; prev
= tail
, tail
= next
)
3516 XSETMISC (overlay
, tail
);
3517 eassert (OVERLAYP (overlay
));
3519 beg
= OVERLAY_START (overlay
);
3520 end
= OVERLAY_END (overlay
);
3522 /* Stop looking, when we know that nothing further
3523 can possibly end before POS. */
3524 if (OVERLAY_POSITION (beg
) > pos
)
3527 if (OVERLAY_POSITION (end
) <= pos
)
3529 /* OVERLAY needs to be moved. */
3530 ptrdiff_t where
= OVERLAY_POSITION (end
);
3531 struct Lisp_Overlay
*other
, *other_prev
;
3533 /* Splice the cons cell TAIL out of overlays_after. */
3537 set_buffer_overlays_after (buf
, next
);
3539 /* Search thru overlays_before for where to put it. */
3541 for (other
= buf
->overlays_before
; other
;
3542 other_prev
= other
, other
= other
->next
)
3544 Lisp_Object otherend
, otheroverlay
;
3546 XSETMISC (otheroverlay
, other
);
3547 eassert (OVERLAYP (otheroverlay
));
3549 otherend
= OVERLAY_END (otheroverlay
);
3550 if (OVERLAY_POSITION (otherend
) <= where
)
3554 /* Add TAIL to overlays_before before OTHER. */
3557 other_prev
->next
= tail
;
3559 set_buffer_overlays_before (buf
, tail
);
3564 buf
->overlay_center
= pos
;
3568 adjust_overlays_for_insert (ptrdiff_t pos
, ptrdiff_t length
)
3570 /* After an insertion, the lists are still sorted properly,
3571 but we may need to update the value of the overlay center. */
3572 if (current_buffer
->overlay_center
>= pos
)
3573 current_buffer
->overlay_center
+= length
;
3577 adjust_overlays_for_delete (ptrdiff_t pos
, ptrdiff_t length
)
3579 if (current_buffer
->overlay_center
< pos
)
3580 /* The deletion was to our right. No change needed; the before- and
3581 after-lists are still consistent. */
3583 else if (current_buffer
->overlay_center
- pos
> length
)
3584 /* The deletion was to our left. We need to adjust the center value
3585 to account for the change in position, but the lists are consistent
3586 given the new value. */
3587 current_buffer
->overlay_center
-= length
;
3589 /* We're right in the middle. There might be things on the after-list
3590 that now belong on the before-list. Recentering will move them,
3591 and also update the center point. */
3592 recenter_overlay_lists (current_buffer
, pos
);
3595 /* Fix up overlays that were garbled as a result of permuting markers
3596 in the range START through END. Any overlay with at least one
3597 endpoint in this range will need to be unlinked from the overlay
3598 list and reinserted in its proper place.
3599 Such an overlay might even have negative size at this point.
3600 If so, we'll make the overlay empty. */
3602 fix_start_end_in_overlays (register ptrdiff_t start
, register ptrdiff_t end
)
3604 Lisp_Object overlay
;
3605 struct Lisp_Overlay
*before_list
IF_LINT (= NULL
);
3606 struct Lisp_Overlay
*after_list
IF_LINT (= NULL
);
3607 /* These are either nil, indicating that before_list or after_list
3608 should be assigned, or the cons cell the cdr of which should be
3610 struct Lisp_Overlay
*beforep
= NULL
, *afterp
= NULL
;
3611 /* 'Parent', likewise, indicates a cons cell or
3612 current_buffer->overlays_before or overlays_after, depending
3613 which loop we're in. */
3614 struct Lisp_Overlay
*tail
, *parent
;
3615 ptrdiff_t startpos
, endpos
;
3617 /* This algorithm shifts links around instead of consing and GCing.
3618 The loop invariant is that before_list (resp. after_list) is a
3619 well-formed list except that its last element, the CDR of beforep
3620 (resp. afterp) if beforep (afterp) isn't nil or before_list
3621 (after_list) if it is, is still uninitialized. So it's not a bug
3622 that before_list isn't initialized, although it may look
3624 for (parent
= NULL
, tail
= current_buffer
->overlays_before
; tail
;)
3626 XSETMISC (overlay
, tail
);
3628 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3629 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3631 /* If the overlay is backwards, make it empty. */
3632 if (endpos
< startpos
)
3635 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3643 || (startpos
>= start
&& startpos
< end
))
3645 /* Add it to the end of the wrong list. Later on,
3646 recenter_overlay_lists will move it to the right place. */
3647 if (endpos
< current_buffer
->overlay_center
)
3652 afterp
->next
= tail
;
3660 beforep
->next
= tail
;
3664 set_buffer_overlays_before (current_buffer
, tail
->next
);
3666 parent
->next
= tail
->next
;
3670 parent
= tail
, tail
= parent
->next
;
3672 for (parent
= NULL
, tail
= current_buffer
->overlays_after
; tail
;)
3674 XSETMISC (overlay
, tail
);
3676 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3677 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3679 /* If the overlay is backwards, make it empty. */
3680 if (endpos
< startpos
)
3683 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3687 if (startpos
>= end
)
3690 if (startpos
>= start
3691 || (endpos
>= start
&& endpos
< end
))
3693 if (endpos
< current_buffer
->overlay_center
)
3698 afterp
->next
= tail
;
3706 beforep
->next
= tail
;
3710 set_buffer_overlays_after (current_buffer
, tail
->next
);
3712 parent
->next
= tail
->next
;
3716 parent
= tail
, tail
= parent
->next
;
3719 /* Splice the constructed (wrong) lists into the buffer's lists,
3720 and let the recenter function make it sane again. */
3723 beforep
->next
= current_buffer
->overlays_before
;
3724 set_buffer_overlays_before (current_buffer
, before_list
);
3729 afterp
->next
= current_buffer
->overlays_after
;
3730 set_buffer_overlays_after (current_buffer
, after_list
);
3732 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3735 /* We have two types of overlay: the one whose ending marker is
3736 after-insertion-marker (this is the usual case) and the one whose
3737 ending marker is before-insertion-marker. When `overlays_before'
3738 contains overlays of the latter type and the former type in this
3739 order and both overlays end at inserting position, inserting a text
3740 increases only the ending marker of the latter type, which results
3741 in incorrect ordering of `overlays_before'.
3743 This function fixes ordering of overlays in the slot
3744 `overlays_before' of the buffer *BP. Before the insertion, `point'
3745 was at PREV, and now is at POS. */
3748 fix_overlays_before (struct buffer
*bp
, ptrdiff_t prev
, ptrdiff_t pos
)
3750 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3751 struct Lisp_Overlay
*tail
= bp
->overlays_before
, *parent
= NULL
, *right_pair
;
3753 ptrdiff_t end
IF_LINT (= 0);
3755 /* After the insertion, the several overlays may be in incorrect
3756 order. The possibility is that, in the list `overlays_before',
3757 an overlay which ends at POS appears after an overlay which ends
3758 at PREV. Since POS is greater than PREV, we must fix the
3759 ordering of these overlays, by moving overlays ends at POS before
3760 the overlays ends at PREV. */
3762 /* At first, find a place where disordered overlays should be linked
3763 in. It is where an overlay which end before POS exists. (i.e. an
3764 overlay whose ending marker is after-insertion-marker if disorder
3767 && (XSETMISC (tem
, tail
),
3768 (end
= OVERLAY_POSITION (OVERLAY_END (tem
))) >= pos
))
3774 /* If we don't find such an overlay,
3775 or the found one ends before PREV,
3776 or the found one is the last one in the list,
3777 we don't have to fix anything. */
3778 if (!tail
|| end
< prev
|| !tail
->next
)
3781 right_pair
= parent
;
3785 /* Now, end position of overlays in the list TAIL should be before
3786 or equal to PREV. In the loop, an overlay which ends at POS is
3787 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3788 we found an overlay which ends before PREV, the remaining
3789 overlays are in correct order. */
3792 XSETMISC (tem
, tail
);
3793 end
= OVERLAY_POSITION (OVERLAY_END (tem
));
3796 { /* This overlay is disordered. */
3797 struct Lisp_Overlay
*found
= tail
;
3799 /* Unlink the found overlay. */
3801 parent
->next
= tail
;
3802 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3803 and link it into the right place. */
3806 found
->next
= bp
->overlays_before
;
3807 set_buffer_overlays_before (bp
, found
);
3811 found
->next
= right_pair
->next
;
3812 right_pair
->next
= found
;
3815 else if (end
== prev
)
3820 else /* No more disordered overlay. */
3825 DEFUN ("overlayp", Foverlayp
, Soverlayp
, 1, 1, 0,
3826 doc
: /* Return t if OBJECT is an overlay. */)
3827 (Lisp_Object object
)
3829 return (OVERLAYP (object
) ? Qt
: Qnil
);
3832 DEFUN ("make-overlay", Fmake_overlay
, Smake_overlay
, 2, 5, 0,
3833 doc
: /* Create a new overlay with range BEG to END in BUFFER.
3834 If omitted, BUFFER defaults to the current buffer.
3835 BEG and END may be integers or markers.
3836 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3837 for the front of the overlay advance when text is inserted there
3838 \(which means the text *is not* included in the overlay).
3839 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3840 for the rear of the overlay advance when text is inserted there
3841 \(which means the text *is* included in the overlay). */)
3842 (Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
, Lisp_Object front_advance
, Lisp_Object rear_advance
)
3844 Lisp_Object overlay
;
3848 XSETBUFFER (buffer
, current_buffer
);
3850 CHECK_BUFFER (buffer
);
3852 && ! EQ (Fmarker_buffer (beg
), buffer
))
3853 error ("Marker points into wrong buffer");
3855 && ! EQ (Fmarker_buffer (end
), buffer
))
3856 error ("Marker points into wrong buffer");
3858 CHECK_NUMBER_COERCE_MARKER (beg
);
3859 CHECK_NUMBER_COERCE_MARKER (end
);
3861 if (XINT (beg
) > XINT (end
))
3864 temp
= beg
; beg
= end
; end
= temp
;
3867 b
= XBUFFER (buffer
);
3869 beg
= Fset_marker (Fmake_marker (), beg
, buffer
);
3870 end
= Fset_marker (Fmake_marker (), end
, buffer
);
3872 if (!NILP (front_advance
))
3873 XMARKER (beg
)->insertion_type
= 1;
3874 if (!NILP (rear_advance
))
3875 XMARKER (end
)->insertion_type
= 1;
3877 overlay
= build_overlay (beg
, end
, Qnil
);
3879 /* Put the new overlay on the wrong list. */
3880 end
= OVERLAY_END (overlay
);
3881 if (OVERLAY_POSITION (end
) < b
->overlay_center
)
3883 eassert (b
->overlays_after
|| (XOVERLAY (overlay
)->next
== NULL
));
3884 XOVERLAY (overlay
)->next
= b
->overlays_after
;
3885 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
3889 eassert (b
->overlays_before
|| (XOVERLAY (overlay
)->next
== NULL
));
3890 XOVERLAY (overlay
)->next
= b
->overlays_before
;
3891 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
3893 /* This puts it in the right list, and in the right order. */
3894 recenter_overlay_lists (b
, b
->overlay_center
);
3896 /* We don't need to redisplay the region covered by the overlay, because
3897 the overlay has no properties at the moment. */
3902 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3905 modify_overlay (struct buffer
*buf
, ptrdiff_t start
, ptrdiff_t end
)
3909 ptrdiff_t temp
= start
;
3914 BUF_COMPUTE_UNCHANGED (buf
, start
, end
);
3916 /* If BUF is visible, consider updating the display if ... */
3917 if (buffer_window_count (buf
) > 0)
3919 /* ... it's visible in other window than selected, */
3920 if (buf
!= XBUFFER (XWINDOW (selected_window
)->contents
))
3921 windows_or_buffers_changed
= 1;
3922 /* ... or if we modify an overlay at the end of the buffer
3923 and so we cannot be sure that window end is still valid. */
3924 else if (end
>= ZV
&& start
<= ZV
)
3925 windows_or_buffers_changed
= 1;
3928 ++BUF_OVERLAY_MODIFF (buf
);
3931 /* Remove OVERLAY from LIST. */
3933 static struct Lisp_Overlay
*
3934 unchain_overlay (struct Lisp_Overlay
*list
, struct Lisp_Overlay
*overlay
)
3936 register struct Lisp_Overlay
*tail
, **prev
= &list
;
3938 for (tail
= list
; tail
; prev
= &tail
->next
, tail
= *prev
)
3939 if (tail
== overlay
)
3941 *prev
= overlay
->next
;
3942 overlay
->next
= NULL
;
3948 /* Remove OVERLAY from both overlay lists of B. */
3951 unchain_both (struct buffer
*b
, Lisp_Object overlay
)
3953 struct Lisp_Overlay
*ov
= XOVERLAY (overlay
);
3955 set_buffer_overlays_before (b
, unchain_overlay (b
->overlays_before
, ov
));
3956 set_buffer_overlays_after (b
, unchain_overlay (b
->overlays_after
, ov
));
3957 eassert (XOVERLAY (overlay
)->next
== NULL
);
3960 DEFUN ("move-overlay", Fmove_overlay
, Smove_overlay
, 3, 4, 0,
3961 doc
: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3962 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3963 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3965 (Lisp_Object overlay
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
)
3967 struct buffer
*b
, *ob
= 0;
3968 Lisp_Object obuffer
;
3969 ptrdiff_t count
= SPECPDL_INDEX ();
3970 ptrdiff_t n_beg
, n_end
, o_beg
IF_LINT (= 0), o_end
IF_LINT (= 0);
3972 CHECK_OVERLAY (overlay
);
3974 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3976 XSETBUFFER (buffer
, current_buffer
);
3977 CHECK_BUFFER (buffer
);
3979 if (NILP (Fbuffer_live_p (buffer
)))
3980 error ("Attempt to move overlay to a dead buffer");
3983 && ! EQ (Fmarker_buffer (beg
), buffer
))
3984 error ("Marker points into wrong buffer");
3986 && ! EQ (Fmarker_buffer (end
), buffer
))
3987 error ("Marker points into wrong buffer");
3989 CHECK_NUMBER_COERCE_MARKER (beg
);
3990 CHECK_NUMBER_COERCE_MARKER (end
);
3992 if (XINT (beg
) > XINT (end
))
3995 temp
= beg
; beg
= end
; end
= temp
;
3998 specbind (Qinhibit_quit
, Qt
);
4000 obuffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4001 b
= XBUFFER (buffer
);
4003 if (!NILP (obuffer
))
4005 ob
= XBUFFER (obuffer
);
4007 o_beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4008 o_end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4010 unchain_both (ob
, overlay
);
4013 /* Set the overlay boundaries, which may clip them. */
4014 Fset_marker (OVERLAY_START (overlay
), beg
, buffer
);
4015 Fset_marker (OVERLAY_END (overlay
), end
, buffer
);
4017 n_beg
= marker_position (OVERLAY_START (overlay
));
4018 n_end
= marker_position (OVERLAY_END (overlay
));
4020 /* If the overlay has changed buffers, do a thorough redisplay. */
4021 if (!EQ (buffer
, obuffer
))
4023 /* Redisplay where the overlay was. */
4025 modify_overlay (ob
, o_beg
, o_end
);
4027 /* Redisplay where the overlay is going to be. */
4028 modify_overlay (b
, n_beg
, n_end
);
4031 /* Redisplay the area the overlay has just left, or just enclosed. */
4034 modify_overlay (b
, o_end
, n_end
);
4035 else if (o_end
== n_end
)
4036 modify_overlay (b
, o_beg
, n_beg
);
4038 modify_overlay (b
, min (o_beg
, n_beg
), max (o_end
, n_end
));
4041 /* Delete the overlay if it is empty after clipping and has the
4042 evaporate property. */
4043 if (n_beg
== n_end
&& !NILP (Foverlay_get (overlay
, Qevaporate
)))
4044 return unbind_to (count
, Fdelete_overlay (overlay
));
4046 /* Put the overlay into the new buffer's overlay lists, first on the
4048 if (n_end
< b
->overlay_center
)
4050 XOVERLAY (overlay
)->next
= b
->overlays_after
;
4051 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
4055 XOVERLAY (overlay
)->next
= b
->overlays_before
;
4056 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
4059 /* This puts it in the right list, and in the right order. */
4060 recenter_overlay_lists (b
, b
->overlay_center
);
4062 return unbind_to (count
, overlay
);
4065 DEFUN ("delete-overlay", Fdelete_overlay
, Sdelete_overlay
, 1, 1, 0,
4066 doc
: /* Delete the overlay OVERLAY from its buffer. */)
4067 (Lisp_Object overlay
)
4071 ptrdiff_t count
= SPECPDL_INDEX ();
4073 CHECK_OVERLAY (overlay
);
4075 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4079 b
= XBUFFER (buffer
);
4080 specbind (Qinhibit_quit
, Qt
);
4082 unchain_both (b
, overlay
);
4083 drop_overlay (b
, XOVERLAY (overlay
));
4085 /* When deleting an overlay with before or after strings, turn off
4086 display optimizations for the affected buffer, on the basis that
4087 these strings may contain newlines. This is easier to do than to
4088 check for that situation during redisplay. */
4089 if (!windows_or_buffers_changed
4090 && (!NILP (Foverlay_get (overlay
, Qbefore_string
))
4091 || !NILP (Foverlay_get (overlay
, Qafter_string
))))
4092 b
->prevent_redisplay_optimizations_p
= 1;
4094 return unbind_to (count
, Qnil
);
4097 DEFUN ("delete-all-overlays", Fdelete_all_overlays
, Sdelete_all_overlays
, 0, 1, 0,
4098 doc
: /* Delete all overlays of BUFFER.
4099 BUFFER omitted or nil means delete all overlays of the current
4101 (Lisp_Object buffer
)
4103 register struct buffer
*buf
;
4106 buf
= current_buffer
;
4109 CHECK_BUFFER (buffer
);
4110 buf
= XBUFFER (buffer
);
4113 delete_all_overlays (buf
);
4117 /* Overlay dissection functions. */
4119 DEFUN ("overlay-start", Foverlay_start
, Soverlay_start
, 1, 1, 0,
4120 doc
: /* Return the position at which OVERLAY starts. */)
4121 (Lisp_Object overlay
)
4123 CHECK_OVERLAY (overlay
);
4125 return (Fmarker_position (OVERLAY_START (overlay
)));
4128 DEFUN ("overlay-end", Foverlay_end
, Soverlay_end
, 1, 1, 0,
4129 doc
: /* Return the position at which OVERLAY ends. */)
4130 (Lisp_Object overlay
)
4132 CHECK_OVERLAY (overlay
);
4134 return (Fmarker_position (OVERLAY_END (overlay
)));
4137 DEFUN ("overlay-buffer", Foverlay_buffer
, Soverlay_buffer
, 1, 1, 0,
4138 doc
: /* Return the buffer OVERLAY belongs to.
4139 Return nil if OVERLAY has been deleted. */)
4140 (Lisp_Object overlay
)
4142 CHECK_OVERLAY (overlay
);
4144 return Fmarker_buffer (OVERLAY_START (overlay
));
4147 DEFUN ("overlay-properties", Foverlay_properties
, Soverlay_properties
, 1, 1, 0,
4148 doc
: /* Return a list of the properties on OVERLAY.
4149 This is a copy of OVERLAY's plist; modifying its conses has no effect on
4151 (Lisp_Object overlay
)
4153 CHECK_OVERLAY (overlay
);
4155 return Fcopy_sequence (XOVERLAY (overlay
)->plist
);
4159 DEFUN ("overlays-at", Foverlays_at
, Soverlays_at
, 1, 1, 0,
4160 doc
: /* Return a list of the overlays that contain the character at POS. */)
4163 ptrdiff_t len
, noverlays
;
4164 Lisp_Object
*overlay_vec
;
4167 CHECK_NUMBER_COERCE_MARKER (pos
);
4170 /* We can't use alloca here because overlays_at can call xrealloc. */
4171 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4173 /* Put all the overlays we want in a vector in overlay_vec.
4174 Store the length in len. */
4175 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4178 /* Make a list of them all. */
4179 result
= Flist (noverlays
, overlay_vec
);
4181 xfree (overlay_vec
);
4185 DEFUN ("overlays-in", Foverlays_in
, Soverlays_in
, 2, 2, 0,
4186 doc
: /* Return a list of the overlays that overlap the region BEG ... END.
4187 Overlap means that at least one character is contained within the overlay
4188 and also contained within the specified region.
4189 Empty overlays are included in the result if they are located at BEG,
4190 between BEG and END, or at END provided END denotes the position at the
4191 end of the buffer. */)
4192 (Lisp_Object beg
, Lisp_Object end
)
4194 ptrdiff_t len
, noverlays
;
4195 Lisp_Object
*overlay_vec
;
4198 CHECK_NUMBER_COERCE_MARKER (beg
);
4199 CHECK_NUMBER_COERCE_MARKER (end
);
4202 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4204 /* Put all the overlays we want in a vector in overlay_vec.
4205 Store the length in len. */
4206 noverlays
= overlays_in (XINT (beg
), XINT (end
), 1, &overlay_vec
, &len
,
4209 /* Make a list of them all. */
4210 result
= Flist (noverlays
, overlay_vec
);
4212 xfree (overlay_vec
);
4216 DEFUN ("next-overlay-change", Fnext_overlay_change
, Snext_overlay_change
,
4218 doc
: /* Return the next position after POS where an overlay starts or ends.
4219 If there are no overlay boundaries from POS to (point-max),
4220 the value is (point-max). */)
4223 ptrdiff_t i
, len
, noverlays
;
4225 Lisp_Object
*overlay_vec
;
4227 CHECK_NUMBER_COERCE_MARKER (pos
);
4230 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4232 /* Put all the overlays we want in a vector in overlay_vec.
4233 Store the length in len.
4234 endpos gets the position where the next overlay starts. */
4235 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4238 /* If any of these overlays ends before endpos,
4239 use its ending point instead. */
4240 for (i
= 0; i
< noverlays
; i
++)
4245 oend
= OVERLAY_END (overlay_vec
[i
]);
4246 oendpos
= OVERLAY_POSITION (oend
);
4247 if (oendpos
< endpos
)
4251 xfree (overlay_vec
);
4252 return make_number (endpos
);
4255 DEFUN ("previous-overlay-change", Fprevious_overlay_change
,
4256 Sprevious_overlay_change
, 1, 1, 0,
4257 doc
: /* Return the previous position before POS where an overlay starts or ends.
4258 If there are no overlay boundaries from (point-min) to POS,
4259 the value is (point-min). */)
4263 Lisp_Object
*overlay_vec
;
4266 CHECK_NUMBER_COERCE_MARKER (pos
);
4268 /* At beginning of buffer, we know the answer;
4269 avoid bug subtracting 1 below. */
4270 if (XINT (pos
) == BEGV
)
4274 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4276 /* Put all the overlays we want in a vector in overlay_vec.
4277 Store the length in len.
4278 prevpos gets the position of the previous change. */
4279 overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4282 xfree (overlay_vec
);
4283 return make_number (prevpos
);
4286 /* These functions are for debugging overlays. */
4288 DEFUN ("overlay-lists", Foverlay_lists
, Soverlay_lists
, 0, 0, 0,
4289 doc
: /* Return a pair of lists giving all the overlays of the current buffer.
4290 The car has all the overlays before the overlay center;
4291 the cdr has all the overlays after the overlay center.
4292 Recentering overlays moves overlays between these lists.
4293 The lists you get are copies, so that changing them has no effect.
4294 However, the overlays you get are the real objects that the buffer uses. */)
4297 struct Lisp_Overlay
*ol
;
4298 Lisp_Object before
= Qnil
, after
= Qnil
, tmp
;
4300 for (ol
= current_buffer
->overlays_before
; ol
; ol
= ol
->next
)
4303 before
= Fcons (tmp
, before
);
4305 for (ol
= current_buffer
->overlays_after
; ol
; ol
= ol
->next
)
4308 after
= Fcons (tmp
, after
);
4311 return Fcons (Fnreverse (before
), Fnreverse (after
));
4314 DEFUN ("overlay-recenter", Foverlay_recenter
, Soverlay_recenter
, 1, 1, 0,
4315 doc
: /* Recenter the overlays of the current buffer around position POS.
4316 That makes overlay lookup faster for positions near POS (but perhaps slower
4317 for positions far away from POS). */)
4321 CHECK_NUMBER_COERCE_MARKER (pos
);
4323 p
= clip_to_bounds (PTRDIFF_MIN
, XINT (pos
), PTRDIFF_MAX
);
4324 recenter_overlay_lists (current_buffer
, p
);
4328 DEFUN ("overlay-get", Foverlay_get
, Soverlay_get
, 2, 2, 0,
4329 doc
: /* Get the property of overlay OVERLAY with property name PROP. */)
4330 (Lisp_Object overlay
, Lisp_Object prop
)
4332 CHECK_OVERLAY (overlay
);
4333 return lookup_char_property (XOVERLAY (overlay
)->plist
, prop
, 0);
4336 DEFUN ("overlay-put", Foverlay_put
, Soverlay_put
, 3, 3, 0,
4337 doc
: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4338 VALUE will be returned.*/)
4339 (Lisp_Object overlay
, Lisp_Object prop
, Lisp_Object value
)
4341 Lisp_Object tail
, buffer
;
4344 CHECK_OVERLAY (overlay
);
4346 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4348 for (tail
= XOVERLAY (overlay
)->plist
;
4349 CONSP (tail
) && CONSP (XCDR (tail
));
4350 tail
= XCDR (XCDR (tail
)))
4351 if (EQ (XCAR (tail
), prop
))
4353 changed
= !EQ (XCAR (XCDR (tail
)), value
);
4354 XSETCAR (XCDR (tail
), value
);
4357 /* It wasn't in the list, so add it to the front. */
4358 changed
= !NILP (value
);
4360 (overlay
, Fcons (prop
, Fcons (value
, XOVERLAY (overlay
)->plist
)));
4362 if (! NILP (buffer
))
4365 modify_overlay (XBUFFER (buffer
),
4366 marker_position (OVERLAY_START (overlay
)),
4367 marker_position (OVERLAY_END (overlay
)));
4368 if (EQ (prop
, Qevaporate
) && ! NILP (value
)
4369 && (OVERLAY_POSITION (OVERLAY_START (overlay
))
4370 == OVERLAY_POSITION (OVERLAY_END (overlay
))))
4371 Fdelete_overlay (overlay
);
4377 /* Subroutine of report_overlay_modification. */
4379 /* Lisp vector holding overlay hook functions to call.
4380 Vector elements come in pairs.
4381 Each even-index element is a list of hook functions.
4382 The following odd-index element is the overlay they came from.
4384 Before the buffer change, we fill in this vector
4385 as we call overlay hook functions.
4386 After the buffer change, we get the functions to call from this vector.
4387 This way we always call the same functions before and after the change. */
4388 static Lisp_Object last_overlay_modification_hooks
;
4390 /* Number of elements actually used in last_overlay_modification_hooks. */
4391 static ptrdiff_t last_overlay_modification_hooks_used
;
4393 /* Add one functionlist/overlay pair
4394 to the end of last_overlay_modification_hooks. */
4397 add_overlay_mod_hooklist (Lisp_Object functionlist
, Lisp_Object overlay
)
4399 ptrdiff_t oldsize
= ASIZE (last_overlay_modification_hooks
);
4401 if (oldsize
- 1 <= last_overlay_modification_hooks_used
)
4402 last_overlay_modification_hooks
=
4403 larger_vector (last_overlay_modification_hooks
, 2, -1);
4404 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4405 functionlist
); last_overlay_modification_hooks_used
++;
4406 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4407 overlay
); last_overlay_modification_hooks_used
++;
4410 /* Run the modification-hooks of overlays that include
4411 any part of the text in START to END.
4412 If this change is an insertion, also
4413 run the insert-before-hooks of overlay starting at END,
4414 and the insert-after-hooks of overlay ending at START.
4416 This is called both before and after the modification.
4417 AFTER is true when we call after the modification.
4419 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4420 When AFTER is nonzero, they are the start position,
4421 the position after the inserted new text,
4422 and the length of deleted or replaced old text. */
4425 report_overlay_modification (Lisp_Object start
, Lisp_Object end
, bool after
,
4426 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4428 Lisp_Object prop
, overlay
;
4429 struct Lisp_Overlay
*tail
;
4430 /* True if this change is an insertion. */
4431 bool insertion
= (after
? XFASTINT (arg3
) == 0 : EQ (start
, end
));
4432 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4437 /* We used to run the functions as soon as we found them and only register
4438 them in last_overlay_modification_hooks for the purpose of the `after'
4439 case. But running elisp code as we traverse the list of overlays is
4440 painful because the list can be modified by the elisp code so we had to
4441 copy at several places. We now simply do a read-only traversal that
4442 only collects the functions to run and we run them afterwards. It's
4443 simpler, especially since all the code was already there. -stef */
4447 /* We are being called before a change.
4448 Scan the overlays to find the functions to call. */
4449 last_overlay_modification_hooks_used
= 0;
4450 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4452 ptrdiff_t startpos
, endpos
;
4453 Lisp_Object ostart
, oend
;
4455 XSETMISC (overlay
, tail
);
4457 ostart
= OVERLAY_START (overlay
);
4458 oend
= OVERLAY_END (overlay
);
4459 endpos
= OVERLAY_POSITION (oend
);
4460 if (XFASTINT (start
) > endpos
)
4462 startpos
= OVERLAY_POSITION (ostart
);
4463 if (insertion
&& (XFASTINT (start
) == startpos
4464 || XFASTINT (end
) == startpos
))
4466 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4468 add_overlay_mod_hooklist (prop
, overlay
);
4470 if (insertion
&& (XFASTINT (start
) == endpos
4471 || XFASTINT (end
) == endpos
))
4473 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4475 add_overlay_mod_hooklist (prop
, overlay
);
4477 /* Test for intersecting intervals. This does the right thing
4478 for both insertion and deletion. */
4479 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4481 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4483 add_overlay_mod_hooklist (prop
, overlay
);
4487 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4489 ptrdiff_t startpos
, endpos
;
4490 Lisp_Object ostart
, oend
;
4492 XSETMISC (overlay
, tail
);
4494 ostart
= OVERLAY_START (overlay
);
4495 oend
= OVERLAY_END (overlay
);
4496 startpos
= OVERLAY_POSITION (ostart
);
4497 endpos
= OVERLAY_POSITION (oend
);
4498 if (XFASTINT (end
) < startpos
)
4500 if (insertion
&& (XFASTINT (start
) == startpos
4501 || XFASTINT (end
) == startpos
))
4503 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4505 add_overlay_mod_hooklist (prop
, overlay
);
4507 if (insertion
&& (XFASTINT (start
) == endpos
4508 || XFASTINT (end
) == endpos
))
4510 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4512 add_overlay_mod_hooklist (prop
, overlay
);
4514 /* Test for intersecting intervals. This does the right thing
4515 for both insertion and deletion. */
4516 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4518 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4520 add_overlay_mod_hooklist (prop
, overlay
);
4525 GCPRO4 (overlay
, arg1
, arg2
, arg3
);
4527 /* Call the functions recorded in last_overlay_modification_hooks.
4528 First copy the vector contents, in case some of these hooks
4529 do subsequent modification of the buffer. */
4530 ptrdiff_t size
= last_overlay_modification_hooks_used
;
4531 Lisp_Object
*copy
= alloca (size
* sizeof *copy
);
4534 memcpy (copy
, XVECTOR (last_overlay_modification_hooks
)->contents
,
4537 gcpro1
.nvars
= size
;
4539 for (i
= 0; i
< size
;)
4541 Lisp_Object prop_i
, overlay_i
;
4543 overlay_i
= copy
[i
++];
4544 call_overlay_mod_hooks (prop_i
, overlay_i
, after
, arg1
, arg2
, arg3
);
4551 call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
, bool after
,
4552 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4554 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4556 GCPRO4 (list
, arg1
, arg2
, arg3
);
4558 while (CONSP (list
))
4561 call4 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
);
4563 call5 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
, arg3
);
4569 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4572 evaporate_overlays (ptrdiff_t pos
)
4574 Lisp_Object overlay
, hit_list
;
4575 struct Lisp_Overlay
*tail
;
4578 if (pos
<= current_buffer
->overlay_center
)
4579 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4582 XSETMISC (overlay
, tail
);
4583 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4586 if (endpos
== pos
&& OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
4587 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4588 hit_list
= Fcons (overlay
, hit_list
);
4591 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4594 XSETMISC (overlay
, tail
);
4595 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4598 if (startpos
== pos
&& OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
4599 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4600 hit_list
= Fcons (overlay
, hit_list
);
4602 for (; CONSP (hit_list
); hit_list
= XCDR (hit_list
))
4603 Fdelete_overlay (XCAR (hit_list
));
4606 /***********************************************************************
4607 Allocation with mmap
4608 ***********************************************************************/
4610 #ifdef USE_MMAP_FOR_BUFFERS
4612 #include <sys/mman.h>
4615 #ifdef MAP_ANONYMOUS
4616 #define MAP_ANON MAP_ANONYMOUS
4623 #define MAP_FAILED ((void *) -1)
4633 /* Memory is allocated in regions which are mapped using mmap(2).
4634 The current implementation lets the system select mapped
4635 addresses; we're not using MAP_FIXED in general, except when
4636 trying to enlarge regions.
4638 Each mapped region starts with a mmap_region structure, the user
4639 area starts after that structure, aligned to MEM_ALIGN.
4641 +-----------------------+
4642 | struct mmap_info + |
4644 +-----------------------+
4648 +-----------------------+ */
4652 /* User-specified size. */
4653 size_t nbytes_specified
;
4655 /* Number of bytes mapped */
4656 size_t nbytes_mapped
;
4658 /* Pointer to the location holding the address of the memory
4659 allocated with the mmap'd block. The variable actually points
4660 after this structure. */
4663 /* Next and previous in list of all mmap'd regions. */
4664 struct mmap_region
*next
, *prev
;
4667 /* Doubly-linked list of mmap'd regions. */
4669 static struct mmap_region
*mmap_regions
;
4671 /* File descriptor for mmap. If we don't have anonymous mapping,
4672 /dev/zero will be opened on it. */
4676 /* Temporary storage for mmap_set_vars, see there. */
4678 static struct mmap_region
*mmap_regions_1
;
4679 static int mmap_fd_1
;
4681 /* Page size on this system. */
4683 static int mmap_page_size
;
4685 /* 1 means mmap has been initialized. */
4687 static bool mmap_initialized_p
;
4689 /* Value is X rounded up to the next multiple of N. */
4691 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4693 /* Size of mmap_region structure plus padding. */
4695 #define MMAP_REGION_STRUCT_SIZE \
4696 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4698 /* Given a pointer P to the start of the user-visible part of a mapped
4699 region, return a pointer to the start of the region. */
4701 #define MMAP_REGION(P) \
4702 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4704 /* Given a pointer P to the start of a mapped region, return a pointer
4705 to the start of the user-visible part of the region. */
4707 #define MMAP_USER_AREA(P) \
4708 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4710 #define MEM_ALIGN sizeof (double)
4712 /* Predicate returning true if part of the address range [START .. END]
4713 is currently mapped. Used to prevent overwriting an existing
4716 Default is to conservatively assume the address range is occupied by
4717 something else. This can be overridden by system configuration
4718 files if system-specific means to determine this exists. */
4720 #ifndef MMAP_ALLOCATED_P
4721 #define MMAP_ALLOCATED_P(start, end) 1
4724 /* Perform necessary initializations for the use of mmap. */
4730 /* The value of mmap_fd is initially 0 in temacs, and -1
4731 in a dumped Emacs. */
4734 /* No anonymous mmap -- we need the file descriptor. */
4735 mmap_fd
= emacs_open ("/dev/zero", O_RDONLY
, 0);
4737 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno
));
4739 #endif /* MAP_ANON == 0 */
4741 if (mmap_initialized_p
)
4743 mmap_initialized_p
= 1;
4749 mmap_page_size
= getpagesize ();
4752 /* Return a region overlapping address range START...END, or null if
4753 none. END is not including, i.e. the last byte in the range
4756 static struct mmap_region
*
4757 mmap_find (void *start
, void *end
)
4759 struct mmap_region
*r
;
4760 char *s
= (char *) start
, *e
= (char *) end
;
4762 for (r
= mmap_regions
; r
; r
= r
->next
)
4764 char *rstart
= (char *) r
;
4765 char *rend
= rstart
+ r
->nbytes_mapped
;
4767 if (/* First byte of range, i.e. START, in this region? */
4768 (s
>= rstart
&& s
< rend
)
4769 /* Last byte of range, i.e. END - 1, in this region? */
4770 || (e
> rstart
&& e
<= rend
)
4771 /* First byte of this region in the range? */
4772 || (rstart
>= s
&& rstart
< e
)
4773 /* Last byte of this region in the range? */
4774 || (rend
> s
&& rend
<= e
))
4782 /* Unmap a region. P is a pointer to the start of the user-araa of
4786 mmap_free_1 (struct mmap_region
*r
)
4789 r
->next
->prev
= r
->prev
;
4791 r
->prev
->next
= r
->next
;
4793 mmap_regions
= r
->next
;
4795 if (munmap (r
, r
->nbytes_mapped
) == -1)
4796 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4800 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4801 Value is true if successful. */
4804 mmap_enlarge (struct mmap_region
*r
, int npages
)
4806 char *region_end
= (char *) r
+ r
->nbytes_mapped
;
4812 /* Unmap pages at the end of the region. */
4813 nbytes
= - npages
* mmap_page_size
;
4814 if (munmap (region_end
- nbytes
, nbytes
) == -1)
4815 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4818 r
->nbytes_mapped
-= nbytes
;
4822 else if (npages
> 0)
4824 nbytes
= npages
* mmap_page_size
;
4826 /* Try to map additional pages at the end of the region. We
4827 cannot do this if the address range is already occupied by
4828 something else because mmap deletes any previous mapping.
4829 I'm not sure this is worth doing, let's see. */
4830 if (!MMAP_ALLOCATED_P (region_end
, region_end
+ nbytes
))
4834 p
= mmap (region_end
, nbytes
, PROT_READ
| PROT_WRITE
,
4835 MAP_ANON
| MAP_PRIVATE
| MAP_FIXED
, mmap_fd
, 0);
4836 if (p
== MAP_FAILED
)
4837 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4838 else if (p
!= region_end
)
4840 /* Kernels are free to choose a different address. In
4841 that case, unmap what we've mapped above; we have
4843 if (munmap (p
, nbytes
) == -1)
4844 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4848 r
->nbytes_mapped
+= nbytes
;
4858 /* Set or reset variables holding references to mapped regions.
4859 If not RESTORE_P, set all variables to null. If RESTORE_P, set all
4860 variables to the start of the user-areas of mapped regions.
4862 This function is called from Fdump_emacs to ensure that the dumped
4863 Emacs doesn't contain references to memory that won't be mapped
4864 when Emacs starts. */
4867 mmap_set_vars (bool restore_p
)
4869 struct mmap_region
*r
;
4873 mmap_regions
= mmap_regions_1
;
4874 mmap_fd
= mmap_fd_1
;
4875 for (r
= mmap_regions
; r
; r
= r
->next
)
4876 *r
->var
= MMAP_USER_AREA (r
);
4880 for (r
= mmap_regions
; r
; r
= r
->next
)
4882 mmap_regions_1
= mmap_regions
;
4883 mmap_regions
= NULL
;
4884 mmap_fd_1
= mmap_fd
;
4890 /* Allocate a block of storage large enough to hold NBYTES bytes of
4891 data. A pointer to the data is returned in *VAR. VAR is thus the
4892 address of some variable which will use the data area.
4894 The allocation of 0 bytes is valid.
4896 If we can't allocate the necessary memory, set *VAR to null, and
4900 mmap_alloc (void **var
, size_t nbytes
)
4907 map
= ROUND (nbytes
+ MMAP_REGION_STRUCT_SIZE
, mmap_page_size
);
4908 p
= mmap (NULL
, map
, PROT_READ
| PROT_WRITE
, MAP_ANON
| MAP_PRIVATE
,
4911 if (p
== MAP_FAILED
)
4913 if (errno
!= ENOMEM
)
4914 fprintf (stderr
, "mmap: %s\n", emacs_strerror (errno
));
4919 struct mmap_region
*r
= (struct mmap_region
*) p
;
4921 r
->nbytes_specified
= nbytes
;
4922 r
->nbytes_mapped
= map
;
4925 r
->next
= mmap_regions
;
4930 p
= MMAP_USER_AREA (p
);
4937 /* Free a block of relocatable storage whose data is pointed to by
4938 PTR. Store 0 in *PTR to show there's no block allocated. */
4941 mmap_free (void **var
)
4947 mmap_free_1 (MMAP_REGION (*var
));
4953 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4954 resize it to size NBYTES. Change *VAR to reflect the new block,
4955 and return this value. If more memory cannot be allocated, then
4956 leave *VAR unchanged, and return null. */
4959 mmap_realloc (void **var
, size_t nbytes
)
4966 result
= mmap_alloc (var
, nbytes
);
4967 else if (nbytes
== 0)
4970 result
= mmap_alloc (var
, nbytes
);
4974 struct mmap_region
*r
= MMAP_REGION (*var
);
4975 size_t room
= r
->nbytes_mapped
- MMAP_REGION_STRUCT_SIZE
;
4980 void *old_ptr
= *var
;
4982 /* Try to map additional pages at the end of the region.
4983 If that fails, allocate a new region, copy data
4984 from the old region, then free it. */
4985 if (mmap_enlarge (r
, (ROUND (nbytes
- room
, mmap_page_size
)
4988 r
->nbytes_specified
= nbytes
;
4989 *var
= result
= old_ptr
;
4991 else if (mmap_alloc (var
, nbytes
))
4993 memcpy (*var
, old_ptr
, r
->nbytes_specified
);
4994 mmap_free_1 (MMAP_REGION (old_ptr
));
4996 r
= MMAP_REGION (result
);
4997 r
->nbytes_specified
= nbytes
;
5005 else if (room
- nbytes
>= mmap_page_size
)
5007 /* Shrinking by at least a page. Let's give some
5008 memory back to the system.
5010 The extra parens are to make the division happens first,
5011 on positive values, so we know it will round towards
5013 mmap_enlarge (r
, - ((room
- nbytes
) / mmap_page_size
));
5015 r
->nbytes_specified
= nbytes
;
5019 /* Leave it alone. */
5021 r
->nbytes_specified
= nbytes
;
5029 #endif /* USE_MMAP_FOR_BUFFERS */
5033 /***********************************************************************
5034 Buffer-text Allocation
5035 ***********************************************************************/
5037 /* Allocate NBYTES bytes for buffer B's text buffer. */
5040 alloc_buffer_text (struct buffer
*b
, ptrdiff_t nbytes
)
5045 #if defined USE_MMAP_FOR_BUFFERS
5046 p
= mmap_alloc ((void **) &b
->text
->beg
, nbytes
);
5047 #elif defined REL_ALLOC
5048 p
= r_alloc ((void **) &b
->text
->beg
, nbytes
);
5050 p
= xmalloc (nbytes
);
5056 memory_full (nbytes
);
5059 b
->text
->beg
= (unsigned char *) p
;
5063 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
5067 enlarge_buffer_text (struct buffer
*b
, ptrdiff_t delta
)
5070 ptrdiff_t nbytes
= (BUF_Z_BYTE (b
) - BUF_BEG_BYTE (b
) + BUF_GAP_SIZE (b
) + 1
5073 #if defined USE_MMAP_FOR_BUFFERS
5074 p
= mmap_realloc ((void **) &b
->text
->beg
, nbytes
);
5075 #elif defined REL_ALLOC
5076 p
= r_re_alloc ((void **) &b
->text
->beg
, nbytes
);
5078 p
= xrealloc (b
->text
->beg
, nbytes
);
5084 memory_full (nbytes
);
5087 BUF_BEG_ADDR (b
) = (unsigned char *) p
;
5092 /* Free buffer B's text buffer. */
5095 free_buffer_text (struct buffer
*b
)
5099 #if defined USE_MMAP_FOR_BUFFERS
5100 mmap_free ((void **) &b
->text
->beg
);
5101 #elif defined REL_ALLOC
5102 r_alloc_free ((void **) &b
->text
->beg
);
5104 xfree (b
->text
->beg
);
5107 BUF_BEG_ADDR (b
) = NULL
;
5113 /***********************************************************************
5115 ***********************************************************************/
5118 init_buffer_once (void)
5122 memset (buffer_permanent_local_flags
, 0, sizeof buffer_permanent_local_flags
);
5124 /* Make sure all markable slots in buffer_defaults
5125 are initialized reasonably, so mark_buffer won't choke. */
5126 reset_buffer (&buffer_defaults
);
5127 eassert (EQ (BVAR (&buffer_defaults
, name
), make_number (0)));
5128 reset_buffer_local_variables (&buffer_defaults
, 1);
5129 eassert (EQ (BVAR (&buffer_local_symbols
, name
), make_number (0)));
5130 reset_buffer (&buffer_local_symbols
);
5131 reset_buffer_local_variables (&buffer_local_symbols
, 1);
5132 /* Prevent GC from getting confused. */
5133 buffer_defaults
.text
= &buffer_defaults
.own_text
;
5134 buffer_local_symbols
.text
= &buffer_local_symbols
.own_text
;
5135 /* No one will share the text with these buffers, but let's play it safe. */
5136 buffer_defaults
.indirections
= 0;
5137 buffer_local_symbols
.indirections
= 0;
5138 /* Likewise no one will display them. */
5139 buffer_defaults
.window_count
= 0;
5140 buffer_local_symbols
.window_count
= 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 BUFFER_PVEC_INIT (&buffer_defaults
);
5147 BUFFER_PVEC_INIT (&buffer_local_symbols
);
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
5377 Lisp_Object stored in the current buffer. LNAME is the Lisp-level
5378 variable name. VNAME is the name of the buffer slot. PREDICATE
5379 is nil for a general Lisp variable. If PREDICATE is non-nil, then
5380 only Lisp values that satisfies the PREDICATE are allowed (except
5381 that nil is allowed too). DOC is a dummy where you write the doc
5382 string as a comment. */
5384 #define DEFVAR_PER_BUFFER(lname, vname, predicate, doc) \
5386 static struct Lisp_Buffer_Objfwd bo_fwd; \
5387 defvar_per_buffer (&bo_fwd, lname, vname, predicate); \
5391 defvar_per_buffer (struct Lisp_Buffer_Objfwd
*bo_fwd
, const char *namestring
,
5392 Lisp_Object
*address
, Lisp_Object predicate
)
5394 struct Lisp_Symbol
*sym
;
5397 sym
= XSYMBOL (intern (namestring
));
5398 offset
= (char *)address
- (char *)current_buffer
;
5400 bo_fwd
->type
= Lisp_Fwd_Buffer_Obj
;
5401 bo_fwd
->offset
= offset
;
5402 bo_fwd
->predicate
= predicate
;
5403 sym
->declared_special
= 1;
5404 sym
->redirect
= SYMBOL_FORWARDED
;
5406 /* I tried to do the job without a cast, but it seems impossible.
5407 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5408 SET_SYMBOL_FWD (sym
, (union Lisp_Fwd
*)bo_fwd
);
5410 XSETSYMBOL (PER_BUFFER_SYMBOL (offset
), sym
);
5412 if (PER_BUFFER_IDX (offset
) == 0)
5413 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5414 slot of buffer_local_flags */
5419 /* initialize the buffer routines */
5421 syms_of_buffer (void)
5423 staticpro (&last_overlay_modification_hooks
);
5424 last_overlay_modification_hooks
5425 = Fmake_vector (make_number (10), Qnil
);
5427 staticpro (&Qfundamental_mode
);
5428 staticpro (&Qmode_class
);
5429 staticpro (&QSFundamental
);
5430 staticpro (&Vbuffer_alist
);
5431 staticpro (&Qprotected_field
);
5432 staticpro (&Qpermanent_local
);
5433 staticpro (&Qkill_buffer_hook
);
5435 DEFSYM (Qpermanent_local_hook
, "permanent-local-hook");
5436 DEFSYM (Qoverlayp
, "overlayp");
5437 DEFSYM (Qevaporate
, "evaporate");
5438 DEFSYM (Qmodification_hooks
, "modification-hooks");
5439 DEFSYM (Qinsert_in_front_hooks
, "insert-in-front-hooks");
5440 DEFSYM (Qinsert_behind_hooks
, "insert-behind-hooks");
5441 DEFSYM (Qget_file_buffer
, "get-file-buffer");
5442 DEFSYM (Qpriority
, "priority");
5443 DEFSYM (Qbefore_string
, "before-string");
5444 DEFSYM (Qafter_string
, "after-string");
5445 DEFSYM (Qfirst_change_hook
, "first-change-hook");
5446 DEFSYM (Qbefore_change_functions
, "before-change-functions");
5447 DEFSYM (Qafter_change_functions
, "after-change-functions");
5448 DEFSYM (Qkill_buffer_query_functions
, "kill-buffer-query-functions");
5450 Fput (Qprotected_field
, Qerror_conditions
,
5451 listn (CONSTYPE_PURE
, 2, Qprotected_field
, Qerror
));
5452 Fput (Qprotected_field
, Qerror_message
,
5453 build_pure_c_string ("Attempt to modify a protected field"));
5455 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5457 doc
: /* Default value of `mode-line-format' for buffers that don't override it.
5458 This is the same as (default-value 'mode-line-format). */);
5460 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5462 doc
: /* Default value of `header-line-format' for buffers that don't override it.
5463 This is the same as (default-value 'header-line-format). */);
5465 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type
,
5466 doc
: /* Default value of `cursor-type' for buffers that don't override it.
5467 This is the same as (default-value 'cursor-type). */);
5469 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5471 doc
: /* Default value of `line-spacing' for buffers that don't override it.
5472 This is the same as (default-value 'line-spacing). */);
5474 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5475 cursor_in_non_selected_windows
,
5476 doc
: /* Default value of `cursor-in-non-selected-windows'.
5477 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5479 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5481 doc
: /* Default value of `abbrev-mode' for buffers that do not override it.
5482 This is the same as (default-value 'abbrev-mode). */);
5484 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5486 doc
: /* Default value of `ctl-arrow' for buffers that do not override it.
5487 This is the same as (default-value 'ctl-arrow). */);
5489 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5490 enable_multibyte_characters
,
5491 doc
: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5492 This is the same as (default-value 'enable-multibyte-characters). */);
5494 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5495 buffer_file_coding_system
,
5496 doc
: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5497 This is the same as (default-value 'buffer-file-coding-system). */);
5499 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5501 doc
: /* Default value of `truncate-lines' for buffers that do not override it.
5502 This is the same as (default-value 'truncate-lines). */);
5504 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5506 doc
: /* Default value of `fill-column' for buffers that do not override it.
5507 This is the same as (default-value 'fill-column). */);
5509 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5511 doc
: /* Default value of `left-margin' for buffers that do not override it.
5512 This is the same as (default-value 'left-margin). */);
5514 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5516 doc
: /* Default value of `tab-width' for buffers that do not override it.
5517 NOTE: This controls the display width of a TAB character, and not
5518 the size of an indentation step.
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
),
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
),
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
),
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
),
5709 doc
: /* Distance between tab stops (for display of tab characters), in columns.
5710 NOTE: This controls the display width of a TAB character, and not
5711 the size of an indentation step.
5712 This should be an integer greater than zero. */);
5714 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer
, ctl_arrow
), Qnil
,
5715 doc
: /* Non-nil means display control chars with uparrow.
5716 A value of nil means use backslash and octal digits.
5717 This variable does not apply to characters whose display is specified
5718 in the current display table (if there is one). */);
5720 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5721 &BVAR (current_buffer
, enable_multibyte_characters
),
5723 doc
: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5724 Otherwise they are regarded as unibyte. This affects the display,
5725 file I/O and the behavior of various editing commands.
5727 This variable is buffer-local but you cannot set it directly;
5728 use the function `set-buffer-multibyte' to change a buffer's representation.
5729 See also Info node `(elisp)Text Representations'. */);
5730 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant
= 1;
5732 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5733 &BVAR (current_buffer
, buffer_file_coding_system
), Qnil
,
5734 doc
: /* Coding system to be used for encoding the buffer contents on saving.
5735 This variable applies to saving the buffer, and also to `write-region'
5736 and other functions that use `write-region'.
5737 It does not apply to sending output to subprocesses, however.
5739 If this is nil, the buffer is saved without any code conversion
5740 unless some coding system is specified in `file-coding-system-alist'
5741 for the buffer file.
5743 If the text to be saved cannot be encoded as specified by this variable,
5744 an alternative encoding is selected by `select-safe-coding-system', which see.
5746 The variable `coding-system-for-write', if non-nil, overrides this variable.
5748 This variable is never applied to a way of decoding a file while reading it. */);
5750 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5751 &BVAR (current_buffer
, bidi_display_reordering
), Qnil
,
5752 doc
: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5754 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5755 &BVAR (current_buffer
, bidi_paragraph_direction
), Qnil
,
5756 doc
: /* If non-nil, forces directionality of text paragraphs in the buffer.
5758 If this is nil (the default), the direction of each paragraph is
5759 determined by the first strong directional character of its text.
5760 The values of `right-to-left' and `left-to-right' override that.
5761 Any other value is treated as nil.
5763 This variable has no effect unless the buffer's value of
5764 \`bidi-display-reordering' is non-nil. */);
5766 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer
, truncate_lines
), Qnil
,
5767 doc
: /* Non-nil means do not display continuation lines.
5768 Instead, give each line of text just one screen line.
5770 Note that this is overridden by the variable
5771 `truncate-partial-width-windows' if that variable is non-nil
5772 and this buffer is not full-frame width.
5774 Minibuffers set this variable to nil. */);
5776 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer
, word_wrap
), Qnil
,
5777 doc
: /* Non-nil means to use word-wrapping for continuation lines.
5778 When word-wrapping is on, continuation lines are wrapped at the space
5779 or tab character nearest to the right window edge.
5780 If nil, continuation lines are wrapped at the right screen edge.
5782 This variable has no effect if long lines are truncated (see
5783 `truncate-lines' and `truncate-partial-width-windows'). If you use
5784 word-wrapping, you might want to reduce the value of
5785 `truncate-partial-width-windows', since wrapping can make text readable
5786 in narrower windows.
5788 Instead of setting this variable directly, most users should use
5789 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5790 to t, and additionally redefines simple editing commands to act on
5791 visual lines rather than logical lines. See the documentation of
5792 `visual-line-mode'. */);
5794 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer
, directory
),
5796 doc
: /* Name of default directory of current buffer. Should end with slash.
5797 To interactively change the default directory, use command `cd'. */);
5799 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer
, auto_fill_function
),
5801 doc
: /* Function called (if non-nil) to perform auto-fill.
5802 It is called after self-inserting any character specified in
5803 the `auto-fill-chars' table.
5804 NOTE: This variable is not a hook;
5805 its value may not be a list of functions. */);
5807 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer
, filename
),
5809 doc
: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5811 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer
, file_truename
),
5813 doc
: /* Abbreviated truename of file visited in current buffer, or nil if none.
5814 The truename of a file is calculated by `file-truename'
5815 and then abbreviated with `abbreviate-file-name'. */);
5817 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5818 &BVAR (current_buffer
, auto_save_file_name
),
5820 doc
: /* Name of file for auto-saving current buffer.
5821 If it is nil, that means don't auto-save this buffer. */);
5823 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer
, read_only
), Qnil
,
5824 doc
: /* Non-nil if this buffer is read-only. */);
5826 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer
, backed_up
), Qnil
,
5827 doc
: /* Non-nil if this buffer's file has been backed up.
5828 Backing up is done before the first time the file is saved. */);
5830 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer
, save_length
),
5832 doc
: /* Length of current buffer when last read in, saved or auto-saved.
5834 -1 means auto-saving turned off until next real save.
5836 If you set this to -2, that means don't turn off auto-saving in this buffer
5837 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5838 you probably should set this to -2 in that buffer. */);
5840 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer
, selective_display
),
5842 doc
: /* Non-nil enables selective display.
5843 An integer N as value means display only lines
5844 that start with less than N columns of space.
5845 A value of t means that the character ^M makes itself and
5846 all the rest of the line invisible; also, when saving the buffer
5847 in a file, save the ^M as a newline. */);
5849 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5850 &BVAR (current_buffer
, selective_display_ellipses
),
5852 doc
: /* Non-nil means display ... on previous line when a line is invisible. */);
5854 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer
, overwrite_mode
), Qnil
,
5855 doc
: /* Non-nil if self-insertion should replace existing text.
5856 The value should be one of `overwrite-mode-textual',
5857 `overwrite-mode-binary', or nil.
5858 If it is `overwrite-mode-textual', self-insertion still
5859 inserts at the end of a line, and inserts when point is before a tab,
5860 until the tab is filled in.
5861 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5863 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer
, display_table
),
5865 doc
: /* Display table that controls display of the contents of current buffer.
5867 If this variable is nil, the value of `standard-display-table' is used.
5868 Each window can have its own, overriding display table, see
5869 `set-window-display-table' and `window-display-table'.
5871 The display table is a char-table created with `make-display-table'.
5872 A char-table is an array indexed by character codes. Normal array
5873 primitives `aref' and `aset' can be used to access elements of a char-table.
5875 Each of the char-table elements control how to display the corresponding
5876 text character: the element at index C in the table says how to display
5877 the character whose code is C. Each element should be a vector of
5878 characters or nil. The value nil means display the character in the
5879 default fashion; otherwise, the characters from the vector are delivered
5880 to the screen instead of the original character.
5882 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5883 to display a capital Y instead of each X character.
5885 In addition, a char-table has six extra slots to control the display of:
5887 the end of a truncated screen line (extra-slot 0, a single character);
5888 the end of a continued line (extra-slot 1, a single character);
5889 the escape character used to display character codes in octal
5890 (extra-slot 2, a single character);
5891 the character used as an arrow for control characters (extra-slot 3,
5892 a single character);
5893 the decoration indicating the presence of invisible lines (extra-slot 4,
5894 a vector of characters);
5895 the character used to draw the border between side-by-side windows
5896 (extra-slot 5, a single character).
5898 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5900 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer
, left_margin_cols
),
5902 doc
: /* Width of left marginal area for display of a buffer.
5903 A value of nil means no marginal area.
5905 Setting this variable does not take effect until a new buffer is displayed
5906 in a window. To make the change take effect, call `set-window-buffer'. */);
5908 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer
, right_margin_cols
),
5910 doc
: /* Width of right marginal area for display of a buffer.
5911 A value of nil means no marginal area.
5913 Setting this variable does not take effect until a new buffer is displayed
5914 in a window. To make the change take effect, call `set-window-buffer'. */);
5916 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer
, left_fringe_width
),
5918 doc
: /* Width of this buffer's left fringe (in pixels).
5919 A value of 0 means no left fringe is shown in this buffer's window.
5920 A value of nil means to use the left fringe width from the window's frame.
5922 Setting this variable does not take effect until a new buffer is displayed
5923 in a window. To make the change take effect, call `set-window-buffer'. */);
5925 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer
, right_fringe_width
),
5927 doc
: /* Width of this buffer's right fringe (in pixels).
5928 A value of 0 means no right fringe is shown in this buffer's window.
5929 A value of nil means to use the right fringe width from the window's frame.
5931 Setting this variable does not take effect until a new buffer is displayed
5932 in a window. To make the change take effect, call `set-window-buffer'. */);
5934 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer
, fringes_outside_margins
),
5936 doc
: /* Non-nil means to display fringes outside display margins.
5937 A value of nil means to display fringes between margins and buffer text.
5939 Setting this variable does not take effect until a new buffer is displayed
5940 in a window. To make the change take effect, call `set-window-buffer'. */);
5942 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer
, scroll_bar_width
),
5944 doc
: /* Width of this buffer's scroll bars in pixels.
5945 A value of nil means to use the scroll bar width from the window's frame. */);
5947 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer
, vertical_scroll_bar_type
),
5949 doc
: /* Position of this buffer's vertical scroll bar.
5950 The value takes effect whenever you tell a window to display this buffer;
5951 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5953 A value of `left' or `right' means put the vertical scroll bar at that side
5954 of the window; a value of nil means don't show any vertical scroll bars.
5955 A value of t (the default) means do whatever the window's frame specifies. */);
5957 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5958 &BVAR (current_buffer
, indicate_empty_lines
), Qnil
,
5959 doc
: /* Visually indicate empty lines after the buffer end.
5960 If non-nil, a bitmap is displayed in the left fringe of a window on
5961 window-systems. */);
5963 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5964 &BVAR (current_buffer
, indicate_buffer_boundaries
), Qnil
,
5965 doc
: /* Visually indicate buffer boundaries and scrolling.
5966 If non-nil, the first and last line of the buffer are marked in the fringe
5967 of a window on window-systems with angle bitmaps, or if the window can be
5968 scrolled, the top and bottom line of the window are marked with up and down
5971 If value is a symbol `left' or `right', both angle and arrow bitmaps
5972 are displayed in the left or right fringe, resp. Any other value
5973 that doesn't look like an alist means display the angle bitmaps in
5974 the left fringe but no arrows.
5976 You can exercise more precise control by using an alist as the
5977 value. Each alist element (INDICATOR . POSITION) specifies
5978 where to show one of the indicators. INDICATOR is one of `top',
5979 `bottom', `up', `down', or t, which specifies the default position,
5980 and POSITION is one of `left', `right', or nil, meaning do not show
5983 For example, ((top . left) (t . right)) places the top angle bitmap in
5984 left fringe, the bottom angle bitmap in right fringe, and both arrow
5985 bitmaps in right fringe. To show just the angle bitmaps in the left
5986 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5988 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5989 &BVAR (current_buffer
, fringe_indicator_alist
), Qnil
,
5990 doc
: /* Mapping from logical to physical fringe indicator bitmaps.
5991 The value is an alist where each element (INDICATOR . BITMAPS)
5992 specifies the fringe bitmaps used to display a specific logical
5995 INDICATOR specifies the logical indicator type which is one of the
5996 following symbols: `truncation' , `continuation', `overlay-arrow',
5997 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5999 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
6000 the actual bitmap shown in the left or right fringe for the logical
6001 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
6002 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
6003 are used only for the `bottom' and `top-bottom' indicators when the
6004 last (only) line has no final newline. BITMAPS may also be a single
6005 symbol which is used in both left and right fringes. */);
6007 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
6008 &BVAR (current_buffer
, fringe_cursor_alist
), Qnil
,
6009 doc
: /* Mapping from logical to physical fringe cursor bitmaps.
6010 The value is an alist where each element (CURSOR . BITMAP)
6011 specifies the fringe bitmaps used to display a specific logical
6012 cursor type in the fringe.
6014 CURSOR specifies the logical cursor type which is one of the following
6015 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
6016 one is used to show a hollow cursor on narrow lines display lines
6017 where the normal hollow cursor will not fit.
6019 BITMAP is the corresponding fringe bitmap shown for the logical
6022 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
6023 &BVAR (current_buffer
, scroll_up_aggressively
), Qfloatp
,
6024 doc
: /* How far to scroll windows upward.
6025 If you move point off the bottom, the window scrolls automatically.
6026 This variable controls how far it scrolls. The value nil, the default,
6027 means scroll to center point. A fraction means scroll to put point
6028 that fraction of the window's height from the bottom of the window.
6029 When the value is 0.0, point goes at the bottom line, which in the
6030 simple case that you moved off with C-f means scrolling just one line.
6031 1.0 means point goes at the top, so that in that simple case, the
6032 window scrolls by a full window height. Meaningful values are
6033 between 0.0 and 1.0, inclusive. */);
6035 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
6036 &BVAR (current_buffer
, scroll_down_aggressively
), Qfloatp
,
6037 doc
: /* How far to scroll windows downward.
6038 If you move point off the top, the window scrolls automatically.
6039 This variable controls how far it scrolls. The value nil, the default,
6040 means scroll to center point. A fraction means scroll to put point
6041 that fraction of the window's height from the top of the window.
6042 When the value is 0.0, point goes at the top line, which in the
6043 simple case that you moved off with C-b means scrolling just one line.
6044 1.0 means point goes at the bottom, so that in that simple case, the
6045 window scrolls by a full window height. Meaningful values are
6046 between 0.0 and 1.0, inclusive. */);
6048 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions
,
6049 doc
: /* List of functions to call before each text change.
6050 Two arguments are passed to each function: the positions of
6051 the beginning and end of the range of old text to be changed.
6052 \(For an insertion, the beginning and end are at the same place.)
6053 No information is given about the length of the text after the change.
6055 Buffer changes made while executing the `before-change-functions'
6056 don't call any before-change or after-change functions.
6057 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6059 If an unhandled error happens in running these functions,
6060 the variable's value remains nil. That prevents the error
6061 from happening repeatedly and making Emacs nonfunctional. */);
6062 Vbefore_change_functions
= Qnil
;
6064 DEFVAR_LISP ("after-change-functions", Vafter_change_functions
,
6065 doc
: /* List of functions to call after each text change.
6066 Three arguments are passed to each function: the positions of
6067 the beginning and end of the range of changed text,
6068 and the length in bytes of the pre-change text replaced by that range.
6069 \(For an insertion, the pre-change length is zero;
6070 for a deletion, that length is the number of bytes deleted,
6071 and the post-change beginning and end are at the same place.)
6073 Buffer changes made while executing the `after-change-functions'
6074 don't call any before-change or after-change functions.
6075 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6077 If an unhandled error happens in running these functions,
6078 the variable's value remains nil. That prevents the error
6079 from happening repeatedly and making Emacs nonfunctional. */);
6080 Vafter_change_functions
= Qnil
;
6082 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook
,
6083 doc
: /* A list of functions to call before changing a buffer which is unmodified.
6084 The functions are run using the `run-hooks' function. */);
6085 Vfirst_change_hook
= Qnil
;
6087 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer
, undo_list
), Qnil
,
6088 doc
: /* List of undo entries in current buffer.
6089 Recent changes come first; older changes follow newer.
6091 An entry (BEG . END) represents an insertion which begins at
6092 position BEG and ends at position END.
6094 An entry (TEXT . POSITION) represents the deletion of the string TEXT
6095 from (abs POSITION). If POSITION is positive, point was at the front
6096 of the text being deleted; if negative, point was at the end.
6098 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
6099 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
6100 and is the visited file's modification time, as of that time. If the
6101 modification time of the most recent save is different, this entry is
6104 An entry (t . 0) means means the buffer was previously unmodified but
6105 its time stamp was unknown because it was not associated with a file.
6106 An entry (t . -1) is similar, except that it means the buffer's visited
6109 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
6110 was modified between BEG and END. PROPERTY is the property name,
6111 and VALUE is the old value.
6113 An entry (apply FUN-NAME . ARGS) means undo the change with
6114 \(apply FUN-NAME ARGS).
6116 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
6117 in the active region. BEG and END is the range affected by this entry
6118 and DELTA is the number of bytes added or deleted in that range by
6121 An entry (MARKER . DISTANCE) indicates that the marker MARKER
6122 was adjusted in position by the offset DISTANCE (an integer).
6124 An entry of the form POSITION indicates that point was at the buffer
6125 location given by the integer. Undoing an entry of this form places
6128 Entries with value `nil' mark undo boundaries. The undo command treats
6129 the changes between two undo boundaries as a single step to be undone.
6131 If the value of the variable is t, undo information is not recorded. */);
6133 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer
, mark_active
), Qnil
,
6134 doc
: /* Non-nil means the mark and region are currently active in this buffer. */);
6136 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer
, cache_long_line_scans
), Qnil
,
6137 doc
: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
6139 Normally, the line-motion functions work by scanning the buffer for
6140 newlines. Columnar operations (like `move-to-column' and
6141 `compute-motion') also work by scanning the buffer, summing character
6142 widths as they go. This works well for ordinary text, but if the
6143 buffer's lines are very long (say, more than 500 characters), these
6144 motion functions will take longer to execute. Emacs may also take
6145 longer to update the display.
6147 If `cache-long-line-scans' is non-nil, these motion functions cache the
6148 results of their scans, and consult the cache to avoid rescanning
6149 regions of the buffer until the text is modified. The caches are most
6150 beneficial when they prevent the most searching---that is, when the
6151 buffer contains long lines and large regions of characters with the
6152 same, fixed screen width.
6154 When `cache-long-line-scans' is non-nil, processing short lines will
6155 become slightly slower (because of the overhead of consulting the
6156 cache), and the caches will use memory roughly proportional to the
6157 number of newlines and characters whose screen width varies.
6159 The caches require no explicit maintenance; their accuracy is
6160 maintained internally by the Emacs primitives. Enabling or disabling
6161 the cache should not affect the behavior of any of the motion
6162 functions; it should only affect their performance. */);
6164 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer
, point_before_scroll
), Qnil
,
6165 doc
: /* Value of point before the last series of scroll operations, or nil. */);
6167 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer
, file_format
), Qnil
,
6168 doc
: /* List of formats to use when saving this buffer.
6169 Formats are defined by `format-alist'. This variable is
6170 set when a file is visited. */);
6172 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6173 &BVAR (current_buffer
, auto_save_file_format
), Qnil
,
6174 doc
: /* Format in which to write auto-save files.
6175 Should be a list of symbols naming formats that are defined in `format-alist'.
6176 If it is t, which is the default, auto-save files are written in the
6177 same format as a regular save would use. */);
6179 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6180 &BVAR (current_buffer
, invisibility_spec
), Qnil
,
6181 doc
: /* Invisibility spec of this buffer.
6182 The default is t, which means that text is invisible
6183 if it has a non-nil `invisible' property.
6184 If the value is a list, a text character is invisible if its `invisible'
6185 property is an element in that list (or is a list with members in common).
6186 If an element is a cons cell of the form (PROP . ELLIPSIS),
6187 then characters with property value PROP are invisible,
6188 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
6190 DEFVAR_PER_BUFFER ("buffer-display-count",
6191 &BVAR (current_buffer
, display_count
), Qintegerp
,
6192 doc
: /* A number incremented each time this buffer is displayed in a window.
6193 The function `set-window-buffer' increments it. */);
6195 DEFVAR_PER_BUFFER ("buffer-display-time",
6196 &BVAR (current_buffer
, display_time
), Qnil
,
6197 doc
: /* Time stamp updated each time this buffer is displayed in a window.
6198 The function `set-window-buffer' updates this variable
6199 to the value obtained by calling `current-time'.
6200 If the buffer has never been shown in a window, the value is nil. */);
6202 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode
,
6203 doc
: /* Non-nil if Transient Mark mode is enabled.
6204 See the command `transient-mark-mode' for a description of this minor mode.
6206 Non-nil also enables highlighting of the region whenever the mark is active.
6207 The variable `highlight-nonselected-windows' controls whether to highlight
6208 all windows or just the selected window.
6210 Lisp programs may give this variable certain special values:
6212 - A value of `lambda' enables Transient Mark mode temporarily.
6213 It is disabled again after any subsequent action that would
6214 normally deactivate the mark (e.g. buffer modification).
6216 - A value of (only . OLDVAL) enables Transient Mark mode
6217 temporarily. After any subsequent point motion command that is
6218 not shift-translated, or any other action that would normally
6219 deactivate the mark (e.g. buffer modification), the value of
6220 `transient-mark-mode' is set to OLDVAL. */);
6221 Vtransient_mark_mode
= Qnil
;
6223 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only
,
6224 doc
: /* Non-nil means disregard read-only status of buffers or characters.
6225 If the value is t, disregard `buffer-read-only' and all `read-only'
6226 text properties. If the value is a list, disregard `buffer-read-only'
6227 and disregard a `read-only' text property if the property value
6228 is a member of the list. */);
6229 Vinhibit_read_only
= Qnil
;
6231 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer
, cursor_type
), Qnil
,
6232 doc
: /* Cursor to use when this buffer is in the selected window.
6233 Values are interpreted as follows:
6235 t use the cursor specified for the frame
6236 nil don't display a cursor
6237 box display a filled box cursor
6238 hollow display a hollow box cursor
6239 bar display a vertical bar cursor with default width
6240 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6241 hbar display a horizontal bar cursor with default height
6242 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6243 ANYTHING ELSE display a hollow box cursor
6245 When the buffer is displayed in a non-selected window, the
6246 cursor's appearance is instead controlled by the variable
6247 `cursor-in-non-selected-windows'. */);
6249 DEFVAR_PER_BUFFER ("line-spacing",
6250 &BVAR (current_buffer
, extra_line_spacing
), Qnumberp
,
6251 doc
: /* Additional space to put between lines when displaying a buffer.
6252 The space is measured in pixels, and put below lines on graphic displays,
6253 see `display-graphic-p'.
6254 If value is a floating point number, it specifies the spacing relative
6255 to the default frame line height. A value of nil means add no extra space. */);
6257 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6258 &BVAR (current_buffer
, cursor_in_non_selected_windows
), Qnil
,
6259 doc
: /* Non-nil means show a cursor in non-selected windows.
6260 If nil, only shows a cursor in the selected window.
6261 If t, displays a cursor related to the usual cursor type
6262 \(a solid box becomes hollow, a bar becomes a narrower bar).
6263 You can also specify the cursor type as in the `cursor-type' variable.
6264 Use Custom to set this variable and update the display." */);
6266 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions
,
6267 doc
: /* List of functions called with no args to query before killing a buffer.
6268 The buffer being killed will be current while the functions are running.
6270 If any of them returns nil, the buffer is not killed. Functions run by
6271 this hook are supposed to not change the current buffer. */);
6272 Vkill_buffer_query_functions
= Qnil
;
6274 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook
,
6275 doc
: /* Normal hook run before changing the major mode of a buffer.
6276 The function `kill-all-local-variables' runs this before doing anything else. */);
6277 Vchange_major_mode_hook
= Qnil
;
6278 DEFSYM (Qchange_major_mode_hook
, "change-major-mode-hook");
6280 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook
,
6281 doc
: /* Hook run when the buffer list changes.
6282 Functions running this hook are `get-buffer-create',
6283 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6284 and `bury-buffer-internal'. */);
6285 Vbuffer_list_update_hook
= Qnil
;
6286 DEFSYM (Qbuffer_list_update_hook
, "buffer-list-update-hook");
6288 defsubr (&Sbuffer_live_p
);
6289 defsubr (&Sbuffer_list
);
6290 defsubr (&Sget_buffer
);
6291 defsubr (&Sget_file_buffer
);
6292 defsubr (&Sget_buffer_create
);
6293 defsubr (&Smake_indirect_buffer
);
6294 defsubr (&Sgenerate_new_buffer_name
);
6295 defsubr (&Sbuffer_name
);
6296 defsubr (&Sbuffer_file_name
);
6297 defsubr (&Sbuffer_base_buffer
);
6298 defsubr (&Sbuffer_local_value
);
6299 defsubr (&Sbuffer_local_variables
);
6300 defsubr (&Sbuffer_modified_p
);
6301 defsubr (&Sset_buffer_modified_p
);
6302 defsubr (&Sbuffer_modified_tick
);
6303 defsubr (&Sbuffer_chars_modified_tick
);
6304 defsubr (&Srename_buffer
);
6305 defsubr (&Sother_buffer
);
6306 defsubr (&Sbuffer_enable_undo
);
6307 defsubr (&Skill_buffer
);
6308 defsubr (&Sbury_buffer_internal
);
6309 defsubr (&Sset_buffer_major_mode
);
6310 defsubr (&Scurrent_buffer
);
6311 defsubr (&Sset_buffer
);
6312 defsubr (&Sbarf_if_buffer_read_only
);
6313 defsubr (&Serase_buffer
);
6314 defsubr (&Sbuffer_swap_text
);
6315 defsubr (&Sset_buffer_multibyte
);
6316 defsubr (&Skill_all_local_variables
);
6318 defsubr (&Soverlayp
);
6319 defsubr (&Smake_overlay
);
6320 defsubr (&Sdelete_overlay
);
6321 defsubr (&Sdelete_all_overlays
);
6322 defsubr (&Smove_overlay
);
6323 defsubr (&Soverlay_start
);
6324 defsubr (&Soverlay_end
);
6325 defsubr (&Soverlay_buffer
);
6326 defsubr (&Soverlay_properties
);
6327 defsubr (&Soverlays_at
);
6328 defsubr (&Soverlays_in
);
6329 defsubr (&Snext_overlay_change
);
6330 defsubr (&Sprevious_overlay_change
);
6331 defsubr (&Soverlay_recenter
);
6332 defsubr (&Soverlay_lists
);
6333 defsubr (&Soverlay_get
);
6334 defsubr (&Soverlay_put
);
6335 defsubr (&Srestore_buffer_modified_p
);
6339 keys_of_buffer (void)
6341 initial_define_key (control_x_map
, 'b', "switch-to-buffer");
6342 initial_define_key (control_x_map
, 'k', "kill-buffer");
6344 /* This must not be in syms_of_buffer, because Qdisabled is not
6345 initialized when that function gets called. */
6346 Fput (intern_c_string ("erase-buffer"), Qdisabled
, Qt
);