1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #define BUFFER_INLINE EXTERN_INLINE
24 #include <sys/types.h>
26 #include <sys/param.h>
35 #include "intervals.h"
38 #include "character.h"
40 #include "region-cache.h"
42 #include "blockinput.h"
47 struct buffer
*current_buffer
; /* The current buffer. */
49 /* First buffer in chain of all buffers (in reverse order of creation).
50 Threaded through ->header.next.buffer. */
52 struct buffer
*all_buffers
;
54 /* This structure holds the default values of the buffer-local variables
55 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
56 The default value occupies the same slot in this structure
57 as an individual buffer's value occupies in that buffer.
58 Setting the default value also goes through the alist of buffers
59 and stores into each buffer that does not say it has a local value. */
61 struct buffer
alignas (GCALIGNMENT
) buffer_defaults
;
63 /* This structure marks which slots in a buffer have corresponding
64 default values in buffer_defaults.
65 Each such slot has a nonzero value in this structure.
66 The value has only one nonzero bit.
68 When a buffer has its own local value for a slot,
69 the entry for that slot (found in the same slot in this structure)
70 is turned on in the buffer's local_flags array.
72 If a slot in this structure is -1, then even though there may
73 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
74 and the corresponding slot in buffer_defaults is not used.
76 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
77 zero, that is a bug. */
79 struct buffer buffer_local_flags
;
81 /* This structure holds the names of symbols whose values may be
82 buffer-local. It is indexed and accessed in the same way as the above. */
84 struct buffer
alignas (GCALIGNMENT
) buffer_local_symbols
;
86 /* Return the symbol of the per-buffer variable at offset OFFSET in
87 the buffer structure. */
89 #define PER_BUFFER_SYMBOL(OFFSET) \
90 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
92 /* Maximum length of an overlay vector. */
93 #define OVERLAY_COUNT_MAX \
94 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
95 min (PTRDIFF_MAX, SIZE_MAX) / word_size))
97 /* Flags indicating which built-in buffer-local variables
98 are permanent locals. */
99 static char buffer_permanent_local_flags
[MAX_PER_BUFFER_VARS
];
101 /* Number of per-buffer variables used. */
103 int last_per_buffer_idx
;
105 static void call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
,
106 bool after
, Lisp_Object arg1
,
107 Lisp_Object arg2
, Lisp_Object arg3
);
108 static void swap_out_buffer_local_variables (struct buffer
*b
);
109 static void reset_buffer_local_variables (struct buffer
*, bool);
111 /* Alist of all buffer names vs the buffers. */
112 /* This used to be a variable, but is no longer,
113 to prevent lossage due to user rplac'ing this alist or its elements. */
114 Lisp_Object Vbuffer_alist
;
116 static Lisp_Object Qkill_buffer_query_functions
;
118 /* Hook run before changing a major mode. */
119 static Lisp_Object Qchange_major_mode_hook
;
121 Lisp_Object Qfirst_change_hook
;
122 Lisp_Object Qbefore_change_functions
;
123 Lisp_Object Qafter_change_functions
;
125 static Lisp_Object Qfundamental_mode
, Qmode_class
, Qpermanent_local
;
126 static Lisp_Object Qpermanent_local_hook
;
128 static Lisp_Object Qprotected_field
;
130 static Lisp_Object QSFundamental
; /* A string "Fundamental". */
132 static Lisp_Object Qkill_buffer_hook
;
133 static Lisp_Object Qbuffer_list_update_hook
;
135 static Lisp_Object Qget_file_buffer
;
137 static Lisp_Object Qoverlayp
;
139 Lisp_Object Qpriority
, Qbefore_string
, Qafter_string
;
141 static Lisp_Object Qevaporate
;
143 Lisp_Object Qmodification_hooks
;
144 Lisp_Object Qinsert_in_front_hooks
;
145 Lisp_Object Qinsert_behind_hooks
;
147 static void alloc_buffer_text (struct buffer
*, ptrdiff_t);
148 static void free_buffer_text (struct buffer
*b
);
149 static struct Lisp_Overlay
* copy_overlays (struct buffer
*, struct Lisp_Overlay
*);
150 static void modify_overlay (struct buffer
*, ptrdiff_t, ptrdiff_t);
151 static Lisp_Object
buffer_lisp_local_variables (struct buffer
*, bool);
153 /* These setters are used only in this file, so they can be private. */
155 bset_abbrev_mode (struct buffer
*b
, Lisp_Object val
)
157 b
->INTERNAL_FIELD (abbrev_mode
) = val
;
160 bset_abbrev_table (struct buffer
*b
, Lisp_Object val
)
162 b
->INTERNAL_FIELD (abbrev_table
) = val
;
165 bset_auto_fill_function (struct buffer
*b
, Lisp_Object val
)
167 b
->INTERNAL_FIELD (auto_fill_function
) = val
;
170 bset_auto_save_file_format (struct buffer
*b
, Lisp_Object val
)
172 b
->INTERNAL_FIELD (auto_save_file_format
) = val
;
175 bset_auto_save_file_name (struct buffer
*b
, Lisp_Object val
)
177 b
->INTERNAL_FIELD (auto_save_file_name
) = val
;
180 bset_backed_up (struct buffer
*b
, Lisp_Object val
)
182 b
->INTERNAL_FIELD (backed_up
) = val
;
185 bset_begv_marker (struct buffer
*b
, Lisp_Object val
)
187 b
->INTERNAL_FIELD (begv_marker
) = val
;
190 bset_bidi_display_reordering (struct buffer
*b
, Lisp_Object val
)
192 b
->INTERNAL_FIELD (bidi_display_reordering
) = val
;
195 bset_buffer_file_coding_system (struct buffer
*b
, Lisp_Object val
)
197 b
->INTERNAL_FIELD (buffer_file_coding_system
) = val
;
200 bset_cache_long_line_scans (struct buffer
*b
, Lisp_Object val
)
202 b
->INTERNAL_FIELD (cache_long_line_scans
) = val
;
205 bset_case_fold_search (struct buffer
*b
, Lisp_Object val
)
207 b
->INTERNAL_FIELD (case_fold_search
) = val
;
210 bset_ctl_arrow (struct buffer
*b
, Lisp_Object val
)
212 b
->INTERNAL_FIELD (ctl_arrow
) = val
;
215 bset_cursor_in_non_selected_windows (struct buffer
*b
, Lisp_Object val
)
217 b
->INTERNAL_FIELD (cursor_in_non_selected_windows
) = val
;
220 bset_cursor_type (struct buffer
*b
, Lisp_Object val
)
222 b
->INTERNAL_FIELD (cursor_type
) = val
;
225 bset_display_table (struct buffer
*b
, Lisp_Object val
)
227 b
->INTERNAL_FIELD (display_table
) = val
;
230 bset_extra_line_spacing (struct buffer
*b
, Lisp_Object val
)
232 b
->INTERNAL_FIELD (extra_line_spacing
) = val
;
235 bset_file_format (struct buffer
*b
, Lisp_Object val
)
237 b
->INTERNAL_FIELD (file_format
) = val
;
240 bset_file_truename (struct buffer
*b
, Lisp_Object val
)
242 b
->INTERNAL_FIELD (file_truename
) = val
;
245 bset_fringe_cursor_alist (struct buffer
*b
, Lisp_Object val
)
247 b
->INTERNAL_FIELD (fringe_cursor_alist
) = val
;
250 bset_fringe_indicator_alist (struct buffer
*b
, Lisp_Object val
)
252 b
->INTERNAL_FIELD (fringe_indicator_alist
) = val
;
255 bset_fringes_outside_margins (struct buffer
*b
, Lisp_Object val
)
257 b
->INTERNAL_FIELD (fringes_outside_margins
) = val
;
260 bset_header_line_format (struct buffer
*b
, Lisp_Object val
)
262 b
->INTERNAL_FIELD (header_line_format
) = val
;
265 bset_indicate_buffer_boundaries (struct buffer
*b
, Lisp_Object val
)
267 b
->INTERNAL_FIELD (indicate_buffer_boundaries
) = val
;
270 bset_indicate_empty_lines (struct buffer
*b
, Lisp_Object val
)
272 b
->INTERNAL_FIELD (indicate_empty_lines
) = val
;
275 bset_invisibility_spec (struct buffer
*b
, Lisp_Object val
)
277 b
->INTERNAL_FIELD (invisibility_spec
) = val
;
280 bset_left_fringe_width (struct buffer
*b
, Lisp_Object val
)
282 b
->INTERNAL_FIELD (left_fringe_width
) = val
;
285 bset_major_mode (struct buffer
*b
, Lisp_Object val
)
287 b
->INTERNAL_FIELD (major_mode
) = val
;
290 bset_mark (struct buffer
*b
, Lisp_Object val
)
292 b
->INTERNAL_FIELD (mark
) = val
;
295 bset_minor_modes (struct buffer
*b
, Lisp_Object val
)
297 b
->INTERNAL_FIELD (minor_modes
) = val
;
300 bset_mode_line_format (struct buffer
*b
, Lisp_Object val
)
302 b
->INTERNAL_FIELD (mode_line_format
) = val
;
305 bset_mode_name (struct buffer
*b
, Lisp_Object val
)
307 b
->INTERNAL_FIELD (mode_name
) = val
;
310 bset_name (struct buffer
*b
, Lisp_Object val
)
312 b
->INTERNAL_FIELD (name
) = val
;
315 bset_overwrite_mode (struct buffer
*b
, Lisp_Object val
)
317 b
->INTERNAL_FIELD (overwrite_mode
) = val
;
320 bset_pt_marker (struct buffer
*b
, Lisp_Object val
)
322 b
->INTERNAL_FIELD (pt_marker
) = val
;
325 bset_right_fringe_width (struct buffer
*b
, Lisp_Object val
)
327 b
->INTERNAL_FIELD (right_fringe_width
) = val
;
330 bset_save_length (struct buffer
*b
, Lisp_Object val
)
332 b
->INTERNAL_FIELD (save_length
) = val
;
335 bset_scroll_bar_width (struct buffer
*b
, Lisp_Object val
)
337 b
->INTERNAL_FIELD (scroll_bar_width
) = val
;
340 bset_scroll_down_aggressively (struct buffer
*b
, Lisp_Object val
)
342 b
->INTERNAL_FIELD (scroll_down_aggressively
) = val
;
345 bset_scroll_up_aggressively (struct buffer
*b
, Lisp_Object val
)
347 b
->INTERNAL_FIELD (scroll_up_aggressively
) = val
;
350 bset_selective_display (struct buffer
*b
, Lisp_Object val
)
352 b
->INTERNAL_FIELD (selective_display
) = val
;
355 bset_selective_display_ellipses (struct buffer
*b
, Lisp_Object val
)
357 b
->INTERNAL_FIELD (selective_display_ellipses
) = val
;
360 bset_vertical_scroll_bar_type (struct buffer
*b
, Lisp_Object val
)
362 b
->INTERNAL_FIELD (vertical_scroll_bar_type
) = val
;
365 bset_word_wrap (struct buffer
*b
, Lisp_Object val
)
367 b
->INTERNAL_FIELD (word_wrap
) = val
;
370 bset_zv_marker (struct buffer
*b
, Lisp_Object val
)
372 b
->INTERNAL_FIELD (zv_marker
) = val
;
375 /* For debugging; temporary. See set_buffer_internal. */
376 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
379 nsberror (Lisp_Object spec
)
382 error ("No buffer named %s", SDATA (spec
));
383 error ("Invalid buffer argument");
386 DEFUN ("buffer-live-p", Fbuffer_live_p
, Sbuffer_live_p
, 1, 1, 0,
387 doc
: /* Return non-nil if OBJECT is a buffer which has not been killed.
388 Value is nil if OBJECT is not a buffer or if it has been killed. */)
391 return ((BUFFERP (object
) && BUFFER_LIVE_P (XBUFFER (object
)))
395 DEFUN ("buffer-list", Fbuffer_list
, Sbuffer_list
, 0, 1, 0,
396 doc
: /* Return a list of all existing live buffers.
397 If the optional arg FRAME is a frame, we return the buffer list in the
398 proper order for that frame: the buffers show in FRAME come first,
399 followed by the rest of the buffers. */)
403 general
= Fmapcar (Qcdr
, Vbuffer_alist
);
407 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. */
553 BUF_GAP_SIZE (b
) = 20;
555 /* We allocate extra 1-byte at the tail and keep it always '\0' for
556 anchoring a search. */
557 alloc_buffer_text (b
, BUF_GAP_SIZE (b
) + 1);
559 if (! BUF_BEG_ADDR (b
))
560 buffer_memory_full (BUF_GAP_SIZE (b
) + 1);
565 b
->pt_byte
= BEG_BYTE
;
566 b
->begv_byte
= BEG_BYTE
;
567 b
->zv_byte
= BEG_BYTE
;
570 BUF_GPT_BYTE (b
) = BEG_BYTE
;
573 BUF_Z_BYTE (b
) = BEG_BYTE
;
575 BUF_CHARS_MODIFF (b
) = 1;
576 BUF_OVERLAY_MODIFF (b
) = 1;
577 BUF_SAVE_MODIFF (b
) = 1;
578 set_buffer_intervals (b
, NULL
);
579 BUF_UNCHANGED_MODIFIED (b
) = 1;
580 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = 1;
581 BUF_END_UNCHANGED (b
) = 0;
582 BUF_BEG_UNCHANGED (b
) = 0;
583 *(BUF_GPT_ADDR (b
)) = *(BUF_Z_ADDR (b
)) = 0; /* Put an anchor '\0'. */
584 b
->text
->inhibit_shrinking
= 0;
586 b
->newline_cache
= 0;
587 b
->width_run_cache
= 0;
588 bset_width_table (b
, Qnil
);
589 b
->prevent_redisplay_optimizations_p
= 1;
591 /* An ordinary buffer normally doesn't need markers
592 to handle BEGV and ZV. */
593 bset_pt_marker (b
, Qnil
);
594 bset_begv_marker (b
, Qnil
);
595 bset_zv_marker (b
, Qnil
);
597 name
= Fcopy_sequence (buffer_or_name
);
598 set_string_intervals (name
, NULL
);
601 bset_undo_list (b
, SREF (name
, 0) != ' ' ? Qnil
: Qt
);
604 reset_buffer_local_variables (b
, 1);
606 bset_mark (b
, Fmake_marker ());
607 BUF_MARKERS (b
) = NULL
;
609 /* Put this in the alist of all live buffers. */
610 XSETBUFFER (buffer
, b
);
611 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buffer
), Qnil
));
612 /* And run buffer-list-update-hook. */
613 if (!NILP (Vrun_hooks
))
614 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
620 /* Return a list of overlays which is a copy of the overlay list
621 LIST, but for buffer B. */
623 static struct Lisp_Overlay
*
624 copy_overlays (struct buffer
*b
, struct Lisp_Overlay
*list
)
626 struct Lisp_Overlay
*result
= NULL
, *tail
= NULL
;
628 for (; list
; list
= list
->next
)
630 Lisp_Object overlay
, start
, end
;
631 struct Lisp_Marker
*m
;
633 eassert (MARKERP (list
->start
));
634 m
= XMARKER (list
->start
);
635 start
= build_marker (b
, m
->charpos
, m
->bytepos
);
636 XMARKER (start
)->insertion_type
= m
->insertion_type
;
638 eassert (MARKERP (list
->end
));
639 m
= XMARKER (list
->end
);
640 end
= build_marker (b
, m
->charpos
, m
->bytepos
);
641 XMARKER (end
)->insertion_type
= m
->insertion_type
;
643 overlay
= build_overlay (start
, end
, Fcopy_sequence (list
->plist
));
645 tail
= tail
->next
= XOVERLAY (overlay
);
647 result
= tail
= XOVERLAY (overlay
);
653 /* Set an appropriate overlay of B. */
656 set_buffer_overlays_before (struct buffer
*b
, struct Lisp_Overlay
*o
)
658 b
->overlays_before
= o
;
662 set_buffer_overlays_after (struct buffer
*b
, struct Lisp_Overlay
*o
)
664 b
->overlays_after
= o
;
667 /* Clone per-buffer values of buffer FROM.
669 Buffer TO gets the same per-buffer values as FROM, with the
670 following exceptions: (1) TO's name is left untouched, (2) markers
671 are copied and made to refer to TO, and (3) overlay lists are
675 clone_per_buffer_values (struct buffer
*from
, struct buffer
*to
)
679 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
683 /* Don't touch the `name' which should be unique for every buffer. */
684 if (offset
== PER_BUFFER_VAR_OFFSET (name
))
687 obj
= per_buffer_value (from
, offset
);
688 if (MARKERP (obj
) && XMARKER (obj
)->buffer
== from
)
690 struct Lisp_Marker
*m
= XMARKER (obj
);
692 obj
= build_marker (to
, m
->charpos
, m
->bytepos
);
693 XMARKER (obj
)->insertion_type
= m
->insertion_type
;
696 set_per_buffer_value (to
, offset
, obj
);
699 memcpy (to
->local_flags
, from
->local_flags
, sizeof to
->local_flags
);
701 set_buffer_overlays_before (to
, copy_overlays (to
, from
->overlays_before
));
702 set_buffer_overlays_after (to
, copy_overlays (to
, from
->overlays_after
));
704 /* Get (a copy of) the alist of Lisp-level local variables of FROM
705 and install that in TO. */
706 bset_local_var_alist (to
, buffer_lisp_local_variables (from
, 1));
710 /* If buffer B has markers to record PT, BEGV and ZV when it is not
711 current, update these markers. */
714 record_buffer_markers (struct buffer
*b
)
716 if (! NILP (BVAR (b
, pt_marker
)))
720 eassert (!NILP (BVAR (b
, begv_marker
)));
721 eassert (!NILP (BVAR (b
, zv_marker
)));
723 XSETBUFFER (buffer
, b
);
724 set_marker_both (BVAR (b
, pt_marker
), buffer
, b
->pt
, b
->pt_byte
);
725 set_marker_both (BVAR (b
, begv_marker
), buffer
, b
->begv
, b
->begv_byte
);
726 set_marker_both (BVAR (b
, zv_marker
), buffer
, b
->zv
, b
->zv_byte
);
731 /* If buffer B has markers to record PT, BEGV and ZV when it is not
732 current, fetch these values into B->begv etc. */
735 fetch_buffer_markers (struct buffer
*b
)
737 if (! NILP (BVAR (b
, pt_marker
)))
741 eassert (!NILP (BVAR (b
, begv_marker
)));
742 eassert (!NILP (BVAR (b
, zv_marker
)));
744 m
= BVAR (b
, pt_marker
);
745 SET_BUF_PT_BOTH (b
, marker_position (m
), marker_byte_position (m
));
747 m
= BVAR (b
, begv_marker
);
748 SET_BUF_BEGV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
750 m
= BVAR (b
, zv_marker
);
751 SET_BUF_ZV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
756 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer
, Smake_indirect_buffer
,
758 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
759 doc
: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
760 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
761 NAME should be a string which is not the name of an existing buffer.
762 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
763 such as major and minor modes, in the indirect buffer.
764 CLONE nil means the indirect buffer's state is reset to default values. */)
765 (Lisp_Object base_buffer
, Lisp_Object name
, Lisp_Object clone
)
767 Lisp_Object buf
, tem
;
771 buf
= Fget_buffer (name
);
773 error ("Buffer name `%s' is in use", SDATA (name
));
776 base_buffer
= Fget_buffer (base_buffer
);
777 if (NILP (base_buffer
))
778 error ("No such buffer: `%s'", SDATA (tem
));
779 if (!BUFFER_LIVE_P (XBUFFER (base_buffer
)))
780 error ("Base buffer has been killed");
782 if (SCHARS (name
) == 0)
783 error ("Empty string for buffer name is not allowed");
785 b
= allocate_buffer ();
787 /* No double indirection - if base buffer is indirect,
788 new buffer becomes an indirect to base's base. */
789 b
->base_buffer
= (XBUFFER (base_buffer
)->base_buffer
790 ? XBUFFER (base_buffer
)->base_buffer
791 : XBUFFER (base_buffer
));
793 /* Use the base buffer's text object. */
794 b
->text
= b
->base_buffer
->text
;
795 /* We have no own text. */
796 b
->indirections
= -1;
797 /* Notify base buffer that we share the text now. */
798 b
->base_buffer
->indirections
++;
800 b
->pt
= b
->base_buffer
->pt
;
801 b
->begv
= b
->base_buffer
->begv
;
802 b
->zv
= b
->base_buffer
->zv
;
803 b
->pt_byte
= b
->base_buffer
->pt_byte
;
804 b
->begv_byte
= b
->base_buffer
->begv_byte
;
805 b
->zv_byte
= b
->base_buffer
->zv_byte
;
807 b
->newline_cache
= 0;
808 b
->width_run_cache
= 0;
809 bset_width_table (b
, Qnil
);
811 name
= Fcopy_sequence (name
);
812 set_string_intervals (name
, NULL
);
816 reset_buffer_local_variables (b
, 1);
818 /* Put this in the alist of all live buffers. */
820 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buf
), Qnil
));
822 bset_mark (b
, Fmake_marker ());
824 /* The multibyte status belongs to the base buffer. */
825 bset_enable_multibyte_characters
826 (b
, BVAR (b
->base_buffer
, enable_multibyte_characters
));
828 /* Make sure the base buffer has markers for its narrowing. */
829 if (NILP (BVAR (b
->base_buffer
, pt_marker
)))
831 eassert (NILP (BVAR (b
->base_buffer
, begv_marker
)));
832 eassert (NILP (BVAR (b
->base_buffer
, zv_marker
)));
834 bset_pt_marker (b
->base_buffer
,
835 build_marker (b
->base_buffer
, b
->base_buffer
->pt
,
836 b
->base_buffer
->pt_byte
));
838 bset_begv_marker (b
->base_buffer
,
839 build_marker (b
->base_buffer
, b
->base_buffer
->begv
,
840 b
->base_buffer
->begv_byte
));
842 bset_zv_marker (b
->base_buffer
,
843 build_marker (b
->base_buffer
, b
->base_buffer
->zv
,
844 b
->base_buffer
->zv_byte
));
846 XMARKER (BVAR (b
->base_buffer
, zv_marker
))->insertion_type
= 1;
851 /* Give the indirect buffer markers for its narrowing. */
852 bset_pt_marker (b
, build_marker (b
, b
->pt
, b
->pt_byte
));
853 bset_begv_marker (b
, build_marker (b
, b
->begv
, b
->begv_byte
));
854 bset_zv_marker (b
, build_marker (b
, b
->zv
, b
->zv_byte
));
855 XMARKER (BVAR (b
, zv_marker
))->insertion_type
= 1;
859 struct buffer
*old_b
= current_buffer
;
861 clone_per_buffer_values (b
->base_buffer
, b
);
862 bset_filename (b
, Qnil
);
863 bset_file_truename (b
, Qnil
);
864 bset_display_count (b
, make_number (0));
865 bset_backed_up (b
, Qnil
);
866 bset_auto_save_file_name (b
, Qnil
);
867 set_buffer_internal_1 (b
);
868 Fset (intern ("buffer-save-without-query"), Qnil
);
869 Fset (intern ("buffer-file-number"), Qnil
);
870 Fset (intern ("buffer-stale-function"), Qnil
);
871 set_buffer_internal_1 (old_b
);
874 /* Run buffer-list-update-hook. */
875 if (!NILP (Vrun_hooks
))
876 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
881 /* Mark OV as no longer associated with B. */
884 drop_overlay (struct buffer
*b
, struct Lisp_Overlay
*ov
)
886 eassert (b
== XBUFFER (Fmarker_buffer (ov
->start
)));
887 modify_overlay (b
, marker_position (ov
->start
),
888 marker_position (ov
->end
));
889 Fset_marker (ov
->start
, Qnil
, Qnil
);
890 Fset_marker (ov
->end
, Qnil
, Qnil
);
894 /* Delete all overlays of B and reset it's overlay lists. */
897 delete_all_overlays (struct buffer
*b
)
899 struct Lisp_Overlay
*ov
, *next
;
901 for (ov
= b
->overlays_before
; ov
; ov
= next
)
903 drop_overlay (b
, ov
);
908 for (ov
= b
->overlays_after
; ov
; ov
= next
)
910 drop_overlay (b
, ov
);
915 set_buffer_overlays_before (b
, NULL
);
916 set_buffer_overlays_after (b
, NULL
);
919 /* Reinitialize everything about a buffer except its name and contents
921 If called on an already-initialized buffer, the list of overlays
922 should be deleted before calling this function, otherwise we end up
923 with overlays that claim to belong to the buffer but the buffer
924 claims it doesn't belong to it. */
927 reset_buffer (register struct buffer
*b
)
929 bset_filename (b
, Qnil
);
930 bset_file_truename (b
, Qnil
);
931 bset_directory (b
, current_buffer
? BVAR (current_buffer
, directory
) : Qnil
);
932 b
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
933 b
->modtime_size
= -1;
934 XSETFASTINT (BVAR (b
, save_length
), 0);
935 b
->last_window_start
= 1;
936 /* It is more conservative to start out "changed" than "unchanged". */
938 b
->prevent_redisplay_optimizations_p
= 1;
939 bset_backed_up (b
, Qnil
);
940 BUF_AUTOSAVE_MODIFF (b
) = 0;
941 b
->auto_save_failure_time
= 0;
942 bset_auto_save_file_name (b
, Qnil
);
943 bset_read_only (b
, Qnil
);
944 set_buffer_overlays_before (b
, NULL
);
945 set_buffer_overlays_after (b
, NULL
);
946 b
->overlay_center
= BEG
;
947 bset_mark_active (b
, Qnil
);
948 bset_point_before_scroll (b
, Qnil
);
949 bset_file_format (b
, Qnil
);
950 bset_auto_save_file_format (b
, Qt
);
951 bset_last_selected_window (b
, Qnil
);
952 bset_display_count (b
, make_number (0));
953 bset_display_time (b
, Qnil
);
954 bset_enable_multibyte_characters
955 (b
, BVAR (&buffer_defaults
, enable_multibyte_characters
));
956 bset_cursor_type (b
, BVAR (&buffer_defaults
, cursor_type
));
957 bset_extra_line_spacing (b
, BVAR (&buffer_defaults
, extra_line_spacing
));
959 b
->display_error_modiff
= 0;
962 /* Reset buffer B's local variables info.
963 Don't use this on a buffer that has already been in use;
964 it does not treat permanent locals consistently.
965 Instead, use Fkill_all_local_variables.
967 If PERMANENT_TOO, reset permanent buffer-local variables.
968 If not, preserve those. */
971 reset_buffer_local_variables (struct buffer
*b
, bool permanent_too
)
975 /* Reset the major mode to Fundamental, together with all the
976 things that depend on the major mode.
977 default-major-mode is handled at a higher level.
978 We ignore it here. */
979 bset_major_mode (b
, Qfundamental_mode
);
980 bset_keymap (b
, Qnil
);
981 bset_mode_name (b
, QSFundamental
);
982 bset_minor_modes (b
, Qnil
);
984 /* If the standard case table has been altered and invalidated,
985 fix up its insides first. */
986 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[0])
987 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[1])
988 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[2])))
989 Fset_standard_case_table (Vascii_downcase_table
);
991 bset_downcase_table (b
, Vascii_downcase_table
);
992 bset_upcase_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[0]);
993 bset_case_canon_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[1]);
994 bset_case_eqv_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[2]);
995 bset_invisibility_spec (b
, Qt
);
997 /* Reset all (or most) per-buffer variables to their defaults. */
999 bset_local_var_alist (b
, Qnil
);
1002 Lisp_Object tmp
, prop
, last
= Qnil
;
1003 for (tmp
= BVAR (b
, local_var_alist
); CONSP (tmp
); tmp
= XCDR (tmp
))
1004 if (!NILP (prop
= Fget (XCAR (XCAR (tmp
)), Qpermanent_local
)))
1006 /* If permanent-local, keep it. */
1008 if (EQ (prop
, Qpermanent_local_hook
))
1010 /* This is a partially permanent hook variable.
1011 Preserve only the elements that want to be preserved. */
1012 Lisp_Object list
, newlist
;
1013 list
= XCDR (XCAR (tmp
));
1017 for (newlist
= Qnil
; CONSP (list
); list
= XCDR (list
))
1019 Lisp_Object elt
= XCAR (list
);
1020 /* Preserve element ELT if it's t,
1021 if it is a function with a `permanent-local-hook' property,
1022 or if it's not a symbol. */
1025 || !NILP (Fget (elt
, Qpermanent_local_hook
)))
1026 newlist
= Fcons (elt
, newlist
);
1028 XSETCDR (XCAR (tmp
), Fnreverse (newlist
));
1031 /* Delete this local variable. */
1032 else if (NILP (last
))
1033 bset_local_var_alist (b
, XCDR (tmp
));
1035 XSETCDR (last
, XCDR (tmp
));
1038 for (i
= 0; i
< last_per_buffer_idx
; ++i
)
1039 if (permanent_too
|| buffer_permanent_local_flags
[i
] == 0)
1040 SET_PER_BUFFER_VALUE_P (b
, i
, 0);
1042 /* For each slot that has a default value, copy that into the slot. */
1043 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1045 int idx
= PER_BUFFER_IDX (offset
);
1048 || buffer_permanent_local_flags
[idx
] == 0)))
1049 set_per_buffer_value (b
, offset
, per_buffer_default (offset
));
1053 /* We split this away from generate-new-buffer, because rename-buffer
1054 and set-visited-file-name ought to be able to use this to really
1055 rename the buffer properly. */
1057 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name
,
1058 Sgenerate_new_buffer_name
, 1, 2, 0,
1059 doc
: /* Return a string that is the name of no existing buffer based on NAME.
1060 If there is no live buffer named NAME, then return NAME.
1061 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
1062 \(starting at 2) until an unused name is found, and then return that name.
1063 Optional second argument IGNORE specifies a name that is okay to use (if
1064 it is in the sequence to be tried) even if a buffer with that name exists.
1066 If NAME begins with a space (i.e., a buffer that is not normally
1067 visible to users), then if buffer NAME already exists a random number
1068 is first appended to NAME, to speed up finding a non-existent buffer. */)
1069 (register Lisp_Object name
, Lisp_Object ignore
)
1071 register Lisp_Object gentemp
, tem
, tem2
;
1073 char number
[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
1075 CHECK_STRING (name
);
1077 tem
= Fstring_equal (name
, ignore
);
1080 tem
= Fget_buffer (name
);
1084 if (!strncmp (SSDATA (name
), " ", 1)) /* see bug#1229 */
1086 /* Note fileio.c:make_temp_name does random differently. */
1087 tem2
= concat2 (name
, make_formatted_string
1089 XFASTINT (Frandom (make_number (999999)))));
1090 tem
= Fget_buffer (tem2
);
1100 gentemp
= concat2 (tem2
, make_formatted_string
1101 (number
, "<%"pD
"d>", ++count
));
1102 tem
= Fstring_equal (gentemp
, ignore
);
1105 tem
= Fget_buffer (gentemp
);
1112 DEFUN ("buffer-name", Fbuffer_name
, Sbuffer_name
, 0, 1, 0,
1113 doc
: /* Return the name of BUFFER, as a string.
1114 BUFFER defaults to the current buffer.
1115 Return nil if BUFFER has been killed. */)
1116 (register Lisp_Object buffer
)
1119 return BVAR (current_buffer
, name
);
1120 CHECK_BUFFER (buffer
);
1121 return BVAR (XBUFFER (buffer
), name
);
1124 DEFUN ("buffer-file-name", Fbuffer_file_name
, Sbuffer_file_name
, 0, 1, 0,
1125 doc
: /* Return name of file BUFFER is visiting, or nil if none.
1126 No argument or nil as argument means use the current buffer. */)
1127 (register Lisp_Object buffer
)
1130 return BVAR (current_buffer
, filename
);
1131 CHECK_BUFFER (buffer
);
1132 return BVAR (XBUFFER (buffer
), filename
);
1135 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer
, Sbuffer_base_buffer
,
1137 doc
: /* Return the base buffer of indirect buffer BUFFER.
1138 If BUFFER is not indirect, return nil.
1139 BUFFER defaults to the current buffer. */)
1140 (register Lisp_Object buffer
)
1142 struct buffer
*base
;
1143 Lisp_Object base_buffer
;
1146 base
= current_buffer
->base_buffer
;
1149 CHECK_BUFFER (buffer
);
1150 base
= XBUFFER (buffer
)->base_buffer
;
1155 XSETBUFFER (base_buffer
, base
);
1159 DEFUN ("buffer-local-value", Fbuffer_local_value
,
1160 Sbuffer_local_value
, 2, 2, 0,
1161 doc
: /* Return the value of VARIABLE in BUFFER.
1162 If VARIABLE does not have a buffer-local binding in BUFFER, the value
1163 is the default binding of the variable. */)
1164 (register Lisp_Object variable
, register Lisp_Object buffer
)
1166 register Lisp_Object result
= buffer_local_value_1 (variable
, buffer
);
1168 if (EQ (result
, Qunbound
))
1169 xsignal1 (Qvoid_variable
, variable
);
1175 /* Like Fbuffer_local_value, but return Qunbound if the variable is
1179 buffer_local_value_1 (Lisp_Object variable
, Lisp_Object buffer
)
1181 register struct buffer
*buf
;
1182 register Lisp_Object result
;
1183 struct Lisp_Symbol
*sym
;
1185 CHECK_SYMBOL (variable
);
1186 CHECK_BUFFER (buffer
);
1187 buf
= XBUFFER (buffer
);
1188 sym
= XSYMBOL (variable
);
1191 switch (sym
->redirect
)
1193 case SYMBOL_VARALIAS
: sym
= indirect_variable (sym
); goto start
;
1194 case SYMBOL_PLAINVAL
: result
= SYMBOL_VAL (sym
); break;
1195 case SYMBOL_LOCALIZED
:
1196 { /* Look in local_var_alist. */
1197 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (sym
);
1198 XSETSYMBOL (variable
, sym
); /* Update In case of aliasing. */
1199 result
= Fassoc (variable
, BVAR (buf
, local_var_alist
));
1203 { /* What binding is loaded right now? */
1204 Lisp_Object current_alist_element
= blv
->valcell
;
1206 /* The value of the currently loaded binding is not
1207 stored in it, but rather in the realvalue slot.
1208 Store that value into the binding it belongs to
1209 in case that is the one we are about to use. */
1211 XSETCDR (current_alist_element
,
1212 do_symval_forwarding (blv
->fwd
));
1214 /* Now get the (perhaps updated) value out of the binding. */
1215 result
= XCDR (result
);
1218 result
= Fdefault_value (variable
);
1221 case SYMBOL_FORWARDED
:
1223 union Lisp_Fwd
*fwd
= SYMBOL_FWD (sym
);
1224 if (BUFFER_OBJFWDP (fwd
))
1225 result
= per_buffer_value (buf
, XBUFFER_OBJFWD (fwd
)->offset
);
1227 result
= Fdefault_value (variable
);
1230 default: emacs_abort ();
1236 /* Return an alist of the Lisp-level buffer-local bindings of
1237 buffer BUF. That is, don't include the variables maintained
1238 in special slots in the buffer object.
1239 If not CLONE, replace elements of the form (VAR . unbound)
1243 buffer_lisp_local_variables (struct buffer
*buf
, bool clone
)
1245 Lisp_Object result
= Qnil
;
1247 for (tail
= BVAR (buf
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
1249 Lisp_Object val
, elt
;
1253 /* Reference each variable in the alist in buf.
1254 If inquiring about the current buffer, this gets the current values,
1255 so store them into the alist so the alist is up to date.
1256 If inquiring about some other buffer, this swaps out any values
1257 for that buffer, making the alist up to date automatically. */
1258 val
= find_symbol_value (XCAR (elt
));
1259 /* Use the current buffer value only if buf is the current buffer. */
1260 if (buf
!= current_buffer
)
1263 result
= Fcons (!clone
&& EQ (val
, Qunbound
)
1265 : Fcons (XCAR (elt
), val
),
1272 DEFUN ("buffer-local-variables", Fbuffer_local_variables
,
1273 Sbuffer_local_variables
, 0, 1, 0,
1274 doc
: /* Return an alist of variables that are buffer-local in BUFFER.
1275 Most elements look like (SYMBOL . VALUE), describing one variable.
1276 For a symbol that is locally unbound, just the symbol appears in the value.
1277 Note that storing new VALUEs in these elements doesn't change the variables.
1278 No argument or nil as argument means use current buffer as BUFFER. */)
1279 (register Lisp_Object buffer
)
1281 register struct buffer
*buf
;
1282 register Lisp_Object result
;
1285 buf
= current_buffer
;
1288 CHECK_BUFFER (buffer
);
1289 buf
= XBUFFER (buffer
);
1292 result
= buffer_lisp_local_variables (buf
, 0);
1294 /* Add on all the variables stored in special slots. */
1298 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1300 idx
= PER_BUFFER_IDX (offset
);
1301 if ((idx
== -1 || PER_BUFFER_VALUE_P (buf
, idx
))
1302 && SYMBOLP (PER_BUFFER_SYMBOL (offset
)))
1304 Lisp_Object sym
= PER_BUFFER_SYMBOL (offset
);
1305 Lisp_Object val
= per_buffer_value (buf
, offset
);
1306 result
= Fcons (EQ (val
, Qunbound
) ? sym
: Fcons (sym
, val
),
1315 DEFUN ("buffer-modified-p", Fbuffer_modified_p
, Sbuffer_modified_p
,
1317 doc
: /* Return t if BUFFER was modified since its file was last read or saved.
1318 No argument or nil as argument means use current buffer as BUFFER. */)
1319 (register Lisp_Object buffer
)
1321 register struct buffer
*buf
;
1323 buf
= current_buffer
;
1326 CHECK_BUFFER (buffer
);
1327 buf
= XBUFFER (buffer
);
1330 return BUF_SAVE_MODIFF (buf
) < BUF_MODIFF (buf
) ? Qt
: Qnil
;
1333 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p
, Sset_buffer_modified_p
,
1335 doc
: /* Mark current buffer as modified or unmodified according to FLAG.
1336 A non-nil FLAG means mark the buffer modified. */)
1339 Lisp_Object fn
, buffer
, window
;
1341 #ifdef CLASH_DETECTION
1342 /* If buffer becoming modified, lock the file.
1343 If buffer becoming unmodified, unlock the file. */
1345 fn
= BVAR (current_buffer
, file_truename
);
1346 /* Test buffer-file-name so that binding it to nil is effective. */
1347 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1349 bool already
= SAVE_MODIFF
< MODIFF
;
1350 if (!already
&& !NILP (flag
))
1352 else if (already
&& NILP (flag
))
1355 #endif /* CLASH_DETECTION */
1357 /* Here we have a problem. SAVE_MODIFF is used here to encode
1358 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1359 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1360 modify SAVE_MODIFF to affect one, we may affect the other
1362 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1363 if SAVE_MODIFF<auto_save_modified that means we risk changing
1364 recent-auto-save-p from t to nil.
1365 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1366 we risk changing recent-auto-save-p from nil to t. */
1367 SAVE_MODIFF
= (NILP (flag
)
1368 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1370 /* Let's try to preserve recent-auto-save-p. */
1371 : SAVE_MODIFF
< MODIFF
? SAVE_MODIFF
1372 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1373 we can either decrease SAVE_MODIFF and auto_save_modified
1374 or increase MODIFF. */
1377 /* Set update_mode_lines only if buffer is displayed in some window.
1378 Packages like jit-lock or lazy-lock preserve a buffer's modified
1379 state by recording/restoring the state around blocks of code.
1380 Setting update_mode_lines makes redisplay consider all windows
1381 (on all frames). Stealth fontification of buffers not displayed
1382 would incur additional redisplay costs if we'd set
1383 update_modes_lines unconditionally.
1385 Ideally, I think there should be another mechanism for fontifying
1386 buffers without "modifying" buffers, or redisplay should be
1387 smarter about updating the `*' in mode lines. --gerd */
1388 XSETBUFFER (buffer
, current_buffer
);
1389 window
= Fget_buffer_window (buffer
, Qt
);
1390 if (WINDOWP (window
))
1392 ++update_mode_lines
;
1393 current_buffer
->prevent_redisplay_optimizations_p
= 1;
1399 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p
,
1400 Srestore_buffer_modified_p
, 1, 1, 0,
1401 doc
: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1402 It is not ensured that mode lines will be updated to show the modified
1403 state of the current buffer. Use with care. */)
1406 #ifdef CLASH_DETECTION
1409 /* If buffer becoming modified, lock the file.
1410 If buffer becoming unmodified, unlock the file. */
1412 fn
= BVAR (current_buffer
, file_truename
);
1413 /* Test buffer-file-name so that binding it to nil is effective. */
1414 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1416 bool already
= SAVE_MODIFF
< MODIFF
;
1417 if (!already
&& !NILP (flag
))
1419 else if (already
&& NILP (flag
))
1422 #endif /* CLASH_DETECTION */
1424 SAVE_MODIFF
= NILP (flag
) ? MODIFF
: 0;
1428 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick
, Sbuffer_modified_tick
,
1430 doc
: /* Return BUFFER's tick counter, incremented for each change in text.
1431 Each buffer has a tick counter which is incremented each time the
1432 text in that buffer is changed. It wraps around occasionally.
1433 No argument or nil as argument means use current buffer as BUFFER. */)
1434 (register Lisp_Object buffer
)
1436 register struct buffer
*buf
;
1438 buf
= current_buffer
;
1441 CHECK_BUFFER (buffer
);
1442 buf
= XBUFFER (buffer
);
1445 return make_number (BUF_MODIFF (buf
));
1448 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick
,
1449 Sbuffer_chars_modified_tick
, 0, 1, 0,
1450 doc
: /* Return BUFFER's character-change tick counter.
1451 Each buffer has a character-change tick counter, which is set to the
1452 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1453 time text in that buffer is inserted or deleted. By comparing the
1454 values returned by two individual calls of `buffer-chars-modified-tick',
1455 you can tell whether a character change occurred in that buffer in
1456 between these calls. No argument or nil as argument means use current
1457 buffer as BUFFER. */)
1458 (register Lisp_Object buffer
)
1460 register struct buffer
*buf
;
1462 buf
= current_buffer
;
1465 CHECK_BUFFER (buffer
);
1466 buf
= XBUFFER (buffer
);
1469 return make_number (BUF_CHARS_MODIFF (buf
));
1472 DEFUN ("rename-buffer", Frename_buffer
, Srename_buffer
, 1, 2,
1473 "(list (read-string \"Rename buffer (to new name): \" \
1474 nil 'buffer-name-history (buffer-name (current-buffer))) \
1475 current-prefix-arg)",
1476 doc
: /* Change current buffer's name to NEWNAME (a string).
1477 If second arg UNIQUE is nil or omitted, it is an error if a
1478 buffer named NEWNAME already exists.
1479 If UNIQUE is non-nil, come up with a new name using
1480 `generate-new-buffer-name'.
1481 Interactively, you can set UNIQUE with a prefix argument.
1482 We return the name we actually gave the buffer.
1483 This does not change the name of the visited file (if any). */)
1484 (register Lisp_Object newname
, Lisp_Object unique
)
1486 register Lisp_Object tem
, buf
;
1488 CHECK_STRING (newname
);
1490 if (SCHARS (newname
) == 0)
1491 error ("Empty string is invalid as a buffer name");
1493 tem
= Fget_buffer (newname
);
1496 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1497 rename the buffer automatically so you can create another
1498 with the original name. It makes UNIQUE equivalent to
1499 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1500 if (NILP (unique
) && XBUFFER (tem
) == current_buffer
)
1501 return BVAR (current_buffer
, name
);
1503 newname
= Fgenerate_new_buffer_name (newname
, BVAR (current_buffer
, name
));
1505 error ("Buffer name `%s' is in use", SDATA (newname
));
1508 bset_name (current_buffer
, newname
);
1510 /* Catch redisplay's attention. Unless we do this, the mode lines for
1511 any windows displaying current_buffer will stay unchanged. */
1512 update_mode_lines
++;
1514 XSETBUFFER (buf
, current_buffer
);
1515 Fsetcar (Frassq (buf
, Vbuffer_alist
), newname
);
1516 if (NILP (BVAR (current_buffer
, filename
))
1517 && !NILP (BVAR (current_buffer
, auto_save_file_name
)))
1518 call0 (intern ("rename-auto-save-file"));
1520 /* Run buffer-list-update-hook. */
1521 if (!NILP (Vrun_hooks
))
1522 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1524 /* Refetch since that last call may have done GC. */
1525 return BVAR (current_buffer
, name
);
1528 DEFUN ("other-buffer", Fother_buffer
, Sother_buffer
, 0, 3, 0,
1529 doc
: /* Return most recently selected buffer other than BUFFER.
1530 Buffers not visible in windows are preferred to visible buffers, unless
1531 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1532 BUFFER unless it denotes a live buffer. If the optional third argument
1533 FRAME is non-nil, use that frame's buffer list instead of the selected
1534 frame's buffer list.
1536 The buffer is found by scanning the selected or specified frame's buffer
1537 list first, followed by the list of all buffers. If no other buffer
1538 exists, return the buffer `*scratch*' (creating it if necessary). */)
1539 (register Lisp_Object buffer
, Lisp_Object visible_ok
, Lisp_Object frame
)
1541 Lisp_Object tail
, buf
, pred
;
1542 Lisp_Object notsogood
= Qnil
;
1545 frame
= selected_frame
;
1547 CHECK_FRAME (frame
);
1549 pred
= frame_buffer_predicate (frame
);
1550 /* Consider buffers that have been seen in the frame first. */
1551 tail
= XFRAME (frame
)->buffer_list
;
1552 for (; CONSP (tail
); tail
= XCDR (tail
))
1555 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1556 && BUFFER_LIVE_P (XBUFFER (buf
))
1557 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' ')
1558 /* If the frame has a buffer_predicate, disregard buffers that
1559 don't fit the predicate. */
1560 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1562 if (!NILP (visible_ok
)
1563 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1565 else if (NILP (notsogood
))
1570 /* Consider alist of all buffers next. */
1571 tail
= Vbuffer_alist
;
1572 for (; CONSP (tail
); tail
= XCDR (tail
))
1574 buf
= Fcdr (XCAR (tail
));
1575 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1576 && BUFFER_LIVE_P (XBUFFER (buf
))
1577 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' ')
1578 /* If the frame has a buffer_predicate, disregard buffers that
1579 don't fit the predicate. */
1580 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1582 if (!NILP (visible_ok
)
1583 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1585 else if (NILP (notsogood
))
1590 if (!NILP (notsogood
))
1594 buf
= Fget_buffer (build_string ("*scratch*"));
1597 buf
= Fget_buffer_create (build_string ("*scratch*"));
1598 Fset_buffer_major_mode (buf
);
1604 /* The following function is a safe variant of Fother_buffer: It doesn't
1605 pay attention to any frame-local buffer lists, doesn't care about
1606 visibility of buffers, and doesn't evaluate any frame predicates. */
1609 other_buffer_safely (Lisp_Object buffer
)
1611 Lisp_Object tail
, buf
;
1613 tail
= Vbuffer_alist
;
1614 for (; CONSP (tail
); tail
= XCDR (tail
))
1616 buf
= Fcdr (XCAR (tail
));
1617 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1618 && BUFFER_LIVE_P (XBUFFER (buf
))
1619 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' '))
1623 buf
= Fget_buffer (build_string ("*scratch*"));
1626 buf
= Fget_buffer_create (build_string ("*scratch*"));
1627 Fset_buffer_major_mode (buf
);
1633 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo
, Sbuffer_enable_undo
,
1635 doc
: /* Start keeping undo information for buffer BUFFER.
1636 No argument or nil as argument means do this for the current buffer. */)
1637 (register Lisp_Object buffer
)
1639 Lisp_Object real_buffer
;
1642 XSETBUFFER (real_buffer
, current_buffer
);
1645 real_buffer
= Fget_buffer (buffer
);
1646 if (NILP (real_buffer
))
1650 if (EQ (BVAR (XBUFFER (real_buffer
), undo_list
), Qt
))
1651 bset_undo_list (XBUFFER (real_buffer
), Qnil
);
1656 /* Truncate undo list and shrink the gap of BUFFER. */
1659 compact_buffer (struct buffer
*buffer
)
1661 /* Verify indirection counters. */
1662 if (buffer
->base_buffer
)
1664 eassert (buffer
->indirections
== -1);
1665 eassert (buffer
->base_buffer
->indirections
> 0);
1668 eassert (buffer
->indirections
>= 0);
1670 /* Skip dead buffers, indirect buffers and buffers
1671 which aren't changed since last compaction. */
1672 if (!NILP (buffer
->INTERNAL_FIELD (name
))
1673 && (buffer
->base_buffer
== NULL
)
1674 && (buffer
->text
->compact
!= buffer
->text
->modiff
))
1676 /* If a buffer's undo list is Qt, that means that undo is
1677 turned off in that buffer. Calling truncate_undo_list on
1678 Qt tends to return NULL, which effectively turns undo back on.
1679 So don't call truncate_undo_list if undo_list is Qt. */
1680 if (!EQ (buffer
->INTERNAL_FIELD (undo_list
), Qt
))
1681 truncate_undo_list (buffer
);
1683 /* Shrink buffer gaps. */
1684 if (!buffer
->text
->inhibit_shrinking
)
1686 /* If a buffer's gap size is more than 10% of the buffer
1687 size, or larger than 2000 bytes, then shrink it
1688 accordingly. Keep a minimum size of 20 bytes. */
1689 int size
= min (2000, max (20, (buffer
->text
->z_byte
/ 10)));
1691 if (buffer
->text
->gap_size
> size
)
1693 struct buffer
*save_current
= current_buffer
;
1694 current_buffer
= buffer
;
1695 make_gap (-(buffer
->text
->gap_size
- size
));
1696 current_buffer
= save_current
;
1699 buffer
->text
->compact
= buffer
->text
->modiff
;
1703 DEFUN ("kill-buffer", Fkill_buffer
, Skill_buffer
, 0, 1, "bKill buffer: ",
1704 doc
: /* Kill the buffer specified by BUFFER-OR-NAME.
1705 The argument may be a buffer or the name of an existing buffer.
1706 Argument nil or omitted means kill the current buffer. Return t if the
1707 buffer is actually killed, nil otherwise.
1709 The functions in `kill-buffer-query-functions' are called with the
1710 buffer to be killed as the current buffer. If any of them returns nil,
1711 the buffer is not killed. The hook `kill-buffer-hook' is run before the
1712 buffer is actually killed. The buffer being killed will be current
1713 while the hook is running. Functions called by any of these hooks are
1714 supposed to not change the current buffer.
1716 Any processes that have this buffer as the `process-buffer' are killed
1717 with SIGHUP. This function calls `replace-buffer-in-windows' for
1718 cleaning up all windows currently displaying the buffer to be killed. */)
1719 (Lisp_Object buffer_or_name
)
1722 register struct buffer
*b
;
1723 register Lisp_Object tem
;
1724 register struct Lisp_Marker
*m
;
1725 struct gcpro gcpro1
;
1727 if (NILP (buffer_or_name
))
1728 buffer
= Fcurrent_buffer ();
1730 buffer
= Fget_buffer (buffer_or_name
);
1732 nsberror (buffer_or_name
);
1734 b
= XBUFFER (buffer
);
1736 /* Avoid trouble for buffer already dead. */
1737 if (!BUFFER_LIVE_P (b
))
1740 /* Query if the buffer is still modified. */
1741 if (INTERACTIVE
&& !NILP (BVAR (b
, filename
))
1742 && BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
1745 tem
= do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1746 BVAR (b
, name
), make_number (0)));
1752 /* Run hooks with the buffer to be killed the current buffer. */
1754 ptrdiff_t count
= SPECPDL_INDEX ();
1755 Lisp_Object arglist
[1];
1757 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1758 set_buffer_internal (b
);
1760 /* First run the query functions; if any query is answered no,
1761 don't kill the buffer. */
1762 arglist
[0] = Qkill_buffer_query_functions
;
1763 tem
= Frun_hook_with_args_until_failure (1, arglist
);
1765 return unbind_to (count
, Qnil
);
1767 /* Then run the hooks. */
1768 Frun_hooks (1, &Qkill_buffer_hook
);
1769 unbind_to (count
, Qnil
);
1772 /* If the hooks have killed the buffer, exit now. */
1773 if (!BUFFER_LIVE_P (b
))
1776 /* We have no more questions to ask. Verify that it is valid
1777 to kill the buffer. This must be done after the questions
1778 since anything can happen within do_yes_or_no_p. */
1780 /* Don't kill the minibuffer now current. */
1781 if (EQ (buffer
, XWINDOW (minibuf_window
)->buffer
))
1784 /* When we kill an ordinary buffer which shares it's buffer text
1785 with indirect buffer(s), we must kill indirect buffer(s) too.
1786 We do it at this stage so nothing terrible happens if they
1787 ask questions or their hooks get errors. */
1788 if (!b
->base_buffer
&& b
->indirections
> 0)
1790 struct buffer
*other
;
1794 FOR_EACH_BUFFER (other
)
1795 if (other
->base_buffer
== b
)
1798 XSETBUFFER (buf
, other
);
1804 /* Exit if we now have killed the base buffer (Bug#11665). */
1805 if (!BUFFER_LIVE_P (b
))
1809 /* Run replace_buffer_in_windows before making another buffer current
1810 since set-window-buffer-start-and-point will refuse to make another
1811 buffer current if the selected window does not show the current
1812 buffer. (Bug#10114) */
1813 replace_buffer_in_windows (buffer
);
1815 /* Exit if replacing the buffer in windows has killed our buffer. */
1816 if (!BUFFER_LIVE_P (b
))
1819 /* Make this buffer not be current. Exit if it is the sole visible
1821 if (b
== current_buffer
)
1823 tem
= Fother_buffer (buffer
, Qnil
, Qnil
);
1825 if (b
== current_buffer
)
1829 /* If the buffer now current is shown in the minibuffer and our buffer
1830 is the sole other buffer give up. */
1831 XSETBUFFER (tem
, current_buffer
);
1832 if (EQ (tem
, XWINDOW (minibuf_window
)->buffer
)
1833 && EQ (buffer
, Fother_buffer (buffer
, Qnil
, Qnil
)))
1836 /* Now there is no question: we can kill the buffer. */
1838 #ifdef CLASH_DETECTION
1839 /* Unlock this buffer's file, if it is locked. */
1841 #endif /* CLASH_DETECTION */
1844 kill_buffer_processes (buffer
);
1847 /* Killing buffer processes may run sentinels which may have killed
1849 if (!BUFFER_LIVE_P (b
))
1852 /* These may run Lisp code and into infinite loops (if someone
1853 insisted on circular lists) so allow quitting here. */
1854 frames_discard_buffer (buffer
);
1856 clear_charpos_cache (b
);
1858 tem
= Vinhibit_quit
;
1860 /* Remove the buffer from the list of all buffers. */
1861 Vbuffer_alist
= Fdelq (Frassq (buffer
, Vbuffer_alist
), Vbuffer_alist
);
1862 /* If replace_buffer_in_windows didn't do its job fix that now. */
1863 replace_buffer_in_windows_safely (buffer
);
1864 Vinhibit_quit
= tem
;
1866 /* Delete any auto-save file, if we saved it in this session.
1867 But not if the buffer is modified. */
1868 if (STRINGP (BVAR (b
, auto_save_file_name
))
1869 && BUF_AUTOSAVE_MODIFF (b
) != 0
1870 && BUF_SAVE_MODIFF (b
) < BUF_AUTOSAVE_MODIFF (b
)
1871 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
1872 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1875 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1876 if (! NILP (delete))
1877 internal_delete_file (BVAR (b
, auto_save_file_name
));
1880 /* Deleting an auto-save file could have killed our buffer. */
1881 if (!BUFFER_LIVE_P (b
))
1886 /* Unchain all markers that belong to this indirect buffer.
1887 Don't unchain the markers that belong to the base buffer
1888 or its other indirect buffers. */
1889 for (m
= BUF_MARKERS (b
); m
; )
1891 struct Lisp_Marker
*next
= m
->next
;
1899 /* Unchain all markers of this buffer and its indirect buffers.
1900 and leave them pointing nowhere. */
1901 for (m
= BUF_MARKERS (b
); m
; )
1903 struct Lisp_Marker
*next
= m
->next
;
1908 BUF_MARKERS (b
) = NULL
;
1909 set_buffer_intervals (b
, NULL
);
1911 /* Perhaps we should explicitly free the interval tree here... */
1914 /* Reset the local variables, so that this buffer's local values
1915 won't be protected from GC. They would be protected
1916 if they happened to remain cached in their symbols.
1917 This gets rid of them for certain. */
1918 swap_out_buffer_local_variables (b
);
1919 reset_buffer_local_variables (b
, 1);
1921 bset_name (b
, Qnil
);
1926 /* Notify our base buffer that we don't share the text anymore. */
1927 eassert (b
->indirections
== -1);
1928 b
->base_buffer
->indirections
--;
1929 eassert (b
->base_buffer
->indirections
>= 0);
1932 /* No one shares our buffer text, can free it. */
1933 free_buffer_text (b
);
1935 if (b
->newline_cache
)
1937 free_region_cache (b
->newline_cache
);
1938 b
->newline_cache
= 0;
1940 if (b
->width_run_cache
)
1942 free_region_cache (b
->width_run_cache
);
1943 b
->width_run_cache
= 0;
1945 bset_width_table (b
, Qnil
);
1947 bset_undo_list (b
, Qnil
);
1949 /* Run buffer-list-update-hook. */
1950 if (!NILP (Vrun_hooks
))
1951 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1956 /* Move association for BUFFER to the front of buffer (a)lists. Since
1957 we do this each time BUFFER is selected visibly, the more recently
1958 selected buffers are always closer to the front of those lists. This
1959 means that other_buffer is more likely to choose a relevant buffer.
1961 Note that this moves BUFFER to the front of the buffer lists of the
1962 selected frame even if BUFFER is not shown there. If BUFFER is not
1963 shown in the selected frame, consider the present behavior a feature.
1964 `select-window' gets this right since it shows BUFFER in the selected
1965 window when calling us. */
1968 record_buffer (Lisp_Object buffer
)
1970 Lisp_Object aelt
, aelt_cons
, tem
;
1971 register struct frame
*f
= XFRAME (selected_frame
);
1973 CHECK_BUFFER (buffer
);
1975 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1976 Don't allow quitting since this might leave the buffer list in an
1977 inconsistent state. */
1978 tem
= Vinhibit_quit
;
1980 aelt
= Frassq (buffer
, Vbuffer_alist
);
1981 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
1982 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
1983 XSETCDR (aelt_cons
, Vbuffer_alist
);
1984 Vbuffer_alist
= aelt_cons
;
1985 Vinhibit_quit
= tem
;
1987 /* Update buffer list of selected frame. */
1988 fset_buffer_list (f
, Fcons (buffer
, Fdelq (buffer
, f
->buffer_list
)));
1989 fset_buried_buffer_list (f
, Fdelq (buffer
, f
->buried_buffer_list
));
1991 /* Run buffer-list-update-hook. */
1992 if (!NILP (Vrun_hooks
))
1993 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1997 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1998 buffer is killed. For the selected frame's buffer list this moves
1999 BUFFER to its end even if it was never shown in that frame. If
2000 this happens we have a feature, hence `bury-buffer-internal' should be
2001 called only when BUFFER was shown in the selected frame. */
2003 DEFUN ("bury-buffer-internal", Fbury_buffer_internal
, Sbury_buffer_internal
,
2005 doc
: /* Move BUFFER to the end of the buffer list. */)
2006 (Lisp_Object buffer
)
2008 Lisp_Object aelt
, aelt_cons
, tem
;
2009 register struct frame
*f
= XFRAME (selected_frame
);
2011 CHECK_BUFFER (buffer
);
2013 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
2014 Don't allow quitting since this might leave the buffer list in an
2015 inconsistent state. */
2016 tem
= Vinhibit_quit
;
2018 aelt
= Frassq (buffer
, Vbuffer_alist
);
2019 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
2020 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
2021 XSETCDR (aelt_cons
, Qnil
);
2022 Vbuffer_alist
= nconc2 (Vbuffer_alist
, aelt_cons
);
2023 Vinhibit_quit
= tem
;
2025 /* Update buffer lists of selected frame. */
2026 fset_buffer_list (f
, Fdelq (buffer
, f
->buffer_list
));
2027 fset_buried_buffer_list
2028 (f
, Fcons (buffer
, Fdelq (buffer
, f
->buried_buffer_list
)));
2030 /* Run buffer-list-update-hook. */
2031 if (!NILP (Vrun_hooks
))
2032 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
2037 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode
, Sset_buffer_major_mode
, 1, 1, 0,
2038 doc
: /* Set an appropriate major mode for BUFFER.
2039 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
2040 according to `default-major-mode'.
2041 Use this function before selecting the buffer, since it may need to inspect
2042 the current buffer's major mode. */)
2043 (Lisp_Object buffer
)
2046 Lisp_Object function
;
2048 CHECK_BUFFER (buffer
);
2050 if (!BUFFER_LIVE_P (XBUFFER (buffer
)))
2051 error ("Attempt to set major mode for a dead buffer");
2053 if (strcmp (SSDATA (BVAR (XBUFFER (buffer
), name
)), "*scratch*") == 0)
2054 function
= find_symbol_value (intern ("initial-major-mode"));
2057 function
= BVAR (&buffer_defaults
, major_mode
);
2059 && NILP (Fget (BVAR (current_buffer
, major_mode
), Qmode_class
)))
2060 function
= BVAR (current_buffer
, major_mode
);
2063 if (NILP (function
) || EQ (function
, Qfundamental_mode
))
2066 count
= SPECPDL_INDEX ();
2068 /* To select a nonfundamental mode,
2069 select the buffer temporarily and then call the mode function. */
2071 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
2073 Fset_buffer (buffer
);
2076 return unbind_to (count
, Qnil
);
2079 DEFUN ("current-buffer", Fcurrent_buffer
, Scurrent_buffer
, 0, 0, 0,
2080 doc
: /* Return the current buffer as a Lisp object. */)
2083 register Lisp_Object buf
;
2084 XSETBUFFER (buf
, current_buffer
);
2088 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
2089 This is used by redisplay. */
2092 set_buffer_internal_1 (register struct buffer
*b
)
2094 register struct buffer
*old_buf
;
2095 register Lisp_Object tail
;
2097 #ifdef USE_MMAP_FOR_BUFFERS
2098 if (b
->text
->beg
== NULL
)
2099 enlarge_buffer_text (b
, 0);
2100 #endif /* USE_MMAP_FOR_BUFFERS */
2102 if (current_buffer
== b
)
2105 old_buf
= current_buffer
;
2107 last_known_column_point
= -1; /* invalidate indentation cache */
2111 /* Put the undo list back in the base buffer, so that it appears
2112 that an indirect buffer shares the undo list of its base. */
2113 if (old_buf
->base_buffer
)
2114 bset_undo_list (old_buf
->base_buffer
, BVAR (old_buf
, undo_list
));
2116 /* If the old current buffer has markers to record PT, BEGV and ZV
2117 when it is not current, update them now. */
2118 record_buffer_markers (old_buf
);
2121 /* Get the undo list from the base buffer, so that it appears
2122 that an indirect buffer shares the undo list of its base. */
2124 bset_undo_list (b
, BVAR (b
->base_buffer
, undo_list
));
2126 /* If the new current buffer has markers to record PT, BEGV and ZV
2127 when it is not current, fetch them now. */
2128 fetch_buffer_markers (b
);
2130 /* Look down buffer's list of local Lisp variables
2131 to find and update any that forward into C variables. */
2135 for (tail
= BVAR (b
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
2137 Lisp_Object var
= XCAR (XCAR (tail
));
2138 struct Lisp_Symbol
*sym
= XSYMBOL (var
);
2139 if (sym
->redirect
== SYMBOL_LOCALIZED
/* Just to be sure. */
2140 && SYMBOL_BLV (sym
)->fwd
)
2141 /* Just reference the variable
2142 to cause it to become set for this buffer. */
2143 Fsymbol_value (var
);
2146 /* Do the same with any others that were local to the previous buffer */
2147 while (b
!= old_buf
&& (b
= old_buf
, b
));
2150 /* Switch to buffer B temporarily for redisplay purposes.
2151 This avoids certain things that don't need to be done within redisplay. */
2154 set_buffer_temp (struct buffer
*b
)
2156 register struct buffer
*old_buf
;
2158 if (current_buffer
== b
)
2161 old_buf
= current_buffer
;
2164 /* If the old current buffer has markers to record PT, BEGV and ZV
2165 when it is not current, update them now. */
2166 record_buffer_markers (old_buf
);
2168 /* If the new current buffer has markers to record PT, BEGV and ZV
2169 when it is not current, fetch them now. */
2170 fetch_buffer_markers (b
);
2173 DEFUN ("set-buffer", Fset_buffer
, Sset_buffer
, 1, 1, 0,
2174 doc
: /* Make buffer BUFFER-OR-NAME current for editing operations.
2175 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
2176 also `save-excursion' when you want to make a buffer current
2177 temporarily. This function does not display the buffer, so its effect
2178 ends when the current command terminates. Use `switch-to-buffer' or
2179 `pop-to-buffer' to switch buffers permanently. */)
2180 (register Lisp_Object buffer_or_name
)
2182 register Lisp_Object buffer
;
2183 buffer
= Fget_buffer (buffer_or_name
);
2185 nsberror (buffer_or_name
);
2186 if (!BUFFER_LIVE_P (XBUFFER (buffer
)))
2187 error ("Selecting deleted buffer");
2188 set_buffer_internal (XBUFFER (buffer
));
2192 /* Set the current buffer to BUFFER provided if it is alive. */
2195 set_buffer_if_live (Lisp_Object buffer
)
2197 if (BUFFER_LIVE_P (XBUFFER (buffer
)))
2198 set_buffer_internal (XBUFFER (buffer
));
2202 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only
,
2203 Sbarf_if_buffer_read_only
, 0, 0, 0,
2204 doc
: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2207 if (!NILP (BVAR (current_buffer
, read_only
))
2208 && NILP (Vinhibit_read_only
))
2209 xsignal1 (Qbuffer_read_only
, Fcurrent_buffer ());
2213 DEFUN ("erase-buffer", Ferase_buffer
, Serase_buffer
, 0, 0, "*",
2214 doc
: /* Delete the entire contents of the current buffer.
2215 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2216 so the buffer is truly empty after this. */)
2223 current_buffer
->last_window_start
= 1;
2224 /* Prevent warnings, or suspension of auto saving, that would happen
2225 if future size is less than past size. Use of erase-buffer
2226 implies that the future text is not really related to the past text. */
2227 XSETFASTINT (BVAR (current_buffer
, save_length
), 0);
2232 validate_region (register Lisp_Object
*b
, register Lisp_Object
*e
)
2234 CHECK_NUMBER_COERCE_MARKER (*b
);
2235 CHECK_NUMBER_COERCE_MARKER (*e
);
2237 if (XINT (*b
) > XINT (*e
))
2240 tem
= *b
; *b
= *e
; *e
= tem
;
2243 if (! (BEGV
<= XINT (*b
) && XINT (*e
) <= ZV
))
2244 args_out_of_range (*b
, *e
);
2247 /* Advance BYTE_POS up to a character boundary
2248 and return the adjusted position. */
2251 advance_to_char_boundary (ptrdiff_t byte_pos
)
2255 if (byte_pos
== BEG
)
2256 /* Beginning of buffer is always a character boundary. */
2259 c
= FETCH_BYTE (byte_pos
);
2260 if (! CHAR_HEAD_P (c
))
2262 /* We should advance BYTE_POS only when C is a constituent of a
2263 multibyte sequence. */
2264 ptrdiff_t orig_byte_pos
= byte_pos
;
2269 c
= FETCH_BYTE (byte_pos
);
2271 while (! CHAR_HEAD_P (c
) && byte_pos
> BEG
);
2273 if (byte_pos
< orig_byte_pos
)
2274 byte_pos
= orig_byte_pos
;
2275 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2276 surely advance to the correct character boundary. If C is
2277 not, BYTE_POS was unchanged. */
2283 DEFUN ("buffer-swap-text", Fbuffer_swap_text
, Sbuffer_swap_text
,
2285 doc
: /* Swap the text between current buffer and BUFFER. */)
2286 (Lisp_Object buffer
)
2288 struct buffer
*other_buffer
;
2289 CHECK_BUFFER (buffer
);
2290 other_buffer
= XBUFFER (buffer
);
2292 if (!BUFFER_LIVE_P (other_buffer
))
2293 error ("Cannot swap a dead buffer's text");
2295 /* Actually, it probably works just fine.
2296 * if (other_buffer == current_buffer)
2297 * error ("Cannot swap a buffer's text with itself"); */
2299 /* Actually, this may be workable as well, tho probably only if they're
2301 if (other_buffer
->base_buffer
2302 || current_buffer
->base_buffer
)
2303 error ("Cannot swap indirect buffers's text");
2305 { /* This is probably harder to make work. */
2306 struct buffer
*other
;
2307 FOR_EACH_BUFFER (other
)
2308 if (other
->base_buffer
== other_buffer
2309 || other
->base_buffer
== current_buffer
)
2310 error ("One of the buffers to swap has indirect buffers");
2313 #define swapfield(field, type) \
2315 type tmp##field = other_buffer->field; \
2316 other_buffer->field = current_buffer->field; \
2317 current_buffer->field = tmp##field; \
2319 #define swapfield_(field, type) \
2321 type tmp##field = BVAR (other_buffer, field); \
2322 bset_##field (other_buffer, BVAR (current_buffer, field)); \
2323 bset_##field (current_buffer, tmp##field); \
2326 swapfield (own_text
, struct buffer_text
);
2327 eassert (current_buffer
->text
== ¤t_buffer
->own_text
);
2328 eassert (other_buffer
->text
== &other_buffer
->own_text
);
2330 r_alloc_reset_variable ((void **) ¤t_buffer
->own_text
.beg
,
2331 (void **) &other_buffer
->own_text
.beg
);
2332 r_alloc_reset_variable ((void **) &other_buffer
->own_text
.beg
,
2333 (void **) ¤t_buffer
->own_text
.beg
);
2334 #endif /* REL_ALLOC */
2336 swapfield (pt
, ptrdiff_t);
2337 swapfield (pt_byte
, ptrdiff_t);
2338 swapfield (begv
, ptrdiff_t);
2339 swapfield (begv_byte
, ptrdiff_t);
2340 swapfield (zv
, ptrdiff_t);
2341 swapfield (zv_byte
, ptrdiff_t);
2342 eassert (!current_buffer
->base_buffer
);
2343 eassert (!other_buffer
->base_buffer
);
2344 swapfield (indirections
, ptrdiff_t);
2345 current_buffer
->clip_changed
= 1; other_buffer
->clip_changed
= 1;
2346 swapfield (newline_cache
, struct region_cache
*);
2347 swapfield (width_run_cache
, struct region_cache
*);
2348 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2349 other_buffer
->prevent_redisplay_optimizations_p
= 1;
2350 swapfield (overlays_before
, struct Lisp_Overlay
*);
2351 swapfield (overlays_after
, struct Lisp_Overlay
*);
2352 swapfield (overlay_center
, ptrdiff_t);
2353 swapfield_ (undo_list
, Lisp_Object
);
2354 swapfield_ (mark
, Lisp_Object
);
2355 swapfield_ (enable_multibyte_characters
, Lisp_Object
);
2356 swapfield_ (bidi_display_reordering
, Lisp_Object
);
2357 swapfield_ (bidi_paragraph_direction
, Lisp_Object
);
2358 /* FIXME: Not sure what we should do with these *_marker fields.
2359 Hopefully they're just nil anyway. */
2360 swapfield_ (pt_marker
, Lisp_Object
);
2361 swapfield_ (begv_marker
, Lisp_Object
);
2362 swapfield_ (zv_marker
, Lisp_Object
);
2363 bset_point_before_scroll (current_buffer
, Qnil
);
2364 bset_point_before_scroll (other_buffer
, Qnil
);
2366 current_buffer
->text
->modiff
++; other_buffer
->text
->modiff
++;
2367 current_buffer
->text
->chars_modiff
++; other_buffer
->text
->chars_modiff
++;
2368 current_buffer
->text
->overlay_modiff
++; other_buffer
->text
->overlay_modiff
++;
2369 current_buffer
->text
->beg_unchanged
= current_buffer
->text
->gpt
;
2370 current_buffer
->text
->end_unchanged
= current_buffer
->text
->gpt
;
2371 other_buffer
->text
->beg_unchanged
= other_buffer
->text
->gpt
;
2372 other_buffer
->text
->end_unchanged
= other_buffer
->text
->gpt
;
2374 struct Lisp_Marker
*m
;
2375 for (m
= BUF_MARKERS (current_buffer
); m
; m
= m
->next
)
2376 if (m
->buffer
== other_buffer
)
2377 m
->buffer
= current_buffer
;
2379 /* Since there's no indirect buffer in sight, markers on
2380 BUF_MARKERS(buf) should either be for `buf' or dead. */
2381 eassert (!m
->buffer
);
2382 for (m
= BUF_MARKERS (other_buffer
); m
; m
= m
->next
)
2383 if (m
->buffer
== current_buffer
)
2384 m
->buffer
= other_buffer
;
2386 /* Since there's no indirect buffer in sight, markers on
2387 BUF_MARKERS(buf) should either be for `buf' or dead. */
2388 eassert (!m
->buffer
);
2390 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2391 So since we just swapped the markers between the two buffers, we need
2392 to undo the effect of this swap for window markers. */
2393 Lisp_Object w
= Fselected_window (), ws
= Qnil
;
2394 Lisp_Object buf1
, buf2
;
2395 XSETBUFFER (buf1
, current_buffer
); XSETBUFFER (buf2
, other_buffer
);
2397 while (NILP (Fmemq (w
, ws
)))
2400 if (MARKERP (XWINDOW (w
)->pointm
)
2401 && (EQ (XWINDOW (w
)->buffer
, buf1
)
2402 || EQ (XWINDOW (w
)->buffer
, buf2
)))
2403 Fset_marker (XWINDOW (w
)->pointm
,
2405 (BUF_BEGV (XBUFFER (XWINDOW (w
)->buffer
))),
2406 XWINDOW (w
)->buffer
);
2407 w
= Fnext_window (w
, Qt
, Qt
);
2411 if (current_buffer
->text
->intervals
)
2412 (eassert (EQ (current_buffer
->text
->intervals
->up
.obj
, buffer
)),
2413 XSETBUFFER (current_buffer
->text
->intervals
->up
.obj
, current_buffer
));
2414 if (other_buffer
->text
->intervals
)
2415 (eassert (EQ (other_buffer
->text
->intervals
->up
.obj
, Fcurrent_buffer ())),
2416 XSETBUFFER (other_buffer
->text
->intervals
->up
.obj
, other_buffer
));
2421 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte
, Sset_buffer_multibyte
,
2423 doc
: /* Set the multibyte flag of the current buffer to FLAG.
2424 If FLAG is t, this makes the buffer a multibyte buffer.
2425 If FLAG is nil, this makes the buffer a single-byte buffer.
2426 In these cases, the buffer contents remain unchanged as a sequence of
2427 bytes but the contents viewed as characters do change.
2428 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2429 all eight-bit bytes to eight-bit characters.
2430 If the multibyte flag was really changed, undo information of the
2431 current buffer is cleared. */)
2434 struct Lisp_Marker
*tail
, *markers
;
2435 struct buffer
*other
;
2437 bool narrowed
= (BEG
!= BEGV
|| Z
!= ZV
);
2438 bool modified_p
= !NILP (Fbuffer_modified_p (Qnil
));
2439 Lisp_Object old_undo
= BVAR (current_buffer
, undo_list
);
2440 struct gcpro gcpro1
;
2442 if (current_buffer
->base_buffer
)
2443 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2445 /* Do nothing if nothing actually changes. */
2446 if (NILP (flag
) == NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2451 /* Don't record these buffer changes. We will put a special undo entry
2453 bset_undo_list (current_buffer
, Qt
);
2455 /* If the cached position is for this buffer, clear it out. */
2456 clear_charpos_cache (current_buffer
);
2459 begv
= BEGV_BYTE
, zv
= ZV_BYTE
;
2461 begv
= BEGV
, zv
= ZV
;
2468 ptrdiff_t pos
, stop
;
2471 /* Do this first, so it can use CHAR_TO_BYTE
2472 to calculate the old correspondences. */
2473 set_intervals_multibyte (0);
2475 bset_enable_multibyte_characters (current_buffer
, Qnil
);
2481 TEMP_SET_PT_BOTH (PT_BYTE
, PT_BYTE
);
2484 for (tail
= BUF_MARKERS (current_buffer
); tail
; tail
= tail
->next
)
2485 tail
->charpos
= tail
->bytepos
;
2487 /* Convert multibyte form of 8-bit characters to unibyte. */
2502 if (ASCII_BYTE_P (*p
))
2504 else if (CHAR_BYTE8_HEAD_P (*p
))
2506 c
= STRING_CHAR_AND_LENGTH (p
, bytes
);
2507 /* Delete all bytes for this 8-bit character but the
2508 last one, and change the last one to the character
2511 del_range_2 (pos
, pos
, pos
+ bytes
, pos
+ bytes
, 0);
2523 bytes
= BYTES_BY_CHAR_HEAD (*p
);
2524 p
+= bytes
, pos
+= bytes
;
2528 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2533 ptrdiff_t pos
, stop
;
2534 unsigned char *p
, *pend
;
2536 /* Be sure not to have a multibyte sequence striding over the GAP.
2537 Ex: We change this: "...abc\302 _GAP_ \241def..."
2538 to: "...abc _GAP_ \302\241def..." */
2541 && GPT_BYTE
> 1 && GPT_BYTE
< Z_BYTE
2542 && ! CHAR_HEAD_P (*(GAP_END_ADDR
)))
2544 unsigned char *q
= GPT_ADDR
- 1;
2546 while (! CHAR_HEAD_P (*q
) && q
> BEG_ADDR
) q
--;
2547 if (LEADING_CODE_P (*q
))
2549 ptrdiff_t new_gpt
= GPT_BYTE
- (GPT_ADDR
- q
);
2551 move_gap_both (new_gpt
, new_gpt
);
2555 /* Make the buffer contents valid as multibyte by converting
2556 8-bit characters to multibyte form. */
2574 if (ASCII_BYTE_P (*p
))
2576 else if (EQ (flag
, Qt
)
2577 && ! CHAR_BYTE8_HEAD_P (*p
)
2578 && (bytes
= MULTIBYTE_LENGTH (p
, pend
)) > 0)
2579 p
+= bytes
, pos
+= bytes
;
2582 unsigned char tmp
[MAX_MULTIBYTE_LENGTH
];
2585 c
= BYTE8_TO_CHAR (*p
);
2586 bytes
= CHAR_STRING (c
, tmp
);
2588 TEMP_SET_PT_BOTH (pos
+ 1, pos
+ 1);
2590 insert_1_both ((char *) tmp
+ 1, bytes
, bytes
, 1, 0, 0);
2591 /* Now the gap is after the just inserted data. */
2609 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2611 /* Do this first, so that chars_in_text asks the right question.
2612 set_intervals_multibyte needs it too. */
2613 bset_enable_multibyte_characters (current_buffer
, Qt
);
2615 GPT_BYTE
= advance_to_char_boundary (GPT_BYTE
);
2616 GPT
= chars_in_text (BEG_ADDR
, GPT_BYTE
- BEG_BYTE
) + BEG
;
2618 Z
= chars_in_text (GAP_END_ADDR
, Z_BYTE
- GPT_BYTE
) + GPT
;
2620 BEGV_BYTE
= advance_to_char_boundary (BEGV_BYTE
);
2621 if (BEGV_BYTE
> GPT_BYTE
)
2622 BEGV
= chars_in_text (GAP_END_ADDR
, BEGV_BYTE
- GPT_BYTE
) + GPT
;
2624 BEGV
= chars_in_text (BEG_ADDR
, BEGV_BYTE
- BEG_BYTE
) + BEG
;
2626 ZV_BYTE
= advance_to_char_boundary (ZV_BYTE
);
2627 if (ZV_BYTE
> GPT_BYTE
)
2628 ZV
= chars_in_text (GAP_END_ADDR
, ZV_BYTE
- GPT_BYTE
) + GPT
;
2630 ZV
= chars_in_text (BEG_ADDR
, ZV_BYTE
- BEG_BYTE
) + BEG
;
2633 ptrdiff_t byte
= advance_to_char_boundary (PT_BYTE
);
2636 if (byte
> GPT_BYTE
)
2637 position
= chars_in_text (GAP_END_ADDR
, byte
- GPT_BYTE
) + GPT
;
2639 position
= chars_in_text (BEG_ADDR
, byte
- BEG_BYTE
) + BEG
;
2640 TEMP_SET_PT_BOTH (position
, byte
);
2643 tail
= markers
= BUF_MARKERS (current_buffer
);
2645 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2646 getting confused by the markers that have not yet been updated.
2647 It is also a signal that it should never create a marker. */
2648 BUF_MARKERS (current_buffer
) = NULL
;
2650 for (; tail
; tail
= tail
->next
)
2652 tail
->bytepos
= advance_to_char_boundary (tail
->bytepos
);
2653 tail
->charpos
= BYTE_TO_CHAR (tail
->bytepos
);
2656 /* Make sure no markers were put on the chain
2657 while the chain value was incorrect. */
2658 if (BUF_MARKERS (current_buffer
))
2661 BUF_MARKERS (current_buffer
) = markers
;
2663 /* Do this last, so it can calculate the new correspondences
2664 between chars and bytes. */
2665 set_intervals_multibyte (1);
2668 if (!EQ (old_undo
, Qt
))
2670 /* Represent all the above changes by a special undo entry. */
2671 bset_undo_list (current_buffer
,
2672 Fcons (list3 (Qapply
,
2673 intern ("set-buffer-multibyte"),
2674 NILP (flag
) ? Qt
: Qnil
),
2680 /* Changing the multibyteness of a buffer means that all windows
2681 showing that buffer must be updated thoroughly. */
2682 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2683 ++windows_or_buffers_changed
;
2685 /* Copy this buffer's new multibyte status
2686 into all of its indirect buffers. */
2687 FOR_EACH_BUFFER (other
)
2688 if (other
->base_buffer
== current_buffer
&& BUFFER_LIVE_P (other
))
2690 BVAR (other
, enable_multibyte_characters
)
2691 = BVAR (current_buffer
, enable_multibyte_characters
);
2692 other
->prevent_redisplay_optimizations_p
= 1;
2695 /* Restore the modifiedness of the buffer. */
2696 if (!modified_p
&& !NILP (Fbuffer_modified_p (Qnil
)))
2697 Fset_buffer_modified_p (Qnil
);
2699 /* Update coding systems of this buffer's process (if any). */
2701 Lisp_Object process
;
2703 process
= Fget_buffer_process (Fcurrent_buffer ());
2704 if (PROCESSP (process
))
2705 setup_process_coding_systems (process
);
2711 DEFUN ("kill-all-local-variables", Fkill_all_local_variables
,
2712 Skill_all_local_variables
, 0, 0, 0,
2713 doc
: /* Switch to Fundamental mode by killing current buffer's local variables.
2714 Most local variable bindings are eliminated so that the default values
2715 become effective once more. Also, the syntax table is set from
2716 `standard-syntax-table', the local keymap is set to nil,
2717 and the abbrev table from `fundamental-mode-abbrev-table'.
2718 This function also forces redisplay of the mode line.
2720 Every function to select a new major mode starts by
2721 calling this function.
2723 As a special exception, local variables whose names have
2724 a non-nil `permanent-local' property are not eliminated by this function.
2726 The first thing this function does is run
2727 the normal hook `change-major-mode-hook'. */)
2730 Frun_hooks (1, &Qchange_major_mode_hook
);
2732 /* Make sure none of the bindings in local_var_alist
2733 remain swapped in, in their symbols. */
2735 swap_out_buffer_local_variables (current_buffer
);
2737 /* Actually eliminate all local bindings of this buffer. */
2739 reset_buffer_local_variables (current_buffer
, 0);
2741 /* Force mode-line redisplay. Useful here because all major mode
2742 commands call this function. */
2743 update_mode_lines
++;
2748 /* Make sure no local variables remain set up with buffer B
2749 for their current values. */
2752 swap_out_buffer_local_variables (struct buffer
*b
)
2754 Lisp_Object oalist
, alist
, buffer
;
2756 XSETBUFFER (buffer
, b
);
2757 oalist
= BVAR (b
, local_var_alist
);
2759 for (alist
= oalist
; CONSP (alist
); alist
= XCDR (alist
))
2761 Lisp_Object sym
= XCAR (XCAR (alist
));
2762 eassert (XSYMBOL (sym
)->redirect
== SYMBOL_LOCALIZED
);
2763 /* Need not do anything if some other buffer's binding is
2765 if (EQ (SYMBOL_BLV (XSYMBOL (sym
))->where
, buffer
))
2767 /* Symbol is set up for this buffer's old local value:
2769 swap_in_global_binding (XSYMBOL (sym
));
2774 /* Find all the overlays in the current buffer that contain position POS.
2775 Return the number found, and store them in a vector in *VEC_PTR.
2776 Store in *LEN_PTR the size allocated for the vector.
2777 Store in *NEXT_PTR the next position after POS where an overlay starts,
2778 or ZV if there are no more overlays between POS and ZV.
2779 Store in *PREV_PTR the previous position before POS where an overlay ends,
2780 or where an overlay starts which ends at or after POS;
2781 or BEGV if there are no such overlays from BEGV to POS.
2782 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2784 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2785 when this function is called.
2787 If EXTEND, make the vector bigger if necessary.
2788 If not, never extend the vector,
2789 and store only as many overlays as will fit.
2790 But still return the total number of overlays.
2792 If CHANGE_REQ, any position written into *PREV_PTR or
2793 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2794 default (BEGV or ZV). */
2797 overlays_at (EMACS_INT pos
, bool extend
, Lisp_Object
**vec_ptr
,
2799 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
, bool change_req
)
2801 Lisp_Object overlay
, start
, end
;
2802 struct Lisp_Overlay
*tail
;
2804 ptrdiff_t len
= *len_ptr
;
2805 Lisp_Object
*vec
= *vec_ptr
;
2806 ptrdiff_t next
= ZV
;
2807 ptrdiff_t prev
= BEGV
;
2808 bool inhibit_storing
= 0;
2810 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2812 ptrdiff_t startpos
, endpos
;
2814 XSETMISC (overlay
, tail
);
2816 start
= OVERLAY_START (overlay
);
2817 end
= OVERLAY_END (overlay
);
2818 endpos
= OVERLAY_POSITION (end
);
2825 startpos
= OVERLAY_POSITION (start
);
2826 /* This one ends at or after POS
2827 so its start counts for PREV_PTR if it's before POS. */
2828 if (prev
< startpos
&& startpos
< pos
)
2832 if (startpos
<= pos
)
2836 /* The supplied vector is full.
2837 Either make it bigger, or don't store any more in it. */
2840 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2846 inhibit_storing
= 1;
2849 if (!inhibit_storing
)
2851 /* Keep counting overlays even if we can't return them all. */
2854 else if (startpos
< next
)
2858 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2860 ptrdiff_t startpos
, endpos
;
2862 XSETMISC (overlay
, tail
);
2864 start
= OVERLAY_START (overlay
);
2865 end
= OVERLAY_END (overlay
);
2866 startpos
= OVERLAY_POSITION (start
);
2869 if (startpos
< next
)
2873 endpos
= OVERLAY_POSITION (end
);
2880 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2886 inhibit_storing
= 1;
2889 if (!inhibit_storing
)
2893 if (startpos
< pos
&& startpos
> prev
)
2896 else if (endpos
< pos
&& endpos
> prev
)
2898 else if (endpos
== pos
&& startpos
> prev
2899 && (!change_req
|| startpos
< pos
))
2910 /* Find all the overlays in the current buffer that overlap the range
2911 BEG-END, or are empty at BEG, or are empty at END provided END
2912 denotes the position at the end of the current buffer.
2914 Return the number found, and store them in a vector in *VEC_PTR.
2915 Store in *LEN_PTR the size allocated for the vector.
2916 Store in *NEXT_PTR the next position after POS where an overlay starts,
2917 or ZV if there are no more overlays.
2918 Store in *PREV_PTR the previous position before POS where an overlay ends,
2919 or BEGV if there are no previous overlays.
2920 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2922 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2923 when this function is called.
2925 If EXTEND, make the vector bigger if necessary.
2926 If not, never extend the vector,
2927 and store only as many overlays as will fit.
2928 But still return the total number of overlays. */
2931 overlays_in (EMACS_INT beg
, EMACS_INT end
, bool extend
,
2932 Lisp_Object
**vec_ptr
, ptrdiff_t *len_ptr
,
2933 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
)
2935 Lisp_Object overlay
, ostart
, oend
;
2936 struct Lisp_Overlay
*tail
;
2938 ptrdiff_t len
= *len_ptr
;
2939 Lisp_Object
*vec
= *vec_ptr
;
2940 ptrdiff_t next
= ZV
;
2941 ptrdiff_t prev
= BEGV
;
2942 bool inhibit_storing
= 0;
2943 bool end_is_Z
= end
== Z
;
2945 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2947 ptrdiff_t startpos
, endpos
;
2949 XSETMISC (overlay
, tail
);
2951 ostart
= OVERLAY_START (overlay
);
2952 oend
= OVERLAY_END (overlay
);
2953 endpos
= OVERLAY_POSITION (oend
);
2960 startpos
= OVERLAY_POSITION (ostart
);
2961 /* Count an interval if it overlaps the range, is empty at the
2962 start of the range, or is empty at END provided END denotes the
2963 end of the buffer. */
2964 if ((beg
< endpos
&& startpos
< end
)
2965 || (startpos
== endpos
2966 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
2970 /* The supplied vector is full.
2971 Either make it bigger, or don't store any more in it. */
2974 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2980 inhibit_storing
= 1;
2983 if (!inhibit_storing
)
2985 /* Keep counting overlays even if we can't return them all. */
2988 else if (startpos
< next
)
2992 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2994 ptrdiff_t startpos
, endpos
;
2996 XSETMISC (overlay
, tail
);
2998 ostart
= OVERLAY_START (overlay
);
2999 oend
= OVERLAY_END (overlay
);
3000 startpos
= OVERLAY_POSITION (ostart
);
3003 if (startpos
< next
)
3007 endpos
= OVERLAY_POSITION (oend
);
3008 /* Count an interval if it overlaps the range, is empty at the
3009 start of the range, or is empty at END provided END denotes the
3010 end of the buffer. */
3011 if ((beg
< endpos
&& startpos
< end
)
3012 || (startpos
== endpos
3013 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
3019 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
3025 inhibit_storing
= 1;
3028 if (!inhibit_storing
)
3032 else if (endpos
< beg
&& endpos
> prev
)
3044 /* Return true if there exists an overlay with a non-nil
3045 `mouse-face' property overlapping OVERLAY. */
3048 mouse_face_overlay_overlaps (Lisp_Object overlay
)
3050 ptrdiff_t start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3051 ptrdiff_t end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3052 ptrdiff_t n
, i
, size
;
3053 Lisp_Object
*v
, tem
;
3056 v
= alloca (size
* sizeof *v
);
3057 n
= overlays_in (start
, end
, 0, &v
, &size
, NULL
, NULL
);
3060 v
= alloca (n
* sizeof *v
);
3061 overlays_in (start
, end
, 0, &v
, &n
, NULL
, NULL
);
3064 for (i
= 0; i
< n
; ++i
)
3065 if (!EQ (v
[i
], overlay
)
3066 && (tem
= Foverlay_get (overlay
, Qmouse_face
),
3075 /* Fast function to just test if we're at an overlay boundary. */
3077 overlay_touches_p (ptrdiff_t pos
)
3079 Lisp_Object overlay
;
3080 struct Lisp_Overlay
*tail
;
3082 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
3086 XSETMISC (overlay
,tail
);
3087 eassert (OVERLAYP (overlay
));
3089 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3092 if (endpos
== pos
|| OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
)
3096 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
3100 XSETMISC (overlay
, tail
);
3101 eassert (OVERLAYP (overlay
));
3103 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3106 if (startpos
== pos
|| OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
)
3114 Lisp_Object overlay
;
3120 compare_overlays (const void *v1
, const void *v2
)
3122 const struct sortvec
*s1
= (const struct sortvec
*) v1
;
3123 const struct sortvec
*s2
= (const struct sortvec
*) v2
;
3124 if (s1
->priority
!= s2
->priority
)
3125 return s1
->priority
< s2
->priority
? -1 : 1;
3126 if (s1
->beg
!= s2
->beg
)
3127 return s1
->beg
< s2
->beg
? -1 : 1;
3128 if (s1
->end
!= s2
->end
)
3129 return s2
->end
< s1
->end
? -1 : 1;
3130 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
3131 between "equal" overlays. The result can still change between
3132 invocations of Emacs, but it won't change in the middle of
3133 `find_field' (bug#6830). */
3134 if (XHASH (s1
->overlay
) != XHASH (s2
->overlay
))
3135 return XHASH (s1
->overlay
) < XHASH (s2
->overlay
) ? -1 : 1;
3139 /* Sort an array of overlays by priority. The array is modified in place.
3140 The return value is the new size; this may be smaller than the original
3141 size if some of the overlays were invalid or were window-specific. */
3143 sort_overlays (Lisp_Object
*overlay_vec
, ptrdiff_t noverlays
, struct window
*w
)
3146 struct sortvec
*sortvec
= alloca (noverlays
* sizeof *sortvec
);
3148 /* Put the valid and relevant overlays into sortvec. */
3150 for (i
= 0, j
= 0; i
< noverlays
; i
++)
3153 Lisp_Object overlay
;
3155 overlay
= overlay_vec
[i
];
3156 if (OVERLAYP (overlay
)
3157 && OVERLAY_POSITION (OVERLAY_START (overlay
)) > 0
3158 && OVERLAY_POSITION (OVERLAY_END (overlay
)) > 0)
3160 /* If we're interested in a specific window, then ignore
3161 overlays that are limited to some other window. */
3166 window
= Foverlay_get (overlay
, Qwindow
);
3167 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3171 /* This overlay is good and counts: put it into sortvec. */
3172 sortvec
[j
].overlay
= overlay
;
3173 sortvec
[j
].beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3174 sortvec
[j
].end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3175 tem
= Foverlay_get (overlay
, Qpriority
);
3177 sortvec
[j
].priority
= XINT (tem
);
3179 sortvec
[j
].priority
= 0;
3185 /* Sort the overlays into the proper order: increasing priority. */
3188 qsort (sortvec
, noverlays
, sizeof (struct sortvec
), compare_overlays
);
3190 for (i
= 0; i
< noverlays
; i
++)
3191 overlay_vec
[i
] = sortvec
[i
].overlay
;
3197 Lisp_Object string
, string2
;
3204 struct sortstr
*buf
; /* An array that expands as needed; never freed. */
3205 ptrdiff_t size
; /* Allocated length of that array. */
3206 ptrdiff_t used
; /* How much of the array is currently in use. */
3207 ptrdiff_t bytes
; /* Total length of the strings in buf. */
3210 /* Buffers for storing information about the overlays touching a given
3211 position. These could be automatic variables in overlay_strings, but
3212 it's more efficient to hold onto the memory instead of repeatedly
3213 allocating and freeing it. */
3214 static struct sortstrlist overlay_heads
, overlay_tails
;
3215 static unsigned char *overlay_str_buf
;
3217 /* Allocated length of overlay_str_buf. */
3218 static ptrdiff_t overlay_str_len
;
3220 /* A comparison function suitable for passing to qsort. */
3222 cmp_for_strings (const void *as1
, const void *as2
)
3224 struct sortstr
*s1
= (struct sortstr
*)as1
;
3225 struct sortstr
*s2
= (struct sortstr
*)as2
;
3226 if (s1
->size
!= s2
->size
)
3227 return s2
->size
< s1
->size
? -1 : 1;
3228 if (s1
->priority
!= s2
->priority
)
3229 return s1
->priority
< s2
->priority
? -1 : 1;
3234 record_overlay_string (struct sortstrlist
*ssl
, Lisp_Object str
,
3235 Lisp_Object str2
, Lisp_Object pri
, ptrdiff_t size
)
3239 if (ssl
->used
== ssl
->size
)
3240 ssl
->buf
= xpalloc (ssl
->buf
, &ssl
->size
, 5, -1, sizeof *ssl
->buf
);
3241 ssl
->buf
[ssl
->used
].string
= str
;
3242 ssl
->buf
[ssl
->used
].string2
= str2
;
3243 ssl
->buf
[ssl
->used
].size
= size
;
3244 ssl
->buf
[ssl
->used
].priority
= (INTEGERP (pri
) ? XINT (pri
) : 0);
3247 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3248 nbytes
= SCHARS (str
);
3249 else if (! STRING_MULTIBYTE (str
))
3250 nbytes
= count_size_as_multibyte (SDATA (str
),
3253 nbytes
= SBYTES (str
);
3255 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3256 memory_full (SIZE_MAX
);
3257 ssl
->bytes
+= nbytes
;
3261 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3262 nbytes
= SCHARS (str2
);
3263 else if (! STRING_MULTIBYTE (str2
))
3264 nbytes
= count_size_as_multibyte (SDATA (str2
),
3267 nbytes
= SBYTES (str2
);
3269 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3270 memory_full (SIZE_MAX
);
3271 ssl
->bytes
+= nbytes
;
3275 /* Return the concatenation of the strings associated with overlays that
3276 begin or end at POS, ignoring overlays that are specific to a window
3277 other than W. The strings are concatenated in the appropriate order:
3278 shorter overlays nest inside longer ones, and higher priority inside
3279 lower. Normally all of the after-strings come first, but zero-sized
3280 overlays have their after-strings ride along with the before-strings
3281 because it would look strange to print them inside-out.
3283 Returns the string length, and stores the contents indirectly through
3284 PSTR, if that variable is non-null. The string may be overwritten by
3285 subsequent calls. */
3288 overlay_strings (ptrdiff_t pos
, struct window
*w
, unsigned char **pstr
)
3290 Lisp_Object overlay
, window
, str
;
3291 struct Lisp_Overlay
*ov
;
3292 ptrdiff_t startpos
, endpos
;
3293 bool multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3295 overlay_heads
.used
= overlay_heads
.bytes
= 0;
3296 overlay_tails
.used
= overlay_tails
.bytes
= 0;
3297 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
3299 XSETMISC (overlay
, ov
);
3300 eassert (OVERLAYP (overlay
));
3302 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3303 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3306 if (endpos
!= pos
&& startpos
!= pos
)
3308 window
= Foverlay_get (overlay
, Qwindow
);
3309 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3312 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3313 record_overlay_string (&overlay_heads
, str
,
3315 ? Foverlay_get (overlay
, Qafter_string
)
3317 Foverlay_get (overlay
, Qpriority
),
3319 else if (endpos
== pos
3320 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3321 record_overlay_string (&overlay_tails
, str
, Qnil
,
3322 Foverlay_get (overlay
, Qpriority
),
3325 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
3327 XSETMISC (overlay
, ov
);
3328 eassert (OVERLAYP (overlay
));
3330 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3331 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3334 if (endpos
!= pos
&& startpos
!= pos
)
3336 window
= Foverlay_get (overlay
, Qwindow
);
3337 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3340 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3341 record_overlay_string (&overlay_heads
, str
,
3343 ? Foverlay_get (overlay
, Qafter_string
)
3345 Foverlay_get (overlay
, Qpriority
),
3347 else if (endpos
== pos
3348 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3349 record_overlay_string (&overlay_tails
, str
, Qnil
,
3350 Foverlay_get (overlay
, Qpriority
),
3353 if (overlay_tails
.used
> 1)
3354 qsort (overlay_tails
.buf
, overlay_tails
.used
, sizeof (struct sortstr
),
3356 if (overlay_heads
.used
> 1)
3357 qsort (overlay_heads
.buf
, overlay_heads
.used
, sizeof (struct sortstr
),
3359 if (overlay_heads
.bytes
|| overlay_tails
.bytes
)
3366 if (INT_ADD_OVERFLOW (overlay_heads
.bytes
, overlay_tails
.bytes
))
3367 memory_full (SIZE_MAX
);
3368 total
= overlay_heads
.bytes
+ overlay_tails
.bytes
;
3369 if (total
> overlay_str_len
)
3370 overlay_str_buf
= xpalloc (overlay_str_buf
, &overlay_str_len
,
3371 total
- overlay_str_len
, -1, 1);
3373 p
= overlay_str_buf
;
3374 for (i
= overlay_tails
.used
; --i
>= 0;)
3377 tem
= overlay_tails
.buf
[i
].string
;
3378 nbytes
= copy_text (SDATA (tem
), p
,
3380 STRING_MULTIBYTE (tem
), multibyte
);
3383 for (i
= 0; i
< overlay_heads
.used
; ++i
)
3386 tem
= overlay_heads
.buf
[i
].string
;
3387 nbytes
= copy_text (SDATA (tem
), p
,
3389 STRING_MULTIBYTE (tem
), multibyte
);
3391 tem
= overlay_heads
.buf
[i
].string2
;
3394 nbytes
= copy_text (SDATA (tem
), p
,
3396 STRING_MULTIBYTE (tem
), multibyte
);
3400 if (p
!= overlay_str_buf
+ total
)
3403 *pstr
= overlay_str_buf
;
3409 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3412 recenter_overlay_lists (struct buffer
*buf
, ptrdiff_t pos
)
3414 Lisp_Object overlay
, beg
, end
;
3415 struct Lisp_Overlay
*prev
, *tail
, *next
;
3417 /* See if anything in overlays_before should move to overlays_after. */
3419 /* We don't strictly need prev in this loop; it should always be nil.
3420 But we use it for symmetry and in case that should cease to be true
3421 with some future change. */
3423 for (tail
= buf
->overlays_before
; tail
; prev
= tail
, tail
= next
)
3426 XSETMISC (overlay
, tail
);
3427 eassert (OVERLAYP (overlay
));
3429 beg
= OVERLAY_START (overlay
);
3430 end
= OVERLAY_END (overlay
);
3432 if (OVERLAY_POSITION (end
) > pos
)
3434 /* OVERLAY needs to be moved. */
3435 ptrdiff_t where
= OVERLAY_POSITION (beg
);
3436 struct Lisp_Overlay
*other
, *other_prev
;
3438 /* Splice the cons cell TAIL out of overlays_before. */
3442 set_buffer_overlays_before (buf
, next
);
3444 /* Search thru overlays_after for where to put it. */
3446 for (other
= buf
->overlays_after
; other
;
3447 other_prev
= other
, other
= other
->next
)
3449 Lisp_Object otherbeg
, otheroverlay
;
3451 XSETMISC (otheroverlay
, other
);
3452 eassert (OVERLAYP (otheroverlay
));
3454 otherbeg
= OVERLAY_START (otheroverlay
);
3455 if (OVERLAY_POSITION (otherbeg
) >= where
)
3459 /* Add TAIL to overlays_after before OTHER. */
3462 other_prev
->next
= tail
;
3464 set_buffer_overlays_after (buf
, tail
);
3468 /* We've reached the things that should stay in overlays_before.
3469 All the rest of overlays_before must end even earlier,
3474 /* See if anything in overlays_after should be in overlays_before. */
3476 for (tail
= buf
->overlays_after
; tail
; prev
= tail
, tail
= next
)
3479 XSETMISC (overlay
, tail
);
3480 eassert (OVERLAYP (overlay
));
3482 beg
= OVERLAY_START (overlay
);
3483 end
= OVERLAY_END (overlay
);
3485 /* Stop looking, when we know that nothing further
3486 can possibly end before POS. */
3487 if (OVERLAY_POSITION (beg
) > pos
)
3490 if (OVERLAY_POSITION (end
) <= pos
)
3492 /* OVERLAY needs to be moved. */
3493 ptrdiff_t where
= OVERLAY_POSITION (end
);
3494 struct Lisp_Overlay
*other
, *other_prev
;
3496 /* Splice the cons cell TAIL out of overlays_after. */
3500 set_buffer_overlays_after (buf
, next
);
3502 /* Search thru overlays_before for where to put it. */
3504 for (other
= buf
->overlays_before
; other
;
3505 other_prev
= other
, other
= other
->next
)
3507 Lisp_Object otherend
, otheroverlay
;
3509 XSETMISC (otheroverlay
, other
);
3510 eassert (OVERLAYP (otheroverlay
));
3512 otherend
= OVERLAY_END (otheroverlay
);
3513 if (OVERLAY_POSITION (otherend
) <= where
)
3517 /* Add TAIL to overlays_before before OTHER. */
3520 other_prev
->next
= tail
;
3522 set_buffer_overlays_before (buf
, tail
);
3527 buf
->overlay_center
= pos
;
3531 adjust_overlays_for_insert (ptrdiff_t pos
, ptrdiff_t length
)
3533 /* After an insertion, the lists are still sorted properly,
3534 but we may need to update the value of the overlay center. */
3535 if (current_buffer
->overlay_center
>= pos
)
3536 current_buffer
->overlay_center
+= length
;
3540 adjust_overlays_for_delete (ptrdiff_t pos
, ptrdiff_t length
)
3542 if (current_buffer
->overlay_center
< pos
)
3543 /* The deletion was to our right. No change needed; the before- and
3544 after-lists are still consistent. */
3546 else if (current_buffer
->overlay_center
- pos
> length
)
3547 /* The deletion was to our left. We need to adjust the center value
3548 to account for the change in position, but the lists are consistent
3549 given the new value. */
3550 current_buffer
->overlay_center
-= length
;
3552 /* We're right in the middle. There might be things on the after-list
3553 that now belong on the before-list. Recentering will move them,
3554 and also update the center point. */
3555 recenter_overlay_lists (current_buffer
, pos
);
3558 /* Fix up overlays that were garbled as a result of permuting markers
3559 in the range START through END. Any overlay with at least one
3560 endpoint in this range will need to be unlinked from the overlay
3561 list and reinserted in its proper place.
3562 Such an overlay might even have negative size at this point.
3563 If so, we'll make the overlay empty. */
3565 fix_start_end_in_overlays (register ptrdiff_t start
, register ptrdiff_t end
)
3567 Lisp_Object overlay
;
3568 struct Lisp_Overlay
*before_list
IF_LINT (= NULL
);
3569 struct Lisp_Overlay
*after_list
IF_LINT (= NULL
);
3570 /* These are either nil, indicating that before_list or after_list
3571 should be assigned, or the cons cell the cdr of which should be
3573 struct Lisp_Overlay
*beforep
= NULL
, *afterp
= NULL
;
3574 /* 'Parent', likewise, indicates a cons cell or
3575 current_buffer->overlays_before or overlays_after, depending
3576 which loop we're in. */
3577 struct Lisp_Overlay
*tail
, *parent
;
3578 ptrdiff_t startpos
, endpos
;
3580 /* This algorithm shifts links around instead of consing and GCing.
3581 The loop invariant is that before_list (resp. after_list) is a
3582 well-formed list except that its last element, the CDR of beforep
3583 (resp. afterp) if beforep (afterp) isn't nil or before_list
3584 (after_list) if it is, is still uninitialized. So it's not a bug
3585 that before_list isn't initialized, although it may look
3587 for (parent
= NULL
, tail
= current_buffer
->overlays_before
; tail
;)
3589 XSETMISC (overlay
, tail
);
3591 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3592 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3594 /* If the overlay is backwards, make it empty. */
3595 if (endpos
< startpos
)
3598 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3606 || (startpos
>= start
&& startpos
< end
))
3608 /* Add it to the end of the wrong list. Later on,
3609 recenter_overlay_lists will move it to the right place. */
3610 if (endpos
< current_buffer
->overlay_center
)
3615 afterp
->next
= tail
;
3623 beforep
->next
= tail
;
3627 set_buffer_overlays_before (current_buffer
, tail
->next
);
3629 parent
->next
= tail
->next
;
3633 parent
= tail
, tail
= parent
->next
;
3635 for (parent
= NULL
, tail
= current_buffer
->overlays_after
; tail
;)
3637 XSETMISC (overlay
, tail
);
3639 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3640 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3642 /* If the overlay is backwards, make it empty. */
3643 if (endpos
< startpos
)
3646 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3650 if (startpos
>= end
)
3653 if (startpos
>= start
3654 || (endpos
>= start
&& endpos
< end
))
3656 if (endpos
< current_buffer
->overlay_center
)
3661 afterp
->next
= tail
;
3669 beforep
->next
= tail
;
3673 set_buffer_overlays_after (current_buffer
, tail
->next
);
3675 parent
->next
= tail
->next
;
3679 parent
= tail
, tail
= parent
->next
;
3682 /* Splice the constructed (wrong) lists into the buffer's lists,
3683 and let the recenter function make it sane again. */
3686 beforep
->next
= current_buffer
->overlays_before
;
3687 set_buffer_overlays_before (current_buffer
, before_list
);
3689 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3693 afterp
->next
= current_buffer
->overlays_after
;
3694 set_buffer_overlays_after (current_buffer
, after_list
);
3696 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3699 /* We have two types of overlay: the one whose ending marker is
3700 after-insertion-marker (this is the usual case) and the one whose
3701 ending marker is before-insertion-marker. When `overlays_before'
3702 contains overlays of the latter type and the former type in this
3703 order and both overlays end at inserting position, inserting a text
3704 increases only the ending marker of the latter type, which results
3705 in incorrect ordering of `overlays_before'.
3707 This function fixes ordering of overlays in the slot
3708 `overlays_before' of the buffer *BP. Before the insertion, `point'
3709 was at PREV, and now is at POS. */
3712 fix_overlays_before (struct buffer
*bp
, ptrdiff_t prev
, ptrdiff_t pos
)
3714 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3715 struct Lisp_Overlay
*tail
= bp
->overlays_before
, *parent
= NULL
, *right_pair
;
3717 ptrdiff_t end
IF_LINT (= 0);
3719 /* After the insertion, the several overlays may be in incorrect
3720 order. The possibility is that, in the list `overlays_before',
3721 an overlay which ends at POS appears after an overlay which ends
3722 at PREV. Since POS is greater than PREV, we must fix the
3723 ordering of these overlays, by moving overlays ends at POS before
3724 the overlays ends at PREV. */
3726 /* At first, find a place where disordered overlays should be linked
3727 in. It is where an overlay which end before POS exists. (i.e. an
3728 overlay whose ending marker is after-insertion-marker if disorder
3731 && (XSETMISC (tem
, tail
),
3732 (end
= OVERLAY_POSITION (OVERLAY_END (tem
))) >= pos
))
3738 /* If we don't find such an overlay,
3739 or the found one ends before PREV,
3740 or the found one is the last one in the list,
3741 we don't have to fix anything. */
3742 if (!tail
|| end
< prev
|| !tail
->next
)
3745 right_pair
= parent
;
3749 /* Now, end position of overlays in the list TAIL should be before
3750 or equal to PREV. In the loop, an overlay which ends at POS is
3751 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3752 we found an overlay which ends before PREV, the remaining
3753 overlays are in correct order. */
3756 XSETMISC (tem
, tail
);
3757 end
= OVERLAY_POSITION (OVERLAY_END (tem
));
3760 { /* This overlay is disordered. */
3761 struct Lisp_Overlay
*found
= tail
;
3763 /* Unlink the found overlay. */
3765 parent
->next
= tail
;
3766 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3767 and link it into the right place. */
3770 found
->next
= bp
->overlays_before
;
3771 set_buffer_overlays_before (bp
, found
);
3775 found
->next
= right_pair
->next
;
3776 right_pair
->next
= found
;
3779 else if (end
== prev
)
3784 else /* No more disordered overlay. */
3789 DEFUN ("overlayp", Foverlayp
, Soverlayp
, 1, 1, 0,
3790 doc
: /* Return t if OBJECT is an overlay. */)
3791 (Lisp_Object object
)
3793 return (OVERLAYP (object
) ? Qt
: Qnil
);
3796 DEFUN ("make-overlay", Fmake_overlay
, Smake_overlay
, 2, 5, 0,
3797 doc
: /* Create a new overlay with range BEG to END in BUFFER.
3798 If omitted, BUFFER defaults to the current buffer.
3799 BEG and END may be integers or markers.
3800 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3801 for the front of the overlay advance when text is inserted there
3802 \(which means the text *is not* included in the overlay).
3803 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3804 for the rear of the overlay advance when text is inserted there
3805 \(which means the text *is* included in the overlay). */)
3806 (Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
, Lisp_Object front_advance
, Lisp_Object rear_advance
)
3808 Lisp_Object overlay
;
3812 XSETBUFFER (buffer
, current_buffer
);
3814 CHECK_BUFFER (buffer
);
3816 && ! EQ (Fmarker_buffer (beg
), buffer
))
3817 error ("Marker points into wrong buffer");
3819 && ! EQ (Fmarker_buffer (end
), buffer
))
3820 error ("Marker points into wrong buffer");
3822 CHECK_NUMBER_COERCE_MARKER (beg
);
3823 CHECK_NUMBER_COERCE_MARKER (end
);
3825 if (XINT (beg
) > XINT (end
))
3828 temp
= beg
; beg
= end
; end
= temp
;
3831 b
= XBUFFER (buffer
);
3833 beg
= Fset_marker (Fmake_marker (), beg
, buffer
);
3834 end
= Fset_marker (Fmake_marker (), end
, buffer
);
3836 if (!NILP (front_advance
))
3837 XMARKER (beg
)->insertion_type
= 1;
3838 if (!NILP (rear_advance
))
3839 XMARKER (end
)->insertion_type
= 1;
3841 overlay
= build_overlay (beg
, end
, Qnil
);
3843 /* Put the new overlay on the wrong list. */
3844 end
= OVERLAY_END (overlay
);
3845 if (OVERLAY_POSITION (end
) < b
->overlay_center
)
3847 if (b
->overlays_after
)
3848 XOVERLAY (overlay
)->next
= b
->overlays_after
;
3849 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
3853 if (b
->overlays_before
)
3854 XOVERLAY (overlay
)->next
= b
->overlays_before
;
3855 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
3858 /* This puts it in the right list, and in the right order. */
3859 recenter_overlay_lists (b
, b
->overlay_center
);
3861 /* We don't need to redisplay the region covered by the overlay, because
3862 the overlay has no properties at the moment. */
3867 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3870 modify_overlay (struct buffer
*buf
, ptrdiff_t start
, ptrdiff_t end
)
3874 ptrdiff_t temp
= start
;
3879 BUF_COMPUTE_UNCHANGED (buf
, start
, end
);
3881 /* If this is a buffer not in the selected window,
3882 we must do other windows. */
3883 if (buf
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
3884 windows_or_buffers_changed
= 1;
3885 /* If multiple windows show this buffer, we must do other windows. */
3886 else if (buffer_shared
> 1)
3887 windows_or_buffers_changed
= 1;
3888 /* If we modify an overlay at the end of the buffer, we cannot
3889 be sure that window end is still valid. */
3890 else if (end
>= ZV
&& start
<= ZV
)
3891 windows_or_buffers_changed
= 1;
3893 ++BUF_OVERLAY_MODIFF (buf
);
3896 /* Remove OVERLAY from LIST. */
3898 static struct Lisp_Overlay
*
3899 unchain_overlay (struct Lisp_Overlay
*list
, struct Lisp_Overlay
*overlay
)
3901 register struct Lisp_Overlay
*tail
, **prev
= &list
;
3903 for (tail
= list
; tail
; prev
= &tail
->next
, tail
= *prev
)
3904 if (tail
== overlay
)
3906 *prev
= overlay
->next
;
3907 overlay
->next
= NULL
;
3913 /* Remove OVERLAY from both overlay lists of B. */
3916 unchain_both (struct buffer
*b
, Lisp_Object overlay
)
3918 struct Lisp_Overlay
*ov
= XOVERLAY (overlay
);
3920 set_buffer_overlays_before (b
, unchain_overlay (b
->overlays_before
, ov
));
3921 set_buffer_overlays_after (b
, unchain_overlay (b
->overlays_after
, ov
));
3922 eassert (XOVERLAY (overlay
)->next
== NULL
);
3925 DEFUN ("move-overlay", Fmove_overlay
, Smove_overlay
, 3, 4, 0,
3926 doc
: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3927 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3928 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3930 (Lisp_Object overlay
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
)
3932 struct buffer
*b
, *ob
= 0;
3933 Lisp_Object obuffer
;
3934 ptrdiff_t count
= SPECPDL_INDEX ();
3935 ptrdiff_t n_beg
, n_end
, o_beg
IF_LINT (= 0), o_end
IF_LINT (= 0);
3937 CHECK_OVERLAY (overlay
);
3939 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3941 XSETBUFFER (buffer
, current_buffer
);
3942 CHECK_BUFFER (buffer
);
3944 if (NILP (Fbuffer_live_p (buffer
)))
3945 error ("Attempt to move overlay to a dead buffer");
3948 && ! EQ (Fmarker_buffer (beg
), buffer
))
3949 error ("Marker points into wrong buffer");
3951 && ! EQ (Fmarker_buffer (end
), buffer
))
3952 error ("Marker points into wrong buffer");
3954 CHECK_NUMBER_COERCE_MARKER (beg
);
3955 CHECK_NUMBER_COERCE_MARKER (end
);
3957 if (XINT (beg
) > XINT (end
))
3960 temp
= beg
; beg
= end
; end
= temp
;
3963 specbind (Qinhibit_quit
, Qt
);
3965 obuffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3966 b
= XBUFFER (buffer
);
3968 if (!NILP (obuffer
))
3970 ob
= XBUFFER (obuffer
);
3972 o_beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3973 o_end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3975 unchain_both (ob
, overlay
);
3978 /* Set the overlay boundaries, which may clip them. */
3979 Fset_marker (OVERLAY_START (overlay
), beg
, buffer
);
3980 Fset_marker (OVERLAY_END (overlay
), end
, buffer
);
3982 n_beg
= marker_position (OVERLAY_START (overlay
));
3983 n_end
= marker_position (OVERLAY_END (overlay
));
3985 /* If the overlay has changed buffers, do a thorough redisplay. */
3986 if (!EQ (buffer
, obuffer
))
3988 /* Redisplay where the overlay was. */
3990 modify_overlay (ob
, o_beg
, o_end
);
3992 /* Redisplay where the overlay is going to be. */
3993 modify_overlay (b
, n_beg
, n_end
);
3996 /* Redisplay the area the overlay has just left, or just enclosed. */
3999 modify_overlay (b
, o_end
, n_end
);
4000 else if (o_end
== n_end
)
4001 modify_overlay (b
, o_beg
, n_beg
);
4003 modify_overlay (b
, min (o_beg
, n_beg
), max (o_end
, n_end
));
4006 /* Delete the overlay if it is empty after clipping and has the
4007 evaporate property. */
4008 if (n_beg
== n_end
&& !NILP (Foverlay_get (overlay
, Qevaporate
)))
4009 return unbind_to (count
, Fdelete_overlay (overlay
));
4011 /* Put the overlay into the new buffer's overlay lists, first on the
4013 if (n_end
< b
->overlay_center
)
4015 XOVERLAY (overlay
)->next
= b
->overlays_after
;
4016 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
4020 XOVERLAY (overlay
)->next
= b
->overlays_before
;
4021 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
4024 /* This puts it in the right list, and in the right order. */
4025 recenter_overlay_lists (b
, b
->overlay_center
);
4027 return unbind_to (count
, overlay
);
4030 DEFUN ("delete-overlay", Fdelete_overlay
, Sdelete_overlay
, 1, 1, 0,
4031 doc
: /* Delete the overlay OVERLAY from its buffer. */)
4032 (Lisp_Object overlay
)
4036 ptrdiff_t count
= SPECPDL_INDEX ();
4038 CHECK_OVERLAY (overlay
);
4040 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4044 b
= XBUFFER (buffer
);
4045 specbind (Qinhibit_quit
, Qt
);
4047 unchain_both (b
, overlay
);
4048 drop_overlay (b
, XOVERLAY (overlay
));
4050 /* When deleting an overlay with before or after strings, turn off
4051 display optimizations for the affected buffer, on the basis that
4052 these strings may contain newlines. This is easier to do than to
4053 check for that situation during redisplay. */
4054 if (!windows_or_buffers_changed
4055 && (!NILP (Foverlay_get (overlay
, Qbefore_string
))
4056 || !NILP (Foverlay_get (overlay
, Qafter_string
))))
4057 b
->prevent_redisplay_optimizations_p
= 1;
4059 return unbind_to (count
, Qnil
);
4062 DEFUN ("delete-all-overlays", Fdelete_all_overlays
, Sdelete_all_overlays
, 0, 1, 0,
4063 doc
: /* Delete all overlays of BUFFER.
4064 BUFFER omitted or nil means delete all overlays of the current
4066 (Lisp_Object buffer
)
4068 register struct buffer
*buf
;
4071 buf
= current_buffer
;
4074 CHECK_BUFFER (buffer
);
4075 buf
= XBUFFER (buffer
);
4078 delete_all_overlays (buf
);
4082 /* Overlay dissection functions. */
4084 DEFUN ("overlay-start", Foverlay_start
, Soverlay_start
, 1, 1, 0,
4085 doc
: /* Return the position at which OVERLAY starts. */)
4086 (Lisp_Object overlay
)
4088 CHECK_OVERLAY (overlay
);
4090 return (Fmarker_position (OVERLAY_START (overlay
)));
4093 DEFUN ("overlay-end", Foverlay_end
, Soverlay_end
, 1, 1, 0,
4094 doc
: /* Return the position at which OVERLAY ends. */)
4095 (Lisp_Object overlay
)
4097 CHECK_OVERLAY (overlay
);
4099 return (Fmarker_position (OVERLAY_END (overlay
)));
4102 DEFUN ("overlay-buffer", Foverlay_buffer
, Soverlay_buffer
, 1, 1, 0,
4103 doc
: /* Return the buffer OVERLAY belongs to.
4104 Return nil if OVERLAY has been deleted. */)
4105 (Lisp_Object overlay
)
4107 CHECK_OVERLAY (overlay
);
4109 return Fmarker_buffer (OVERLAY_START (overlay
));
4112 DEFUN ("overlay-properties", Foverlay_properties
, Soverlay_properties
, 1, 1, 0,
4113 doc
: /* Return a list of the properties on OVERLAY.
4114 This is a copy of OVERLAY's plist; modifying its conses has no effect on
4116 (Lisp_Object overlay
)
4118 CHECK_OVERLAY (overlay
);
4120 return Fcopy_sequence (XOVERLAY (overlay
)->plist
);
4124 DEFUN ("overlays-at", Foverlays_at
, Soverlays_at
, 1, 1, 0,
4125 doc
: /* Return a list of the overlays that contain the character at POS. */)
4128 ptrdiff_t len
, noverlays
;
4129 Lisp_Object
*overlay_vec
;
4132 CHECK_NUMBER_COERCE_MARKER (pos
);
4135 /* We can't use alloca here because overlays_at can call xrealloc. */
4136 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4138 /* Put all the overlays we want in a vector in overlay_vec.
4139 Store the length in len. */
4140 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4143 /* Make a list of them all. */
4144 result
= Flist (noverlays
, overlay_vec
);
4146 xfree (overlay_vec
);
4150 DEFUN ("overlays-in", Foverlays_in
, Soverlays_in
, 2, 2, 0,
4151 doc
: /* Return a list of the overlays that overlap the region BEG ... END.
4152 Overlap means that at least one character is contained within the overlay
4153 and also contained within the specified region.
4154 Empty overlays are included in the result if they are located at BEG,
4155 between BEG and END, or at END provided END denotes the position at the
4156 end of the buffer. */)
4157 (Lisp_Object beg
, Lisp_Object end
)
4159 ptrdiff_t len
, noverlays
;
4160 Lisp_Object
*overlay_vec
;
4163 CHECK_NUMBER_COERCE_MARKER (beg
);
4164 CHECK_NUMBER_COERCE_MARKER (end
);
4167 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4169 /* Put all the overlays we want in a vector in overlay_vec.
4170 Store the length in len. */
4171 noverlays
= overlays_in (XINT (beg
), XINT (end
), 1, &overlay_vec
, &len
,
4174 /* Make a list of them all. */
4175 result
= Flist (noverlays
, overlay_vec
);
4177 xfree (overlay_vec
);
4181 DEFUN ("next-overlay-change", Fnext_overlay_change
, Snext_overlay_change
,
4183 doc
: /* Return the next position after POS where an overlay starts or ends.
4184 If there are no overlay boundaries from POS to (point-max),
4185 the value is (point-max). */)
4188 ptrdiff_t i
, len
, noverlays
;
4190 Lisp_Object
*overlay_vec
;
4192 CHECK_NUMBER_COERCE_MARKER (pos
);
4195 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4197 /* Put all the overlays we want in a vector in overlay_vec.
4198 Store the length in len.
4199 endpos gets the position where the next overlay starts. */
4200 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4203 /* If any of these overlays ends before endpos,
4204 use its ending point instead. */
4205 for (i
= 0; i
< noverlays
; i
++)
4210 oend
= OVERLAY_END (overlay_vec
[i
]);
4211 oendpos
= OVERLAY_POSITION (oend
);
4212 if (oendpos
< endpos
)
4216 xfree (overlay_vec
);
4217 return make_number (endpos
);
4220 DEFUN ("previous-overlay-change", Fprevious_overlay_change
,
4221 Sprevious_overlay_change
, 1, 1, 0,
4222 doc
: /* Return the previous position before POS where an overlay starts or ends.
4223 If there are no overlay boundaries from (point-min) to POS,
4224 the value is (point-min). */)
4228 Lisp_Object
*overlay_vec
;
4231 CHECK_NUMBER_COERCE_MARKER (pos
);
4233 /* At beginning of buffer, we know the answer;
4234 avoid bug subtracting 1 below. */
4235 if (XINT (pos
) == BEGV
)
4239 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4241 /* Put all the overlays we want in a vector in overlay_vec.
4242 Store the length in len.
4243 prevpos gets the position of the previous change. */
4244 overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4247 xfree (overlay_vec
);
4248 return make_number (prevpos
);
4251 /* These functions are for debugging overlays. */
4253 DEFUN ("overlay-lists", Foverlay_lists
, Soverlay_lists
, 0, 0, 0,
4254 doc
: /* Return a pair of lists giving all the overlays of the current buffer.
4255 The car has all the overlays before the overlay center;
4256 the cdr has all the overlays after the overlay center.
4257 Recentering overlays moves overlays between these lists.
4258 The lists you get are copies, so that changing them has no effect.
4259 However, the overlays you get are the real objects that the buffer uses. */)
4262 struct Lisp_Overlay
*ol
;
4263 Lisp_Object before
= Qnil
, after
= Qnil
, tmp
;
4265 for (ol
= current_buffer
->overlays_before
; ol
; ol
= ol
->next
)
4268 before
= Fcons (tmp
, before
);
4270 for (ol
= current_buffer
->overlays_after
; ol
; ol
= ol
->next
)
4273 after
= Fcons (tmp
, after
);
4276 return Fcons (Fnreverse (before
), Fnreverse (after
));
4279 DEFUN ("overlay-recenter", Foverlay_recenter
, Soverlay_recenter
, 1, 1, 0,
4280 doc
: /* Recenter the overlays of the current buffer around position POS.
4281 That makes overlay lookup faster for positions near POS (but perhaps slower
4282 for positions far away from POS). */)
4286 CHECK_NUMBER_COERCE_MARKER (pos
);
4288 p
= clip_to_bounds (PTRDIFF_MIN
, XINT (pos
), PTRDIFF_MAX
);
4289 recenter_overlay_lists (current_buffer
, p
);
4293 DEFUN ("overlay-get", Foverlay_get
, Soverlay_get
, 2, 2, 0,
4294 doc
: /* Get the property of overlay OVERLAY with property name PROP. */)
4295 (Lisp_Object overlay
, Lisp_Object prop
)
4297 CHECK_OVERLAY (overlay
);
4298 return lookup_char_property (XOVERLAY (overlay
)->plist
, prop
, 0);
4301 DEFUN ("overlay-put", Foverlay_put
, Soverlay_put
, 3, 3, 0,
4302 doc
: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4303 VALUE will be returned.*/)
4304 (Lisp_Object overlay
, Lisp_Object prop
, Lisp_Object value
)
4306 Lisp_Object tail
, buffer
;
4309 CHECK_OVERLAY (overlay
);
4311 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4313 for (tail
= XOVERLAY (overlay
)->plist
;
4314 CONSP (tail
) && CONSP (XCDR (tail
));
4315 tail
= XCDR (XCDR (tail
)))
4316 if (EQ (XCAR (tail
), prop
))
4318 changed
= !EQ (XCAR (XCDR (tail
)), value
);
4319 XSETCAR (XCDR (tail
), value
);
4322 /* It wasn't in the list, so add it to the front. */
4323 changed
= !NILP (value
);
4325 (overlay
, Fcons (prop
, Fcons (value
, XOVERLAY (overlay
)->plist
)));
4327 if (! NILP (buffer
))
4330 modify_overlay (XBUFFER (buffer
),
4331 marker_position (OVERLAY_START (overlay
)),
4332 marker_position (OVERLAY_END (overlay
)));
4333 if (EQ (prop
, Qevaporate
) && ! NILP (value
)
4334 && (OVERLAY_POSITION (OVERLAY_START (overlay
))
4335 == OVERLAY_POSITION (OVERLAY_END (overlay
))))
4336 Fdelete_overlay (overlay
);
4342 /* Subroutine of report_overlay_modification. */
4344 /* Lisp vector holding overlay hook functions to call.
4345 Vector elements come in pairs.
4346 Each even-index element is a list of hook functions.
4347 The following odd-index element is the overlay they came from.
4349 Before the buffer change, we fill in this vector
4350 as we call overlay hook functions.
4351 After the buffer change, we get the functions to call from this vector.
4352 This way we always call the same functions before and after the change. */
4353 static Lisp_Object last_overlay_modification_hooks
;
4355 /* Number of elements actually used in last_overlay_modification_hooks. */
4356 static ptrdiff_t last_overlay_modification_hooks_used
;
4358 /* Add one functionlist/overlay pair
4359 to the end of last_overlay_modification_hooks. */
4362 add_overlay_mod_hooklist (Lisp_Object functionlist
, Lisp_Object overlay
)
4364 ptrdiff_t oldsize
= ASIZE (last_overlay_modification_hooks
);
4366 if (oldsize
- 1 <= last_overlay_modification_hooks_used
)
4367 last_overlay_modification_hooks
=
4368 larger_vector (last_overlay_modification_hooks
, 2, -1);
4369 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4370 functionlist
); last_overlay_modification_hooks_used
++;
4371 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4372 overlay
); last_overlay_modification_hooks_used
++;
4375 /* Run the modification-hooks of overlays that include
4376 any part of the text in START to END.
4377 If this change is an insertion, also
4378 run the insert-before-hooks of overlay starting at END,
4379 and the insert-after-hooks of overlay ending at START.
4381 This is called both before and after the modification.
4382 AFTER is true when we call after the modification.
4384 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4385 When AFTER is nonzero, they are the start position,
4386 the position after the inserted new text,
4387 and the length of deleted or replaced old text. */
4390 report_overlay_modification (Lisp_Object start
, Lisp_Object end
, bool after
,
4391 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4393 Lisp_Object prop
, overlay
;
4394 struct Lisp_Overlay
*tail
;
4395 /* True if this change is an insertion. */
4396 bool insertion
= (after
? XFASTINT (arg3
) == 0 : EQ (start
, end
));
4397 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4402 /* We used to run the functions as soon as we found them and only register
4403 them in last_overlay_modification_hooks for the purpose of the `after'
4404 case. But running elisp code as we traverse the list of overlays is
4405 painful because the list can be modified by the elisp code so we had to
4406 copy at several places. We now simply do a read-only traversal that
4407 only collects the functions to run and we run them afterwards. It's
4408 simpler, especially since all the code was already there. -stef */
4412 /* We are being called before a change.
4413 Scan the overlays to find the functions to call. */
4414 last_overlay_modification_hooks_used
= 0;
4415 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4417 ptrdiff_t startpos
, endpos
;
4418 Lisp_Object ostart
, oend
;
4420 XSETMISC (overlay
, tail
);
4422 ostart
= OVERLAY_START (overlay
);
4423 oend
= OVERLAY_END (overlay
);
4424 endpos
= OVERLAY_POSITION (oend
);
4425 if (XFASTINT (start
) > endpos
)
4427 startpos
= OVERLAY_POSITION (ostart
);
4428 if (insertion
&& (XFASTINT (start
) == startpos
4429 || XFASTINT (end
) == startpos
))
4431 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4433 add_overlay_mod_hooklist (prop
, overlay
);
4435 if (insertion
&& (XFASTINT (start
) == endpos
4436 || XFASTINT (end
) == endpos
))
4438 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4440 add_overlay_mod_hooklist (prop
, overlay
);
4442 /* Test for intersecting intervals. This does the right thing
4443 for both insertion and deletion. */
4444 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4446 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4448 add_overlay_mod_hooklist (prop
, overlay
);
4452 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4454 ptrdiff_t startpos
, endpos
;
4455 Lisp_Object ostart
, oend
;
4457 XSETMISC (overlay
, tail
);
4459 ostart
= OVERLAY_START (overlay
);
4460 oend
= OVERLAY_END (overlay
);
4461 startpos
= OVERLAY_POSITION (ostart
);
4462 endpos
= OVERLAY_POSITION (oend
);
4463 if (XFASTINT (end
) < startpos
)
4465 if (insertion
&& (XFASTINT (start
) == startpos
4466 || XFASTINT (end
) == startpos
))
4468 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4470 add_overlay_mod_hooklist (prop
, overlay
);
4472 if (insertion
&& (XFASTINT (start
) == endpos
4473 || XFASTINT (end
) == endpos
))
4475 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4477 add_overlay_mod_hooklist (prop
, overlay
);
4479 /* Test for intersecting intervals. This does the right thing
4480 for both insertion and deletion. */
4481 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4483 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4485 add_overlay_mod_hooklist (prop
, overlay
);
4490 GCPRO4 (overlay
, arg1
, arg2
, arg3
);
4492 /* Call the functions recorded in last_overlay_modification_hooks.
4493 First copy the vector contents, in case some of these hooks
4494 do subsequent modification of the buffer. */
4495 ptrdiff_t size
= last_overlay_modification_hooks_used
;
4496 Lisp_Object
*copy
= alloca (size
* sizeof *copy
);
4499 memcpy (copy
, XVECTOR (last_overlay_modification_hooks
)->contents
,
4502 gcpro1
.nvars
= size
;
4504 for (i
= 0; i
< size
;)
4506 Lisp_Object prop_i
, overlay_i
;
4508 overlay_i
= copy
[i
++];
4509 call_overlay_mod_hooks (prop_i
, overlay_i
, after
, arg1
, arg2
, arg3
);
4516 call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
, bool after
,
4517 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4519 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4521 GCPRO4 (list
, arg1
, arg2
, arg3
);
4523 while (CONSP (list
))
4526 call4 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
);
4528 call5 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
, arg3
);
4534 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4537 evaporate_overlays (ptrdiff_t pos
)
4539 Lisp_Object overlay
, hit_list
;
4540 struct Lisp_Overlay
*tail
;
4543 if (pos
<= current_buffer
->overlay_center
)
4544 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4547 XSETMISC (overlay
, tail
);
4548 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4551 if (endpos
== pos
&& OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
4552 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4553 hit_list
= Fcons (overlay
, hit_list
);
4556 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4559 XSETMISC (overlay
, tail
);
4560 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4563 if (startpos
== pos
&& OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
4564 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4565 hit_list
= Fcons (overlay
, hit_list
);
4567 for (; CONSP (hit_list
); hit_list
= XCDR (hit_list
))
4568 Fdelete_overlay (XCAR (hit_list
));
4571 /* Somebody has tried to store a value with an unacceptable type
4572 in the slot with offset OFFSET. */
4575 buffer_slot_type_mismatch (Lisp_Object newval
, int type
)
4577 Lisp_Object predicate
;
4581 case_Lisp_Int
: predicate
= Qintegerp
; break;
4582 case Lisp_String
: predicate
= Qstringp
; break;
4583 case Lisp_Symbol
: predicate
= Qsymbolp
; break;
4584 default: emacs_abort ();
4587 wrong_type_argument (predicate
, newval
);
4591 /***********************************************************************
4592 Allocation with mmap
4593 ***********************************************************************/
4595 #ifdef USE_MMAP_FOR_BUFFERS
4597 #include <sys/types.h>
4598 #include <sys/mman.h>
4601 #ifdef MAP_ANONYMOUS
4602 #define MAP_ANON MAP_ANONYMOUS
4609 #define MAP_FAILED ((void *) -1)
4621 /* Memory is allocated in regions which are mapped using mmap(2).
4622 The current implementation lets the system select mapped
4623 addresses; we're not using MAP_FIXED in general, except when
4624 trying to enlarge regions.
4626 Each mapped region starts with a mmap_region structure, the user
4627 area starts after that structure, aligned to MEM_ALIGN.
4629 +-----------------------+
4630 | struct mmap_info + |
4632 +-----------------------+
4636 +-----------------------+ */
4640 /* User-specified size. */
4641 size_t nbytes_specified
;
4643 /* Number of bytes mapped */
4644 size_t nbytes_mapped
;
4646 /* Pointer to the location holding the address of the memory
4647 allocated with the mmap'd block. The variable actually points
4648 after this structure. */
4651 /* Next and previous in list of all mmap'd regions. */
4652 struct mmap_region
*next
, *prev
;
4655 /* Doubly-linked list of mmap'd regions. */
4657 static struct mmap_region
*mmap_regions
;
4659 /* File descriptor for mmap. If we don't have anonymous mapping,
4660 /dev/zero will be opened on it. */
4664 /* Temporary storage for mmap_set_vars, see there. */
4666 static struct mmap_region
*mmap_regions_1
;
4667 static int mmap_fd_1
;
4669 /* Page size on this system. */
4671 static int mmap_page_size
;
4673 /* 1 means mmap has been initialized. */
4675 static bool mmap_initialized_p
;
4677 /* Value is X rounded up to the next multiple of N. */
4679 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4681 /* Size of mmap_region structure plus padding. */
4683 #define MMAP_REGION_STRUCT_SIZE \
4684 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4686 /* Given a pointer P to the start of the user-visible part of a mapped
4687 region, return a pointer to the start of the region. */
4689 #define MMAP_REGION(P) \
4690 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4692 /* Given a pointer P to the start of a mapped region, return a pointer
4693 to the start of the user-visible part of the region. */
4695 #define MMAP_USER_AREA(P) \
4696 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4698 #define MEM_ALIGN sizeof (double)
4700 /* Predicate returning true if part of the address range [START .. END]
4701 is currently mapped. Used to prevent overwriting an existing
4704 Default is to conservatively assume the address range is occupied by
4705 something else. This can be overridden by system configuration
4706 files if system-specific means to determine this exists. */
4708 #ifndef MMAP_ALLOCATED_P
4709 #define MMAP_ALLOCATED_P(start, end) 1
4712 /* Perform necessary initializations for the use of mmap. */
4718 /* The value of mmap_fd is initially 0 in temacs, and -1
4719 in a dumped Emacs. */
4722 /* No anonymous mmap -- we need the file descriptor. */
4723 mmap_fd
= open ("/dev/zero", O_RDONLY
);
4725 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno
));
4727 #endif /* MAP_ANON == 0 */
4729 if (mmap_initialized_p
)
4731 mmap_initialized_p
= 1;
4737 mmap_page_size
= getpagesize ();
4740 /* Return a region overlapping address range START...END, or null if
4741 none. END is not including, i.e. the last byte in the range
4744 static struct mmap_region
*
4745 mmap_find (void *start
, void *end
)
4747 struct mmap_region
*r
;
4748 char *s
= (char *) start
, *e
= (char *) end
;
4750 for (r
= mmap_regions
; r
; r
= r
->next
)
4752 char *rstart
= (char *) r
;
4753 char *rend
= rstart
+ r
->nbytes_mapped
;
4755 if (/* First byte of range, i.e. START, in this region? */
4756 (s
>= rstart
&& s
< rend
)
4757 /* Last byte of range, i.e. END - 1, in this region? */
4758 || (e
> rstart
&& e
<= rend
)
4759 /* First byte of this region in the range? */
4760 || (rstart
>= s
&& rstart
< e
)
4761 /* Last byte of this region in the range? */
4762 || (rend
> s
&& rend
<= e
))
4770 /* Unmap a region. P is a pointer to the start of the user-araa of
4774 mmap_free_1 (struct mmap_region
*r
)
4777 r
->next
->prev
= r
->prev
;
4779 r
->prev
->next
= r
->next
;
4781 mmap_regions
= r
->next
;
4783 if (munmap (r
, r
->nbytes_mapped
) == -1)
4784 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4788 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4789 Value is true if successful. */
4792 mmap_enlarge (struct mmap_region
*r
, int npages
)
4794 char *region_end
= (char *) r
+ r
->nbytes_mapped
;
4800 /* Unmap pages at the end of the region. */
4801 nbytes
= - npages
* mmap_page_size
;
4802 if (munmap (region_end
- nbytes
, nbytes
) == -1)
4803 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4806 r
->nbytes_mapped
-= nbytes
;
4810 else if (npages
> 0)
4812 nbytes
= npages
* mmap_page_size
;
4814 /* Try to map additional pages at the end of the region. We
4815 cannot do this if the address range is already occupied by
4816 something else because mmap deletes any previous mapping.
4817 I'm not sure this is worth doing, let's see. */
4818 if (!MMAP_ALLOCATED_P (region_end
, region_end
+ nbytes
))
4822 p
= mmap (region_end
, nbytes
, PROT_READ
| PROT_WRITE
,
4823 MAP_ANON
| MAP_PRIVATE
| MAP_FIXED
, mmap_fd
, 0);
4824 if (p
== MAP_FAILED
)
4825 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4826 else if (p
!= region_end
)
4828 /* Kernels are free to choose a different address. In
4829 that case, unmap what we've mapped above; we have
4831 if (munmap (p
, nbytes
) == -1)
4832 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4836 r
->nbytes_mapped
+= nbytes
;
4846 /* Set or reset variables holding references to mapped regions.
4847 If not RESTORE_P, set all variables to null. If RESTORE_P, set all
4848 variables to the start of the user-areas of mapped regions.
4850 This function is called from Fdump_emacs to ensure that the dumped
4851 Emacs doesn't contain references to memory that won't be mapped
4852 when Emacs starts. */
4855 mmap_set_vars (bool restore_p
)
4857 struct mmap_region
*r
;
4861 mmap_regions
= mmap_regions_1
;
4862 mmap_fd
= mmap_fd_1
;
4863 for (r
= mmap_regions
; r
; r
= r
->next
)
4864 *r
->var
= MMAP_USER_AREA (r
);
4868 for (r
= mmap_regions
; r
; r
= r
->next
)
4870 mmap_regions_1
= mmap_regions
;
4871 mmap_regions
= NULL
;
4872 mmap_fd_1
= mmap_fd
;
4878 /* Allocate a block of storage large enough to hold NBYTES bytes of
4879 data. A pointer to the data is returned in *VAR. VAR is thus the
4880 address of some variable which will use the data area.
4882 The allocation of 0 bytes is valid.
4884 If we can't allocate the necessary memory, set *VAR to null, and
4888 mmap_alloc (void **var
, size_t nbytes
)
4895 map
= ROUND (nbytes
+ MMAP_REGION_STRUCT_SIZE
, mmap_page_size
);
4896 p
= mmap (NULL
, map
, PROT_READ
| PROT_WRITE
, MAP_ANON
| MAP_PRIVATE
,
4899 if (p
== MAP_FAILED
)
4901 if (errno
!= ENOMEM
)
4902 fprintf (stderr
, "mmap: %s\n", emacs_strerror (errno
));
4907 struct mmap_region
*r
= (struct mmap_region
*) p
;
4909 r
->nbytes_specified
= nbytes
;
4910 r
->nbytes_mapped
= map
;
4913 r
->next
= mmap_regions
;
4918 p
= MMAP_USER_AREA (p
);
4925 /* Free a block of relocatable storage whose data is pointed to by
4926 PTR. Store 0 in *PTR to show there's no block allocated. */
4929 mmap_free (void **var
)
4935 mmap_free_1 (MMAP_REGION (*var
));
4941 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4942 resize it to size NBYTES. Change *VAR to reflect the new block,
4943 and return this value. If more memory cannot be allocated, then
4944 leave *VAR unchanged, and return null. */
4947 mmap_realloc (void **var
, size_t nbytes
)
4954 result
= mmap_alloc (var
, nbytes
);
4955 else if (nbytes
== 0)
4958 result
= mmap_alloc (var
, nbytes
);
4962 struct mmap_region
*r
= MMAP_REGION (*var
);
4963 size_t room
= r
->nbytes_mapped
- MMAP_REGION_STRUCT_SIZE
;
4968 void *old_ptr
= *var
;
4970 /* Try to map additional pages at the end of the region.
4971 If that fails, allocate a new region, copy data
4972 from the old region, then free it. */
4973 if (mmap_enlarge (r
, (ROUND (nbytes
- room
, mmap_page_size
)
4976 r
->nbytes_specified
= nbytes
;
4977 *var
= result
= old_ptr
;
4979 else if (mmap_alloc (var
, nbytes
))
4981 memcpy (*var
, old_ptr
, r
->nbytes_specified
);
4982 mmap_free_1 (MMAP_REGION (old_ptr
));
4984 r
= MMAP_REGION (result
);
4985 r
->nbytes_specified
= nbytes
;
4993 else if (room
- nbytes
>= mmap_page_size
)
4995 /* Shrinking by at least a page. Let's give some
4996 memory back to the system.
4998 The extra parens are to make the division happens first,
4999 on positive values, so we know it will round towards
5001 mmap_enlarge (r
, - ((room
- nbytes
) / mmap_page_size
));
5003 r
->nbytes_specified
= nbytes
;
5007 /* Leave it alone. */
5009 r
->nbytes_specified
= nbytes
;
5017 #endif /* USE_MMAP_FOR_BUFFERS */
5021 /***********************************************************************
5022 Buffer-text Allocation
5023 ***********************************************************************/
5025 /* Allocate NBYTES bytes for buffer B's text buffer. */
5028 alloc_buffer_text (struct buffer
*b
, ptrdiff_t nbytes
)
5033 #if defined USE_MMAP_FOR_BUFFERS
5034 p
= mmap_alloc ((void **) &b
->text
->beg
, nbytes
);
5035 #elif defined REL_ALLOC
5036 p
= r_alloc ((void **) &b
->text
->beg
, nbytes
);
5038 p
= xmalloc (nbytes
);
5044 memory_full (nbytes
);
5047 b
->text
->beg
= (unsigned char *) p
;
5051 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
5055 enlarge_buffer_text (struct buffer
*b
, ptrdiff_t delta
)
5058 ptrdiff_t nbytes
= (BUF_Z_BYTE (b
) - BUF_BEG_BYTE (b
) + BUF_GAP_SIZE (b
) + 1
5061 #if defined USE_MMAP_FOR_BUFFERS
5062 p
= mmap_realloc ((void **) &b
->text
->beg
, nbytes
);
5063 #elif defined REL_ALLOC
5064 p
= r_re_alloc ((void **) &b
->text
->beg
, nbytes
);
5066 p
= xrealloc (b
->text
->beg
, nbytes
);
5072 memory_full (nbytes
);
5075 BUF_BEG_ADDR (b
) = (unsigned char *) p
;
5080 /* Free buffer B's text buffer. */
5083 free_buffer_text (struct buffer
*b
)
5087 #if defined USE_MMAP_FOR_BUFFERS
5088 mmap_free ((void **) &b
->text
->beg
);
5089 #elif defined REL_ALLOC
5090 r_alloc_free ((void **) &b
->text
->beg
);
5092 xfree (b
->text
->beg
);
5095 BUF_BEG_ADDR (b
) = NULL
;
5101 /***********************************************************************
5103 ***********************************************************************/
5106 init_buffer_once (void)
5109 /* If you add, remove, or reorder Lisp_Objects in a struct buffer, make
5110 sure that this is still correct. Otherwise, mark_vectorlike may not
5111 trace all Lisp_Objects in buffer_defaults and buffer_local_symbols. */
5113 = (offsetof (struct buffer
, own_text
) - header_size
) / word_size
;
5115 memset (buffer_permanent_local_flags
, 0, sizeof buffer_permanent_local_flags
);
5117 /* Make sure all markable slots in buffer_defaults
5118 are initialized reasonably, so mark_buffer won't choke. */
5119 reset_buffer (&buffer_defaults
);
5120 eassert (EQ (BVAR (&buffer_defaults
, name
), make_number (0)));
5121 reset_buffer_local_variables (&buffer_defaults
, 1);
5122 eassert (EQ (BVAR (&buffer_local_symbols
, name
), make_number (0)));
5123 reset_buffer (&buffer_local_symbols
);
5124 reset_buffer_local_variables (&buffer_local_symbols
, 1);
5125 /* Prevent GC from getting confused. */
5126 buffer_defaults
.text
= &buffer_defaults
.own_text
;
5127 buffer_local_symbols
.text
= &buffer_local_symbols
.own_text
;
5128 /* No one will share the text with these buffers, but let's play it safe. */
5129 buffer_defaults
.indirections
= 0;
5130 buffer_local_symbols
.indirections
= 0;
5131 set_buffer_intervals (&buffer_defaults
, NULL
);
5132 set_buffer_intervals (&buffer_local_symbols
, NULL
);
5133 /* This is not strictly necessary, but let's make them initialized. */
5134 bset_name (&buffer_defaults
, build_pure_c_string (" *buffer-defaults*"));
5135 bset_name (&buffer_local_symbols
, build_pure_c_string (" *buffer-local-symbols*"));
5136 XSETPVECTYPESIZE (&buffer_defaults
, PVEC_BUFFER
, pvecsize
);
5137 XSETPVECTYPESIZE (&buffer_local_symbols
, PVEC_BUFFER
, pvecsize
);
5139 /* Set up the default values of various buffer slots. */
5140 /* Must do these before making the first buffer! */
5142 /* real setup is done in bindings.el */
5143 bset_mode_line_format (&buffer_defaults
, build_pure_c_string ("%-"));
5144 bset_header_line_format (&buffer_defaults
, Qnil
);
5145 bset_abbrev_mode (&buffer_defaults
, Qnil
);
5146 bset_overwrite_mode (&buffer_defaults
, Qnil
);
5147 bset_case_fold_search (&buffer_defaults
, Qt
);
5148 bset_auto_fill_function (&buffer_defaults
, Qnil
);
5149 bset_selective_display (&buffer_defaults
, Qnil
);
5150 bset_selective_display_ellipses (&buffer_defaults
, Qt
);
5151 bset_abbrev_table (&buffer_defaults
, Qnil
);
5152 bset_display_table (&buffer_defaults
, Qnil
);
5153 bset_undo_list (&buffer_defaults
, Qnil
);
5154 bset_mark_active (&buffer_defaults
, Qnil
);
5155 bset_file_format (&buffer_defaults
, Qnil
);
5156 bset_auto_save_file_format (&buffer_defaults
, Qt
);
5157 set_buffer_overlays_before (&buffer_defaults
, NULL
);
5158 set_buffer_overlays_after (&buffer_defaults
, NULL
);
5159 buffer_defaults
.overlay_center
= BEG
;
5161 XSETFASTINT (BVAR (&buffer_defaults
, tab_width
), 8);
5162 bset_truncate_lines (&buffer_defaults
, Qnil
);
5163 bset_word_wrap (&buffer_defaults
, Qnil
);
5164 bset_ctl_arrow (&buffer_defaults
, Qt
);
5165 bset_bidi_display_reordering (&buffer_defaults
, Qt
);
5166 bset_bidi_paragraph_direction (&buffer_defaults
, Qnil
);
5167 bset_cursor_type (&buffer_defaults
, Qt
);
5168 bset_extra_line_spacing (&buffer_defaults
, Qnil
);
5169 bset_cursor_in_non_selected_windows (&buffer_defaults
, Qt
);
5171 bset_enable_multibyte_characters (&buffer_defaults
, Qt
);
5172 bset_buffer_file_coding_system (&buffer_defaults
, Qnil
);
5173 XSETFASTINT (BVAR (&buffer_defaults
, fill_column
), 70);
5174 XSETFASTINT (BVAR (&buffer_defaults
, left_margin
), 0);
5175 bset_cache_long_line_scans (&buffer_defaults
, Qnil
);
5176 bset_file_truename (&buffer_defaults
, Qnil
);
5177 XSETFASTINT (BVAR (&buffer_defaults
, display_count
), 0);
5178 XSETFASTINT (BVAR (&buffer_defaults
, left_margin_cols
), 0);
5179 XSETFASTINT (BVAR (&buffer_defaults
, right_margin_cols
), 0);
5180 bset_left_fringe_width (&buffer_defaults
, Qnil
);
5181 bset_right_fringe_width (&buffer_defaults
, Qnil
);
5182 bset_fringes_outside_margins (&buffer_defaults
, Qnil
);
5183 bset_scroll_bar_width (&buffer_defaults
, Qnil
);
5184 bset_vertical_scroll_bar_type (&buffer_defaults
, Qt
);
5185 bset_indicate_empty_lines (&buffer_defaults
, Qnil
);
5186 bset_indicate_buffer_boundaries (&buffer_defaults
, Qnil
);
5187 bset_fringe_indicator_alist (&buffer_defaults
, Qnil
);
5188 bset_fringe_cursor_alist (&buffer_defaults
, Qnil
);
5189 bset_scroll_up_aggressively (&buffer_defaults
, Qnil
);
5190 bset_scroll_down_aggressively (&buffer_defaults
, Qnil
);
5191 bset_display_time (&buffer_defaults
, Qnil
);
5193 /* Assign the local-flags to the slots that have default values.
5194 The local flag is a bit that is used in the buffer
5195 to say that it has its own local value for the slot.
5196 The local flag bits are in the local_var_flags slot of the buffer. */
5198 /* Nothing can work if this isn't true */
5199 { verify (sizeof (EMACS_INT
) == word_size
); }
5201 /* 0 means not a lisp var, -1 means always local, else mask */
5202 memset (&buffer_local_flags
, 0, sizeof buffer_local_flags
);
5203 bset_filename (&buffer_local_flags
, make_number (-1));
5204 bset_directory (&buffer_local_flags
, make_number (-1));
5205 bset_backed_up (&buffer_local_flags
, make_number (-1));
5206 bset_save_length (&buffer_local_flags
, make_number (-1));
5207 bset_auto_save_file_name (&buffer_local_flags
, make_number (-1));
5208 bset_read_only (&buffer_local_flags
, make_number (-1));
5209 bset_major_mode (&buffer_local_flags
, make_number (-1));
5210 bset_mode_name (&buffer_local_flags
, make_number (-1));
5211 bset_undo_list (&buffer_local_flags
, make_number (-1));
5212 bset_mark_active (&buffer_local_flags
, make_number (-1));
5213 bset_point_before_scroll (&buffer_local_flags
, make_number (-1));
5214 bset_file_truename (&buffer_local_flags
, make_number (-1));
5215 bset_invisibility_spec (&buffer_local_flags
, make_number (-1));
5216 bset_file_format (&buffer_local_flags
, make_number (-1));
5217 bset_auto_save_file_format (&buffer_local_flags
, make_number (-1));
5218 bset_display_count (&buffer_local_flags
, make_number (-1));
5219 bset_display_time (&buffer_local_flags
, make_number (-1));
5220 bset_enable_multibyte_characters (&buffer_local_flags
, make_number (-1));
5223 XSETFASTINT (BVAR (&buffer_local_flags
, mode_line_format
), idx
); ++idx
;
5224 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_mode
), idx
); ++idx
;
5225 XSETFASTINT (BVAR (&buffer_local_flags
, overwrite_mode
), idx
); ++idx
;
5226 XSETFASTINT (BVAR (&buffer_local_flags
, case_fold_search
), idx
); ++idx
;
5227 XSETFASTINT (BVAR (&buffer_local_flags
, auto_fill_function
), idx
); ++idx
;
5228 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display
), idx
); ++idx
;
5229 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display_ellipses
), idx
); ++idx
;
5230 XSETFASTINT (BVAR (&buffer_local_flags
, tab_width
), idx
); ++idx
;
5231 XSETFASTINT (BVAR (&buffer_local_flags
, truncate_lines
), idx
); ++idx
;
5232 XSETFASTINT (BVAR (&buffer_local_flags
, word_wrap
), idx
); ++idx
;
5233 XSETFASTINT (BVAR (&buffer_local_flags
, ctl_arrow
), idx
); ++idx
;
5234 XSETFASTINT (BVAR (&buffer_local_flags
, fill_column
), idx
); ++idx
;
5235 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin
), idx
); ++idx
;
5236 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_table
), idx
); ++idx
;
5237 XSETFASTINT (BVAR (&buffer_local_flags
, display_table
), idx
); ++idx
;
5238 XSETFASTINT (BVAR (&buffer_local_flags
, syntax_table
), idx
); ++idx
;
5239 XSETFASTINT (BVAR (&buffer_local_flags
, cache_long_line_scans
), idx
); ++idx
;
5240 XSETFASTINT (BVAR (&buffer_local_flags
, category_table
), idx
); ++idx
;
5241 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_display_reordering
), idx
); ++idx
;
5242 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_paragraph_direction
), idx
); ++idx
;
5243 XSETFASTINT (BVAR (&buffer_local_flags
, buffer_file_coding_system
), idx
);
5244 /* Make this one a permanent local. */
5245 buffer_permanent_local_flags
[idx
++] = 1;
5246 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin_cols
), idx
); ++idx
;
5247 XSETFASTINT (BVAR (&buffer_local_flags
, right_margin_cols
), idx
); ++idx
;
5248 XSETFASTINT (BVAR (&buffer_local_flags
, left_fringe_width
), idx
); ++idx
;
5249 XSETFASTINT (BVAR (&buffer_local_flags
, right_fringe_width
), idx
); ++idx
;
5250 XSETFASTINT (BVAR (&buffer_local_flags
, fringes_outside_margins
), idx
); ++idx
;
5251 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_bar_width
), idx
); ++idx
;
5252 XSETFASTINT (BVAR (&buffer_local_flags
, vertical_scroll_bar_type
), idx
); ++idx
;
5253 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_empty_lines
), idx
); ++idx
;
5254 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_buffer_boundaries
), idx
); ++idx
;
5255 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_indicator_alist
), idx
); ++idx
;
5256 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_cursor_alist
), idx
); ++idx
;
5257 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_up_aggressively
), idx
); ++idx
;
5258 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_down_aggressively
), idx
); ++idx
;
5259 XSETFASTINT (BVAR (&buffer_local_flags
, header_line_format
), idx
); ++idx
;
5260 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_type
), idx
); ++idx
;
5261 XSETFASTINT (BVAR (&buffer_local_flags
, extra_line_spacing
), idx
); ++idx
;
5262 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_in_non_selected_windows
), idx
); ++idx
;
5264 /* Need more room? */
5265 if (idx
>= MAX_PER_BUFFER_VARS
)
5267 last_per_buffer_idx
= idx
;
5269 Vbuffer_alist
= Qnil
;
5273 QSFundamental
= build_pure_c_string ("Fundamental");
5275 Qfundamental_mode
= intern_c_string ("fundamental-mode");
5276 bset_major_mode (&buffer_defaults
, Qfundamental_mode
);
5278 Qmode_class
= intern_c_string ("mode-class");
5280 Qprotected_field
= intern_c_string ("protected-field");
5282 Qpermanent_local
= intern_c_string ("permanent-local");
5284 Qkill_buffer_hook
= intern_c_string ("kill-buffer-hook");
5285 Fput (Qkill_buffer_hook
, Qpermanent_local
, Qt
);
5287 /* super-magic invisible buffer */
5288 Vprin1_to_string_buffer
= Fget_buffer_create (build_pure_c_string (" prin1"));
5289 Vbuffer_alist
= Qnil
;
5291 Fset_buffer (Fget_buffer_create (build_pure_c_string ("*scratch*")));
5293 inhibit_modification_hooks
= 0;
5303 #ifdef USE_MMAP_FOR_BUFFERS
5305 /* When using the ralloc implementation based on mmap(2), buffer
5306 text pointers will have been set to null in the dumped Emacs.
5311 if (b
->text
->beg
== NULL
)
5312 enlarge_buffer_text (b
, 0);
5314 #endif /* USE_MMAP_FOR_BUFFERS */
5316 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5317 if (NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5318 Fset_buffer_multibyte (Qnil
);
5320 pwd
= get_current_dir_name ();
5323 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5325 /* Maybe this should really use some standard subroutine
5326 whose definition is filename syntax dependent. */
5328 if (!(IS_DIRECTORY_SEP (pwd
[len
- 1])))
5330 /* Grow buffer to add directory separator and '\0'. */
5331 pwd
= realloc (pwd
, len
+ 2);
5333 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5334 pwd
[len
] = DIRECTORY_SEP
;
5335 pwd
[len
+ 1] = '\0';
5339 bset_directory (current_buffer
, make_unibyte_string (pwd
, len
));
5340 if (! NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5341 /* At this moment, we still don't know how to decode the
5342 directory name. So, we keep the bytes in multibyte form so
5343 that ENCODE_FILE correctly gets the original bytes. */
5345 (current_buffer
, string_to_multibyte (BVAR (current_buffer
, directory
)));
5347 /* Add /: to the front of the name
5348 if it would otherwise be treated as magic. */
5349 temp
= Ffind_file_name_handler (BVAR (current_buffer
, directory
), Qt
);
5351 /* If the default dir is just /, TEMP is non-nil
5352 because of the ange-ftp completion handler.
5353 However, it is not necessary to turn / into /:/.
5354 So avoid doing that. */
5355 && strcmp ("/", SSDATA (BVAR (current_buffer
, directory
))))
5358 concat2 (build_string ("/:"), BVAR (current_buffer
, directory
)));
5360 temp
= get_minibuffer (0);
5361 bset_directory (XBUFFER (temp
), BVAR (current_buffer
, directory
));
5366 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5367 Object stored in the current buffer. address is the address of the slot
5368 in the buffer that is current now. */
5370 /* TYPE is nil for a general Lisp variable.
5371 An integer specifies a type; then only Lisp values
5372 with that type code are allowed (except that nil is allowed too).
5373 LNAME is the Lisp-level variable name.
5374 VNAME is the name of the buffer slot.
5375 DOC is a dummy where you write the doc string as a comment. */
5376 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5378 static struct Lisp_Buffer_Objfwd bo_fwd; \
5379 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5383 defvar_per_buffer (struct Lisp_Buffer_Objfwd
*bo_fwd
, const char *namestring
,
5384 Lisp_Object
*address
, Lisp_Object type
)
5386 struct Lisp_Symbol
*sym
;
5389 sym
= XSYMBOL (intern (namestring
));
5390 offset
= (char *)address
- (char *)current_buffer
;
5392 bo_fwd
->type
= Lisp_Fwd_Buffer_Obj
;
5393 bo_fwd
->offset
= offset
;
5394 bo_fwd
->slottype
= type
;
5395 sym
->declared_special
= 1;
5396 sym
->redirect
= SYMBOL_FORWARDED
;
5398 /* I tried to do the job without a cast, but it seems impossible.
5399 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5400 SET_SYMBOL_FWD (sym
, (union Lisp_Fwd
*)bo_fwd
);
5402 XSETSYMBOL (PER_BUFFER_SYMBOL (offset
), sym
);
5404 if (PER_BUFFER_IDX (offset
) == 0)
5405 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5406 slot of buffer_local_flags */
5411 /* initialize the buffer routines */
5413 syms_of_buffer (void)
5415 staticpro (&last_overlay_modification_hooks
);
5416 last_overlay_modification_hooks
5417 = Fmake_vector (make_number (10), Qnil
);
5419 staticpro (&Qfundamental_mode
);
5420 staticpro (&Qmode_class
);
5421 staticpro (&QSFundamental
);
5422 staticpro (&Vbuffer_alist
);
5423 staticpro (&Qprotected_field
);
5424 staticpro (&Qpermanent_local
);
5425 staticpro (&Qkill_buffer_hook
);
5427 DEFSYM (Qpermanent_local_hook
, "permanent-local-hook");
5428 DEFSYM (Qoverlayp
, "overlayp");
5429 DEFSYM (Qevaporate
, "evaporate");
5430 DEFSYM (Qmodification_hooks
, "modification-hooks");
5431 DEFSYM (Qinsert_in_front_hooks
, "insert-in-front-hooks");
5432 DEFSYM (Qinsert_behind_hooks
, "insert-behind-hooks");
5433 DEFSYM (Qget_file_buffer
, "get-file-buffer");
5434 DEFSYM (Qpriority
, "priority");
5435 DEFSYM (Qbefore_string
, "before-string");
5436 DEFSYM (Qafter_string
, "after-string");
5437 DEFSYM (Qfirst_change_hook
, "first-change-hook");
5438 DEFSYM (Qbefore_change_functions
, "before-change-functions");
5439 DEFSYM (Qafter_change_functions
, "after-change-functions");
5440 DEFSYM (Qkill_buffer_query_functions
, "kill-buffer-query-functions");
5442 Fput (Qprotected_field
, Qerror_conditions
,
5443 listn (CONSTYPE_PURE
, 2, Qprotected_field
, Qerror
));
5444 Fput (Qprotected_field
, Qerror_message
,
5445 build_pure_c_string ("Attempt to modify a protected field"));
5447 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5449 doc
: /* Default value of `mode-line-format' for buffers that don't override it.
5450 This is the same as (default-value 'mode-line-format). */);
5452 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5454 doc
: /* Default value of `header-line-format' for buffers that don't override it.
5455 This is the same as (default-value 'header-line-format). */);
5457 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type
,
5458 doc
: /* Default value of `cursor-type' for buffers that don't override it.
5459 This is the same as (default-value 'cursor-type). */);
5461 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5463 doc
: /* Default value of `line-spacing' for buffers that don't override it.
5464 This is the same as (default-value 'line-spacing). */);
5466 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5467 cursor_in_non_selected_windows
,
5468 doc
: /* Default value of `cursor-in-non-selected-windows'.
5469 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5471 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5473 doc
: /* Default value of `abbrev-mode' for buffers that do not override it.
5474 This is the same as (default-value 'abbrev-mode). */);
5476 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5478 doc
: /* Default value of `ctl-arrow' for buffers that do not override it.
5479 This is the same as (default-value 'ctl-arrow). */);
5481 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5482 enable_multibyte_characters
,
5483 doc
: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5484 This is the same as (default-value 'enable-multibyte-characters). */);
5486 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5487 buffer_file_coding_system
,
5488 doc
: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5489 This is the same as (default-value 'buffer-file-coding-system). */);
5491 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5493 doc
: /* Default value of `truncate-lines' for buffers that do not override it.
5494 This is the same as (default-value 'truncate-lines). */);
5496 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5498 doc
: /* Default value of `fill-column' for buffers that do not override it.
5499 This is the same as (default-value 'fill-column). */);
5501 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5503 doc
: /* Default value of `left-margin' for buffers that do not override it.
5504 This is the same as (default-value 'left-margin). */);
5506 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5508 doc
: /* Default value of `tab-width' for buffers that do not override it.
5509 This is the same as (default-value 'tab-width). */);
5511 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5513 doc
: /* Default value of `case-fold-search' for buffers that don't override it.
5514 This is the same as (default-value 'case-fold-search). */);
5516 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5518 doc
: /* Default value of `left-margin-width' for buffers that don't override it.
5519 This is the same as (default-value 'left-margin-width). */);
5521 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5523 doc
: /* Default value of `right-margin-width' for buffers that don't override it.
5524 This is the same as (default-value 'right-margin-width). */);
5526 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5528 doc
: /* Default value of `left-fringe-width' for buffers that don't override it.
5529 This is the same as (default-value 'left-fringe-width). */);
5531 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5533 doc
: /* Default value of `right-fringe-width' for buffers that don't override it.
5534 This is the same as (default-value 'right-fringe-width). */);
5536 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5537 fringes_outside_margins
,
5538 doc
: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5539 This is the same as (default-value 'fringes-outside-margins). */);
5541 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5543 doc
: /* Default value of `scroll-bar-width' for buffers that don't override it.
5544 This is the same as (default-value 'scroll-bar-width). */);
5546 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5547 vertical_scroll_bar_type
,
5548 doc
: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5549 This is the same as (default-value 'vertical-scroll-bar). */);
5551 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5552 indicate_empty_lines
,
5553 doc
: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5554 This is the same as (default-value 'indicate-empty-lines). */);
5556 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5557 indicate_buffer_boundaries
,
5558 doc
: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5559 This is the same as (default-value 'indicate-buffer-boundaries). */);
5561 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5562 fringe_indicator_alist
,
5563 doc
: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5564 This is the same as (default-value 'fringe-indicator-alist'). */);
5566 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5567 fringe_cursor_alist
,
5568 doc
: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5569 This is the same as (default-value 'fringe-cursor-alist'). */);
5571 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5572 scroll_up_aggressively
,
5573 doc
: /* Default value of `scroll-up-aggressively'.
5574 This value applies in buffers that don't have their own local values.
5575 This is the same as (default-value 'scroll-up-aggressively). */);
5577 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5578 scroll_down_aggressively
,
5579 doc
: /* Default value of `scroll-down-aggressively'.
5580 This value applies in buffers that don't have their own local values.
5581 This is the same as (default-value 'scroll-down-aggressively). */);
5583 DEFVAR_PER_BUFFER ("header-line-format",
5584 &BVAR (current_buffer
, header_line_format
),
5586 doc
: /* Analogous to `mode-line-format', but controls the header line.
5587 The header line appears, optionally, at the top of a window;
5588 the mode line appears at the bottom. */);
5590 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer
, mode_line_format
),
5592 doc
: /* Template for displaying mode line for current buffer.
5594 The value may be nil, a string, a symbol or a list.
5596 A value of nil means don't display a mode line.
5598 For any symbol other than t or nil, the symbol's value is processed as
5599 a mode line construct. As a special exception, if that value is a
5600 string, the string is processed verbatim, without handling any
5601 %-constructs (see below). Also, unless the symbol has a non-nil
5602 `risky-local-variable' property, all properties in any strings, as
5603 well as all :eval and :propertize forms in the value, are ignored.
5605 A list whose car is a string or list is processed by processing each
5606 of the list elements recursively, as separate mode line constructs,
5607 and concatenating the results.
5609 A list of the form `(:eval FORM)' is processed by evaluating FORM and
5610 using the result as a mode line construct. Be careful--FORM should
5611 not load any files, because that can cause an infinite recursion.
5613 A list of the form `(:propertize ELT PROPS...)' is processed by
5614 processing ELT as the mode line construct, and adding the text
5615 properties PROPS to the result.
5617 A list whose car is a symbol is processed by examining the symbol's
5618 value, and, if that value is non-nil, processing the cadr of the list
5619 recursively; and if that value is nil, processing the caddr of the
5622 A list whose car is an integer is processed by processing the cadr of
5623 the list, and padding (if the number is positive) or truncating (if
5624 negative) to the width specified by that number.
5626 A string is printed verbatim in the mode line except for %-constructs:
5627 %b -- print buffer name. %f -- print visited file name.
5628 %F -- print frame name.
5629 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5630 %& is like %*, but ignore read-only-ness.
5631 % means buffer is read-only and * means it is modified.
5632 For a modified read-only buffer, %* gives % and %+ gives *.
5633 %s -- print process status. %l -- print the current line number.
5634 %c -- print the current column number (this makes editing slower).
5635 To make the column number update correctly in all cases,
5636 `column-number-mode' must be non-nil.
5637 %i -- print the size of the buffer.
5638 %I -- like %i, but use k, M, G, etc., to abbreviate.
5639 %p -- print percent of buffer above top of window, or Top, Bot or All.
5640 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5641 or print Bottom or All.
5642 %n -- print Narrow if appropriate.
5643 %t -- visited file is text or binary (if OS supports this distinction).
5644 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5645 %Z -- like %z, but including the end-of-line format.
5646 %e -- print error message about full memory.
5647 %@ -- print @ or hyphen. @ means that default-directory is on a
5649 %[ -- print one [ for each recursive editing level. %] similar.
5650 %% -- print %. %- -- print infinitely many dashes.
5651 Decimal digits after the % specify field width to which to pad. */);
5653 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode
,
5654 doc
: /* Value of `major-mode' for new buffers. */);
5656 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer
, major_mode
),
5657 make_number (Lisp_Symbol
),
5658 doc
: /* Symbol for current buffer's major mode.
5659 The default value (normally `fundamental-mode') affects new buffers.
5660 A value of nil means to use the current buffer's major mode, provided
5661 it is not marked as "special".
5663 When a mode is used by default, `find-file' switches to it before it
5664 reads the contents into the buffer and before it finishes setting up
5665 the buffer. Thus, the mode and its hooks should not expect certain
5666 variables such as `buffer-read-only' and `buffer-file-coding-system'
5669 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer
, mode_name
),
5671 doc
: /* Pretty name of current buffer's major mode.
5672 Usually a string, but can use any of the constructs for `mode-line-format',
5674 Format with `format-mode-line' to produce a string value. */);
5676 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer
, abbrev_table
), Qnil
,
5677 doc
: /* Local (mode-specific) abbrev table of current buffer. */);
5679 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer
, abbrev_mode
), Qnil
,
5680 doc
: /* Non-nil if Abbrev mode is enabled.
5681 Use the command `abbrev-mode' to change this variable. */);
5683 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer
, case_fold_search
),
5685 doc
: /* Non-nil if searches and matches should ignore case. */);
5687 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer
, fill_column
),
5688 make_number (Lisp_Int0
),
5689 doc
: /* Column beyond which automatic line-wrapping should happen.
5690 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5692 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer
, left_margin
),
5693 make_number (Lisp_Int0
),
5694 doc
: /* Column for the default `indent-line-function' to indent to.
5695 Linefeed indents to this column in Fundamental mode. */);
5697 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer
, tab_width
),
5698 make_number (Lisp_Int0
),
5699 doc
: /* Distance between tab stops (for display of tab characters), in columns.
5700 This should be an integer greater than zero. */);
5702 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer
, ctl_arrow
), Qnil
,
5703 doc
: /* Non-nil means display control chars with uparrow.
5704 A value of nil means use backslash and octal digits.
5705 This variable does not apply to characters whose display is specified
5706 in the current display table (if there is one). */);
5708 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5709 &BVAR (current_buffer
, enable_multibyte_characters
),
5711 doc
: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5712 Otherwise they are regarded as unibyte. This affects the display,
5713 file I/O and the behavior of various editing commands.
5715 This variable is buffer-local but you cannot set it directly;
5716 use the function `set-buffer-multibyte' to change a buffer's representation.
5717 See also Info node `(elisp)Text Representations'. */);
5718 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant
= 1;
5720 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5721 &BVAR (current_buffer
, buffer_file_coding_system
), Qnil
,
5722 doc
: /* Coding system to be used for encoding the buffer contents on saving.
5723 This variable applies to saving the buffer, and also to `write-region'
5724 and other functions that use `write-region'.
5725 It does not apply to sending output to subprocesses, however.
5727 If this is nil, the buffer is saved without any code conversion
5728 unless some coding system is specified in `file-coding-system-alist'
5729 for the buffer file.
5731 If the text to be saved cannot be encoded as specified by this variable,
5732 an alternative encoding is selected by `select-safe-coding-system', which see.
5734 The variable `coding-system-for-write', if non-nil, overrides this variable.
5736 This variable is never applied to a way of decoding a file while reading it. */);
5738 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5739 &BVAR (current_buffer
, bidi_display_reordering
), Qnil
,
5740 doc
: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5742 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5743 &BVAR (current_buffer
, bidi_paragraph_direction
), Qnil
,
5744 doc
: /* If non-nil, forces directionality of text paragraphs in the buffer.
5746 If this is nil (the default), the direction of each paragraph is
5747 determined by the first strong directional character of its text.
5748 The values of `right-to-left' and `left-to-right' override that.
5749 Any other value is treated as nil.
5751 This variable has no effect unless the buffer's value of
5752 \`bidi-display-reordering' is non-nil. */);
5754 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer
, truncate_lines
), Qnil
,
5755 doc
: /* Non-nil means do not display continuation lines.
5756 Instead, give each line of text just one screen line.
5758 Note that this is overridden by the variable
5759 `truncate-partial-width-windows' if that variable is non-nil
5760 and this buffer is not full-frame width.
5762 Minibuffers set this variable to nil. */);
5764 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer
, word_wrap
), Qnil
,
5765 doc
: /* Non-nil means to use word-wrapping for continuation lines.
5766 When word-wrapping is on, continuation lines are wrapped at the space
5767 or tab character nearest to the right window edge.
5768 If nil, continuation lines are wrapped at the right screen edge.
5770 This variable has no effect if long lines are truncated (see
5771 `truncate-lines' and `truncate-partial-width-windows'). If you use
5772 word-wrapping, you might want to reduce the value of
5773 `truncate-partial-width-windows', since wrapping can make text readable
5774 in narrower windows.
5776 Instead of setting this variable directly, most users should use
5777 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5778 to t, and additionally redefines simple editing commands to act on
5779 visual lines rather than logical lines. See the documentation of
5780 `visual-line-mode'. */);
5782 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer
, directory
),
5783 make_number (Lisp_String
),
5784 doc
: /* Name of default directory of current buffer. Should end with slash.
5785 To interactively change the default directory, use command `cd'. */);
5787 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer
, auto_fill_function
),
5789 doc
: /* Function called (if non-nil) to perform auto-fill.
5790 It is called after self-inserting any character specified in
5791 the `auto-fill-chars' table.
5792 NOTE: This variable is not a hook;
5793 its value may not be a list of functions. */);
5795 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer
, filename
),
5796 make_number (Lisp_String
),
5797 doc
: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5799 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer
, file_truename
),
5800 make_number (Lisp_String
),
5801 doc
: /* Abbreviated truename of file visited in current buffer, or nil if none.
5802 The truename of a file is calculated by `file-truename'
5803 and then abbreviated with `abbreviate-file-name'. */);
5805 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5806 &BVAR (current_buffer
, auto_save_file_name
),
5807 make_number (Lisp_String
),
5808 doc
: /* Name of file for auto-saving current buffer.
5809 If it is nil, that means don't auto-save this buffer. */);
5811 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer
, read_only
), Qnil
,
5812 doc
: /* Non-nil if this buffer is read-only. */);
5814 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer
, backed_up
), Qnil
,
5815 doc
: /* Non-nil if this buffer's file has been backed up.
5816 Backing up is done before the first time the file is saved. */);
5818 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer
, save_length
),
5819 make_number (Lisp_Int0
),
5820 doc
: /* Length of current buffer when last read in, saved or auto-saved.
5822 -1 means auto-saving turned off until next real save.
5824 If you set this to -2, that means don't turn off auto-saving in this buffer
5825 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5826 you probably should set this to -2 in that buffer. */);
5828 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer
, selective_display
),
5830 doc
: /* Non-nil enables selective display.
5831 An integer N as value means display only lines
5832 that start with less than N columns of space.
5833 A value of t means that the character ^M makes itself and
5834 all the rest of the line invisible; also, when saving the buffer
5835 in a file, save the ^M as a newline. */);
5837 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5838 &BVAR (current_buffer
, selective_display_ellipses
),
5840 doc
: /* Non-nil means display ... on previous line when a line is invisible. */);
5842 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer
, overwrite_mode
), Qnil
,
5843 doc
: /* Non-nil if self-insertion should replace existing text.
5844 The value should be one of `overwrite-mode-textual',
5845 `overwrite-mode-binary', or nil.
5846 If it is `overwrite-mode-textual', self-insertion still
5847 inserts at the end of a line, and inserts when point is before a tab,
5848 until the tab is filled in.
5849 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5851 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer
, display_table
),
5853 doc
: /* Display table that controls display of the contents of current buffer.
5855 If this variable is nil, the value of `standard-display-table' is used.
5856 Each window can have its own, overriding display table, see
5857 `set-window-display-table' and `window-display-table'.
5859 The display table is a char-table created with `make-display-table'.
5860 A char-table is an array indexed by character codes. Normal array
5861 primitives `aref' and `aset' can be used to access elements of a char-table.
5863 Each of the char-table elements control how to display the corresponding
5864 text character: the element at index C in the table says how to display
5865 the character whose code is C. Each element should be a vector of
5866 characters or nil. The value nil means display the character in the
5867 default fashion; otherwise, the characters from the vector are delivered
5868 to the screen instead of the original character.
5870 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5871 to display a capital Y instead of each X character.
5873 In addition, a char-table has six extra slots to control the display of:
5875 the end of a truncated screen line (extra-slot 0, a single character);
5876 the end of a continued line (extra-slot 1, a single character);
5877 the escape character used to display character codes in octal
5878 (extra-slot 2, a single character);
5879 the character used as an arrow for control characters (extra-slot 3,
5880 a single character);
5881 the decoration indicating the presence of invisible lines (extra-slot 4,
5882 a vector of characters);
5883 the character used to draw the border between side-by-side windows
5884 (extra-slot 5, a single character).
5886 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5888 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer
, left_margin_cols
),
5890 doc
: /* Width of left marginal area for display of a buffer.
5891 A value of nil means no marginal area. */);
5893 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer
, right_margin_cols
),
5895 doc
: /* Width of right marginal area for display of a buffer.
5896 A value of nil means no marginal area. */);
5898 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer
, left_fringe_width
),
5900 doc
: /* Width of this buffer's left fringe (in pixels).
5901 A value of 0 means no left fringe is shown in this buffer's window.
5902 A value of nil means to use the left fringe width from the window's frame. */);
5904 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer
, right_fringe_width
),
5906 doc
: /* Width of this buffer's right fringe (in pixels).
5907 A value of 0 means no right fringe is shown in this buffer's window.
5908 A value of nil means to use the right fringe width from the window's frame. */);
5910 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer
, fringes_outside_margins
),
5912 doc
: /* Non-nil means to display fringes outside display margins.
5913 A value of nil means to display fringes between margins and buffer text. */);
5915 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer
, scroll_bar_width
),
5917 doc
: /* Width of this buffer's scroll bars in pixels.
5918 A value of nil means to use the scroll bar width from the window's frame. */);
5920 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer
, vertical_scroll_bar_type
),
5922 doc
: /* Position of this buffer's vertical scroll bar.
5923 The value takes effect whenever you tell a window to display this buffer;
5924 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5926 A value of `left' or `right' means put the vertical scroll bar at that side
5927 of the window; a value of nil means don't show any vertical scroll bars.
5928 A value of t (the default) means do whatever the window's frame specifies. */);
5930 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5931 &BVAR (current_buffer
, indicate_empty_lines
), Qnil
,
5932 doc
: /* Visually indicate empty lines after the buffer end.
5933 If non-nil, a bitmap is displayed in the left fringe of a window on
5934 window-systems. */);
5936 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5937 &BVAR (current_buffer
, indicate_buffer_boundaries
), Qnil
,
5938 doc
: /* Visually indicate buffer boundaries and scrolling.
5939 If non-nil, the first and last line of the buffer are marked in the fringe
5940 of a window on window-systems with angle bitmaps, or if the window can be
5941 scrolled, the top and bottom line of the window are marked with up and down
5944 If value is a symbol `left' or `right', both angle and arrow bitmaps
5945 are displayed in the left or right fringe, resp. Any other value
5946 that doesn't look like an alist means display the angle bitmaps in
5947 the left fringe but no arrows.
5949 You can exercise more precise control by using an alist as the
5950 value. Each alist element (INDICATOR . POSITION) specifies
5951 where to show one of the indicators. INDICATOR is one of `top',
5952 `bottom', `up', `down', or t, which specifies the default position,
5953 and POSITION is one of `left', `right', or nil, meaning do not show
5956 For example, ((top . left) (t . right)) places the top angle bitmap in
5957 left fringe, the bottom angle bitmap in right fringe, and both arrow
5958 bitmaps in right fringe. To show just the angle bitmaps in the left
5959 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5961 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5962 &BVAR (current_buffer
, fringe_indicator_alist
), Qnil
,
5963 doc
: /* Mapping from logical to physical fringe indicator bitmaps.
5964 The value is an alist where each element (INDICATOR . BITMAPS)
5965 specifies the fringe bitmaps used to display a specific logical
5968 INDICATOR specifies the logical indicator type which is one of the
5969 following symbols: `truncation' , `continuation', `overlay-arrow',
5970 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5972 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5973 the actual bitmap shown in the left or right fringe for the logical
5974 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5975 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5976 are used only for the `bottom' and `top-bottom' indicators when the
5977 last (only) line has no final newline. BITMAPS may also be a single
5978 symbol which is used in both left and right fringes. */);
5980 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5981 &BVAR (current_buffer
, fringe_cursor_alist
), Qnil
,
5982 doc
: /* Mapping from logical to physical fringe cursor bitmaps.
5983 The value is an alist where each element (CURSOR . BITMAP)
5984 specifies the fringe bitmaps used to display a specific logical
5985 cursor type in the fringe.
5987 CURSOR specifies the logical cursor type which is one of the following
5988 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5989 one is used to show a hollow cursor on narrow lines display lines
5990 where the normal hollow cursor will not fit.
5992 BITMAP is the corresponding fringe bitmap shown for the logical
5995 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5996 &BVAR (current_buffer
, scroll_up_aggressively
), Qnil
,
5997 doc
: /* How far to scroll windows upward.
5998 If you move point off the bottom, the window scrolls automatically.
5999 This variable controls how far it scrolls. The value nil, the default,
6000 means scroll to center point. A fraction means scroll to put point
6001 that fraction of the window's height from the bottom of the window.
6002 When the value is 0.0, point goes at the bottom line, which in the
6003 simple case that you moved off with C-f means scrolling just one line.
6004 1.0 means point goes at the top, so that in that simple case, the
6005 window scrolls by a full window height. Meaningful values are
6006 between 0.0 and 1.0, inclusive. */);
6008 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
6009 &BVAR (current_buffer
, scroll_down_aggressively
), Qnil
,
6010 doc
: /* How far to scroll windows downward.
6011 If you move point off the top, the window scrolls automatically.
6012 This variable controls how far it scrolls. The value nil, the default,
6013 means scroll to center point. A fraction means scroll to put point
6014 that fraction of the window's height from the top of the window.
6015 When the value is 0.0, point goes at the top line, which in the
6016 simple case that you moved off with C-b means scrolling just one line.
6017 1.0 means point goes at the bottom, so that in that simple case, the
6018 window scrolls by a full window height. Meaningful values are
6019 between 0.0 and 1.0, inclusive. */);
6021 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
6025 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions
,
6026 doc
: /* List of functions to call before each text change.
6027 Two arguments are passed to each function: the positions of
6028 the beginning and end of the range of old text to be changed.
6029 \(For an insertion, the beginning and end are at the same place.)
6030 No information is given about the length of the text after the change.
6032 Buffer changes made while executing the `before-change-functions'
6033 don't call any before-change or after-change functions.
6034 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6036 If an unhandled error happens in running these functions,
6037 the variable's value remains nil. That prevents the error
6038 from happening repeatedly and making Emacs nonfunctional. */);
6039 Vbefore_change_functions
= Qnil
;
6041 DEFVAR_LISP ("after-change-functions", Vafter_change_functions
,
6042 doc
: /* List of functions to call after each text change.
6043 Three arguments are passed to each function: the positions of
6044 the beginning and end of the range of changed text,
6045 and the length in bytes of the pre-change text replaced by that range.
6046 \(For an insertion, the pre-change length is zero;
6047 for a deletion, that length is the number of bytes deleted,
6048 and the post-change beginning and end are at the same place.)
6050 Buffer changes made while executing the `after-change-functions'
6051 don't call any before-change or after-change functions.
6052 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6054 If an unhandled error happens in running these functions,
6055 the variable's value remains nil. That prevents the error
6056 from happening repeatedly and making Emacs nonfunctional. */);
6057 Vafter_change_functions
= Qnil
;
6059 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook
,
6060 doc
: /* A list of functions to call before changing a buffer which is unmodified.
6061 The functions are run using the `run-hooks' function. */);
6062 Vfirst_change_hook
= Qnil
;
6064 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer
, undo_list
), Qnil
,
6065 doc
: /* List of undo entries in current buffer.
6066 Recent changes come first; older changes follow newer.
6068 An entry (BEG . END) represents an insertion which begins at
6069 position BEG and ends at position END.
6071 An entry (TEXT . POSITION) represents the deletion of the string TEXT
6072 from (abs POSITION). If POSITION is positive, point was at the front
6073 of the text being deleted; if negative, point was at the end.
6075 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
6076 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
6077 and is the visited file's modification time, as of that time. If the
6078 modification time of the most recent save is different, this entry is
6081 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
6082 was modified between BEG and END. PROPERTY is the property name,
6083 and VALUE is the old value.
6085 An entry (apply FUN-NAME . ARGS) means undo the change with
6086 \(apply FUN-NAME ARGS).
6088 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
6089 in the active region. BEG and END is the range affected by this entry
6090 and DELTA is the number of bytes added or deleted in that range by
6093 An entry (MARKER . DISTANCE) indicates that the marker MARKER
6094 was adjusted in position by the offset DISTANCE (an integer).
6096 An entry of the form POSITION indicates that point was at the buffer
6097 location given by the integer. Undoing an entry of this form places
6100 Entries with value `nil' mark undo boundaries. The undo command treats
6101 the changes between two undo boundaries as a single step to be undone.
6103 If the value of the variable is t, undo information is not recorded. */);
6105 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer
, mark_active
), Qnil
,
6106 doc
: /* Non-nil means the mark and region are currently active in this buffer. */);
6108 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer
, cache_long_line_scans
), Qnil
,
6109 doc
: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
6111 Normally, the line-motion functions work by scanning the buffer for
6112 newlines. Columnar operations (like `move-to-column' and
6113 `compute-motion') also work by scanning the buffer, summing character
6114 widths as they go. This works well for ordinary text, but if the
6115 buffer's lines are very long (say, more than 500 characters), these
6116 motion functions will take longer to execute. Emacs may also take
6117 longer to update the display.
6119 If `cache-long-line-scans' is non-nil, these motion functions cache the
6120 results of their scans, and consult the cache to avoid rescanning
6121 regions of the buffer until the text is modified. The caches are most
6122 beneficial when they prevent the most searching---that is, when the
6123 buffer contains long lines and large regions of characters with the
6124 same, fixed screen width.
6126 When `cache-long-line-scans' is non-nil, processing short lines will
6127 become slightly slower (because of the overhead of consulting the
6128 cache), and the caches will use memory roughly proportional to the
6129 number of newlines and characters whose screen width varies.
6131 The caches require no explicit maintenance; their accuracy is
6132 maintained internally by the Emacs primitives. Enabling or disabling
6133 the cache should not affect the behavior of any of the motion
6134 functions; it should only affect their performance. */);
6136 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer
, point_before_scroll
), Qnil
,
6137 doc
: /* Value of point before the last series of scroll operations, or nil. */);
6139 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer
, file_format
), Qnil
,
6140 doc
: /* List of formats to use when saving this buffer.
6141 Formats are defined by `format-alist'. This variable is
6142 set when a file is visited. */);
6144 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6145 &BVAR (current_buffer
, auto_save_file_format
), Qnil
,
6146 doc
: /* Format in which to write auto-save files.
6147 Should be a list of symbols naming formats that are defined in `format-alist'.
6148 If it is t, which is the default, auto-save files are written in the
6149 same format as a regular save would use. */);
6151 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6152 &BVAR (current_buffer
, invisibility_spec
), Qnil
,
6153 doc
: /* Invisibility spec of this buffer.
6154 The default is t, which means that text is invisible
6155 if it has a non-nil `invisible' property.
6156 If the value is a list, a text character is invisible if its `invisible'
6157 property is an element in that list (or is a list with members in common).
6158 If an element is a cons cell of the form (PROP . ELLIPSIS),
6159 then characters with property value PROP are invisible,
6160 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
6162 DEFVAR_PER_BUFFER ("buffer-display-count",
6163 &BVAR (current_buffer
, display_count
), Qnil
,
6164 doc
: /* A number incremented each time this buffer is displayed in a window.
6165 The function `set-window-buffer' increments it. */);
6167 DEFVAR_PER_BUFFER ("buffer-display-time",
6168 &BVAR (current_buffer
, display_time
), Qnil
,
6169 doc
: /* Time stamp updated each time this buffer is displayed in a window.
6170 The function `set-window-buffer' updates this variable
6171 to the value obtained by calling `current-time'.
6172 If the buffer has never been shown in a window, the value is nil. */);
6174 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode
,
6175 doc
: /* Non-nil if Transient Mark mode is enabled.
6176 See the command `transient-mark-mode' for a description of this minor mode.
6178 Non-nil also enables highlighting of the region whenever the mark is active.
6179 The variable `highlight-nonselected-windows' controls whether to highlight
6180 all windows or just the selected window.
6182 Lisp programs may give this variable certain special values:
6184 - A value of `lambda' enables Transient Mark mode temporarily.
6185 It is disabled again after any subsequent action that would
6186 normally deactivate the mark (e.g. buffer modification).
6188 - A value of (only . OLDVAL) enables Transient Mark mode
6189 temporarily. After any subsequent point motion command that is
6190 not shift-translated, or any other action that would normally
6191 deactivate the mark (e.g. buffer modification), the value of
6192 `transient-mark-mode' is set to OLDVAL. */);
6193 Vtransient_mark_mode
= Qnil
;
6195 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only
,
6196 doc
: /* Non-nil means disregard read-only status of buffers or characters.
6197 If the value is t, disregard `buffer-read-only' and all `read-only'
6198 text properties. If the value is a list, disregard `buffer-read-only'
6199 and disregard a `read-only' text property if the property value
6200 is a member of the list. */);
6201 Vinhibit_read_only
= Qnil
;
6203 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer
, cursor_type
), Qnil
,
6204 doc
: /* Cursor to use when this buffer is in the selected window.
6205 Values are interpreted as follows:
6207 t use the cursor specified for the frame
6208 nil don't display a cursor
6209 box display a filled box cursor
6210 hollow display a hollow box cursor
6211 bar display a vertical bar cursor with default width
6212 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6213 hbar display a horizontal bar cursor with default height
6214 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6215 ANYTHING ELSE display a hollow box cursor
6217 When the buffer is displayed in a non-selected window, the
6218 cursor's appearance is instead controlled by the variable
6219 `cursor-in-non-selected-windows'. */);
6221 DEFVAR_PER_BUFFER ("line-spacing",
6222 &BVAR (current_buffer
, extra_line_spacing
), Qnil
,
6223 doc
: /* Additional space to put between lines when displaying a buffer.
6224 The space is measured in pixels, and put below lines on graphic displays,
6225 see `display-graphic-p'.
6226 If value is a floating point number, it specifies the spacing relative
6227 to the default frame line height. A value of nil means add no extra space. */);
6229 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6230 &BVAR (current_buffer
, cursor_in_non_selected_windows
), Qnil
,
6231 doc
: /* Non-nil means show a cursor in non-selected windows.
6232 If nil, only shows a cursor in the selected window.
6233 If t, displays a cursor related to the usual cursor type
6234 \(a solid box becomes hollow, a bar becomes a narrower bar).
6235 You can also specify the cursor type as in the `cursor-type' variable.
6236 Use Custom to set this variable and update the display." */);
6238 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions
,
6239 doc
: /* List of functions called with no args to query before killing a buffer.
6240 The buffer being killed will be current while the functions are running.
6242 If any of them returns nil, the buffer is not killed. Functions run by
6243 this hook are supposed to not change the current buffer. */);
6244 Vkill_buffer_query_functions
= Qnil
;
6246 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook
,
6247 doc
: /* Normal hook run before changing the major mode of a buffer.
6248 The function `kill-all-local-variables' runs this before doing anything else. */);
6249 Vchange_major_mode_hook
= Qnil
;
6250 DEFSYM (Qchange_major_mode_hook
, "change-major-mode-hook");
6252 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook
,
6253 doc
: /* Hook run when the buffer list changes.
6254 Functions running this hook are `get-buffer-create',
6255 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6256 and `bury-buffer-internal'. */);
6257 Vbuffer_list_update_hook
= Qnil
;
6258 DEFSYM (Qbuffer_list_update_hook
, "buffer-list-update-hook");
6260 defsubr (&Sbuffer_live_p
);
6261 defsubr (&Sbuffer_list
);
6262 defsubr (&Sget_buffer
);
6263 defsubr (&Sget_file_buffer
);
6264 defsubr (&Sget_buffer_create
);
6265 defsubr (&Smake_indirect_buffer
);
6266 defsubr (&Sgenerate_new_buffer_name
);
6267 defsubr (&Sbuffer_name
);
6268 defsubr (&Sbuffer_file_name
);
6269 defsubr (&Sbuffer_base_buffer
);
6270 defsubr (&Sbuffer_local_value
);
6271 defsubr (&Sbuffer_local_variables
);
6272 defsubr (&Sbuffer_modified_p
);
6273 defsubr (&Sset_buffer_modified_p
);
6274 defsubr (&Sbuffer_modified_tick
);
6275 defsubr (&Sbuffer_chars_modified_tick
);
6276 defsubr (&Srename_buffer
);
6277 defsubr (&Sother_buffer
);
6278 defsubr (&Sbuffer_enable_undo
);
6279 defsubr (&Skill_buffer
);
6280 defsubr (&Sbury_buffer_internal
);
6281 defsubr (&Sset_buffer_major_mode
);
6282 defsubr (&Scurrent_buffer
);
6283 defsubr (&Sset_buffer
);
6284 defsubr (&Sbarf_if_buffer_read_only
);
6285 defsubr (&Serase_buffer
);
6286 defsubr (&Sbuffer_swap_text
);
6287 defsubr (&Sset_buffer_multibyte
);
6288 defsubr (&Skill_all_local_variables
);
6290 defsubr (&Soverlayp
);
6291 defsubr (&Smake_overlay
);
6292 defsubr (&Sdelete_overlay
);
6293 defsubr (&Sdelete_all_overlays
);
6294 defsubr (&Smove_overlay
);
6295 defsubr (&Soverlay_start
);
6296 defsubr (&Soverlay_end
);
6297 defsubr (&Soverlay_buffer
);
6298 defsubr (&Soverlay_properties
);
6299 defsubr (&Soverlays_at
);
6300 defsubr (&Soverlays_in
);
6301 defsubr (&Snext_overlay_change
);
6302 defsubr (&Sprevious_overlay_change
);
6303 defsubr (&Soverlay_recenter
);
6304 defsubr (&Soverlay_lists
);
6305 defsubr (&Soverlay_get
);
6306 defsubr (&Soverlay_put
);
6307 defsubr (&Srestore_buffer_modified_p
);
6311 keys_of_buffer (void)
6313 initial_define_key (control_x_map
, 'b', "switch-to-buffer");
6314 initial_define_key (control_x_map
, 'k', "kill-buffer");
6316 /* This must not be in syms_of_buffer, because Qdisabled is not
6317 initialized when that function gets called. */
6318 Fput (intern_c_string ("erase-buffer"), Qdisabled
, Qt
);