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 /* A Lisp_Object pointer to the above, used for staticpro */
65 static Lisp_Object Vbuffer_defaults
;
67 /* This structure marks which slots in a buffer have corresponding
68 default values in buffer_defaults.
69 Each such slot has a nonzero value in this structure.
70 The value has only one nonzero bit.
72 When a buffer has its own local value for a slot,
73 the entry for that slot (found in the same slot in this structure)
74 is turned on in the buffer's local_flags array.
76 If a slot in this structure is -1, then even though there may
77 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
78 and the corresponding slot in buffer_defaults is not used.
80 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
81 zero, that is a bug */
83 struct buffer buffer_local_flags
;
85 /* This structure holds the names of symbols whose values may be
86 buffer-local. It is indexed and accessed in the same way as the above. */
88 struct buffer
alignas (GCALIGNMENT
) buffer_local_symbols
;
90 /* A Lisp_Object pointer to the above, used for staticpro */
91 static Lisp_Object Vbuffer_local_symbols
;
93 /* Return the symbol of the per-buffer variable at offset OFFSET in
94 the buffer structure. */
96 #define PER_BUFFER_SYMBOL(OFFSET) \
97 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
99 /* Maximum length of an overlay vector. */
100 #define OVERLAY_COUNT_MAX \
101 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
102 min (PTRDIFF_MAX, SIZE_MAX) / word_size))
104 /* Flags indicating which built-in buffer-local variables
105 are permanent locals. */
106 static char buffer_permanent_local_flags
[MAX_PER_BUFFER_VARS
];
108 /* Number of per-buffer variables used. */
110 int last_per_buffer_idx
;
112 static void call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
,
113 int after
, Lisp_Object arg1
,
114 Lisp_Object arg2
, Lisp_Object arg3
);
115 static void swap_out_buffer_local_variables (struct buffer
*b
);
116 static void reset_buffer_local_variables (struct buffer
*b
, int permanent_too
);
118 /* Alist of all buffer names vs the buffers. */
119 /* This used to be a variable, but is no longer,
120 to prevent lossage due to user rplac'ing this alist or its elements. */
121 Lisp_Object Vbuffer_alist
;
123 static Lisp_Object Qkill_buffer_query_functions
;
125 /* Hook run before changing a major mode. */
126 static Lisp_Object Qchange_major_mode_hook
;
128 Lisp_Object Qfirst_change_hook
;
129 Lisp_Object Qbefore_change_functions
;
130 Lisp_Object Qafter_change_functions
;
132 static Lisp_Object Qfundamental_mode
, Qmode_class
, Qpermanent_local
;
133 static Lisp_Object Qpermanent_local_hook
;
135 static Lisp_Object Qprotected_field
;
137 static Lisp_Object QSFundamental
; /* A string "Fundamental" */
139 static Lisp_Object Qkill_buffer_hook
;
140 static Lisp_Object Qbuffer_list_update_hook
;
142 static Lisp_Object Qget_file_buffer
;
144 static Lisp_Object Qoverlayp
;
146 Lisp_Object Qpriority
, Qbefore_string
, Qafter_string
;
148 static Lisp_Object Qevaporate
;
150 Lisp_Object Qmodification_hooks
;
151 Lisp_Object Qinsert_in_front_hooks
;
152 Lisp_Object Qinsert_behind_hooks
;
154 static void alloc_buffer_text (struct buffer
*, ptrdiff_t);
155 static void free_buffer_text (struct buffer
*b
);
156 static struct Lisp_Overlay
* copy_overlays (struct buffer
*, struct Lisp_Overlay
*);
157 static void modify_overlay (struct buffer
*, ptrdiff_t, ptrdiff_t);
158 static Lisp_Object
buffer_lisp_local_variables (struct buffer
*, int);
160 /* These setters are used only in this file, so they can be private. */
162 bset_abbrev_mode (struct buffer
*b
, Lisp_Object val
)
164 b
->INTERNAL_FIELD (abbrev_mode
) = val
;
167 bset_abbrev_table (struct buffer
*b
, Lisp_Object val
)
169 b
->INTERNAL_FIELD (abbrev_table
) = val
;
172 bset_auto_fill_function (struct buffer
*b
, Lisp_Object val
)
174 b
->INTERNAL_FIELD (auto_fill_function
) = val
;
177 bset_auto_save_file_format (struct buffer
*b
, Lisp_Object val
)
179 b
->INTERNAL_FIELD (auto_save_file_format
) = val
;
182 bset_auto_save_file_name (struct buffer
*b
, Lisp_Object val
)
184 b
->INTERNAL_FIELD (auto_save_file_name
) = val
;
187 bset_backed_up (struct buffer
*b
, Lisp_Object val
)
189 b
->INTERNAL_FIELD (backed_up
) = val
;
192 bset_begv_marker (struct buffer
*b
, Lisp_Object val
)
194 b
->INTERNAL_FIELD (begv_marker
) = val
;
197 bset_bidi_display_reordering (struct buffer
*b
, Lisp_Object val
)
199 b
->INTERNAL_FIELD (bidi_display_reordering
) = val
;
202 bset_buffer_file_coding_system (struct buffer
*b
, Lisp_Object val
)
204 b
->INTERNAL_FIELD (buffer_file_coding_system
) = val
;
207 bset_cache_long_line_scans (struct buffer
*b
, Lisp_Object val
)
209 b
->INTERNAL_FIELD (cache_long_line_scans
) = val
;
212 bset_case_fold_search (struct buffer
*b
, Lisp_Object val
)
214 b
->INTERNAL_FIELD (case_fold_search
) = val
;
217 bset_ctl_arrow (struct buffer
*b
, Lisp_Object val
)
219 b
->INTERNAL_FIELD (ctl_arrow
) = val
;
222 bset_cursor_in_non_selected_windows (struct buffer
*b
, Lisp_Object val
)
224 b
->INTERNAL_FIELD (cursor_in_non_selected_windows
) = val
;
227 bset_cursor_type (struct buffer
*b
, Lisp_Object val
)
229 b
->INTERNAL_FIELD (cursor_type
) = val
;
232 bset_display_table (struct buffer
*b
, Lisp_Object val
)
234 b
->INTERNAL_FIELD (display_table
) = val
;
237 bset_extra_line_spacing (struct buffer
*b
, Lisp_Object val
)
239 b
->INTERNAL_FIELD (extra_line_spacing
) = val
;
242 bset_file_format (struct buffer
*b
, Lisp_Object val
)
244 b
->INTERNAL_FIELD (file_format
) = val
;
247 bset_file_truename (struct buffer
*b
, Lisp_Object val
)
249 b
->INTERNAL_FIELD (file_truename
) = val
;
252 bset_fringe_cursor_alist (struct buffer
*b
, Lisp_Object val
)
254 b
->INTERNAL_FIELD (fringe_cursor_alist
) = val
;
257 bset_fringe_indicator_alist (struct buffer
*b
, Lisp_Object val
)
259 b
->INTERNAL_FIELD (fringe_indicator_alist
) = val
;
262 bset_fringes_outside_margins (struct buffer
*b
, Lisp_Object val
)
264 b
->INTERNAL_FIELD (fringes_outside_margins
) = val
;
267 bset_header_line_format (struct buffer
*b
, Lisp_Object val
)
269 b
->INTERNAL_FIELD (header_line_format
) = val
;
272 bset_indicate_buffer_boundaries (struct buffer
*b
, Lisp_Object val
)
274 b
->INTERNAL_FIELD (indicate_buffer_boundaries
) = val
;
277 bset_indicate_empty_lines (struct buffer
*b
, Lisp_Object val
)
279 b
->INTERNAL_FIELD (indicate_empty_lines
) = val
;
282 bset_invisibility_spec (struct buffer
*b
, Lisp_Object val
)
284 b
->INTERNAL_FIELD (invisibility_spec
) = val
;
287 bset_left_fringe_width (struct buffer
*b
, Lisp_Object val
)
289 b
->INTERNAL_FIELD (left_fringe_width
) = val
;
292 bset_major_mode (struct buffer
*b
, Lisp_Object val
)
294 b
->INTERNAL_FIELD (major_mode
) = val
;
297 bset_mark (struct buffer
*b
, Lisp_Object val
)
299 b
->INTERNAL_FIELD (mark
) = val
;
302 bset_minor_modes (struct buffer
*b
, Lisp_Object val
)
304 b
->INTERNAL_FIELD (minor_modes
) = val
;
307 bset_mode_line_format (struct buffer
*b
, Lisp_Object val
)
309 b
->INTERNAL_FIELD (mode_line_format
) = val
;
312 bset_mode_name (struct buffer
*b
, Lisp_Object val
)
314 b
->INTERNAL_FIELD (mode_name
) = val
;
317 bset_name (struct buffer
*b
, Lisp_Object val
)
319 b
->INTERNAL_FIELD (name
) = val
;
322 bset_overwrite_mode (struct buffer
*b
, Lisp_Object val
)
324 b
->INTERNAL_FIELD (overwrite_mode
) = val
;
327 bset_pt_marker (struct buffer
*b
, Lisp_Object val
)
329 b
->INTERNAL_FIELD (pt_marker
) = val
;
332 bset_right_fringe_width (struct buffer
*b
, Lisp_Object val
)
334 b
->INTERNAL_FIELD (right_fringe_width
) = val
;
337 bset_save_length (struct buffer
*b
, Lisp_Object val
)
339 b
->INTERNAL_FIELD (save_length
) = val
;
342 bset_scroll_bar_width (struct buffer
*b
, Lisp_Object val
)
344 b
->INTERNAL_FIELD (scroll_bar_width
) = val
;
347 bset_scroll_down_aggressively (struct buffer
*b
, Lisp_Object val
)
349 b
->INTERNAL_FIELD (scroll_down_aggressively
) = val
;
352 bset_scroll_up_aggressively (struct buffer
*b
, Lisp_Object val
)
354 b
->INTERNAL_FIELD (scroll_up_aggressively
) = val
;
357 bset_selective_display (struct buffer
*b
, Lisp_Object val
)
359 b
->INTERNAL_FIELD (selective_display
) = val
;
362 bset_selective_display_ellipses (struct buffer
*b
, Lisp_Object val
)
364 b
->INTERNAL_FIELD (selective_display_ellipses
) = val
;
367 bset_vertical_scroll_bar_type (struct buffer
*b
, Lisp_Object val
)
369 b
->INTERNAL_FIELD (vertical_scroll_bar_type
) = val
;
372 bset_word_wrap (struct buffer
*b
, Lisp_Object val
)
374 b
->INTERNAL_FIELD (word_wrap
) = val
;
377 bset_zv_marker (struct buffer
*b
, Lisp_Object val
)
379 b
->INTERNAL_FIELD (zv_marker
) = val
;
382 /* For debugging; temporary. See set_buffer_internal. */
383 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
386 nsberror (Lisp_Object spec
)
389 error ("No buffer named %s", SDATA (spec
));
390 error ("Invalid buffer argument");
393 DEFUN ("buffer-live-p", Fbuffer_live_p
, Sbuffer_live_p
, 1, 1, 0,
394 doc
: /* Return non-nil if OBJECT is a buffer which has not been killed.
395 Value is nil if OBJECT is not a buffer or if it has been killed. */)
398 return ((BUFFERP (object
) && ! NILP (BVAR (XBUFFER (object
), name
)))
402 DEFUN ("buffer-list", Fbuffer_list
, Sbuffer_list
, 0, 1, 0,
403 doc
: /* Return a list of all existing live buffers.
404 If the optional arg FRAME is a frame, we return the buffer list in the
405 proper order for that frame: the buffers show in FRAME come first,
406 followed by the rest of the buffers. */)
410 general
= Fmapcar (Qcdr
, Vbuffer_alist
);
414 Lisp_Object framelist
, prevlist
, tail
;
418 framelist
= Fcopy_sequence (XFRAME (frame
)->buffer_list
);
419 prevlist
= Fnreverse (Fcopy_sequence
420 (XFRAME (frame
)->buried_buffer_list
));
422 /* Remove from GENERAL any buffer that duplicates one in
423 FRAMELIST or PREVLIST. */
427 general
= Fdelq (XCAR (tail
), general
);
433 general
= Fdelq (XCAR (tail
), general
);
440 return Fnconc (3, args
);
446 /* Like Fassoc, but use Fstring_equal to compare
447 (which ignores text properties),
448 and don't ever QUIT. */
451 assoc_ignore_text_properties (register Lisp_Object key
, Lisp_Object list
)
453 register Lisp_Object tail
;
454 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
456 register Lisp_Object elt
, tem
;
458 tem
= Fstring_equal (Fcar (elt
), key
);
465 DEFUN ("get-buffer", Fget_buffer
, Sget_buffer
, 1, 1, 0,
466 doc
: /* Return the buffer named BUFFER-OR-NAME.
467 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
468 is a string and there is no buffer with that name, return nil. If
469 BUFFER-OR-NAME is a buffer, return it as given. */)
470 (register Lisp_Object buffer_or_name
)
472 if (BUFFERP (buffer_or_name
))
473 return buffer_or_name
;
474 CHECK_STRING (buffer_or_name
);
476 return Fcdr (assoc_ignore_text_properties (buffer_or_name
, Vbuffer_alist
));
479 DEFUN ("get-file-buffer", Fget_file_buffer
, Sget_file_buffer
, 1, 1, 0,
480 doc
: /* Return the buffer visiting file FILENAME (a string).
481 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
482 If there is no such live buffer, return nil.
483 See also `find-buffer-visiting'. */)
484 (register Lisp_Object filename
)
486 register Lisp_Object tail
, buf
, tem
;
489 CHECK_STRING (filename
);
490 filename
= Fexpand_file_name (filename
, Qnil
);
492 /* If the file name has special constructs in it,
493 call the corresponding file handler. */
494 handler
= Ffind_file_name_handler (filename
, Qget_file_buffer
);
497 Lisp_Object handled_buf
= call2 (handler
, Qget_file_buffer
,
499 return BUFFERP (handled_buf
) ? handled_buf
: Qnil
;
502 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
504 buf
= Fcdr (XCAR (tail
));
505 if (!BUFFERP (buf
)) continue;
506 if (!STRINGP (BVAR (XBUFFER (buf
), filename
))) continue;
507 tem
= Fstring_equal (BVAR (XBUFFER (buf
), filename
), filename
);
515 get_truename_buffer (register Lisp_Object filename
)
517 register Lisp_Object tail
, buf
, tem
;
519 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
521 buf
= Fcdr (XCAR (tail
));
522 if (!BUFFERP (buf
)) continue;
523 if (!STRINGP (BVAR (XBUFFER (buf
), file_truename
))) continue;
524 tem
= Fstring_equal (BVAR (XBUFFER (buf
), file_truename
), filename
);
531 DEFUN ("get-buffer-create", Fget_buffer_create
, Sget_buffer_create
, 1, 1, 0,
532 doc
: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
533 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
534 return that buffer. If no such buffer exists, create a new buffer with
535 that name and return it. If BUFFER-OR-NAME starts with a space, the new
536 buffer does not keep undo information.
538 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
539 even if it is dead. The return value is never nil. */)
540 (register Lisp_Object buffer_or_name
)
542 register Lisp_Object buffer
, name
;
543 register struct buffer
*b
;
545 buffer
= Fget_buffer (buffer_or_name
);
549 if (SCHARS (buffer_or_name
) == 0)
550 error ("Empty string for buffer name is not allowed");
552 b
= allocate_buffer ();
554 /* An ordinary buffer uses its own struct buffer_text. */
555 b
->text
= &b
->own_text
;
556 b
->base_buffer
= NULL
;
557 /* No one shares the text with us now. */
560 BUF_GAP_SIZE (b
) = 20;
562 /* We allocate extra 1-byte at the tail and keep it always '\0' for
563 anchoring a search. */
564 alloc_buffer_text (b
, BUF_GAP_SIZE (b
) + 1);
566 if (! BUF_BEG_ADDR (b
))
567 buffer_memory_full (BUF_GAP_SIZE (b
) + 1);
572 b
->pt_byte
= BEG_BYTE
;
573 b
->begv_byte
= BEG_BYTE
;
574 b
->zv_byte
= BEG_BYTE
;
577 BUF_GPT_BYTE (b
) = BEG_BYTE
;
580 BUF_Z_BYTE (b
) = BEG_BYTE
;
582 BUF_CHARS_MODIFF (b
) = 1;
583 BUF_OVERLAY_MODIFF (b
) = 1;
584 BUF_SAVE_MODIFF (b
) = 1;
585 set_buffer_intervals (b
, NULL
);
586 BUF_UNCHANGED_MODIFIED (b
) = 1;
587 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = 1;
588 BUF_END_UNCHANGED (b
) = 0;
589 BUF_BEG_UNCHANGED (b
) = 0;
590 *(BUF_GPT_ADDR (b
)) = *(BUF_Z_ADDR (b
)) = 0; /* Put an anchor '\0'. */
591 b
->text
->inhibit_shrinking
= 0;
593 b
->newline_cache
= 0;
594 b
->width_run_cache
= 0;
595 bset_width_table (b
, Qnil
);
596 b
->prevent_redisplay_optimizations_p
= 1;
598 /* Put this on the chain of all buffers including killed ones. */
599 b
->header
.next
.buffer
= all_buffers
;
602 /* An ordinary buffer normally doesn't need markers
603 to handle BEGV and ZV. */
604 bset_pt_marker (b
, Qnil
);
605 bset_begv_marker (b
, Qnil
);
606 bset_zv_marker (b
, Qnil
);
608 name
= Fcopy_sequence (buffer_or_name
);
609 set_string_intervals (name
, NULL
);
612 bset_undo_list (b
, SREF (name
, 0) != ' ' ? Qnil
: Qt
);
615 reset_buffer_local_variables (b
, 1);
617 bset_mark (b
, Fmake_marker ());
618 BUF_MARKERS (b
) = NULL
;
620 /* Put this in the alist of all live buffers. */
621 XSETBUFFER (buffer
, b
);
622 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buffer
), Qnil
));
623 /* And run buffer-list-update-hook. */
624 if (!NILP (Vrun_hooks
))
625 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
631 /* Return a list of overlays which is a copy of the overlay list
632 LIST, but for buffer B. */
634 static struct Lisp_Overlay
*
635 copy_overlays (struct buffer
*b
, struct Lisp_Overlay
*list
)
637 struct Lisp_Overlay
*result
= NULL
, *tail
= NULL
;
639 for (; list
; list
= list
->next
)
641 Lisp_Object overlay
, start
, end
;
642 struct Lisp_Marker
*m
;
644 eassert (MARKERP (list
->start
));
645 m
= XMARKER (list
->start
);
646 start
= build_marker (b
, m
->charpos
, m
->bytepos
);
647 XMARKER (start
)->insertion_type
= m
->insertion_type
;
649 eassert (MARKERP (list
->end
));
650 m
= XMARKER (list
->end
);
651 end
= build_marker (b
, m
->charpos
, m
->bytepos
);
652 XMARKER (end
)->insertion_type
= m
->insertion_type
;
654 overlay
= build_overlay (start
, end
, Fcopy_sequence (list
->plist
));
656 tail
= tail
->next
= XOVERLAY (overlay
);
658 result
= tail
= XOVERLAY (overlay
);
664 /* Set an appropriate overlay of B. */
667 set_buffer_overlays_before (struct buffer
*b
, struct Lisp_Overlay
*o
)
669 b
->overlays_before
= o
;
673 set_buffer_overlays_after (struct buffer
*b
, struct Lisp_Overlay
*o
)
675 b
->overlays_after
= o
;
678 /* Clone per-buffer values of buffer FROM.
680 Buffer TO gets the same per-buffer values as FROM, with the
681 following exceptions: (1) TO's name is left untouched, (2) markers
682 are copied and made to refer to TO, and (3) overlay lists are
686 clone_per_buffer_values (struct buffer
*from
, struct buffer
*to
)
690 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
694 /* Don't touch the `name' which should be unique for every buffer. */
695 if (offset
== PER_BUFFER_VAR_OFFSET (name
))
698 obj
= per_buffer_value (from
, offset
);
699 if (MARKERP (obj
) && XMARKER (obj
)->buffer
== from
)
701 struct Lisp_Marker
*m
= XMARKER (obj
);
703 obj
= build_marker (to
, m
->charpos
, m
->bytepos
);
704 XMARKER (obj
)->insertion_type
= m
->insertion_type
;
707 set_per_buffer_value (to
, offset
, obj
);
710 memcpy (to
->local_flags
, from
->local_flags
, sizeof to
->local_flags
);
712 set_buffer_overlays_before (to
, copy_overlays (to
, from
->overlays_before
));
713 set_buffer_overlays_after (to
, copy_overlays (to
, from
->overlays_after
));
715 /* Get (a copy of) the alist of Lisp-level local variables of FROM
716 and install that in TO. */
717 bset_local_var_alist (to
, buffer_lisp_local_variables (from
, 1));
721 /* If buffer B has markers to record PT, BEGV and ZV when it is not
722 current, update these markers. */
725 record_buffer_markers (struct buffer
*b
)
727 if (! NILP (BVAR (b
, pt_marker
)))
731 eassert (!NILP (BVAR (b
, begv_marker
)));
732 eassert (!NILP (BVAR (b
, zv_marker
)));
734 XSETBUFFER (buffer
, b
);
735 set_marker_both (BVAR (b
, pt_marker
), buffer
, b
->pt
, b
->pt_byte
);
736 set_marker_both (BVAR (b
, begv_marker
), buffer
, b
->begv
, b
->begv_byte
);
737 set_marker_both (BVAR (b
, zv_marker
), buffer
, b
->zv
, b
->zv_byte
);
742 /* If buffer B has markers to record PT, BEGV and ZV when it is not
743 current, fetch these values into B->begv etc. */
746 fetch_buffer_markers (struct buffer
*b
)
748 if (! NILP (BVAR (b
, pt_marker
)))
752 eassert (!NILP (BVAR (b
, begv_marker
)));
753 eassert (!NILP (BVAR (b
, zv_marker
)));
755 m
= BVAR (b
, pt_marker
);
756 SET_BUF_PT_BOTH (b
, marker_position (m
), marker_byte_position (m
));
758 m
= BVAR (b
, begv_marker
);
759 SET_BUF_BEGV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
761 m
= BVAR (b
, zv_marker
);
762 SET_BUF_ZV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
767 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer
, Smake_indirect_buffer
,
769 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
770 doc
: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
771 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
772 NAME should be a string which is not the name of an existing buffer.
773 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
774 such as major and minor modes, in the indirect buffer.
775 CLONE nil means the indirect buffer's state is reset to default values. */)
776 (Lisp_Object base_buffer
, Lisp_Object name
, Lisp_Object clone
)
778 Lisp_Object buf
, tem
;
782 buf
= Fget_buffer (name
);
784 error ("Buffer name `%s' is in use", SDATA (name
));
787 base_buffer
= Fget_buffer (base_buffer
);
788 if (NILP (base_buffer
))
789 error ("No such buffer: `%s'", SDATA (tem
));
790 if (NILP (BVAR (XBUFFER (base_buffer
), name
)))
791 error ("Base buffer has been killed");
793 if (SCHARS (name
) == 0)
794 error ("Empty string for buffer name is not allowed");
796 b
= allocate_buffer ();
798 /* No double indirection - if base buffer is indirect,
799 new buffer becomes an indirect to base's base. */
800 b
->base_buffer
= (XBUFFER (base_buffer
)->base_buffer
801 ? XBUFFER (base_buffer
)->base_buffer
802 : XBUFFER (base_buffer
));
804 /* Use the base buffer's text object. */
805 b
->text
= b
->base_buffer
->text
;
806 /* We have no own text. */
807 b
->indirections
= -1;
808 /* Notify base buffer that we share the text now. */
809 b
->base_buffer
->indirections
++;
811 b
->pt
= b
->base_buffer
->pt
;
812 b
->begv
= b
->base_buffer
->begv
;
813 b
->zv
= b
->base_buffer
->zv
;
814 b
->pt_byte
= b
->base_buffer
->pt_byte
;
815 b
->begv_byte
= b
->base_buffer
->begv_byte
;
816 b
->zv_byte
= b
->base_buffer
->zv_byte
;
818 b
->newline_cache
= 0;
819 b
->width_run_cache
= 0;
820 bset_width_table (b
, Qnil
);
822 /* Put this on the chain of all buffers including killed ones. */
823 b
->header
.next
.buffer
= all_buffers
;
826 name
= Fcopy_sequence (name
);
827 set_string_intervals (name
, NULL
);
831 reset_buffer_local_variables (b
, 1);
833 /* Put this in the alist of all live buffers. */
835 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buf
), Qnil
));
837 bset_mark (b
, Fmake_marker ());
839 /* The multibyte status belongs to the base buffer. */
840 bset_enable_multibyte_characters
841 (b
, BVAR (b
->base_buffer
, enable_multibyte_characters
));
843 /* Make sure the base buffer has markers for its narrowing. */
844 if (NILP (BVAR (b
->base_buffer
, pt_marker
)))
846 eassert (NILP (BVAR (b
->base_buffer
, begv_marker
)));
847 eassert (NILP (BVAR (b
->base_buffer
, zv_marker
)));
849 bset_pt_marker (b
->base_buffer
,
850 build_marker (b
->base_buffer
, b
->base_buffer
->pt
,
851 b
->base_buffer
->pt_byte
));
853 bset_begv_marker (b
->base_buffer
,
854 build_marker (b
->base_buffer
, b
->base_buffer
->begv
,
855 b
->base_buffer
->begv_byte
));
857 bset_zv_marker (b
->base_buffer
,
858 build_marker (b
->base_buffer
, b
->base_buffer
->zv
,
859 b
->base_buffer
->zv_byte
));
861 XMARKER (BVAR (b
->base_buffer
, zv_marker
))->insertion_type
= 1;
866 /* Give the indirect buffer markers for its narrowing. */
867 bset_pt_marker (b
, build_marker (b
, b
->pt
, b
->pt_byte
));
868 bset_begv_marker (b
, build_marker (b
, b
->begv
, b
->begv_byte
));
869 bset_zv_marker (b
, build_marker (b
, b
->zv
, b
->zv_byte
));
870 XMARKER (BVAR (b
, zv_marker
))->insertion_type
= 1;
874 struct buffer
*old_b
= current_buffer
;
876 clone_per_buffer_values (b
->base_buffer
, b
);
877 bset_filename (b
, Qnil
);
878 bset_file_truename (b
, Qnil
);
879 bset_display_count (b
, make_number (0));
880 bset_backed_up (b
, Qnil
);
881 bset_auto_save_file_name (b
, Qnil
);
882 set_buffer_internal_1 (b
);
883 Fset (intern ("buffer-save-without-query"), Qnil
);
884 Fset (intern ("buffer-file-number"), Qnil
);
885 Fset (intern ("buffer-stale-function"), Qnil
);
886 set_buffer_internal_1 (old_b
);
889 /* Run buffer-list-update-hook. */
890 if (!NILP (Vrun_hooks
))
891 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
896 /* Mark OV as no longer associated with B. */
899 drop_overlay (struct buffer
*b
, struct Lisp_Overlay
*ov
)
901 eassert (b
== XBUFFER (Fmarker_buffer (ov
->start
)));
902 modify_overlay (b
, marker_position (ov
->start
),
903 marker_position (ov
->end
));
904 Fset_marker (ov
->start
, Qnil
, Qnil
);
905 Fset_marker (ov
->end
, Qnil
, Qnil
);
909 /* Delete all overlays of B and reset it's overlay lists. */
912 delete_all_overlays (struct buffer
*b
)
914 struct Lisp_Overlay
*ov
, *next
;
916 for (ov
= b
->overlays_before
; ov
; ov
= next
)
918 drop_overlay (b
, ov
);
923 for (ov
= b
->overlays_after
; ov
; ov
= next
)
925 drop_overlay (b
, ov
);
930 set_buffer_overlays_before (b
, NULL
);
931 set_buffer_overlays_after (b
, NULL
);
934 /* Reinitialize everything about a buffer except its name and contents
936 If called on an already-initialized buffer, the list of overlays
937 should be deleted before calling this function, otherwise we end up
938 with overlays that claim to belong to the buffer but the buffer
939 claims it doesn't belong to it. */
942 reset_buffer (register struct buffer
*b
)
944 bset_filename (b
, Qnil
);
945 bset_file_truename (b
, Qnil
);
946 bset_directory (b
, current_buffer
? BVAR (current_buffer
, directory
) : Qnil
);
947 b
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
948 b
->modtime_size
= -1;
949 XSETFASTINT (BVAR (b
, save_length
), 0);
950 b
->last_window_start
= 1;
951 /* It is more conservative to start out "changed" than "unchanged". */
953 b
->prevent_redisplay_optimizations_p
= 1;
954 bset_backed_up (b
, Qnil
);
955 BUF_AUTOSAVE_MODIFF (b
) = 0;
956 b
->auto_save_failure_time
= 0;
957 bset_auto_save_file_name (b
, Qnil
);
958 bset_read_only (b
, Qnil
);
959 set_buffer_overlays_before (b
, NULL
);
960 set_buffer_overlays_after (b
, NULL
);
961 b
->overlay_center
= BEG
;
962 bset_mark_active (b
, Qnil
);
963 bset_point_before_scroll (b
, Qnil
);
964 bset_file_format (b
, Qnil
);
965 bset_auto_save_file_format (b
, Qt
);
966 bset_last_selected_window (b
, Qnil
);
967 bset_display_count (b
, make_number (0));
968 bset_display_time (b
, Qnil
);
969 bset_enable_multibyte_characters
970 (b
, BVAR (&buffer_defaults
, enable_multibyte_characters
));
971 bset_cursor_type (b
, BVAR (&buffer_defaults
, cursor_type
));
972 bset_extra_line_spacing (b
, BVAR (&buffer_defaults
, extra_line_spacing
));
974 b
->display_error_modiff
= 0;
977 /* Reset buffer B's local variables info.
978 Don't use this on a buffer that has already been in use;
979 it does not treat permanent locals consistently.
980 Instead, use Fkill_all_local_variables.
982 If PERMANENT_TOO is 1, then we reset permanent
983 buffer-local variables. If PERMANENT_TOO is 0,
984 we preserve those. */
987 reset_buffer_local_variables (register struct buffer
*b
, int permanent_too
)
992 /* Reset the major mode to Fundamental, together with all the
993 things that depend on the major mode.
994 default-major-mode is handled at a higher level.
995 We ignore it here. */
996 bset_major_mode (b
, Qfundamental_mode
);
997 bset_keymap (b
, Qnil
);
998 bset_mode_name (b
, QSFundamental
);
999 bset_minor_modes (b
, Qnil
);
1001 /* If the standard case table has been altered and invalidated,
1002 fix up its insides first. */
1003 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[0])
1004 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[1])
1005 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[2])))
1006 Fset_standard_case_table (Vascii_downcase_table
);
1008 bset_downcase_table (b
, Vascii_downcase_table
);
1009 bset_upcase_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[0]);
1010 bset_case_canon_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[1]);
1011 bset_case_eqv_table (b
, XCHAR_TABLE (Vascii_downcase_table
)->extras
[2]);
1012 bset_invisibility_spec (b
, Qt
);
1014 /* Reset all (or most) per-buffer variables to their defaults. */
1016 bset_local_var_alist (b
, Qnil
);
1019 Lisp_Object tmp
, prop
, last
= Qnil
;
1020 for (tmp
= BVAR (b
, local_var_alist
); CONSP (tmp
); tmp
= XCDR (tmp
))
1021 if (!NILP (prop
= Fget (XCAR (XCAR (tmp
)), Qpermanent_local
)))
1023 /* If permanent-local, keep it. */
1025 if (EQ (prop
, Qpermanent_local_hook
))
1027 /* This is a partially permanent hook variable.
1028 Preserve only the elements that want to be preserved. */
1029 Lisp_Object list
, newlist
;
1030 list
= XCDR (XCAR (tmp
));
1034 for (newlist
= Qnil
; CONSP (list
); list
= XCDR (list
))
1036 Lisp_Object elt
= XCAR (list
);
1037 /* Preserve element ELT if it's t,
1038 if it is a function with a `permanent-local-hook' property,
1039 or if it's not a symbol. */
1042 || !NILP (Fget (elt
, Qpermanent_local_hook
)))
1043 newlist
= Fcons (elt
, newlist
);
1045 XSETCDR (XCAR (tmp
), Fnreverse (newlist
));
1048 /* Delete this local variable. */
1049 else if (NILP (last
))
1050 bset_local_var_alist (b
, XCDR (tmp
));
1052 XSETCDR (last
, XCDR (tmp
));
1055 for (i
= 0; i
< last_per_buffer_idx
; ++i
)
1056 if (permanent_too
|| buffer_permanent_local_flags
[i
] == 0)
1057 SET_PER_BUFFER_VALUE_P (b
, i
, 0);
1059 /* For each slot that has a default value, copy that into the slot. */
1060 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1062 int idx
= PER_BUFFER_IDX (offset
);
1065 || buffer_permanent_local_flags
[idx
] == 0)))
1066 set_per_buffer_value (b
, offset
, per_buffer_default (offset
));
1070 /* We split this away from generate-new-buffer, because rename-buffer
1071 and set-visited-file-name ought to be able to use this to really
1072 rename the buffer properly. */
1074 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name
,
1075 Sgenerate_new_buffer_name
, 1, 2, 0,
1076 doc
: /* Return a string that is the name of no existing buffer based on NAME.
1077 If there is no live buffer named NAME, then return NAME.
1078 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
1079 \(starting at 2) until an unused name is found, and then return that name.
1080 Optional second argument IGNORE specifies a name that is okay to use (if
1081 it is in the sequence to be tried) even if a buffer with that name exists.
1083 If NAME begins with a space (i.e., a buffer that is not normally
1084 visible to users), then if buffer NAME already exists a random number
1085 is first appended to NAME, to speed up finding a non-existent buffer. */)
1086 (register Lisp_Object name
, Lisp_Object ignore
)
1088 register Lisp_Object gentemp
, tem
, tem2
;
1090 char number
[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
1092 CHECK_STRING (name
);
1094 tem
= Fstring_equal (name
, ignore
);
1097 tem
= Fget_buffer (name
);
1101 if (!strncmp (SSDATA (name
), " ", 1)) /* see bug#1229 */
1103 /* Note fileio.c:make_temp_name does random differently. */
1104 tem2
= concat2 (name
, make_formatted_string
1106 XFASTINT (Frandom (make_number (999999)))));
1107 tem
= Fget_buffer (tem2
);
1117 gentemp
= concat2 (tem2
, make_formatted_string
1118 (number
, "<%"pD
"d>", ++count
));
1119 tem
= Fstring_equal (gentemp
, ignore
);
1122 tem
= Fget_buffer (gentemp
);
1129 DEFUN ("buffer-name", Fbuffer_name
, Sbuffer_name
, 0, 1, 0,
1130 doc
: /* Return the name of BUFFER, as a string.
1131 BUFFER defaults to the current buffer.
1132 Return nil if BUFFER has been killed. */)
1133 (register Lisp_Object buffer
)
1136 return BVAR (current_buffer
, name
);
1137 CHECK_BUFFER (buffer
);
1138 return BVAR (XBUFFER (buffer
), name
);
1141 DEFUN ("buffer-file-name", Fbuffer_file_name
, Sbuffer_file_name
, 0, 1, 0,
1142 doc
: /* Return name of file BUFFER is visiting, or nil if none.
1143 No argument or nil as argument means use the current buffer. */)
1144 (register Lisp_Object buffer
)
1147 return BVAR (current_buffer
, filename
);
1148 CHECK_BUFFER (buffer
);
1149 return BVAR (XBUFFER (buffer
), filename
);
1152 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer
, Sbuffer_base_buffer
,
1154 doc
: /* Return the base buffer of indirect buffer BUFFER.
1155 If BUFFER is not indirect, return nil.
1156 BUFFER defaults to the current buffer. */)
1157 (register Lisp_Object buffer
)
1159 struct buffer
*base
;
1160 Lisp_Object base_buffer
;
1163 base
= current_buffer
->base_buffer
;
1166 CHECK_BUFFER (buffer
);
1167 base
= XBUFFER (buffer
)->base_buffer
;
1172 XSETBUFFER (base_buffer
, base
);
1176 DEFUN ("buffer-local-value", Fbuffer_local_value
,
1177 Sbuffer_local_value
, 2, 2, 0,
1178 doc
: /* Return the value of VARIABLE in BUFFER.
1179 If VARIABLE does not have a buffer-local binding in BUFFER, the value
1180 is the default binding of the variable. */)
1181 (register Lisp_Object variable
, register Lisp_Object buffer
)
1183 register Lisp_Object result
= buffer_local_value_1 (variable
, buffer
);
1185 if (EQ (result
, Qunbound
))
1186 xsignal1 (Qvoid_variable
, variable
);
1192 /* Like Fbuffer_local_value, but return Qunbound if the variable is
1196 buffer_local_value_1 (Lisp_Object variable
, Lisp_Object buffer
)
1198 register struct buffer
*buf
;
1199 register Lisp_Object result
;
1200 struct Lisp_Symbol
*sym
;
1202 CHECK_SYMBOL (variable
);
1203 CHECK_BUFFER (buffer
);
1204 buf
= XBUFFER (buffer
);
1205 sym
= XSYMBOL (variable
);
1208 switch (sym
->redirect
)
1210 case SYMBOL_VARALIAS
: sym
= indirect_variable (sym
); goto start
;
1211 case SYMBOL_PLAINVAL
: result
= SYMBOL_VAL (sym
); break;
1212 case SYMBOL_LOCALIZED
:
1213 { /* Look in local_var_alist. */
1214 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (sym
);
1215 XSETSYMBOL (variable
, sym
); /* Update In case of aliasing. */
1216 result
= Fassoc (variable
, BVAR (buf
, local_var_alist
));
1220 { /* What binding is loaded right now? */
1221 Lisp_Object current_alist_element
= blv
->valcell
;
1223 /* The value of the currently loaded binding is not
1224 stored in it, but rather in the realvalue slot.
1225 Store that value into the binding it belongs to
1226 in case that is the one we are about to use. */
1228 XSETCDR (current_alist_element
,
1229 do_symval_forwarding (blv
->fwd
));
1231 /* Now get the (perhaps updated) value out of the binding. */
1232 result
= XCDR (result
);
1235 result
= Fdefault_value (variable
);
1238 case SYMBOL_FORWARDED
:
1240 union Lisp_Fwd
*fwd
= SYMBOL_FWD (sym
);
1241 if (BUFFER_OBJFWDP (fwd
))
1242 result
= per_buffer_value (buf
, XBUFFER_OBJFWD (fwd
)->offset
);
1244 result
= Fdefault_value (variable
);
1253 /* Return an alist of the Lisp-level buffer-local bindings of
1254 buffer BUF. That is, don't include the variables maintained
1255 in special slots in the buffer object.
1256 If CLONE is zero elements of the form (VAR . unbound) are replaced
1260 buffer_lisp_local_variables (struct buffer
*buf
, int clone
)
1262 Lisp_Object result
= Qnil
;
1263 register Lisp_Object tail
;
1264 for (tail
= BVAR (buf
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
1266 Lisp_Object val
, elt
;
1270 /* Reference each variable in the alist in buf.
1271 If inquiring about the current buffer, this gets the current values,
1272 so store them into the alist so the alist is up to date.
1273 If inquiring about some other buffer, this swaps out any values
1274 for that buffer, making the alist up to date automatically. */
1275 val
= find_symbol_value (XCAR (elt
));
1276 /* Use the current buffer value only if buf is the current buffer. */
1277 if (buf
!= current_buffer
)
1280 result
= Fcons (!clone
&& EQ (val
, Qunbound
)
1282 : Fcons (XCAR (elt
), val
),
1289 DEFUN ("buffer-local-variables", Fbuffer_local_variables
,
1290 Sbuffer_local_variables
, 0, 1, 0,
1291 doc
: /* Return an alist of variables that are buffer-local in BUFFER.
1292 Most elements look like (SYMBOL . VALUE), describing one variable.
1293 For a symbol that is locally unbound, just the symbol appears in the value.
1294 Note that storing new VALUEs in these elements doesn't change the variables.
1295 No argument or nil as argument means use current buffer as BUFFER. */)
1296 (register Lisp_Object buffer
)
1298 register struct buffer
*buf
;
1299 register Lisp_Object result
;
1302 buf
= current_buffer
;
1305 CHECK_BUFFER (buffer
);
1306 buf
= XBUFFER (buffer
);
1309 result
= buffer_lisp_local_variables (buf
, 0);
1311 /* Add on all the variables stored in special slots. */
1315 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1317 idx
= PER_BUFFER_IDX (offset
);
1318 if ((idx
== -1 || PER_BUFFER_VALUE_P (buf
, idx
))
1319 && SYMBOLP (PER_BUFFER_SYMBOL (offset
)))
1321 Lisp_Object sym
= PER_BUFFER_SYMBOL (offset
);
1322 Lisp_Object val
= per_buffer_value (buf
, offset
);
1323 result
= Fcons (EQ (val
, Qunbound
) ? sym
: Fcons (sym
, val
),
1332 DEFUN ("buffer-modified-p", Fbuffer_modified_p
, Sbuffer_modified_p
,
1334 doc
: /* Return t if BUFFER was modified since its file was last read or saved.
1335 No argument or nil as argument means use current buffer as BUFFER. */)
1336 (register Lisp_Object buffer
)
1338 register struct buffer
*buf
;
1340 buf
= current_buffer
;
1343 CHECK_BUFFER (buffer
);
1344 buf
= XBUFFER (buffer
);
1347 return BUF_SAVE_MODIFF (buf
) < BUF_MODIFF (buf
) ? Qt
: Qnil
;
1350 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p
, Sset_buffer_modified_p
,
1352 doc
: /* Mark current buffer as modified or unmodified according to FLAG.
1353 A non-nil FLAG means mark the buffer modified. */)
1354 (register Lisp_Object flag
)
1356 register int already
;
1357 register Lisp_Object fn
;
1358 Lisp_Object buffer
, window
;
1360 #ifdef CLASH_DETECTION
1361 /* If buffer becoming modified, lock the file.
1362 If buffer becoming unmodified, unlock the file. */
1364 fn
= BVAR (current_buffer
, file_truename
);
1365 /* Test buffer-file-name so that binding it to nil is effective. */
1366 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1368 already
= SAVE_MODIFF
< MODIFF
;
1369 if (!already
&& !NILP (flag
))
1371 else if (already
&& NILP (flag
))
1374 #endif /* CLASH_DETECTION */
1376 /* Here we have a problem. SAVE_MODIFF is used here to encode
1377 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1378 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1379 modify SAVE_MODIFF to affect one, we may affect the other
1381 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1382 if SAVE_MODIFF<auto_save_modified that means we risk changing
1383 recent-auto-save-p from t to nil.
1384 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1385 we risk changing recent-auto-save-p from nil to t. */
1386 SAVE_MODIFF
= (NILP (flag
)
1387 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1389 /* Let's try to preserve recent-auto-save-p. */
1390 : SAVE_MODIFF
< MODIFF
? SAVE_MODIFF
1391 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1392 we can either decrease SAVE_MODIFF and auto_save_modified
1393 or increase MODIFF. */
1396 /* Set update_mode_lines only if buffer is displayed in some window.
1397 Packages like jit-lock or lazy-lock preserve a buffer's modified
1398 state by recording/restoring the state around blocks of code.
1399 Setting update_mode_lines makes redisplay consider all windows
1400 (on all frames). Stealth fontification of buffers not displayed
1401 would incur additional redisplay costs if we'd set
1402 update_modes_lines unconditionally.
1404 Ideally, I think there should be another mechanism for fontifying
1405 buffers without "modifying" buffers, or redisplay should be
1406 smarter about updating the `*' in mode lines. --gerd */
1407 XSETBUFFER (buffer
, current_buffer
);
1408 window
= Fget_buffer_window (buffer
, Qt
);
1409 if (WINDOWP (window
))
1411 ++update_mode_lines
;
1412 current_buffer
->prevent_redisplay_optimizations_p
= 1;
1418 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p
,
1419 Srestore_buffer_modified_p
, 1, 1, 0,
1420 doc
: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1421 It is not ensured that mode lines will be updated to show the modified
1422 state of the current buffer. Use with care. */)
1425 #ifdef CLASH_DETECTION
1428 /* If buffer becoming modified, lock the file.
1429 If buffer becoming unmodified, unlock the file. */
1431 fn
= BVAR (current_buffer
, file_truename
);
1432 /* Test buffer-file-name so that binding it to nil is effective. */
1433 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1435 int already
= SAVE_MODIFF
< MODIFF
;
1436 if (!already
&& !NILP (flag
))
1438 else if (already
&& NILP (flag
))
1441 #endif /* CLASH_DETECTION */
1443 SAVE_MODIFF
= NILP (flag
) ? MODIFF
: 0;
1447 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick
, Sbuffer_modified_tick
,
1449 doc
: /* Return BUFFER's tick counter, incremented for each change in text.
1450 Each buffer has a tick counter which is incremented each time the
1451 text in that buffer is changed. It wraps around occasionally.
1452 No argument or nil as argument means use current buffer as BUFFER. */)
1453 (register Lisp_Object buffer
)
1455 register struct buffer
*buf
;
1457 buf
= current_buffer
;
1460 CHECK_BUFFER (buffer
);
1461 buf
= XBUFFER (buffer
);
1464 return make_number (BUF_MODIFF (buf
));
1467 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick
,
1468 Sbuffer_chars_modified_tick
, 0, 1, 0,
1469 doc
: /* Return BUFFER's character-change tick counter.
1470 Each buffer has a character-change tick counter, which is set to the
1471 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1472 time text in that buffer is inserted or deleted. By comparing the
1473 values returned by two individual calls of `buffer-chars-modified-tick',
1474 you can tell whether a character change occurred in that buffer in
1475 between these calls. No argument or nil as argument means use current
1476 buffer as BUFFER. */)
1477 (register Lisp_Object buffer
)
1479 register struct buffer
*buf
;
1481 buf
= current_buffer
;
1484 CHECK_BUFFER (buffer
);
1485 buf
= XBUFFER (buffer
);
1488 return make_number (BUF_CHARS_MODIFF (buf
));
1491 DEFUN ("rename-buffer", Frename_buffer
, Srename_buffer
, 1, 2,
1492 "(list (read-string \"Rename buffer (to new name): \" \
1493 nil 'buffer-name-history (buffer-name (current-buffer))) \
1494 current-prefix-arg)",
1495 doc
: /* Change current buffer's name to NEWNAME (a string).
1496 If second arg UNIQUE is nil or omitted, it is an error if a
1497 buffer named NEWNAME already exists.
1498 If UNIQUE is non-nil, come up with a new name using
1499 `generate-new-buffer-name'.
1500 Interactively, you can set UNIQUE with a prefix argument.
1501 We return the name we actually gave the buffer.
1502 This does not change the name of the visited file (if any). */)
1503 (register Lisp_Object newname
, Lisp_Object unique
)
1505 register Lisp_Object tem
, buf
;
1507 CHECK_STRING (newname
);
1509 if (SCHARS (newname
) == 0)
1510 error ("Empty string is invalid as a buffer name");
1512 tem
= Fget_buffer (newname
);
1515 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1516 rename the buffer automatically so you can create another
1517 with the original name. It makes UNIQUE equivalent to
1518 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1519 if (NILP (unique
) && XBUFFER (tem
) == current_buffer
)
1520 return BVAR (current_buffer
, name
);
1522 newname
= Fgenerate_new_buffer_name (newname
, BVAR (current_buffer
, name
));
1524 error ("Buffer name `%s' is in use", SDATA (newname
));
1527 bset_name (current_buffer
, newname
);
1529 /* Catch redisplay's attention. Unless we do this, the mode lines for
1530 any windows displaying current_buffer will stay unchanged. */
1531 update_mode_lines
++;
1533 XSETBUFFER (buf
, current_buffer
);
1534 Fsetcar (Frassq (buf
, Vbuffer_alist
), newname
);
1535 if (NILP (BVAR (current_buffer
, filename
))
1536 && !NILP (BVAR (current_buffer
, auto_save_file_name
)))
1537 call0 (intern ("rename-auto-save-file"));
1539 /* Run buffer-list-update-hook. */
1540 if (!NILP (Vrun_hooks
))
1541 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1543 /* Refetch since that last call may have done GC. */
1544 return BVAR (current_buffer
, name
);
1547 DEFUN ("other-buffer", Fother_buffer
, Sother_buffer
, 0, 3, 0,
1548 doc
: /* Return most recently selected buffer other than BUFFER.
1549 Buffers not visible in windows are preferred to visible buffers, unless
1550 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1551 BUFFER unless it denotes a live buffer. If the optional third argument
1552 FRAME is non-nil, use that frame's buffer list instead of the selected
1553 frame's buffer list.
1555 The buffer is found by scanning the selected or specified frame's buffer
1556 list first, followed by the list of all buffers. If no other buffer
1557 exists, return the buffer `*scratch*' (creating it if necessary). */)
1558 (register Lisp_Object buffer
, Lisp_Object visible_ok
, Lisp_Object frame
)
1560 Lisp_Object
Fset_buffer_major_mode (Lisp_Object buffer
);
1561 Lisp_Object tail
, buf
, pred
;
1562 Lisp_Object notsogood
= Qnil
;
1565 frame
= selected_frame
;
1567 CHECK_FRAME (frame
);
1569 pred
= frame_buffer_predicate (frame
);
1570 /* Consider buffers that have been seen in the frame first. */
1571 tail
= XFRAME (frame
)->buffer_list
;
1572 for (; CONSP (tail
); tail
= XCDR (tail
))
1575 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1576 && !NILP (BVAR (XBUFFER (buf
), name
))
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 /* Consider alist of all buffers next. */
1591 tail
= Vbuffer_alist
;
1592 for (; CONSP (tail
); tail
= XCDR (tail
))
1594 buf
= Fcdr (XCAR (tail
));
1595 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1596 && !NILP (BVAR (XBUFFER (buf
), name
))
1597 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' ')
1598 /* If the frame has a buffer_predicate, disregard buffers that
1599 don't fit the predicate. */
1600 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1602 if (!NILP (visible_ok
)
1603 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1605 else if (NILP (notsogood
))
1610 if (!NILP (notsogood
))
1614 buf
= Fget_buffer (build_string ("*scratch*"));
1617 buf
= Fget_buffer_create (build_string ("*scratch*"));
1618 Fset_buffer_major_mode (buf
);
1624 /* The following function is a safe variant of Fother_buffer: It doesn't
1625 pay attention to any frame-local buffer lists, doesn't care about
1626 visibility of buffers, and doesn't evaluate any frame predicates. */
1629 other_buffer_safely (Lisp_Object buffer
)
1631 Lisp_Object
Fset_buffer_major_mode (Lisp_Object buffer
);
1632 Lisp_Object tail
, buf
;
1634 tail
= Vbuffer_alist
;
1635 for (; CONSP (tail
); tail
= XCDR (tail
))
1637 buf
= Fcdr (XCAR (tail
));
1638 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1639 && !NILP (BVAR (XBUFFER (buf
), name
))
1640 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' '))
1644 buf
= Fget_buffer (build_string ("*scratch*"));
1647 buf
= Fget_buffer_create (build_string ("*scratch*"));
1648 Fset_buffer_major_mode (buf
);
1654 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo
, Sbuffer_enable_undo
,
1656 doc
: /* Start keeping undo information for buffer BUFFER.
1657 No argument or nil as argument means do this for the current buffer. */)
1658 (register Lisp_Object buffer
)
1660 Lisp_Object real_buffer
;
1663 XSETBUFFER (real_buffer
, current_buffer
);
1666 real_buffer
= Fget_buffer (buffer
);
1667 if (NILP (real_buffer
))
1671 if (EQ (BVAR (XBUFFER (real_buffer
), undo_list
), Qt
))
1672 bset_undo_list (XBUFFER (real_buffer
), Qnil
);
1677 /* Truncate undo list and shrink the gap of BUFFER. */
1680 compact_buffer (struct buffer
*buffer
)
1682 /* Verify indirection counters. */
1683 if (buffer
->base_buffer
)
1685 eassert (buffer
->indirections
== -1);
1686 eassert (buffer
->base_buffer
->indirections
> 0);
1689 eassert (buffer
->indirections
>= 0);
1691 /* Skip dead buffers, indirect buffers and buffers
1692 which aren't changed since last compaction. */
1693 if (!NILP (buffer
->INTERNAL_FIELD (name
))
1694 && (buffer
->base_buffer
== NULL
)
1695 && (buffer
->text
->compact
!= buffer
->text
->modiff
))
1697 /* If a buffer's undo list is Qt, that means that undo is
1698 turned off in that buffer. Calling truncate_undo_list on
1699 Qt tends to return NULL, which effectively turns undo back on.
1700 So don't call truncate_undo_list if undo_list is Qt. */
1701 if (!EQ (buffer
->INTERNAL_FIELD (undo_list
), Qt
))
1702 truncate_undo_list (buffer
);
1704 /* Shrink buffer gaps. */
1705 if (!buffer
->text
->inhibit_shrinking
)
1707 /* If a buffer's gap size is more than 10% of the buffer
1708 size, or larger than 2000 bytes, then shrink it
1709 accordingly. Keep a minimum size of 20 bytes. */
1710 int size
= min (2000, max (20, (buffer
->text
->z_byte
/ 10)));
1712 if (buffer
->text
->gap_size
> size
)
1714 struct buffer
*save_current
= current_buffer
;
1715 current_buffer
= buffer
;
1716 make_gap (-(buffer
->text
->gap_size
- size
));
1717 current_buffer
= save_current
;
1720 buffer
->text
->compact
= buffer
->text
->modiff
;
1726 DEFUN ("kill-buffer", Fkill_buffer
, Skill_buffer
, 0, 1, "bKill buffer: ",
1727 doc
: /* Kill the buffer specified by BUFFER-OR-NAME.
1728 The argument may be a buffer or the name of an existing buffer.
1729 Argument nil or omitted means kill the current buffer. Return t if the
1730 buffer is actually killed, nil otherwise.
1732 The functions in `kill-buffer-query-functions' are called with the
1733 buffer to be killed as the current buffer. If any of them returns nil,
1734 the buffer is not killed. The hook `kill-buffer-hook' is run before the
1735 buffer is actually killed. The buffer being killed will be current
1736 while the hook is running. Functions called by any of these hooks are
1737 supposed to not change the current buffer.
1739 Any processes that have this buffer as the `process-buffer' are killed
1740 with SIGHUP. This function calls `replace-buffer-in-windows' for
1741 cleaning up all windows currently displaying the buffer to be killed. */)
1742 (Lisp_Object buffer_or_name
)
1745 register struct buffer
*b
;
1746 register Lisp_Object tem
;
1747 register struct Lisp_Marker
*m
;
1748 struct gcpro gcpro1
;
1750 if (NILP (buffer_or_name
))
1751 buffer
= Fcurrent_buffer ();
1753 buffer
= Fget_buffer (buffer_or_name
);
1755 nsberror (buffer_or_name
);
1757 b
= XBUFFER (buffer
);
1759 /* Avoid trouble for buffer already dead. */
1760 if (NILP (BVAR (b
, name
)))
1763 /* Query if the buffer is still modified. */
1764 if (INTERACTIVE
&& !NILP (BVAR (b
, filename
))
1765 && BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
1768 tem
= do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1769 BVAR (b
, name
), make_number (0)));
1775 /* Run hooks with the buffer to be killed the current buffer. */
1777 ptrdiff_t count
= SPECPDL_INDEX ();
1778 Lisp_Object arglist
[1];
1780 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1781 set_buffer_internal (b
);
1783 /* First run the query functions; if any query is answered no,
1784 don't kill the buffer. */
1785 arglist
[0] = Qkill_buffer_query_functions
;
1786 tem
= Frun_hook_with_args_until_failure (1, arglist
);
1788 return unbind_to (count
, Qnil
);
1790 /* Then run the hooks. */
1791 Frun_hooks (1, &Qkill_buffer_hook
);
1792 unbind_to (count
, Qnil
);
1795 /* If the hooks have killed the buffer, exit now. */
1796 if (NILP (BVAR (b
, name
)))
1799 /* We have no more questions to ask. Verify that it is valid
1800 to kill the buffer. This must be done after the questions
1801 since anything can happen within do_yes_or_no_p. */
1803 /* Don't kill the minibuffer now current. */
1804 if (EQ (buffer
, XWINDOW (minibuf_window
)->buffer
))
1807 /* When we kill an ordinary buffer which shares it's buffer text
1808 with indirect buffer(s), we must kill indirect buffer(s) too.
1809 We do it at this stage so nothing terrible happens if they
1810 ask questions or their hooks get errors. */
1811 if (!b
->base_buffer
&& b
->indirections
> 0)
1813 struct buffer
*other
;
1817 FOR_EACH_BUFFER (other
)
1818 if (other
->base_buffer
== b
)
1821 XSETBUFFER (buf
, other
);
1827 /* Exit if we now have killed the base buffer (Bug#11665). */
1828 if (NILP (BVAR (b
, name
)))
1832 /* Run replace_buffer_in_windows before making another buffer current
1833 since set-window-buffer-start-and-point will refuse to make another
1834 buffer current if the selected window does not show the current
1835 buffer. (Bug#10114) */
1836 replace_buffer_in_windows (buffer
);
1838 /* Exit if replacing the buffer in windows has killed our buffer. */
1839 if (NILP (BVAR (b
, name
)))
1842 /* Make this buffer not be current. Exit if it is the sole visible
1844 if (b
== current_buffer
)
1846 tem
= Fother_buffer (buffer
, Qnil
, Qnil
);
1848 if (b
== current_buffer
)
1852 /* If the buffer now current is shown in the minibuffer and our buffer
1853 is the sole other buffer give up. */
1854 XSETBUFFER (tem
, current_buffer
);
1855 if (EQ (tem
, XWINDOW (minibuf_window
)->buffer
)
1856 && EQ (buffer
, Fother_buffer (buffer
, Qnil
, Qnil
)))
1859 /* Now there is no question: we can kill the buffer. */
1861 #ifdef CLASH_DETECTION
1862 /* Unlock this buffer's file, if it is locked. */
1864 #endif /* CLASH_DETECTION */
1867 kill_buffer_processes (buffer
);
1870 /* Killing buffer processes may run sentinels which may have killed
1872 if (NILP (BVAR (b
, name
)))
1875 /* These may run Lisp code and into infinite loops (if someone
1876 insisted on circular lists) so allow quitting here. */
1877 frames_discard_buffer (buffer
);
1879 clear_charpos_cache (b
);
1881 tem
= Vinhibit_quit
;
1883 /* Remove the buffer from the list of all buffers. */
1884 Vbuffer_alist
= Fdelq (Frassq (buffer
, Vbuffer_alist
), Vbuffer_alist
);
1885 /* If replace_buffer_in_windows didn't do its job fix that now. */
1886 replace_buffer_in_windows_safely (buffer
);
1887 Vinhibit_quit
= tem
;
1889 /* Delete any auto-save file, if we saved it in this session.
1890 But not if the buffer is modified. */
1891 if (STRINGP (BVAR (b
, auto_save_file_name
))
1892 && BUF_AUTOSAVE_MODIFF (b
) != 0
1893 && BUF_SAVE_MODIFF (b
) < BUF_AUTOSAVE_MODIFF (b
)
1894 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
1895 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1898 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1899 if (! NILP (delete))
1900 internal_delete_file (BVAR (b
, auto_save_file_name
));
1903 /* Deleting an auto-save file could have killed our buffer. */
1904 if (NILP (BVAR (b
, name
)))
1909 /* Unchain all markers that belong to this indirect buffer.
1910 Don't unchain the markers that belong to the base buffer
1911 or its other indirect buffers. */
1912 for (m
= BUF_MARKERS (b
); m
; )
1914 struct Lisp_Marker
*next
= m
->next
;
1922 /* Unchain all markers of this buffer and its indirect buffers.
1923 and leave them pointing nowhere. */
1924 for (m
= BUF_MARKERS (b
); m
; )
1926 struct Lisp_Marker
*next
= m
->next
;
1931 BUF_MARKERS (b
) = NULL
;
1932 set_buffer_intervals (b
, NULL
);
1934 /* Perhaps we should explicitly free the interval tree here... */
1937 /* Reset the local variables, so that this buffer's local values
1938 won't be protected from GC. They would be protected
1939 if they happened to remain cached in their symbols.
1940 This gets rid of them for certain. */
1941 swap_out_buffer_local_variables (b
);
1942 reset_buffer_local_variables (b
, 1);
1944 bset_name (b
, Qnil
);
1949 /* Notify our base buffer that we don't share the text anymore. */
1950 eassert (b
->indirections
== -1);
1951 b
->base_buffer
->indirections
--;
1952 eassert (b
->base_buffer
->indirections
>= 0);
1955 /* No one shares our buffer text, can free it. */
1956 free_buffer_text (b
);
1958 if (b
->newline_cache
)
1960 free_region_cache (b
->newline_cache
);
1961 b
->newline_cache
= 0;
1963 if (b
->width_run_cache
)
1965 free_region_cache (b
->width_run_cache
);
1966 b
->width_run_cache
= 0;
1968 bset_width_table (b
, Qnil
);
1970 bset_undo_list (b
, Qnil
);
1972 /* Run buffer-list-update-hook. */
1973 if (!NILP (Vrun_hooks
))
1974 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1979 /* Move association for BUFFER to the front of buffer (a)lists. Since
1980 we do this each time BUFFER is selected visibly, the more recently
1981 selected buffers are always closer to the front of those lists. This
1982 means that other_buffer is more likely to choose a relevant buffer.
1984 Note that this moves BUFFER to the front of the buffer lists of the
1985 selected frame even if BUFFER is not shown there. If BUFFER is not
1986 shown in the selected frame, consider the present behavior a feature.
1987 `select-window' gets this right since it shows BUFFER in the selected
1988 window when calling us. */
1991 record_buffer (Lisp_Object buffer
)
1993 Lisp_Object aelt
, aelt_cons
, tem
;
1994 register struct frame
*f
= XFRAME (selected_frame
);
1996 CHECK_BUFFER (buffer
);
1998 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1999 Don't allow quitting since this might leave the buffer list in an
2000 inconsistent state. */
2001 tem
= Vinhibit_quit
;
2003 aelt
= Frassq (buffer
, Vbuffer_alist
);
2004 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
2005 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
2006 XSETCDR (aelt_cons
, Vbuffer_alist
);
2007 Vbuffer_alist
= aelt_cons
;
2008 Vinhibit_quit
= tem
;
2010 /* Update buffer list of selected frame. */
2011 fset_buffer_list (f
, Fcons (buffer
, Fdelq (buffer
, f
->buffer_list
)));
2012 fset_buried_buffer_list (f
, Fdelq (buffer
, f
->buried_buffer_list
));
2014 /* Run buffer-list-update-hook. */
2015 if (!NILP (Vrun_hooks
))
2016 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
2020 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
2021 buffer is killed. For the selected frame's buffer list this moves
2022 BUFFER to its end even if it was never shown in that frame. If
2023 this happens we have a feature, hence `bury-buffer-internal' should be
2024 called only when BUFFER was shown in the selected frame. */
2026 DEFUN ("bury-buffer-internal", Fbury_buffer_internal
, Sbury_buffer_internal
,
2028 doc
: /* Move BUFFER to the end of the buffer list. */)
2029 (Lisp_Object buffer
)
2031 Lisp_Object aelt
, aelt_cons
, tem
;
2032 register struct frame
*f
= XFRAME (selected_frame
);
2034 CHECK_BUFFER (buffer
);
2036 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
2037 Don't allow quitting since this might leave the buffer list in an
2038 inconsistent state. */
2039 tem
= Vinhibit_quit
;
2041 aelt
= Frassq (buffer
, Vbuffer_alist
);
2042 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
2043 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
2044 XSETCDR (aelt_cons
, Qnil
);
2045 Vbuffer_alist
= nconc2 (Vbuffer_alist
, aelt_cons
);
2046 Vinhibit_quit
= tem
;
2048 /* Update buffer lists of selected frame. */
2049 fset_buffer_list (f
, Fdelq (buffer
, f
->buffer_list
));
2050 fset_buried_buffer_list
2051 (f
, Fcons (buffer
, Fdelq (buffer
, f
->buried_buffer_list
)));
2053 /* Run buffer-list-update-hook. */
2054 if (!NILP (Vrun_hooks
))
2055 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
2060 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode
, Sset_buffer_major_mode
, 1, 1, 0,
2061 doc
: /* Set an appropriate major mode for BUFFER.
2062 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
2063 according to `default-major-mode'.
2064 Use this function before selecting the buffer, since it may need to inspect
2065 the current buffer's major mode. */)
2066 (Lisp_Object buffer
)
2069 Lisp_Object function
;
2071 CHECK_BUFFER (buffer
);
2073 if (STRINGP (BVAR (XBUFFER (buffer
), name
))
2074 && strcmp (SSDATA (BVAR (XBUFFER (buffer
), name
)), "*scratch*") == 0)
2075 function
= find_symbol_value (intern ("initial-major-mode"));
2078 function
= BVAR (&buffer_defaults
, major_mode
);
2080 && NILP (Fget (BVAR (current_buffer
, major_mode
), Qmode_class
)))
2081 function
= BVAR (current_buffer
, major_mode
);
2084 if (NILP (function
) || EQ (function
, Qfundamental_mode
))
2087 count
= SPECPDL_INDEX ();
2089 /* To select a nonfundamental mode,
2090 select the buffer temporarily and then call the mode function. */
2092 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
2094 Fset_buffer (buffer
);
2097 return unbind_to (count
, Qnil
);
2100 DEFUN ("current-buffer", Fcurrent_buffer
, Scurrent_buffer
, 0, 0, 0,
2101 doc
: /* Return the current buffer as a Lisp object. */)
2104 register Lisp_Object buf
;
2105 XSETBUFFER (buf
, current_buffer
);
2109 /* Set the current buffer to B.
2111 We previously set windows_or_buffers_changed here to invalidate
2112 global unchanged information in beg_unchanged and end_unchanged.
2113 This is no longer necessary because we now compute unchanged
2114 information on a buffer-basis. Every action affecting other
2115 windows than the selected one requires a select_window at some
2116 time, and that increments windows_or_buffers_changed. */
2119 set_buffer_internal (register struct buffer
*b
)
2121 if (current_buffer
!= b
)
2122 set_buffer_internal_1 (b
);
2125 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
2126 This is used by redisplay. */
2129 set_buffer_internal_1 (register struct buffer
*b
)
2131 register struct buffer
*old_buf
;
2132 register Lisp_Object tail
;
2134 #ifdef USE_MMAP_FOR_BUFFERS
2135 if (b
->text
->beg
== NULL
)
2136 enlarge_buffer_text (b
, 0);
2137 #endif /* USE_MMAP_FOR_BUFFERS */
2139 if (current_buffer
== b
)
2142 old_buf
= current_buffer
;
2144 last_known_column_point
= -1; /* invalidate indentation cache */
2148 /* Put the undo list back in the base buffer, so that it appears
2149 that an indirect buffer shares the undo list of its base. */
2150 if (old_buf
->base_buffer
)
2151 bset_undo_list (old_buf
->base_buffer
, BVAR (old_buf
, undo_list
));
2153 /* If the old current buffer has markers to record PT, BEGV and ZV
2154 when it is not current, update them now. */
2155 record_buffer_markers (old_buf
);
2158 /* Get the undo list from the base buffer, so that it appears
2159 that an indirect buffer shares the undo list of its base. */
2161 bset_undo_list (b
, BVAR (b
->base_buffer
, undo_list
));
2163 /* If the new current buffer has markers to record PT, BEGV and ZV
2164 when it is not current, fetch them now. */
2165 fetch_buffer_markers (b
);
2167 /* Look down buffer's list of local Lisp variables
2168 to find and update any that forward into C variables. */
2172 for (tail
= BVAR (b
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
2174 Lisp_Object var
= XCAR (XCAR (tail
));
2175 struct Lisp_Symbol
*sym
= XSYMBOL (var
);
2176 if (sym
->redirect
== SYMBOL_LOCALIZED
/* Just to be sure. */
2177 && SYMBOL_BLV (sym
)->fwd
)
2178 /* Just reference the variable
2179 to cause it to become set for this buffer. */
2180 Fsymbol_value (var
);
2183 /* Do the same with any others that were local to the previous buffer */
2184 while (b
!= old_buf
&& (b
= old_buf
, b
));
2187 /* Switch to buffer B temporarily for redisplay purposes.
2188 This avoids certain things that don't need to be done within redisplay. */
2191 set_buffer_temp (struct buffer
*b
)
2193 register struct buffer
*old_buf
;
2195 if (current_buffer
== b
)
2198 old_buf
= current_buffer
;
2201 /* If the old current buffer has markers to record PT, BEGV and ZV
2202 when it is not current, update them now. */
2203 record_buffer_markers (old_buf
);
2205 /* If the new current buffer has markers to record PT, BEGV and ZV
2206 when it is not current, fetch them now. */
2207 fetch_buffer_markers (b
);
2210 DEFUN ("set-buffer", Fset_buffer
, Sset_buffer
, 1, 1, 0,
2211 doc
: /* Make buffer BUFFER-OR-NAME current for editing operations.
2212 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
2213 also `save-excursion' when you want to make a buffer current
2214 temporarily. This function does not display the buffer, so its effect
2215 ends when the current command terminates. Use `switch-to-buffer' or
2216 `pop-to-buffer' to switch buffers permanently. */)
2217 (register Lisp_Object buffer_or_name
)
2219 register Lisp_Object buffer
;
2220 buffer
= Fget_buffer (buffer_or_name
);
2222 nsberror (buffer_or_name
);
2223 if (NILP (BVAR (XBUFFER (buffer
), name
)))
2224 error ("Selecting deleted buffer");
2225 set_buffer_internal (XBUFFER (buffer
));
2229 /* Set the current buffer to BUFFER provided it is alive. */
2232 set_buffer_if_live (Lisp_Object buffer
)
2234 if (! NILP (BVAR (XBUFFER (buffer
), name
)))
2235 Fset_buffer (buffer
);
2239 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only
,
2240 Sbarf_if_buffer_read_only
, 0, 0, 0,
2241 doc
: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2244 if (!NILP (BVAR (current_buffer
, read_only
))
2245 && NILP (Vinhibit_read_only
))
2246 xsignal1 (Qbuffer_read_only
, Fcurrent_buffer ());
2250 DEFUN ("erase-buffer", Ferase_buffer
, Serase_buffer
, 0, 0, "*",
2251 doc
: /* Delete the entire contents of the current buffer.
2252 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2253 so the buffer is truly empty after this. */)
2260 current_buffer
->last_window_start
= 1;
2261 /* Prevent warnings, or suspension of auto saving, that would happen
2262 if future size is less than past size. Use of erase-buffer
2263 implies that the future text is not really related to the past text. */
2264 XSETFASTINT (BVAR (current_buffer
, save_length
), 0);
2269 validate_region (register Lisp_Object
*b
, register Lisp_Object
*e
)
2271 CHECK_NUMBER_COERCE_MARKER (*b
);
2272 CHECK_NUMBER_COERCE_MARKER (*e
);
2274 if (XINT (*b
) > XINT (*e
))
2277 tem
= *b
; *b
= *e
; *e
= tem
;
2280 if (! (BEGV
<= XINT (*b
) && XINT (*e
) <= ZV
))
2281 args_out_of_range (*b
, *e
);
2284 /* Advance BYTE_POS up to a character boundary
2285 and return the adjusted position. */
2288 advance_to_char_boundary (ptrdiff_t byte_pos
)
2292 if (byte_pos
== BEG
)
2293 /* Beginning of buffer is always a character boundary. */
2296 c
= FETCH_BYTE (byte_pos
);
2297 if (! CHAR_HEAD_P (c
))
2299 /* We should advance BYTE_POS only when C is a constituent of a
2300 multibyte sequence. */
2301 ptrdiff_t orig_byte_pos
= byte_pos
;
2306 c
= FETCH_BYTE (byte_pos
);
2308 while (! CHAR_HEAD_P (c
) && byte_pos
> BEG
);
2310 if (byte_pos
< orig_byte_pos
)
2311 byte_pos
= orig_byte_pos
;
2312 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2313 surely advance to the correct character boundary. If C is
2314 not, BYTE_POS was unchanged. */
2320 DEFUN ("buffer-swap-text", Fbuffer_swap_text
, Sbuffer_swap_text
,
2322 doc
: /* Swap the text between current buffer and BUFFER. */)
2323 (Lisp_Object buffer
)
2325 struct buffer
*other_buffer
;
2326 CHECK_BUFFER (buffer
);
2327 other_buffer
= XBUFFER (buffer
);
2329 if (NILP (BVAR (other_buffer
, name
)))
2330 error ("Cannot swap a dead buffer's text");
2332 /* Actually, it probably works just fine.
2333 * if (other_buffer == current_buffer)
2334 * error ("Cannot swap a buffer's text with itself"); */
2336 /* Actually, this may be workable as well, tho probably only if they're
2338 if (other_buffer
->base_buffer
2339 || current_buffer
->base_buffer
)
2340 error ("Cannot swap indirect buffers's text");
2342 { /* This is probably harder to make work. */
2343 struct buffer
*other
;
2344 FOR_EACH_BUFFER (other
)
2345 if (other
->base_buffer
== other_buffer
2346 || other
->base_buffer
== current_buffer
)
2347 error ("One of the buffers to swap has indirect buffers");
2350 #define swapfield(field, type) \
2352 type tmp##field = other_buffer->field; \
2353 other_buffer->field = current_buffer->field; \
2354 current_buffer->field = tmp##field; \
2356 #define swapfield_(field, type) \
2358 type tmp##field = BVAR (other_buffer, field); \
2359 bset_##field (other_buffer, BVAR (current_buffer, field)); \
2360 bset_##field (current_buffer, tmp##field); \
2363 swapfield (own_text
, struct buffer_text
);
2364 eassert (current_buffer
->text
== ¤t_buffer
->own_text
);
2365 eassert (other_buffer
->text
== &other_buffer
->own_text
);
2367 r_alloc_reset_variable ((void **) ¤t_buffer
->own_text
.beg
,
2368 (void **) &other_buffer
->own_text
.beg
);
2369 r_alloc_reset_variable ((void **) &other_buffer
->own_text
.beg
,
2370 (void **) ¤t_buffer
->own_text
.beg
);
2371 #endif /* REL_ALLOC */
2373 swapfield (pt
, ptrdiff_t);
2374 swapfield (pt_byte
, ptrdiff_t);
2375 swapfield (begv
, ptrdiff_t);
2376 swapfield (begv_byte
, ptrdiff_t);
2377 swapfield (zv
, ptrdiff_t);
2378 swapfield (zv_byte
, ptrdiff_t);
2379 eassert (!current_buffer
->base_buffer
);
2380 eassert (!other_buffer
->base_buffer
);
2381 swapfield (indirections
, ptrdiff_t);
2382 current_buffer
->clip_changed
= 1; other_buffer
->clip_changed
= 1;
2383 swapfield (newline_cache
, struct region_cache
*);
2384 swapfield (width_run_cache
, struct region_cache
*);
2385 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2386 other_buffer
->prevent_redisplay_optimizations_p
= 1;
2387 swapfield (overlays_before
, struct Lisp_Overlay
*);
2388 swapfield (overlays_after
, struct Lisp_Overlay
*);
2389 swapfield (overlay_center
, ptrdiff_t);
2390 swapfield_ (undo_list
, Lisp_Object
);
2391 swapfield_ (mark
, Lisp_Object
);
2392 swapfield_ (enable_multibyte_characters
, Lisp_Object
);
2393 swapfield_ (bidi_display_reordering
, Lisp_Object
);
2394 swapfield_ (bidi_paragraph_direction
, Lisp_Object
);
2395 /* FIXME: Not sure what we should do with these *_marker fields.
2396 Hopefully they're just nil anyway. */
2397 swapfield_ (pt_marker
, Lisp_Object
);
2398 swapfield_ (begv_marker
, Lisp_Object
);
2399 swapfield_ (zv_marker
, Lisp_Object
);
2400 bset_point_before_scroll (current_buffer
, Qnil
);
2401 bset_point_before_scroll (other_buffer
, Qnil
);
2403 current_buffer
->text
->modiff
++; other_buffer
->text
->modiff
++;
2404 current_buffer
->text
->chars_modiff
++; other_buffer
->text
->chars_modiff
++;
2405 current_buffer
->text
->overlay_modiff
++; other_buffer
->text
->overlay_modiff
++;
2406 current_buffer
->text
->beg_unchanged
= current_buffer
->text
->gpt
;
2407 current_buffer
->text
->end_unchanged
= current_buffer
->text
->gpt
;
2408 other_buffer
->text
->beg_unchanged
= other_buffer
->text
->gpt
;
2409 other_buffer
->text
->end_unchanged
= other_buffer
->text
->gpt
;
2411 struct Lisp_Marker
*m
;
2412 for (m
= BUF_MARKERS (current_buffer
); m
; m
= m
->next
)
2413 if (m
->buffer
== other_buffer
)
2414 m
->buffer
= current_buffer
;
2416 /* Since there's no indirect buffer in sight, markers on
2417 BUF_MARKERS(buf) should either be for `buf' or dead. */
2418 eassert (!m
->buffer
);
2419 for (m
= BUF_MARKERS (other_buffer
); m
; m
= m
->next
)
2420 if (m
->buffer
== current_buffer
)
2421 m
->buffer
= other_buffer
;
2423 /* Since there's no indirect buffer in sight, markers on
2424 BUF_MARKERS(buf) should either be for `buf' or dead. */
2425 eassert (!m
->buffer
);
2427 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2428 So since we just swapped the markers between the two buffers, we need
2429 to undo the effect of this swap for window markers. */
2430 Lisp_Object w
= Fselected_window (), ws
= Qnil
;
2431 Lisp_Object buf1
, buf2
;
2432 XSETBUFFER (buf1
, current_buffer
); XSETBUFFER (buf2
, other_buffer
);
2434 while (NILP (Fmemq (w
, ws
)))
2437 if (MARKERP (XWINDOW (w
)->pointm
)
2438 && (EQ (XWINDOW (w
)->buffer
, buf1
)
2439 || EQ (XWINDOW (w
)->buffer
, buf2
)))
2440 Fset_marker (XWINDOW (w
)->pointm
,
2442 (BUF_BEGV (XBUFFER (XWINDOW (w
)->buffer
))),
2443 XWINDOW (w
)->buffer
);
2444 w
= Fnext_window (w
, Qt
, Qt
);
2448 if (current_buffer
->text
->intervals
)
2449 (eassert (EQ (current_buffer
->text
->intervals
->up
.obj
, buffer
)),
2450 XSETBUFFER (current_buffer
->text
->intervals
->up
.obj
, current_buffer
));
2451 if (other_buffer
->text
->intervals
)
2452 (eassert (EQ (other_buffer
->text
->intervals
->up
.obj
, Fcurrent_buffer ())),
2453 XSETBUFFER (other_buffer
->text
->intervals
->up
.obj
, other_buffer
));
2458 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte
, Sset_buffer_multibyte
,
2460 doc
: /* Set the multibyte flag of the current buffer to FLAG.
2461 If FLAG is t, this makes the buffer a multibyte buffer.
2462 If FLAG is nil, this makes the buffer a single-byte buffer.
2463 In these cases, the buffer contents remain unchanged as a sequence of
2464 bytes but the contents viewed as characters do change.
2465 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2466 all eight-bit bytes to eight-bit characters.
2467 If the multibyte flag was really changed, undo information of the
2468 current buffer is cleared. */)
2471 struct Lisp_Marker
*tail
, *markers
;
2472 struct buffer
*other
;
2474 int narrowed
= (BEG
!= BEGV
|| Z
!= ZV
);
2475 int modified_p
= !NILP (Fbuffer_modified_p (Qnil
));
2476 Lisp_Object old_undo
= BVAR (current_buffer
, undo_list
);
2477 struct gcpro gcpro1
;
2479 if (current_buffer
->base_buffer
)
2480 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2482 /* Do nothing if nothing actually changes. */
2483 if (NILP (flag
) == NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2488 /* Don't record these buffer changes. We will put a special undo entry
2490 bset_undo_list (current_buffer
, Qt
);
2492 /* If the cached position is for this buffer, clear it out. */
2493 clear_charpos_cache (current_buffer
);
2496 begv
= BEGV_BYTE
, zv
= ZV_BYTE
;
2498 begv
= BEGV
, zv
= ZV
;
2505 ptrdiff_t pos
, stop
;
2508 /* Do this first, so it can use CHAR_TO_BYTE
2509 to calculate the old correspondences. */
2510 set_intervals_multibyte (0);
2512 bset_enable_multibyte_characters (current_buffer
, Qnil
);
2518 TEMP_SET_PT_BOTH (PT_BYTE
, PT_BYTE
);
2521 for (tail
= BUF_MARKERS (current_buffer
); tail
; tail
= tail
->next
)
2522 tail
->charpos
= tail
->bytepos
;
2524 /* Convert multibyte form of 8-bit characters to unibyte. */
2539 if (ASCII_BYTE_P (*p
))
2541 else if (CHAR_BYTE8_HEAD_P (*p
))
2543 c
= STRING_CHAR_AND_LENGTH (p
, bytes
);
2544 /* Delete all bytes for this 8-bit character but the
2545 last one, and change the last one to the character
2548 del_range_2 (pos
, pos
, pos
+ bytes
, pos
+ bytes
, 0);
2560 bytes
= BYTES_BY_CHAR_HEAD (*p
);
2561 p
+= bytes
, pos
+= bytes
;
2565 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2570 ptrdiff_t pos
, stop
;
2571 unsigned char *p
, *pend
;
2573 /* Be sure not to have a multibyte sequence striding over the GAP.
2574 Ex: We change this: "...abc\302 _GAP_ \241def..."
2575 to: "...abc _GAP_ \302\241def..." */
2578 && GPT_BYTE
> 1 && GPT_BYTE
< Z_BYTE
2579 && ! CHAR_HEAD_P (*(GAP_END_ADDR
)))
2581 unsigned char *q
= GPT_ADDR
- 1;
2583 while (! CHAR_HEAD_P (*q
) && q
> BEG_ADDR
) q
--;
2584 if (LEADING_CODE_P (*q
))
2586 ptrdiff_t new_gpt
= GPT_BYTE
- (GPT_ADDR
- q
);
2588 move_gap_both (new_gpt
, new_gpt
);
2592 /* Make the buffer contents valid as multibyte by converting
2593 8-bit characters to multibyte form. */
2611 if (ASCII_BYTE_P (*p
))
2613 else if (EQ (flag
, Qt
)
2614 && ! CHAR_BYTE8_HEAD_P (*p
)
2615 && (bytes
= MULTIBYTE_LENGTH (p
, pend
)) > 0)
2616 p
+= bytes
, pos
+= bytes
;
2619 unsigned char tmp
[MAX_MULTIBYTE_LENGTH
];
2622 c
= BYTE8_TO_CHAR (*p
);
2623 bytes
= CHAR_STRING (c
, tmp
);
2625 TEMP_SET_PT_BOTH (pos
+ 1, pos
+ 1);
2627 insert_1_both ((char *) tmp
+ 1, bytes
, bytes
, 1, 0, 0);
2628 /* Now the gap is after the just inserted data. */
2646 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2648 /* Do this first, so that chars_in_text asks the right question.
2649 set_intervals_multibyte needs it too. */
2650 bset_enable_multibyte_characters (current_buffer
, Qt
);
2652 GPT_BYTE
= advance_to_char_boundary (GPT_BYTE
);
2653 GPT
= chars_in_text (BEG_ADDR
, GPT_BYTE
- BEG_BYTE
) + BEG
;
2655 Z
= chars_in_text (GAP_END_ADDR
, Z_BYTE
- GPT_BYTE
) + GPT
;
2657 BEGV_BYTE
= advance_to_char_boundary (BEGV_BYTE
);
2658 if (BEGV_BYTE
> GPT_BYTE
)
2659 BEGV
= chars_in_text (GAP_END_ADDR
, BEGV_BYTE
- GPT_BYTE
) + GPT
;
2661 BEGV
= chars_in_text (BEG_ADDR
, BEGV_BYTE
- BEG_BYTE
) + BEG
;
2663 ZV_BYTE
= advance_to_char_boundary (ZV_BYTE
);
2664 if (ZV_BYTE
> GPT_BYTE
)
2665 ZV
= chars_in_text (GAP_END_ADDR
, ZV_BYTE
- GPT_BYTE
) + GPT
;
2667 ZV
= chars_in_text (BEG_ADDR
, ZV_BYTE
- BEG_BYTE
) + BEG
;
2670 ptrdiff_t byte
= advance_to_char_boundary (PT_BYTE
);
2673 if (byte
> GPT_BYTE
)
2674 position
= chars_in_text (GAP_END_ADDR
, byte
- GPT_BYTE
) + GPT
;
2676 position
= chars_in_text (BEG_ADDR
, byte
- BEG_BYTE
) + BEG
;
2677 TEMP_SET_PT_BOTH (position
, byte
);
2680 tail
= markers
= BUF_MARKERS (current_buffer
);
2682 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2683 getting confused by the markers that have not yet been updated.
2684 It is also a signal that it should never create a marker. */
2685 BUF_MARKERS (current_buffer
) = NULL
;
2687 for (; tail
; tail
= tail
->next
)
2689 tail
->bytepos
= advance_to_char_boundary (tail
->bytepos
);
2690 tail
->charpos
= BYTE_TO_CHAR (tail
->bytepos
);
2693 /* Make sure no markers were put on the chain
2694 while the chain value was incorrect. */
2695 if (BUF_MARKERS (current_buffer
))
2698 BUF_MARKERS (current_buffer
) = markers
;
2700 /* Do this last, so it can calculate the new correspondences
2701 between chars and bytes. */
2702 set_intervals_multibyte (1);
2705 if (!EQ (old_undo
, Qt
))
2707 /* Represent all the above changes by a special undo entry. */
2708 bset_undo_list (current_buffer
,
2709 Fcons (list3 (Qapply
,
2710 intern ("set-buffer-multibyte"),
2711 NILP (flag
) ? Qt
: Qnil
),
2717 /* Changing the multibyteness of a buffer means that all windows
2718 showing that buffer must be updated thoroughly. */
2719 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2720 ++windows_or_buffers_changed
;
2722 /* Copy this buffer's new multibyte status
2723 into all of its indirect buffers. */
2724 FOR_EACH_BUFFER (other
)
2725 if (other
->base_buffer
== current_buffer
&& !NILP (BVAR (other
, name
)))
2727 BVAR (other
, enable_multibyte_characters
)
2728 = BVAR (current_buffer
, enable_multibyte_characters
);
2729 other
->prevent_redisplay_optimizations_p
= 1;
2732 /* Restore the modifiedness of the buffer. */
2733 if (!modified_p
&& !NILP (Fbuffer_modified_p (Qnil
)))
2734 Fset_buffer_modified_p (Qnil
);
2736 /* Update coding systems of this buffer's process (if any). */
2738 Lisp_Object process
;
2740 process
= Fget_buffer_process (Fcurrent_buffer ());
2741 if (PROCESSP (process
))
2742 setup_process_coding_systems (process
);
2748 DEFUN ("kill-all-local-variables", Fkill_all_local_variables
,
2749 Skill_all_local_variables
, 0, 0, 0,
2750 doc
: /* Switch to Fundamental mode by killing current buffer's local variables.
2751 Most local variable bindings are eliminated so that the default values
2752 become effective once more. Also, the syntax table is set from
2753 `standard-syntax-table', the local keymap is set to nil,
2754 and the abbrev table from `fundamental-mode-abbrev-table'.
2755 This function also forces redisplay of the mode line.
2757 Every function to select a new major mode starts by
2758 calling this function.
2760 As a special exception, local variables whose names have
2761 a non-nil `permanent-local' property are not eliminated by this function.
2763 The first thing this function does is run
2764 the normal hook `change-major-mode-hook'. */)
2767 Frun_hooks (1, &Qchange_major_mode_hook
);
2769 /* Make sure none of the bindings in local_var_alist
2770 remain swapped in, in their symbols. */
2772 swap_out_buffer_local_variables (current_buffer
);
2774 /* Actually eliminate all local bindings of this buffer. */
2776 reset_buffer_local_variables (current_buffer
, 0);
2778 /* Force mode-line redisplay. Useful here because all major mode
2779 commands call this function. */
2780 update_mode_lines
++;
2785 /* Make sure no local variables remain set up with buffer B
2786 for their current values. */
2789 swap_out_buffer_local_variables (struct buffer
*b
)
2791 Lisp_Object oalist
, alist
, buffer
;
2793 XSETBUFFER (buffer
, b
);
2794 oalist
= BVAR (b
, local_var_alist
);
2796 for (alist
= oalist
; CONSP (alist
); alist
= XCDR (alist
))
2798 Lisp_Object sym
= XCAR (XCAR (alist
));
2799 eassert (XSYMBOL (sym
)->redirect
== SYMBOL_LOCALIZED
);
2800 /* Need not do anything if some other buffer's binding is
2802 if (EQ (SYMBOL_BLV (XSYMBOL (sym
))->where
, buffer
))
2804 /* Symbol is set up for this buffer's old local value:
2806 swap_in_global_binding (XSYMBOL (sym
));
2811 /* Find all the overlays in the current buffer that contain position POS.
2812 Return the number found, and store them in a vector in *VEC_PTR.
2813 Store in *LEN_PTR the size allocated for the vector.
2814 Store in *NEXT_PTR the next position after POS where an overlay starts,
2815 or ZV if there are no more overlays between POS and ZV.
2816 Store in *PREV_PTR the previous position before POS where an overlay ends,
2817 or where an overlay starts which ends at or after POS;
2818 or BEGV if there are no such overlays from BEGV to POS.
2819 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2821 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2822 when this function is called.
2824 If EXTEND is non-zero, we make the vector bigger if necessary.
2825 If EXTEND is zero, we never extend the vector,
2826 and we store only as many overlays as will fit.
2827 But we still return the total number of overlays.
2829 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2830 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2831 default (BEGV or ZV). */
2834 overlays_at (EMACS_INT pos
, int extend
, Lisp_Object
**vec_ptr
,
2836 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
, int change_req
)
2838 Lisp_Object overlay
, start
, end
;
2839 struct Lisp_Overlay
*tail
;
2841 ptrdiff_t len
= *len_ptr
;
2842 Lisp_Object
*vec
= *vec_ptr
;
2843 ptrdiff_t next
= ZV
;
2844 ptrdiff_t prev
= BEGV
;
2845 int inhibit_storing
= 0;
2847 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2849 ptrdiff_t startpos
, endpos
;
2851 XSETMISC (overlay
, tail
);
2853 start
= OVERLAY_START (overlay
);
2854 end
= OVERLAY_END (overlay
);
2855 endpos
= OVERLAY_POSITION (end
);
2862 startpos
= OVERLAY_POSITION (start
);
2863 /* This one ends at or after POS
2864 so its start counts for PREV_PTR if it's before POS. */
2865 if (prev
< startpos
&& startpos
< pos
)
2869 if (startpos
<= pos
)
2873 /* The supplied vector is full.
2874 Either make it bigger, or don't store any more in it. */
2877 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2883 inhibit_storing
= 1;
2886 if (!inhibit_storing
)
2888 /* Keep counting overlays even if we can't return them all. */
2891 else if (startpos
< next
)
2895 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2897 ptrdiff_t startpos
, endpos
;
2899 XSETMISC (overlay
, tail
);
2901 start
= OVERLAY_START (overlay
);
2902 end
= OVERLAY_END (overlay
);
2903 startpos
= OVERLAY_POSITION (start
);
2906 if (startpos
< next
)
2910 endpos
= OVERLAY_POSITION (end
);
2917 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2923 inhibit_storing
= 1;
2926 if (!inhibit_storing
)
2930 if (startpos
< pos
&& startpos
> prev
)
2933 else if (endpos
< pos
&& endpos
> prev
)
2935 else if (endpos
== pos
&& startpos
> prev
2936 && (!change_req
|| startpos
< pos
))
2947 /* Find all the overlays in the current buffer that overlap the range
2948 BEG-END, or are empty at BEG, or are empty at END provided END
2949 denotes the position at the end of the current buffer.
2951 Return the number found, and store them in a vector in *VEC_PTR.
2952 Store in *LEN_PTR the size allocated for the vector.
2953 Store in *NEXT_PTR the next position after POS where an overlay starts,
2954 or ZV if there are no more overlays.
2955 Store in *PREV_PTR the previous position before POS where an overlay ends,
2956 or BEGV if there are no previous overlays.
2957 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2959 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2960 when this function is called.
2962 If EXTEND is non-zero, we make the vector bigger if necessary.
2963 If EXTEND is zero, we never extend the vector,
2964 and we store only as many overlays as will fit.
2965 But we still return the total number of overlays. */
2968 overlays_in (EMACS_INT beg
, EMACS_INT end
, int extend
,
2969 Lisp_Object
**vec_ptr
, ptrdiff_t *len_ptr
,
2970 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
)
2972 Lisp_Object overlay
, ostart
, oend
;
2973 struct Lisp_Overlay
*tail
;
2975 ptrdiff_t len
= *len_ptr
;
2976 Lisp_Object
*vec
= *vec_ptr
;
2977 ptrdiff_t next
= ZV
;
2978 ptrdiff_t prev
= BEGV
;
2979 int inhibit_storing
= 0;
2980 int end_is_Z
= end
== Z
;
2982 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2984 ptrdiff_t startpos
, endpos
;
2986 XSETMISC (overlay
, tail
);
2988 ostart
= OVERLAY_START (overlay
);
2989 oend
= OVERLAY_END (overlay
);
2990 endpos
= OVERLAY_POSITION (oend
);
2997 startpos
= OVERLAY_POSITION (ostart
);
2998 /* Count an interval if it overlaps the range, is empty at the
2999 start of the range, or is empty at END provided END denotes the
3000 end of the buffer. */
3001 if ((beg
< endpos
&& startpos
< end
)
3002 || (startpos
== endpos
3003 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
3007 /* The supplied vector is full.
3008 Either make it bigger, or don't store any more in it. */
3011 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
3017 inhibit_storing
= 1;
3020 if (!inhibit_storing
)
3022 /* Keep counting overlays even if we can't return them all. */
3025 else if (startpos
< next
)
3029 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
3031 ptrdiff_t startpos
, endpos
;
3033 XSETMISC (overlay
, tail
);
3035 ostart
= OVERLAY_START (overlay
);
3036 oend
= OVERLAY_END (overlay
);
3037 startpos
= OVERLAY_POSITION (ostart
);
3040 if (startpos
< next
)
3044 endpos
= OVERLAY_POSITION (oend
);
3045 /* Count an interval if it overlaps the range, is empty at the
3046 start of the range, or is empty at END provided END denotes the
3047 end of the buffer. */
3048 if ((beg
< endpos
&& startpos
< end
)
3049 || (startpos
== endpos
3050 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
3056 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
3062 inhibit_storing
= 1;
3065 if (!inhibit_storing
)
3069 else if (endpos
< beg
&& endpos
> prev
)
3081 /* Return non-zero if there exists an overlay with a non-nil
3082 `mouse-face' property overlapping OVERLAY. */
3085 mouse_face_overlay_overlaps (Lisp_Object overlay
)
3087 ptrdiff_t start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3088 ptrdiff_t end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3089 ptrdiff_t n
, i
, size
;
3090 Lisp_Object
*v
, tem
;
3093 v
= alloca (size
* sizeof *v
);
3094 n
= overlays_in (start
, end
, 0, &v
, &size
, NULL
, NULL
);
3097 v
= alloca (n
* sizeof *v
);
3098 overlays_in (start
, end
, 0, &v
, &n
, NULL
, NULL
);
3101 for (i
= 0; i
< n
; ++i
)
3102 if (!EQ (v
[i
], overlay
)
3103 && (tem
= Foverlay_get (overlay
, Qmouse_face
),
3112 /* Fast function to just test if we're at an overlay boundary. */
3114 overlay_touches_p (ptrdiff_t pos
)
3116 Lisp_Object overlay
;
3117 struct Lisp_Overlay
*tail
;
3119 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
3123 XSETMISC (overlay
,tail
);
3124 eassert (OVERLAYP (overlay
));
3126 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3129 if (endpos
== pos
|| OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
)
3133 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
3137 XSETMISC (overlay
, tail
);
3138 eassert (OVERLAYP (overlay
));
3140 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3143 if (startpos
== pos
|| OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
)
3151 Lisp_Object overlay
;
3157 compare_overlays (const void *v1
, const void *v2
)
3159 const struct sortvec
*s1
= (const struct sortvec
*) v1
;
3160 const struct sortvec
*s2
= (const struct sortvec
*) v2
;
3161 if (s1
->priority
!= s2
->priority
)
3162 return s1
->priority
< s2
->priority
? -1 : 1;
3163 if (s1
->beg
!= s2
->beg
)
3164 return s1
->beg
< s2
->beg
? -1 : 1;
3165 if (s1
->end
!= s2
->end
)
3166 return s2
->end
< s1
->end
? -1 : 1;
3167 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
3168 between "equal" overlays. The result can still change between
3169 invocations of Emacs, but it won't change in the middle of
3170 `find_field' (bug#6830). */
3171 if (XHASH (s1
->overlay
) != XHASH (s2
->overlay
))
3172 return XHASH (s1
->overlay
) < XHASH (s2
->overlay
) ? -1 : 1;
3176 /* Sort an array of overlays by priority. The array is modified in place.
3177 The return value is the new size; this may be smaller than the original
3178 size if some of the overlays were invalid or were window-specific. */
3180 sort_overlays (Lisp_Object
*overlay_vec
, ptrdiff_t noverlays
, struct window
*w
)
3183 struct sortvec
*sortvec
= alloca (noverlays
* sizeof *sortvec
);
3185 /* Put the valid and relevant overlays into sortvec. */
3187 for (i
= 0, j
= 0; i
< noverlays
; i
++)
3190 Lisp_Object overlay
;
3192 overlay
= overlay_vec
[i
];
3193 if (OVERLAYP (overlay
)
3194 && OVERLAY_POSITION (OVERLAY_START (overlay
)) > 0
3195 && OVERLAY_POSITION (OVERLAY_END (overlay
)) > 0)
3197 /* If we're interested in a specific window, then ignore
3198 overlays that are limited to some other window. */
3203 window
= Foverlay_get (overlay
, Qwindow
);
3204 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3208 /* This overlay is good and counts: put it into sortvec. */
3209 sortvec
[j
].overlay
= overlay
;
3210 sortvec
[j
].beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3211 sortvec
[j
].end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3212 tem
= Foverlay_get (overlay
, Qpriority
);
3214 sortvec
[j
].priority
= XINT (tem
);
3216 sortvec
[j
].priority
= 0;
3222 /* Sort the overlays into the proper order: increasing priority. */
3225 qsort (sortvec
, noverlays
, sizeof (struct sortvec
), compare_overlays
);
3227 for (i
= 0; i
< noverlays
; i
++)
3228 overlay_vec
[i
] = sortvec
[i
].overlay
;
3234 Lisp_Object string
, string2
;
3241 struct sortstr
*buf
; /* An array that expands as needed; never freed. */
3242 ptrdiff_t size
; /* Allocated length of that array. */
3243 ptrdiff_t used
; /* How much of the array is currently in use. */
3244 ptrdiff_t bytes
; /* Total length of the strings in buf. */
3247 /* Buffers for storing information about the overlays touching a given
3248 position. These could be automatic variables in overlay_strings, but
3249 it's more efficient to hold onto the memory instead of repeatedly
3250 allocating and freeing it. */
3251 static struct sortstrlist overlay_heads
, overlay_tails
;
3252 static unsigned char *overlay_str_buf
;
3254 /* Allocated length of overlay_str_buf. */
3255 static ptrdiff_t overlay_str_len
;
3257 /* A comparison function suitable for passing to qsort. */
3259 cmp_for_strings (const void *as1
, const void *as2
)
3261 struct sortstr
*s1
= (struct sortstr
*)as1
;
3262 struct sortstr
*s2
= (struct sortstr
*)as2
;
3263 if (s1
->size
!= s2
->size
)
3264 return s2
->size
< s1
->size
? -1 : 1;
3265 if (s1
->priority
!= s2
->priority
)
3266 return s1
->priority
< s2
->priority
? -1 : 1;
3271 record_overlay_string (struct sortstrlist
*ssl
, Lisp_Object str
,
3272 Lisp_Object str2
, Lisp_Object pri
, ptrdiff_t size
)
3276 if (ssl
->used
== ssl
->size
)
3277 ssl
->buf
= xpalloc (ssl
->buf
, &ssl
->size
, 5, -1, sizeof *ssl
->buf
);
3278 ssl
->buf
[ssl
->used
].string
= str
;
3279 ssl
->buf
[ssl
->used
].string2
= str2
;
3280 ssl
->buf
[ssl
->used
].size
= size
;
3281 ssl
->buf
[ssl
->used
].priority
= (INTEGERP (pri
) ? XINT (pri
) : 0);
3284 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3285 nbytes
= SCHARS (str
);
3286 else if (! STRING_MULTIBYTE (str
))
3287 nbytes
= count_size_as_multibyte (SDATA (str
),
3290 nbytes
= SBYTES (str
);
3292 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3293 memory_full (SIZE_MAX
);
3294 ssl
->bytes
+= nbytes
;
3298 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3299 nbytes
= SCHARS (str2
);
3300 else if (! STRING_MULTIBYTE (str2
))
3301 nbytes
= count_size_as_multibyte (SDATA (str2
),
3304 nbytes
= SBYTES (str2
);
3306 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3307 memory_full (SIZE_MAX
);
3308 ssl
->bytes
+= nbytes
;
3312 /* Return the concatenation of the strings associated with overlays that
3313 begin or end at POS, ignoring overlays that are specific to a window
3314 other than W. The strings are concatenated in the appropriate order:
3315 shorter overlays nest inside longer ones, and higher priority inside
3316 lower. Normally all of the after-strings come first, but zero-sized
3317 overlays have their after-strings ride along with the before-strings
3318 because it would look strange to print them inside-out.
3320 Returns the string length, and stores the contents indirectly through
3321 PSTR, if that variable is non-null. The string may be overwritten by
3322 subsequent calls. */
3325 overlay_strings (ptrdiff_t pos
, struct window
*w
, unsigned char **pstr
)
3327 Lisp_Object overlay
, window
, str
;
3328 struct Lisp_Overlay
*ov
;
3329 ptrdiff_t startpos
, endpos
;
3330 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3332 overlay_heads
.used
= overlay_heads
.bytes
= 0;
3333 overlay_tails
.used
= overlay_tails
.bytes
= 0;
3334 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
3336 XSETMISC (overlay
, ov
);
3337 eassert (OVERLAYP (overlay
));
3339 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3340 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3343 if (endpos
!= pos
&& startpos
!= pos
)
3345 window
= Foverlay_get (overlay
, Qwindow
);
3346 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3349 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3350 record_overlay_string (&overlay_heads
, str
,
3352 ? Foverlay_get (overlay
, Qafter_string
)
3354 Foverlay_get (overlay
, Qpriority
),
3356 else if (endpos
== pos
3357 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3358 record_overlay_string (&overlay_tails
, str
, Qnil
,
3359 Foverlay_get (overlay
, Qpriority
),
3362 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
3364 XSETMISC (overlay
, ov
);
3365 eassert (OVERLAYP (overlay
));
3367 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3368 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3371 if (endpos
!= pos
&& startpos
!= pos
)
3373 window
= Foverlay_get (overlay
, Qwindow
);
3374 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3377 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3378 record_overlay_string (&overlay_heads
, str
,
3380 ? Foverlay_get (overlay
, Qafter_string
)
3382 Foverlay_get (overlay
, Qpriority
),
3384 else if (endpos
== pos
3385 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3386 record_overlay_string (&overlay_tails
, str
, Qnil
,
3387 Foverlay_get (overlay
, Qpriority
),
3390 if (overlay_tails
.used
> 1)
3391 qsort (overlay_tails
.buf
, overlay_tails
.used
, sizeof (struct sortstr
),
3393 if (overlay_heads
.used
> 1)
3394 qsort (overlay_heads
.buf
, overlay_heads
.used
, sizeof (struct sortstr
),
3396 if (overlay_heads
.bytes
|| overlay_tails
.bytes
)
3403 if (INT_ADD_OVERFLOW (overlay_heads
.bytes
, overlay_tails
.bytes
))
3404 memory_full (SIZE_MAX
);
3405 total
= overlay_heads
.bytes
+ overlay_tails
.bytes
;
3406 if (total
> overlay_str_len
)
3407 overlay_str_buf
= xpalloc (overlay_str_buf
, &overlay_str_len
,
3408 total
- overlay_str_len
, -1, 1);
3410 p
= overlay_str_buf
;
3411 for (i
= overlay_tails
.used
; --i
>= 0;)
3414 tem
= overlay_tails
.buf
[i
].string
;
3415 nbytes
= copy_text (SDATA (tem
), p
,
3417 STRING_MULTIBYTE (tem
), multibyte
);
3420 for (i
= 0; i
< overlay_heads
.used
; ++i
)
3423 tem
= overlay_heads
.buf
[i
].string
;
3424 nbytes
= copy_text (SDATA (tem
), p
,
3426 STRING_MULTIBYTE (tem
), multibyte
);
3428 tem
= overlay_heads
.buf
[i
].string2
;
3431 nbytes
= copy_text (SDATA (tem
), p
,
3433 STRING_MULTIBYTE (tem
), multibyte
);
3437 if (p
!= overlay_str_buf
+ total
)
3440 *pstr
= overlay_str_buf
;
3446 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3449 recenter_overlay_lists (struct buffer
*buf
, ptrdiff_t pos
)
3451 Lisp_Object overlay
, beg
, end
;
3452 struct Lisp_Overlay
*prev
, *tail
, *next
;
3454 /* See if anything in overlays_before should move to overlays_after. */
3456 /* We don't strictly need prev in this loop; it should always be nil.
3457 But we use it for symmetry and in case that should cease to be true
3458 with some future change. */
3460 for (tail
= buf
->overlays_before
; tail
; prev
= tail
, tail
= next
)
3463 XSETMISC (overlay
, tail
);
3464 eassert (OVERLAYP (overlay
));
3466 beg
= OVERLAY_START (overlay
);
3467 end
= OVERLAY_END (overlay
);
3469 if (OVERLAY_POSITION (end
) > pos
)
3471 /* OVERLAY needs to be moved. */
3472 ptrdiff_t where
= OVERLAY_POSITION (beg
);
3473 struct Lisp_Overlay
*other
, *other_prev
;
3475 /* Splice the cons cell TAIL out of overlays_before. */
3479 set_buffer_overlays_before (buf
, next
);
3481 /* Search thru overlays_after for where to put it. */
3483 for (other
= buf
->overlays_after
; other
;
3484 other_prev
= other
, other
= other
->next
)
3486 Lisp_Object otherbeg
, otheroverlay
;
3488 XSETMISC (otheroverlay
, other
);
3489 eassert (OVERLAYP (otheroverlay
));
3491 otherbeg
= OVERLAY_START (otheroverlay
);
3492 if (OVERLAY_POSITION (otherbeg
) >= where
)
3496 /* Add TAIL to overlays_after before OTHER. */
3499 other_prev
->next
= tail
;
3501 set_buffer_overlays_after (buf
, tail
);
3505 /* We've reached the things that should stay in overlays_before.
3506 All the rest of overlays_before must end even earlier,
3511 /* See if anything in overlays_after should be in overlays_before. */
3513 for (tail
= buf
->overlays_after
; tail
; prev
= tail
, tail
= next
)
3516 XSETMISC (overlay
, tail
);
3517 eassert (OVERLAYP (overlay
));
3519 beg
= OVERLAY_START (overlay
);
3520 end
= OVERLAY_END (overlay
);
3522 /* Stop looking, when we know that nothing further
3523 can possibly end before POS. */
3524 if (OVERLAY_POSITION (beg
) > pos
)
3527 if (OVERLAY_POSITION (end
) <= pos
)
3529 /* OVERLAY needs to be moved. */
3530 ptrdiff_t where
= OVERLAY_POSITION (end
);
3531 struct Lisp_Overlay
*other
, *other_prev
;
3533 /* Splice the cons cell TAIL out of overlays_after. */
3537 set_buffer_overlays_after (buf
, next
);
3539 /* Search thru overlays_before for where to put it. */
3541 for (other
= buf
->overlays_before
; other
;
3542 other_prev
= other
, other
= other
->next
)
3544 Lisp_Object otherend
, otheroverlay
;
3546 XSETMISC (otheroverlay
, other
);
3547 eassert (OVERLAYP (otheroverlay
));
3549 otherend
= OVERLAY_END (otheroverlay
);
3550 if (OVERLAY_POSITION (otherend
) <= where
)
3554 /* Add TAIL to overlays_before before OTHER. */
3557 other_prev
->next
= tail
;
3559 set_buffer_overlays_before (buf
, tail
);
3564 buf
->overlay_center
= pos
;
3568 adjust_overlays_for_insert (ptrdiff_t pos
, ptrdiff_t length
)
3570 /* After an insertion, the lists are still sorted properly,
3571 but we may need to update the value of the overlay center. */
3572 if (current_buffer
->overlay_center
>= pos
)
3573 current_buffer
->overlay_center
+= length
;
3577 adjust_overlays_for_delete (ptrdiff_t pos
, ptrdiff_t length
)
3579 if (current_buffer
->overlay_center
< pos
)
3580 /* The deletion was to our right. No change needed; the before- and
3581 after-lists are still consistent. */
3583 else if (current_buffer
->overlay_center
- pos
> length
)
3584 /* The deletion was to our left. We need to adjust the center value
3585 to account for the change in position, but the lists are consistent
3586 given the new value. */
3587 current_buffer
->overlay_center
-= length
;
3589 /* We're right in the middle. There might be things on the after-list
3590 that now belong on the before-list. Recentering will move them,
3591 and also update the center point. */
3592 recenter_overlay_lists (current_buffer
, pos
);
3595 /* Fix up overlays that were garbled as a result of permuting markers
3596 in the range START through END. Any overlay with at least one
3597 endpoint in this range will need to be unlinked from the overlay
3598 list and reinserted in its proper place.
3599 Such an overlay might even have negative size at this point.
3600 If so, we'll make the overlay empty. */
3602 fix_start_end_in_overlays (register ptrdiff_t start
, register ptrdiff_t end
)
3604 Lisp_Object overlay
;
3605 struct Lisp_Overlay
*before_list
IF_LINT (= NULL
);
3606 struct Lisp_Overlay
*after_list
IF_LINT (= NULL
);
3607 /* These are either nil, indicating that before_list or after_list
3608 should be assigned, or the cons cell the cdr of which should be
3610 struct Lisp_Overlay
*beforep
= NULL
, *afterp
= NULL
;
3611 /* 'Parent', likewise, indicates a cons cell or
3612 current_buffer->overlays_before or overlays_after, depending
3613 which loop we're in. */
3614 struct Lisp_Overlay
*tail
, *parent
;
3615 ptrdiff_t startpos
, endpos
;
3617 /* This algorithm shifts links around instead of consing and GCing.
3618 The loop invariant is that before_list (resp. after_list) is a
3619 well-formed list except that its last element, the CDR of beforep
3620 (resp. afterp) if beforep (afterp) isn't nil or before_list
3621 (after_list) if it is, is still uninitialized. So it's not a bug
3622 that before_list isn't initialized, although it may look
3624 for (parent
= NULL
, tail
= current_buffer
->overlays_before
; tail
;)
3626 XSETMISC (overlay
, tail
);
3628 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3629 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3631 /* If the overlay is backwards, make it empty. */
3632 if (endpos
< startpos
)
3635 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3643 || (startpos
>= start
&& startpos
< end
))
3645 /* Add it to the end of the wrong list. Later on,
3646 recenter_overlay_lists will move it to the right place. */
3647 if (endpos
< current_buffer
->overlay_center
)
3652 afterp
->next
= tail
;
3660 beforep
->next
= tail
;
3664 set_buffer_overlays_before (current_buffer
, tail
->next
);
3666 parent
->next
= tail
->next
;
3670 parent
= tail
, tail
= parent
->next
;
3672 for (parent
= NULL
, tail
= current_buffer
->overlays_after
; tail
;)
3674 XSETMISC (overlay
, tail
);
3676 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3677 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3679 /* If the overlay is backwards, make it empty. */
3680 if (endpos
< startpos
)
3683 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3687 if (startpos
>= end
)
3690 if (startpos
>= start
3691 || (endpos
>= start
&& endpos
< end
))
3693 if (endpos
< current_buffer
->overlay_center
)
3698 afterp
->next
= tail
;
3706 beforep
->next
= tail
;
3710 set_buffer_overlays_after (current_buffer
, tail
->next
);
3712 parent
->next
= tail
->next
;
3716 parent
= tail
, tail
= parent
->next
;
3719 /* Splice the constructed (wrong) lists into the buffer's lists,
3720 and let the recenter function make it sane again. */
3723 beforep
->next
= current_buffer
->overlays_before
;
3724 set_buffer_overlays_before (current_buffer
, before_list
);
3726 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3730 afterp
->next
= current_buffer
->overlays_after
;
3731 set_buffer_overlays_after (current_buffer
, after_list
);
3733 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3736 /* We have two types of overlay: the one whose ending marker is
3737 after-insertion-marker (this is the usual case) and the one whose
3738 ending marker is before-insertion-marker. When `overlays_before'
3739 contains overlays of the latter type and the former type in this
3740 order and both overlays end at inserting position, inserting a text
3741 increases only the ending marker of the latter type, which results
3742 in incorrect ordering of `overlays_before'.
3744 This function fixes ordering of overlays in the slot
3745 `overlays_before' of the buffer *BP. Before the insertion, `point'
3746 was at PREV, and now is at POS. */
3749 fix_overlays_before (struct buffer
*bp
, ptrdiff_t prev
, ptrdiff_t pos
)
3751 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3752 struct Lisp_Overlay
*tail
= bp
->overlays_before
, *parent
= NULL
, *right_pair
;
3754 ptrdiff_t end
IF_LINT (= 0);
3756 /* After the insertion, the several overlays may be in incorrect
3757 order. The possibility is that, in the list `overlays_before',
3758 an overlay which ends at POS appears after an overlay which ends
3759 at PREV. Since POS is greater than PREV, we must fix the
3760 ordering of these overlays, by moving overlays ends at POS before
3761 the overlays ends at PREV. */
3763 /* At first, find a place where disordered overlays should be linked
3764 in. It is where an overlay which end before POS exists. (i.e. an
3765 overlay whose ending marker is after-insertion-marker if disorder
3768 && (XSETMISC (tem
, tail
),
3769 (end
= OVERLAY_POSITION (OVERLAY_END (tem
))) >= pos
))
3775 /* If we don't find such an overlay,
3776 or the found one ends before PREV,
3777 or the found one is the last one in the list,
3778 we don't have to fix anything. */
3779 if (!tail
|| end
< prev
|| !tail
->next
)
3782 right_pair
= parent
;
3786 /* Now, end position of overlays in the list TAIL should be before
3787 or equal to PREV. In the loop, an overlay which ends at POS is
3788 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3789 we found an overlay which ends before PREV, the remaining
3790 overlays are in correct order. */
3793 XSETMISC (tem
, tail
);
3794 end
= OVERLAY_POSITION (OVERLAY_END (tem
));
3797 { /* This overlay is disordered. */
3798 struct Lisp_Overlay
*found
= tail
;
3800 /* Unlink the found overlay. */
3802 parent
->next
= tail
;
3803 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3804 and link it into the right place. */
3807 found
->next
= bp
->overlays_before
;
3808 set_buffer_overlays_before (bp
, found
);
3812 found
->next
= right_pair
->next
;
3813 right_pair
->next
= found
;
3816 else if (end
== prev
)
3821 else /* No more disordered overlay. */
3826 DEFUN ("overlayp", Foverlayp
, Soverlayp
, 1, 1, 0,
3827 doc
: /* Return t if OBJECT is an overlay. */)
3828 (Lisp_Object object
)
3830 return (OVERLAYP (object
) ? Qt
: Qnil
);
3833 DEFUN ("make-overlay", Fmake_overlay
, Smake_overlay
, 2, 5, 0,
3834 doc
: /* Create a new overlay with range BEG to END in BUFFER.
3835 If omitted, BUFFER defaults to the current buffer.
3836 BEG and END may be integers or markers.
3837 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3838 for the front of the overlay advance when text is inserted there
3839 \(which means the text *is not* included in the overlay).
3840 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3841 for the rear of the overlay advance when text is inserted there
3842 \(which means the text *is* included in the overlay). */)
3843 (Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
, Lisp_Object front_advance
, Lisp_Object rear_advance
)
3845 Lisp_Object overlay
;
3849 XSETBUFFER (buffer
, current_buffer
);
3851 CHECK_BUFFER (buffer
);
3853 && ! EQ (Fmarker_buffer (beg
), buffer
))
3854 error ("Marker points into wrong buffer");
3856 && ! EQ (Fmarker_buffer (end
), buffer
))
3857 error ("Marker points into wrong buffer");
3859 CHECK_NUMBER_COERCE_MARKER (beg
);
3860 CHECK_NUMBER_COERCE_MARKER (end
);
3862 if (XINT (beg
) > XINT (end
))
3865 temp
= beg
; beg
= end
; end
= temp
;
3868 b
= XBUFFER (buffer
);
3870 beg
= Fset_marker (Fmake_marker (), beg
, buffer
);
3871 end
= Fset_marker (Fmake_marker (), end
, buffer
);
3873 if (!NILP (front_advance
))
3874 XMARKER (beg
)->insertion_type
= 1;
3875 if (!NILP (rear_advance
))
3876 XMARKER (end
)->insertion_type
= 1;
3878 overlay
= build_overlay (beg
, end
, Qnil
);
3880 /* Put the new overlay on the wrong list. */
3881 end
= OVERLAY_END (overlay
);
3882 if (OVERLAY_POSITION (end
) < b
->overlay_center
)
3884 if (b
->overlays_after
)
3885 XOVERLAY (overlay
)->next
= b
->overlays_after
;
3886 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
3890 if (b
->overlays_before
)
3891 XOVERLAY (overlay
)->next
= b
->overlays_before
;
3892 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
3895 /* This puts it in the right list, and in the right order. */
3896 recenter_overlay_lists (b
, b
->overlay_center
);
3898 /* We don't need to redisplay the region covered by the overlay, because
3899 the overlay has no properties at the moment. */
3904 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3907 modify_overlay (struct buffer
*buf
, ptrdiff_t start
, ptrdiff_t end
)
3911 ptrdiff_t temp
= start
;
3916 BUF_COMPUTE_UNCHANGED (buf
, start
, end
);
3918 /* If this is a buffer not in the selected window,
3919 we must do other windows. */
3920 if (buf
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
3921 windows_or_buffers_changed
= 1;
3922 /* If multiple windows show this buffer, we must do other windows. */
3923 else if (buffer_shared
> 1)
3924 windows_or_buffers_changed
= 1;
3925 /* If we modify an overlay at the end of the buffer, we cannot
3926 be sure that window end is still valid. */
3927 else if (end
>= ZV
&& start
<= ZV
)
3928 windows_or_buffers_changed
= 1;
3930 ++BUF_OVERLAY_MODIFF (buf
);
3933 /* Remove OVERLAY from LIST. */
3935 static struct Lisp_Overlay
*
3936 unchain_overlay (struct Lisp_Overlay
*list
, struct Lisp_Overlay
*overlay
)
3938 register struct Lisp_Overlay
*tail
, **prev
= &list
;
3940 for (tail
= list
; tail
; prev
= &tail
->next
, tail
= *prev
)
3941 if (tail
== overlay
)
3943 *prev
= overlay
->next
;
3944 overlay
->next
= NULL
;
3950 /* Remove OVERLAY from both overlay lists of B. */
3953 unchain_both (struct buffer
*b
, Lisp_Object overlay
)
3955 struct Lisp_Overlay
*ov
= XOVERLAY (overlay
);
3957 set_buffer_overlays_before (b
, unchain_overlay (b
->overlays_before
, ov
));
3958 set_buffer_overlays_after (b
, unchain_overlay (b
->overlays_after
, ov
));
3959 eassert (XOVERLAY (overlay
)->next
== NULL
);
3962 DEFUN ("move-overlay", Fmove_overlay
, Smove_overlay
, 3, 4, 0,
3963 doc
: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3964 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3965 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3967 (Lisp_Object overlay
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
)
3969 struct buffer
*b
, *ob
= 0;
3970 Lisp_Object obuffer
;
3971 ptrdiff_t count
= SPECPDL_INDEX ();
3972 ptrdiff_t n_beg
, n_end
, o_beg
IF_LINT (= 0), o_end
IF_LINT (= 0);
3974 CHECK_OVERLAY (overlay
);
3976 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3978 XSETBUFFER (buffer
, current_buffer
);
3979 CHECK_BUFFER (buffer
);
3981 if (NILP (Fbuffer_live_p (buffer
)))
3982 error ("Attempt to move overlay to a dead buffer");
3985 && ! EQ (Fmarker_buffer (beg
), buffer
))
3986 error ("Marker points into wrong buffer");
3988 && ! EQ (Fmarker_buffer (end
), buffer
))
3989 error ("Marker points into wrong buffer");
3991 CHECK_NUMBER_COERCE_MARKER (beg
);
3992 CHECK_NUMBER_COERCE_MARKER (end
);
3994 if (XINT (beg
) > XINT (end
))
3997 temp
= beg
; beg
= end
; end
= temp
;
4000 specbind (Qinhibit_quit
, Qt
);
4002 obuffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4003 b
= XBUFFER (buffer
);
4005 if (!NILP (obuffer
))
4007 ob
= XBUFFER (obuffer
);
4009 o_beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4010 o_end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4012 unchain_both (ob
, overlay
);
4015 /* Set the overlay boundaries, which may clip them. */
4016 Fset_marker (OVERLAY_START (overlay
), beg
, buffer
);
4017 Fset_marker (OVERLAY_END (overlay
), end
, buffer
);
4019 n_beg
= marker_position (OVERLAY_START (overlay
));
4020 n_end
= marker_position (OVERLAY_END (overlay
));
4022 /* If the overlay has changed buffers, do a thorough redisplay. */
4023 if (!EQ (buffer
, obuffer
))
4025 /* Redisplay where the overlay was. */
4027 modify_overlay (ob
, o_beg
, o_end
);
4029 /* Redisplay where the overlay is going to be. */
4030 modify_overlay (b
, n_beg
, n_end
);
4033 /* Redisplay the area the overlay has just left, or just enclosed. */
4036 modify_overlay (b
, o_end
, n_end
);
4037 else if (o_end
== n_end
)
4038 modify_overlay (b
, o_beg
, n_beg
);
4040 modify_overlay (b
, min (o_beg
, n_beg
), max (o_end
, n_end
));
4043 /* Delete the overlay if it is empty after clipping and has the
4044 evaporate property. */
4045 if (n_beg
== n_end
&& !NILP (Foverlay_get (overlay
, Qevaporate
)))
4046 return unbind_to (count
, Fdelete_overlay (overlay
));
4048 /* Put the overlay into the new buffer's overlay lists, first on the
4050 if (n_end
< b
->overlay_center
)
4052 XOVERLAY (overlay
)->next
= b
->overlays_after
;
4053 set_buffer_overlays_after (b
, XOVERLAY (overlay
));
4057 XOVERLAY (overlay
)->next
= b
->overlays_before
;
4058 set_buffer_overlays_before (b
, XOVERLAY (overlay
));
4061 /* This puts it in the right list, and in the right order. */
4062 recenter_overlay_lists (b
, b
->overlay_center
);
4064 return unbind_to (count
, overlay
);
4067 DEFUN ("delete-overlay", Fdelete_overlay
, Sdelete_overlay
, 1, 1, 0,
4068 doc
: /* Delete the overlay OVERLAY from its buffer. */)
4069 (Lisp_Object overlay
)
4073 ptrdiff_t count
= SPECPDL_INDEX ();
4075 CHECK_OVERLAY (overlay
);
4077 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4081 b
= XBUFFER (buffer
);
4082 specbind (Qinhibit_quit
, Qt
);
4084 unchain_both (b
, overlay
);
4085 drop_overlay (b
, XOVERLAY (overlay
));
4087 /* When deleting an overlay with before or after strings, turn off
4088 display optimizations for the affected buffer, on the basis that
4089 these strings may contain newlines. This is easier to do than to
4090 check for that situation during redisplay. */
4091 if (!windows_or_buffers_changed
4092 && (!NILP (Foverlay_get (overlay
, Qbefore_string
))
4093 || !NILP (Foverlay_get (overlay
, Qafter_string
))))
4094 b
->prevent_redisplay_optimizations_p
= 1;
4096 return unbind_to (count
, Qnil
);
4099 /* Overlay dissection functions. */
4101 DEFUN ("overlay-start", Foverlay_start
, Soverlay_start
, 1, 1, 0,
4102 doc
: /* Return the position at which OVERLAY starts. */)
4103 (Lisp_Object overlay
)
4105 CHECK_OVERLAY (overlay
);
4107 return (Fmarker_position (OVERLAY_START (overlay
)));
4110 DEFUN ("overlay-end", Foverlay_end
, Soverlay_end
, 1, 1, 0,
4111 doc
: /* Return the position at which OVERLAY ends. */)
4112 (Lisp_Object overlay
)
4114 CHECK_OVERLAY (overlay
);
4116 return (Fmarker_position (OVERLAY_END (overlay
)));
4119 DEFUN ("overlay-buffer", Foverlay_buffer
, Soverlay_buffer
, 1, 1, 0,
4120 doc
: /* Return the buffer OVERLAY belongs to.
4121 Return nil if OVERLAY has been deleted. */)
4122 (Lisp_Object overlay
)
4124 CHECK_OVERLAY (overlay
);
4126 return Fmarker_buffer (OVERLAY_START (overlay
));
4129 DEFUN ("overlay-properties", Foverlay_properties
, Soverlay_properties
, 1, 1, 0,
4130 doc
: /* Return a list of the properties on OVERLAY.
4131 This is a copy of OVERLAY's plist; modifying its conses has no effect on
4133 (Lisp_Object overlay
)
4135 CHECK_OVERLAY (overlay
);
4137 return Fcopy_sequence (XOVERLAY (overlay
)->plist
);
4141 DEFUN ("overlays-at", Foverlays_at
, Soverlays_at
, 1, 1, 0,
4142 doc
: /* Return a list of the overlays that contain the character at POS. */)
4145 ptrdiff_t len
, noverlays
;
4146 Lisp_Object
*overlay_vec
;
4149 CHECK_NUMBER_COERCE_MARKER (pos
);
4152 /* We can't use alloca here because overlays_at can call xrealloc. */
4153 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4155 /* Put all the overlays we want in a vector in overlay_vec.
4156 Store the length in len. */
4157 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4160 /* Make a list of them all. */
4161 result
= Flist (noverlays
, overlay_vec
);
4163 xfree (overlay_vec
);
4167 DEFUN ("overlays-in", Foverlays_in
, Soverlays_in
, 2, 2, 0,
4168 doc
: /* Return a list of the overlays that overlap the region BEG ... END.
4169 Overlap means that at least one character is contained within the overlay
4170 and also contained within the specified region.
4171 Empty overlays are included in the result if they are located at BEG,
4172 between BEG and END, or at END provided END denotes the position at the
4173 end of the buffer. */)
4174 (Lisp_Object beg
, Lisp_Object end
)
4176 ptrdiff_t len
, noverlays
;
4177 Lisp_Object
*overlay_vec
;
4180 CHECK_NUMBER_COERCE_MARKER (beg
);
4181 CHECK_NUMBER_COERCE_MARKER (end
);
4184 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4186 /* Put all the overlays we want in a vector in overlay_vec.
4187 Store the length in len. */
4188 noverlays
= overlays_in (XINT (beg
), XINT (end
), 1, &overlay_vec
, &len
,
4191 /* Make a list of them all. */
4192 result
= Flist (noverlays
, overlay_vec
);
4194 xfree (overlay_vec
);
4198 DEFUN ("next-overlay-change", Fnext_overlay_change
, Snext_overlay_change
,
4200 doc
: /* Return the next position after POS where an overlay starts or ends.
4201 If there are no overlay boundaries from POS to (point-max),
4202 the value is (point-max). */)
4205 ptrdiff_t i
, len
, noverlays
;
4207 Lisp_Object
*overlay_vec
;
4209 CHECK_NUMBER_COERCE_MARKER (pos
);
4212 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4214 /* Put all the overlays we want in a vector in overlay_vec.
4215 Store the length in len.
4216 endpos gets the position where the next overlay starts. */
4217 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4220 /* If any of these overlays ends before endpos,
4221 use its ending point instead. */
4222 for (i
= 0; i
< noverlays
; i
++)
4227 oend
= OVERLAY_END (overlay_vec
[i
]);
4228 oendpos
= OVERLAY_POSITION (oend
);
4229 if (oendpos
< endpos
)
4233 xfree (overlay_vec
);
4234 return make_number (endpos
);
4237 DEFUN ("previous-overlay-change", Fprevious_overlay_change
,
4238 Sprevious_overlay_change
, 1, 1, 0,
4239 doc
: /* Return the previous position before POS where an overlay starts or ends.
4240 If there are no overlay boundaries from (point-min) to POS,
4241 the value is (point-min). */)
4245 Lisp_Object
*overlay_vec
;
4248 CHECK_NUMBER_COERCE_MARKER (pos
);
4250 /* At beginning of buffer, we know the answer;
4251 avoid bug subtracting 1 below. */
4252 if (XINT (pos
) == BEGV
)
4256 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4258 /* Put all the overlays we want in a vector in overlay_vec.
4259 Store the length in len.
4260 prevpos gets the position of the previous change. */
4261 overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4264 xfree (overlay_vec
);
4265 return make_number (prevpos
);
4268 /* These functions are for debugging overlays. */
4270 DEFUN ("overlay-lists", Foverlay_lists
, Soverlay_lists
, 0, 0, 0,
4271 doc
: /* Return a pair of lists giving all the overlays of the current buffer.
4272 The car has all the overlays before the overlay center;
4273 the cdr has all the overlays after the overlay center.
4274 Recentering overlays moves overlays between these lists.
4275 The lists you get are copies, so that changing them has no effect.
4276 However, the overlays you get are the real objects that the buffer uses. */)
4279 struct Lisp_Overlay
*ol
;
4280 Lisp_Object before
= Qnil
, after
= Qnil
, tmp
;
4282 for (ol
= current_buffer
->overlays_before
; ol
; ol
= ol
->next
)
4285 before
= Fcons (tmp
, before
);
4287 for (ol
= current_buffer
->overlays_after
; ol
; ol
= ol
->next
)
4290 after
= Fcons (tmp
, after
);
4293 return Fcons (Fnreverse (before
), Fnreverse (after
));
4296 DEFUN ("overlay-recenter", Foverlay_recenter
, Soverlay_recenter
, 1, 1, 0,
4297 doc
: /* Recenter the overlays of the current buffer around position POS.
4298 That makes overlay lookup faster for positions near POS (but perhaps slower
4299 for positions far away from POS). */)
4303 CHECK_NUMBER_COERCE_MARKER (pos
);
4305 p
= clip_to_bounds (PTRDIFF_MIN
, XINT (pos
), PTRDIFF_MAX
);
4306 recenter_overlay_lists (current_buffer
, p
);
4310 DEFUN ("overlay-get", Foverlay_get
, Soverlay_get
, 2, 2, 0,
4311 doc
: /* Get the property of overlay OVERLAY with property name PROP. */)
4312 (Lisp_Object overlay
, Lisp_Object prop
)
4314 CHECK_OVERLAY (overlay
);
4315 return lookup_char_property (XOVERLAY (overlay
)->plist
, prop
, 0);
4318 DEFUN ("overlay-put", Foverlay_put
, Soverlay_put
, 3, 3, 0,
4319 doc
: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4320 VALUE will be returned.*/)
4321 (Lisp_Object overlay
, Lisp_Object prop
, Lisp_Object value
)
4323 Lisp_Object tail
, buffer
;
4326 CHECK_OVERLAY (overlay
);
4328 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4330 for (tail
= XOVERLAY (overlay
)->plist
;
4331 CONSP (tail
) && CONSP (XCDR (tail
));
4332 tail
= XCDR (XCDR (tail
)))
4333 if (EQ (XCAR (tail
), prop
))
4335 changed
= !EQ (XCAR (XCDR (tail
)), value
);
4336 XSETCAR (XCDR (tail
), value
);
4339 /* It wasn't in the list, so add it to the front. */
4340 changed
= !NILP (value
);
4342 (overlay
, Fcons (prop
, Fcons (value
, XOVERLAY (overlay
)->plist
)));
4344 if (! NILP (buffer
))
4347 modify_overlay (XBUFFER (buffer
),
4348 marker_position (OVERLAY_START (overlay
)),
4349 marker_position (OVERLAY_END (overlay
)));
4350 if (EQ (prop
, Qevaporate
) && ! NILP (value
)
4351 && (OVERLAY_POSITION (OVERLAY_START (overlay
))
4352 == OVERLAY_POSITION (OVERLAY_END (overlay
))))
4353 Fdelete_overlay (overlay
);
4359 /* Subroutine of report_overlay_modification. */
4361 /* Lisp vector holding overlay hook functions to call.
4362 Vector elements come in pairs.
4363 Each even-index element is a list of hook functions.
4364 The following odd-index element is the overlay they came from.
4366 Before the buffer change, we fill in this vector
4367 as we call overlay hook functions.
4368 After the buffer change, we get the functions to call from this vector.
4369 This way we always call the same functions before and after the change. */
4370 static Lisp_Object last_overlay_modification_hooks
;
4372 /* Number of elements actually used in last_overlay_modification_hooks. */
4373 static ptrdiff_t last_overlay_modification_hooks_used
;
4375 /* Add one functionlist/overlay pair
4376 to the end of last_overlay_modification_hooks. */
4379 add_overlay_mod_hooklist (Lisp_Object functionlist
, Lisp_Object overlay
)
4381 ptrdiff_t oldsize
= ASIZE (last_overlay_modification_hooks
);
4383 if (oldsize
- 1 <= last_overlay_modification_hooks_used
)
4384 last_overlay_modification_hooks
=
4385 larger_vector (last_overlay_modification_hooks
, 2, -1);
4386 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4387 functionlist
); last_overlay_modification_hooks_used
++;
4388 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4389 overlay
); last_overlay_modification_hooks_used
++;
4392 /* Run the modification-hooks of overlays that include
4393 any part of the text in START to END.
4394 If this change is an insertion, also
4395 run the insert-before-hooks of overlay starting at END,
4396 and the insert-after-hooks of overlay ending at START.
4398 This is called both before and after the modification.
4399 AFTER is nonzero when we call after the modification.
4401 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4402 When AFTER is nonzero, they are the start position,
4403 the position after the inserted new text,
4404 and the length of deleted or replaced old text. */
4407 report_overlay_modification (Lisp_Object start
, Lisp_Object end
, int after
,
4408 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4410 Lisp_Object prop
, overlay
;
4411 struct Lisp_Overlay
*tail
;
4412 /* 1 if this change is an insertion. */
4413 int insertion
= (after
? XFASTINT (arg3
) == 0 : EQ (start
, end
));
4414 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4419 /* We used to run the functions as soon as we found them and only register
4420 them in last_overlay_modification_hooks for the purpose of the `after'
4421 case. But running elisp code as we traverse the list of overlays is
4422 painful because the list can be modified by the elisp code so we had to
4423 copy at several places. We now simply do a read-only traversal that
4424 only collects the functions to run and we run them afterwards. It's
4425 simpler, especially since all the code was already there. -stef */
4429 /* We are being called before a change.
4430 Scan the overlays to find the functions to call. */
4431 last_overlay_modification_hooks_used
= 0;
4432 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4434 ptrdiff_t startpos
, endpos
;
4435 Lisp_Object ostart
, oend
;
4437 XSETMISC (overlay
, tail
);
4439 ostart
= OVERLAY_START (overlay
);
4440 oend
= OVERLAY_END (overlay
);
4441 endpos
= OVERLAY_POSITION (oend
);
4442 if (XFASTINT (start
) > endpos
)
4444 startpos
= OVERLAY_POSITION (ostart
);
4445 if (insertion
&& (XFASTINT (start
) == startpos
4446 || XFASTINT (end
) == startpos
))
4448 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4450 add_overlay_mod_hooklist (prop
, overlay
);
4452 if (insertion
&& (XFASTINT (start
) == endpos
4453 || XFASTINT (end
) == endpos
))
4455 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4457 add_overlay_mod_hooklist (prop
, overlay
);
4459 /* Test for intersecting intervals. This does the right thing
4460 for both insertion and deletion. */
4461 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4463 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4465 add_overlay_mod_hooklist (prop
, overlay
);
4469 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4471 ptrdiff_t startpos
, endpos
;
4472 Lisp_Object ostart
, oend
;
4474 XSETMISC (overlay
, tail
);
4476 ostart
= OVERLAY_START (overlay
);
4477 oend
= OVERLAY_END (overlay
);
4478 startpos
= OVERLAY_POSITION (ostart
);
4479 endpos
= OVERLAY_POSITION (oend
);
4480 if (XFASTINT (end
) < startpos
)
4482 if (insertion
&& (XFASTINT (start
) == startpos
4483 || XFASTINT (end
) == startpos
))
4485 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4487 add_overlay_mod_hooklist (prop
, overlay
);
4489 if (insertion
&& (XFASTINT (start
) == endpos
4490 || XFASTINT (end
) == endpos
))
4492 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4494 add_overlay_mod_hooklist (prop
, overlay
);
4496 /* Test for intersecting intervals. This does the right thing
4497 for both insertion and deletion. */
4498 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4500 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4502 add_overlay_mod_hooklist (prop
, overlay
);
4507 GCPRO4 (overlay
, arg1
, arg2
, arg3
);
4509 /* Call the functions recorded in last_overlay_modification_hooks.
4510 First copy the vector contents, in case some of these hooks
4511 do subsequent modification of the buffer. */
4512 ptrdiff_t size
= last_overlay_modification_hooks_used
;
4513 Lisp_Object
*copy
= alloca (size
* sizeof *copy
);
4516 memcpy (copy
, XVECTOR (last_overlay_modification_hooks
)->contents
,
4519 gcpro1
.nvars
= size
;
4521 for (i
= 0; i
< size
;)
4523 Lisp_Object prop_i
, overlay_i
;
4525 overlay_i
= copy
[i
++];
4526 call_overlay_mod_hooks (prop_i
, overlay_i
, after
, arg1
, arg2
, arg3
);
4533 call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
, int after
,
4534 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4536 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4538 GCPRO4 (list
, arg1
, arg2
, arg3
);
4540 while (CONSP (list
))
4543 call4 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
);
4545 call5 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
, arg3
);
4551 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4554 evaporate_overlays (ptrdiff_t pos
)
4556 Lisp_Object overlay
, hit_list
;
4557 struct Lisp_Overlay
*tail
;
4560 if (pos
<= current_buffer
->overlay_center
)
4561 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4564 XSETMISC (overlay
, tail
);
4565 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4568 if (endpos
== pos
&& OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
4569 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4570 hit_list
= Fcons (overlay
, hit_list
);
4573 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4576 XSETMISC (overlay
, tail
);
4577 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4580 if (startpos
== pos
&& OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
4581 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4582 hit_list
= Fcons (overlay
, hit_list
);
4584 for (; CONSP (hit_list
); hit_list
= XCDR (hit_list
))
4585 Fdelete_overlay (XCAR (hit_list
));
4588 /* Somebody has tried to store a value with an unacceptable type
4589 in the slot with offset OFFSET. */
4592 buffer_slot_type_mismatch (Lisp_Object newval
, int type
)
4594 Lisp_Object predicate
;
4598 case_Lisp_Int
: predicate
= Qintegerp
; break;
4599 case Lisp_String
: predicate
= Qstringp
; break;
4600 case Lisp_Symbol
: predicate
= Qsymbolp
; break;
4604 wrong_type_argument (predicate
, newval
);
4608 /***********************************************************************
4609 Allocation with mmap
4610 ***********************************************************************/
4612 #ifdef USE_MMAP_FOR_BUFFERS
4614 #include <sys/types.h>
4615 #include <sys/mman.h>
4618 #ifdef MAP_ANONYMOUS
4619 #define MAP_ANON MAP_ANONYMOUS
4626 #define MAP_FAILED ((void *) -1)
4638 /* Memory is allocated in regions which are mapped using mmap(2).
4639 The current implementation lets the system select mapped
4640 addresses; we're not using MAP_FIXED in general, except when
4641 trying to enlarge regions.
4643 Each mapped region starts with a mmap_region structure, the user
4644 area starts after that structure, aligned to MEM_ALIGN.
4646 +-----------------------+
4647 | struct mmap_info + |
4649 +-----------------------+
4653 +-----------------------+ */
4657 /* User-specified size. */
4658 size_t nbytes_specified
;
4660 /* Number of bytes mapped */
4661 size_t nbytes_mapped
;
4663 /* Pointer to the location holding the address of the memory
4664 allocated with the mmap'd block. The variable actually points
4665 after this structure. */
4668 /* Next and previous in list of all mmap'd regions. */
4669 struct mmap_region
*next
, *prev
;
4672 /* Doubly-linked list of mmap'd regions. */
4674 static struct mmap_region
*mmap_regions
;
4676 /* File descriptor for mmap. If we don't have anonymous mapping,
4677 /dev/zero will be opened on it. */
4681 /* Temporary storage for mmap_set_vars, see there. */
4683 static struct mmap_region
*mmap_regions_1
;
4684 static int mmap_fd_1
;
4686 /* Page size on this system. */
4688 static int mmap_page_size
;
4690 /* 1 means mmap has been initialized. */
4692 static int mmap_initialized_p
;
4694 /* Value is X rounded up to the next multiple of N. */
4696 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4698 /* Size of mmap_region structure plus padding. */
4700 #define MMAP_REGION_STRUCT_SIZE \
4701 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4703 /* Given a pointer P to the start of the user-visible part of a mapped
4704 region, return a pointer to the start of the region. */
4706 #define MMAP_REGION(P) \
4707 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4709 /* Given a pointer P to the start of a mapped region, return a pointer
4710 to the start of the user-visible part of the region. */
4712 #define MMAP_USER_AREA(P) \
4713 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4715 #define MEM_ALIGN sizeof (double)
4717 /* Predicate returning true if part of the address range [START .. END]
4718 is currently mapped. Used to prevent overwriting an existing
4721 Default is to conservatively assume the address range is occupied by
4722 something else. This can be overridden by system configuration
4723 files if system-specific means to determine this exists. */
4725 #ifndef MMAP_ALLOCATED_P
4726 #define MMAP_ALLOCATED_P(start, end) 1
4729 /* Perform necessary initializations for the use of mmap. */
4735 /* The value of mmap_fd is initially 0 in temacs, and -1
4736 in a dumped Emacs. */
4739 /* No anonymous mmap -- we need the file descriptor. */
4740 mmap_fd
= open ("/dev/zero", O_RDONLY
);
4742 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno
));
4744 #endif /* MAP_ANON == 0 */
4746 if (mmap_initialized_p
)
4748 mmap_initialized_p
= 1;
4754 mmap_page_size
= getpagesize ();
4757 /* Return a region overlapping address range START...END, or null if
4758 none. END is not including, i.e. the last byte in the range
4761 static struct mmap_region
*
4762 mmap_find (void *start
, void *end
)
4764 struct mmap_region
*r
;
4765 char *s
= (char *) start
, *e
= (char *) end
;
4767 for (r
= mmap_regions
; r
; r
= r
->next
)
4769 char *rstart
= (char *) r
;
4770 char *rend
= rstart
+ r
->nbytes_mapped
;
4772 if (/* First byte of range, i.e. START, in this region? */
4773 (s
>= rstart
&& s
< rend
)
4774 /* Last byte of range, i.e. END - 1, in this region? */
4775 || (e
> rstart
&& e
<= rend
)
4776 /* First byte of this region in the range? */
4777 || (rstart
>= s
&& rstart
< e
)
4778 /* Last byte of this region in the range? */
4779 || (rend
> s
&& rend
<= e
))
4787 /* Unmap a region. P is a pointer to the start of the user-araa of
4788 the region. Value is non-zero if successful. */
4791 mmap_free_1 (struct mmap_region
*r
)
4794 r
->next
->prev
= r
->prev
;
4796 r
->prev
->next
= r
->next
;
4798 mmap_regions
= r
->next
;
4800 if (munmap (r
, r
->nbytes_mapped
) == -1)
4802 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4810 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4811 Value is non-zero if successful. */
4814 mmap_enlarge (struct mmap_region
*r
, int npages
)
4816 char *region_end
= (char *) r
+ r
->nbytes_mapped
;
4822 /* Unmap pages at the end of the region. */
4823 nbytes
= - npages
* mmap_page_size
;
4824 if (munmap (region_end
- nbytes
, nbytes
) == -1)
4825 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4828 r
->nbytes_mapped
-= nbytes
;
4832 else if (npages
> 0)
4834 nbytes
= npages
* mmap_page_size
;
4836 /* Try to map additional pages at the end of the region. We
4837 cannot do this if the address range is already occupied by
4838 something else because mmap deletes any previous mapping.
4839 I'm not sure this is worth doing, let's see. */
4840 if (!MMAP_ALLOCATED_P (region_end
, region_end
+ nbytes
))
4844 p
= mmap (region_end
, nbytes
, PROT_READ
| PROT_WRITE
,
4845 MAP_ANON
| MAP_PRIVATE
| MAP_FIXED
, mmap_fd
, 0);
4846 if (p
== MAP_FAILED
)
4847 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4848 else if (p
!= region_end
)
4850 /* Kernels are free to choose a different address. In
4851 that case, unmap what we've mapped above; we have
4853 if (munmap (p
, nbytes
) == -1)
4854 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4858 r
->nbytes_mapped
+= nbytes
;
4868 /* Set or reset variables holding references to mapped regions. If
4869 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4870 non-zero, set all variables to the start of the user-areas
4873 This function is called from Fdump_emacs to ensure that the dumped
4874 Emacs doesn't contain references to memory that won't be mapped
4875 when Emacs starts. */
4878 mmap_set_vars (int restore_p
)
4880 struct mmap_region
*r
;
4884 mmap_regions
= mmap_regions_1
;
4885 mmap_fd
= mmap_fd_1
;
4886 for (r
= mmap_regions
; r
; r
= r
->next
)
4887 *r
->var
= MMAP_USER_AREA (r
);
4891 for (r
= mmap_regions
; r
; r
= r
->next
)
4893 mmap_regions_1
= mmap_regions
;
4894 mmap_regions
= NULL
;
4895 mmap_fd_1
= mmap_fd
;
4901 /* Allocate a block of storage large enough to hold NBYTES bytes of
4902 data. A pointer to the data is returned in *VAR. VAR is thus the
4903 address of some variable which will use the data area.
4905 The allocation of 0 bytes is valid.
4907 If we can't allocate the necessary memory, set *VAR to null, and
4911 mmap_alloc (void **var
, size_t nbytes
)
4918 map
= ROUND (nbytes
+ MMAP_REGION_STRUCT_SIZE
, mmap_page_size
);
4919 p
= mmap (NULL
, map
, PROT_READ
| PROT_WRITE
, MAP_ANON
| MAP_PRIVATE
,
4922 if (p
== MAP_FAILED
)
4924 if (errno
!= ENOMEM
)
4925 fprintf (stderr
, "mmap: %s\n", emacs_strerror (errno
));
4930 struct mmap_region
*r
= (struct mmap_region
*) p
;
4932 r
->nbytes_specified
= nbytes
;
4933 r
->nbytes_mapped
= map
;
4936 r
->next
= mmap_regions
;
4941 p
= MMAP_USER_AREA (p
);
4948 /* Free a block of relocatable storage whose data is pointed to by
4949 PTR. Store 0 in *PTR to show there's no block allocated. */
4952 mmap_free (void **var
)
4958 mmap_free_1 (MMAP_REGION (*var
));
4964 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4965 resize it to size NBYTES. Change *VAR to reflect the new block,
4966 and return this value. If more memory cannot be allocated, then
4967 leave *VAR unchanged, and return null. */
4970 mmap_realloc (void **var
, size_t nbytes
)
4977 result
= mmap_alloc (var
, nbytes
);
4978 else if (nbytes
== 0)
4981 result
= mmap_alloc (var
, nbytes
);
4985 struct mmap_region
*r
= MMAP_REGION (*var
);
4986 size_t room
= r
->nbytes_mapped
- MMAP_REGION_STRUCT_SIZE
;
4991 void *old_ptr
= *var
;
4993 /* Try to map additional pages at the end of the region.
4994 If that fails, allocate a new region, copy data
4995 from the old region, then free it. */
4996 if (mmap_enlarge (r
, (ROUND (nbytes
- room
, mmap_page_size
)
4999 r
->nbytes_specified
= nbytes
;
5000 *var
= result
= old_ptr
;
5002 else if (mmap_alloc (var
, nbytes
))
5004 memcpy (*var
, old_ptr
, r
->nbytes_specified
);
5005 mmap_free_1 (MMAP_REGION (old_ptr
));
5007 r
= MMAP_REGION (result
);
5008 r
->nbytes_specified
= nbytes
;
5016 else if (room
- nbytes
>= mmap_page_size
)
5018 /* Shrinking by at least a page. Let's give some
5019 memory back to the system.
5021 The extra parens are to make the division happens first,
5022 on positive values, so we know it will round towards
5024 mmap_enlarge (r
, - ((room
- nbytes
) / mmap_page_size
));
5026 r
->nbytes_specified
= nbytes
;
5030 /* Leave it alone. */
5032 r
->nbytes_specified
= nbytes
;
5040 #endif /* USE_MMAP_FOR_BUFFERS */
5044 /***********************************************************************
5045 Buffer-text Allocation
5046 ***********************************************************************/
5048 /* Allocate NBYTES bytes for buffer B's text buffer. */
5051 alloc_buffer_text (struct buffer
*b
, ptrdiff_t nbytes
)
5056 #if defined USE_MMAP_FOR_BUFFERS
5057 p
= mmap_alloc ((void **) &b
->text
->beg
, nbytes
);
5058 #elif defined REL_ALLOC
5059 p
= r_alloc ((void **) &b
->text
->beg
, nbytes
);
5061 p
= xmalloc (nbytes
);
5067 memory_full (nbytes
);
5070 b
->text
->beg
= (unsigned char *) p
;
5074 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
5078 enlarge_buffer_text (struct buffer
*b
, ptrdiff_t delta
)
5081 ptrdiff_t nbytes
= (BUF_Z_BYTE (b
) - BUF_BEG_BYTE (b
) + BUF_GAP_SIZE (b
) + 1
5084 #if defined USE_MMAP_FOR_BUFFERS
5085 p
= mmap_realloc ((void **) &b
->text
->beg
, nbytes
);
5086 #elif defined REL_ALLOC
5087 p
= r_re_alloc ((void **) &b
->text
->beg
, nbytes
);
5089 p
= xrealloc (b
->text
->beg
, nbytes
);
5095 memory_full (nbytes
);
5098 BUF_BEG_ADDR (b
) = (unsigned char *) p
;
5103 /* Free buffer B's text buffer. */
5106 free_buffer_text (struct buffer
*b
)
5110 #if defined USE_MMAP_FOR_BUFFERS
5111 mmap_free ((void **) &b
->text
->beg
);
5112 #elif defined REL_ALLOC
5113 r_alloc_free ((void **) &b
->text
->beg
);
5115 xfree (b
->text
->beg
);
5118 BUF_BEG_ADDR (b
) = NULL
;
5124 /***********************************************************************
5126 ***********************************************************************/
5129 init_buffer_once (void)
5132 /* If you add, remove, or reorder Lisp_Objects in a struct buffer, make
5133 sure that this is still correct. Otherwise, mark_vectorlike may not
5134 trace all Lisp_Objects in buffer_defaults and buffer_local_symbols. */
5136 = (offsetof (struct buffer
, own_text
) - header_size
) / word_size
;
5138 memset (buffer_permanent_local_flags
, 0, sizeof buffer_permanent_local_flags
);
5140 /* Make sure all markable slots in buffer_defaults
5141 are initialized reasonably, so mark_buffer won't choke. */
5142 reset_buffer (&buffer_defaults
);
5143 eassert (EQ (BVAR (&buffer_defaults
, name
), make_number (0)));
5144 reset_buffer_local_variables (&buffer_defaults
, 1);
5145 eassert (EQ (BVAR (&buffer_local_symbols
, name
), make_number (0)));
5146 reset_buffer (&buffer_local_symbols
);
5147 reset_buffer_local_variables (&buffer_local_symbols
, 1);
5148 /* Prevent GC from getting confused. */
5149 buffer_defaults
.text
= &buffer_defaults
.own_text
;
5150 buffer_local_symbols
.text
= &buffer_local_symbols
.own_text
;
5151 /* No one will share the text with these buffers, but let's play it safe. */
5152 buffer_defaults
.indirections
= 0;
5153 buffer_local_symbols
.indirections
= 0;
5154 set_buffer_intervals (&buffer_defaults
, NULL
);
5155 set_buffer_intervals (&buffer_local_symbols
, NULL
);
5156 XSETPVECTYPESIZE (&buffer_defaults
, PVEC_BUFFER
, pvecsize
);
5157 XSETBUFFER (Vbuffer_defaults
, &buffer_defaults
);
5158 XSETPVECTYPESIZE (&buffer_local_symbols
, PVEC_BUFFER
, pvecsize
);
5159 XSETBUFFER (Vbuffer_local_symbols
, &buffer_local_symbols
);
5161 /* Set up the default values of various buffer slots. */
5162 /* Must do these before making the first buffer! */
5164 /* real setup is done in bindings.el */
5165 bset_mode_line_format (&buffer_defaults
, build_pure_c_string ("%-"));
5166 bset_header_line_format (&buffer_defaults
, Qnil
);
5167 bset_abbrev_mode (&buffer_defaults
, Qnil
);
5168 bset_overwrite_mode (&buffer_defaults
, Qnil
);
5169 bset_case_fold_search (&buffer_defaults
, Qt
);
5170 bset_auto_fill_function (&buffer_defaults
, Qnil
);
5171 bset_selective_display (&buffer_defaults
, Qnil
);
5172 bset_selective_display_ellipses (&buffer_defaults
, Qt
);
5173 bset_abbrev_table (&buffer_defaults
, Qnil
);
5174 bset_display_table (&buffer_defaults
, Qnil
);
5175 bset_undo_list (&buffer_defaults
, Qnil
);
5176 bset_mark_active (&buffer_defaults
, Qnil
);
5177 bset_file_format (&buffer_defaults
, Qnil
);
5178 bset_auto_save_file_format (&buffer_defaults
, Qt
);
5179 set_buffer_overlays_before (&buffer_defaults
, NULL
);
5180 set_buffer_overlays_after (&buffer_defaults
, NULL
);
5181 buffer_defaults
.overlay_center
= BEG
;
5183 XSETFASTINT (BVAR (&buffer_defaults
, tab_width
), 8);
5184 bset_truncate_lines (&buffer_defaults
, Qnil
);
5185 bset_word_wrap (&buffer_defaults
, Qnil
);
5186 bset_ctl_arrow (&buffer_defaults
, Qt
);
5187 bset_bidi_display_reordering (&buffer_defaults
, Qt
);
5188 bset_bidi_paragraph_direction (&buffer_defaults
, Qnil
);
5189 bset_cursor_type (&buffer_defaults
, Qt
);
5190 bset_extra_line_spacing (&buffer_defaults
, Qnil
);
5191 bset_cursor_in_non_selected_windows (&buffer_defaults
, Qt
);
5193 bset_enable_multibyte_characters (&buffer_defaults
, Qt
);
5194 bset_buffer_file_coding_system (&buffer_defaults
, Qnil
);
5195 XSETFASTINT (BVAR (&buffer_defaults
, fill_column
), 70);
5196 XSETFASTINT (BVAR (&buffer_defaults
, left_margin
), 0);
5197 bset_cache_long_line_scans (&buffer_defaults
, Qnil
);
5198 bset_file_truename (&buffer_defaults
, Qnil
);
5199 XSETFASTINT (BVAR (&buffer_defaults
, display_count
), 0);
5200 XSETFASTINT (BVAR (&buffer_defaults
, left_margin_cols
), 0);
5201 XSETFASTINT (BVAR (&buffer_defaults
, right_margin_cols
), 0);
5202 bset_left_fringe_width (&buffer_defaults
, Qnil
);
5203 bset_right_fringe_width (&buffer_defaults
, Qnil
);
5204 bset_fringes_outside_margins (&buffer_defaults
, Qnil
);
5205 bset_scroll_bar_width (&buffer_defaults
, Qnil
);
5206 bset_vertical_scroll_bar_type (&buffer_defaults
, Qt
);
5207 bset_indicate_empty_lines (&buffer_defaults
, Qnil
);
5208 bset_indicate_buffer_boundaries (&buffer_defaults
, Qnil
);
5209 bset_fringe_indicator_alist (&buffer_defaults
, Qnil
);
5210 bset_fringe_cursor_alist (&buffer_defaults
, Qnil
);
5211 bset_scroll_up_aggressively (&buffer_defaults
, Qnil
);
5212 bset_scroll_down_aggressively (&buffer_defaults
, Qnil
);
5213 bset_display_time (&buffer_defaults
, Qnil
);
5215 /* Assign the local-flags to the slots that have default values.
5216 The local flag is a bit that is used in the buffer
5217 to say that it has its own local value for the slot.
5218 The local flag bits are in the local_var_flags slot of the buffer. */
5220 /* Nothing can work if this isn't true */
5221 { verify (sizeof (EMACS_INT
) == word_size
); }
5223 /* 0 means not a lisp var, -1 means always local, else mask */
5224 memset (&buffer_local_flags
, 0, sizeof buffer_local_flags
);
5225 bset_filename (&buffer_local_flags
, make_number (-1));
5226 bset_directory (&buffer_local_flags
, make_number (-1));
5227 bset_backed_up (&buffer_local_flags
, make_number (-1));
5228 bset_save_length (&buffer_local_flags
, make_number (-1));
5229 bset_auto_save_file_name (&buffer_local_flags
, make_number (-1));
5230 bset_read_only (&buffer_local_flags
, make_number (-1));
5231 bset_major_mode (&buffer_local_flags
, make_number (-1));
5232 bset_mode_name (&buffer_local_flags
, make_number (-1));
5233 bset_undo_list (&buffer_local_flags
, make_number (-1));
5234 bset_mark_active (&buffer_local_flags
, make_number (-1));
5235 bset_point_before_scroll (&buffer_local_flags
, make_number (-1));
5236 bset_file_truename (&buffer_local_flags
, make_number (-1));
5237 bset_invisibility_spec (&buffer_local_flags
, make_number (-1));
5238 bset_file_format (&buffer_local_flags
, make_number (-1));
5239 bset_auto_save_file_format (&buffer_local_flags
, make_number (-1));
5240 bset_display_count (&buffer_local_flags
, make_number (-1));
5241 bset_display_time (&buffer_local_flags
, make_number (-1));
5242 bset_enable_multibyte_characters (&buffer_local_flags
, make_number (-1));
5245 XSETFASTINT (BVAR (&buffer_local_flags
, mode_line_format
), idx
); ++idx
;
5246 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_mode
), idx
); ++idx
;
5247 XSETFASTINT (BVAR (&buffer_local_flags
, overwrite_mode
), idx
); ++idx
;
5248 XSETFASTINT (BVAR (&buffer_local_flags
, case_fold_search
), idx
); ++idx
;
5249 XSETFASTINT (BVAR (&buffer_local_flags
, auto_fill_function
), idx
); ++idx
;
5250 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display
), idx
); ++idx
;
5251 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display_ellipses
), idx
); ++idx
;
5252 XSETFASTINT (BVAR (&buffer_local_flags
, tab_width
), idx
); ++idx
;
5253 XSETFASTINT (BVAR (&buffer_local_flags
, truncate_lines
), idx
); ++idx
;
5254 XSETFASTINT (BVAR (&buffer_local_flags
, word_wrap
), idx
); ++idx
;
5255 XSETFASTINT (BVAR (&buffer_local_flags
, ctl_arrow
), idx
); ++idx
;
5256 XSETFASTINT (BVAR (&buffer_local_flags
, fill_column
), idx
); ++idx
;
5257 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin
), idx
); ++idx
;
5258 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_table
), idx
); ++idx
;
5259 XSETFASTINT (BVAR (&buffer_local_flags
, display_table
), idx
); ++idx
;
5260 XSETFASTINT (BVAR (&buffer_local_flags
, syntax_table
), idx
); ++idx
;
5261 XSETFASTINT (BVAR (&buffer_local_flags
, cache_long_line_scans
), idx
); ++idx
;
5262 XSETFASTINT (BVAR (&buffer_local_flags
, category_table
), idx
); ++idx
;
5263 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_display_reordering
), idx
); ++idx
;
5264 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_paragraph_direction
), idx
); ++idx
;
5265 XSETFASTINT (BVAR (&buffer_local_flags
, buffer_file_coding_system
), idx
);
5266 /* Make this one a permanent local. */
5267 buffer_permanent_local_flags
[idx
++] = 1;
5268 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin_cols
), idx
); ++idx
;
5269 XSETFASTINT (BVAR (&buffer_local_flags
, right_margin_cols
), idx
); ++idx
;
5270 XSETFASTINT (BVAR (&buffer_local_flags
, left_fringe_width
), idx
); ++idx
;
5271 XSETFASTINT (BVAR (&buffer_local_flags
, right_fringe_width
), idx
); ++idx
;
5272 XSETFASTINT (BVAR (&buffer_local_flags
, fringes_outside_margins
), idx
); ++idx
;
5273 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_bar_width
), idx
); ++idx
;
5274 XSETFASTINT (BVAR (&buffer_local_flags
, vertical_scroll_bar_type
), idx
); ++idx
;
5275 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_empty_lines
), idx
); ++idx
;
5276 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_buffer_boundaries
), idx
); ++idx
;
5277 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_indicator_alist
), idx
); ++idx
;
5278 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_cursor_alist
), idx
); ++idx
;
5279 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_up_aggressively
), idx
); ++idx
;
5280 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_down_aggressively
), idx
); ++idx
;
5281 XSETFASTINT (BVAR (&buffer_local_flags
, header_line_format
), idx
); ++idx
;
5282 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_type
), idx
); ++idx
;
5283 XSETFASTINT (BVAR (&buffer_local_flags
, extra_line_spacing
), idx
); ++idx
;
5284 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_in_non_selected_windows
), idx
); ++idx
;
5286 /* Need more room? */
5287 if (idx
>= MAX_PER_BUFFER_VARS
)
5289 last_per_buffer_idx
= idx
;
5291 Vbuffer_alist
= Qnil
;
5295 QSFundamental
= build_pure_c_string ("Fundamental");
5297 Qfundamental_mode
= intern_c_string ("fundamental-mode");
5298 bset_major_mode (&buffer_defaults
, Qfundamental_mode
);
5300 Qmode_class
= intern_c_string ("mode-class");
5302 Qprotected_field
= intern_c_string ("protected-field");
5304 Qpermanent_local
= intern_c_string ("permanent-local");
5306 Qkill_buffer_hook
= intern_c_string ("kill-buffer-hook");
5307 Fput (Qkill_buffer_hook
, Qpermanent_local
, Qt
);
5309 /* super-magic invisible buffer */
5310 Vprin1_to_string_buffer
= Fget_buffer_create (build_pure_c_string (" prin1"));
5311 Vbuffer_alist
= Qnil
;
5313 Fset_buffer (Fget_buffer_create (build_pure_c_string ("*scratch*")));
5315 inhibit_modification_hooks
= 0;
5325 #ifdef USE_MMAP_FOR_BUFFERS
5327 /* When using the ralloc implementation based on mmap(2), buffer
5328 text pointers will have been set to null in the dumped Emacs.
5333 if (b
->text
->beg
== NULL
)
5334 enlarge_buffer_text (b
, 0);
5336 #endif /* USE_MMAP_FOR_BUFFERS */
5338 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5339 if (NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5340 Fset_buffer_multibyte (Qnil
);
5342 pwd
= get_current_dir_name ();
5345 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5347 /* Maybe this should really use some standard subroutine
5348 whose definition is filename syntax dependent. */
5350 if (!(IS_DIRECTORY_SEP (pwd
[len
- 1])))
5352 /* Grow buffer to add directory separator and '\0'. */
5353 pwd
= realloc (pwd
, len
+ 2);
5355 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5356 pwd
[len
] = DIRECTORY_SEP
;
5357 pwd
[len
+ 1] = '\0';
5361 bset_directory (current_buffer
, make_unibyte_string (pwd
, len
));
5362 if (! NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5363 /* At this moment, we still don't know how to decode the
5364 directory name. So, we keep the bytes in multibyte form so
5365 that ENCODE_FILE correctly gets the original bytes. */
5367 (current_buffer
, string_to_multibyte (BVAR (current_buffer
, directory
)));
5369 /* Add /: to the front of the name
5370 if it would otherwise be treated as magic. */
5371 temp
= Ffind_file_name_handler (BVAR (current_buffer
, directory
), Qt
);
5373 /* If the default dir is just /, TEMP is non-nil
5374 because of the ange-ftp completion handler.
5375 However, it is not necessary to turn / into /:/.
5376 So avoid doing that. */
5377 && strcmp ("/", SSDATA (BVAR (current_buffer
, directory
))))
5380 concat2 (build_string ("/:"), BVAR (current_buffer
, directory
)));
5382 temp
= get_minibuffer (0);
5383 bset_directory (XBUFFER (temp
), BVAR (current_buffer
, directory
));
5388 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5389 Object stored in the current buffer. address is the address of the slot
5390 in the buffer that is current now. */
5392 /* TYPE is nil for a general Lisp variable.
5393 An integer specifies a type; then only Lisp values
5394 with that type code are allowed (except that nil is allowed too).
5395 LNAME is the Lisp-level variable name.
5396 VNAME is the name of the buffer slot.
5397 DOC is a dummy where you write the doc string as a comment. */
5398 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5400 static struct Lisp_Buffer_Objfwd bo_fwd; \
5401 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5405 defvar_per_buffer (struct Lisp_Buffer_Objfwd
*bo_fwd
, const char *namestring
,
5406 Lisp_Object
*address
, Lisp_Object type
)
5408 struct Lisp_Symbol
*sym
;
5411 sym
= XSYMBOL (intern (namestring
));
5412 offset
= (char *)address
- (char *)current_buffer
;
5414 bo_fwd
->type
= Lisp_Fwd_Buffer_Obj
;
5415 bo_fwd
->offset
= offset
;
5416 bo_fwd
->slottype
= type
;
5417 sym
->declared_special
= 1;
5418 sym
->redirect
= SYMBOL_FORWARDED
;
5420 /* I tried to do the job without a cast, but it seems impossible.
5421 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5422 SET_SYMBOL_FWD (sym
, (union Lisp_Fwd
*)bo_fwd
);
5424 XSETSYMBOL (PER_BUFFER_SYMBOL (offset
), sym
);
5426 if (PER_BUFFER_IDX (offset
) == 0)
5427 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5428 slot of buffer_local_flags */
5433 /* initialize the buffer routines */
5435 syms_of_buffer (void)
5437 staticpro (&last_overlay_modification_hooks
);
5438 last_overlay_modification_hooks
5439 = Fmake_vector (make_number (10), Qnil
);
5441 staticpro (&Vbuffer_defaults
);
5442 staticpro (&Vbuffer_local_symbols
);
5443 staticpro (&Qfundamental_mode
);
5444 staticpro (&Qmode_class
);
5445 staticpro (&QSFundamental
);
5446 staticpro (&Vbuffer_alist
);
5447 staticpro (&Qprotected_field
);
5448 staticpro (&Qpermanent_local
);
5449 staticpro (&Qkill_buffer_hook
);
5451 DEFSYM (Qpermanent_local_hook
, "permanent-local-hook");
5452 DEFSYM (Qoverlayp
, "overlayp");
5453 DEFSYM (Qevaporate
, "evaporate");
5454 DEFSYM (Qmodification_hooks
, "modification-hooks");
5455 DEFSYM (Qinsert_in_front_hooks
, "insert-in-front-hooks");
5456 DEFSYM (Qinsert_behind_hooks
, "insert-behind-hooks");
5457 DEFSYM (Qget_file_buffer
, "get-file-buffer");
5458 DEFSYM (Qpriority
, "priority");
5459 DEFSYM (Qbefore_string
, "before-string");
5460 DEFSYM (Qafter_string
, "after-string");
5461 DEFSYM (Qfirst_change_hook
, "first-change-hook");
5462 DEFSYM (Qbefore_change_functions
, "before-change-functions");
5463 DEFSYM (Qafter_change_functions
, "after-change-functions");
5464 DEFSYM (Qkill_buffer_query_functions
, "kill-buffer-query-functions");
5466 Fput (Qprotected_field
, Qerror_conditions
,
5467 listn (CONSTYPE_PURE
, 2, Qprotected_field
, Qerror
));
5468 Fput (Qprotected_field
, Qerror_message
,
5469 build_pure_c_string ("Attempt to modify a protected field"));
5471 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5473 doc
: /* Default value of `mode-line-format' for buffers that don't override it.
5474 This is the same as (default-value 'mode-line-format). */);
5476 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5478 doc
: /* Default value of `header-line-format' for buffers that don't override it.
5479 This is the same as (default-value 'header-line-format). */);
5481 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type
,
5482 doc
: /* Default value of `cursor-type' for buffers that don't override it.
5483 This is the same as (default-value 'cursor-type). */);
5485 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5487 doc
: /* Default value of `line-spacing' for buffers that don't override it.
5488 This is the same as (default-value 'line-spacing). */);
5490 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5491 cursor_in_non_selected_windows
,
5492 doc
: /* Default value of `cursor-in-non-selected-windows'.
5493 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5495 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5497 doc
: /* Default value of `abbrev-mode' for buffers that do not override it.
5498 This is the same as (default-value 'abbrev-mode). */);
5500 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5502 doc
: /* Default value of `ctl-arrow' for buffers that do not override it.
5503 This is the same as (default-value 'ctl-arrow). */);
5505 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5506 enable_multibyte_characters
,
5507 doc
: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5508 This is the same as (default-value 'enable-multibyte-characters). */);
5510 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5511 buffer_file_coding_system
,
5512 doc
: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5513 This is the same as (default-value 'buffer-file-coding-system). */);
5515 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5517 doc
: /* Default value of `truncate-lines' for buffers that do not override it.
5518 This is the same as (default-value 'truncate-lines). */);
5520 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5522 doc
: /* Default value of `fill-column' for buffers that do not override it.
5523 This is the same as (default-value 'fill-column). */);
5525 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5527 doc
: /* Default value of `left-margin' for buffers that do not override it.
5528 This is the same as (default-value 'left-margin). */);
5530 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5532 doc
: /* Default value of `tab-width' for buffers that do not override it.
5533 This is the same as (default-value 'tab-width). */);
5535 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5537 doc
: /* Default value of `case-fold-search' for buffers that don't override it.
5538 This is the same as (default-value 'case-fold-search). */);
5540 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5542 doc
: /* Default value of `left-margin-width' for buffers that don't override it.
5543 This is the same as (default-value 'left-margin-width). */);
5545 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5547 doc
: /* Default value of `right-margin-width' for buffers that don't override it.
5548 This is the same as (default-value 'right-margin-width). */);
5550 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5552 doc
: /* Default value of `left-fringe-width' for buffers that don't override it.
5553 This is the same as (default-value 'left-fringe-width). */);
5555 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5557 doc
: /* Default value of `right-fringe-width' for buffers that don't override it.
5558 This is the same as (default-value 'right-fringe-width). */);
5560 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5561 fringes_outside_margins
,
5562 doc
: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5563 This is the same as (default-value 'fringes-outside-margins). */);
5565 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5567 doc
: /* Default value of `scroll-bar-width' for buffers that don't override it.
5568 This is the same as (default-value 'scroll-bar-width). */);
5570 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5571 vertical_scroll_bar_type
,
5572 doc
: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5573 This is the same as (default-value 'vertical-scroll-bar). */);
5575 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5576 indicate_empty_lines
,
5577 doc
: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5578 This is the same as (default-value 'indicate-empty-lines). */);
5580 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5581 indicate_buffer_boundaries
,
5582 doc
: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5583 This is the same as (default-value 'indicate-buffer-boundaries). */);
5585 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5586 fringe_indicator_alist
,
5587 doc
: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5588 This is the same as (default-value 'fringe-indicator-alist'). */);
5590 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5591 fringe_cursor_alist
,
5592 doc
: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5593 This is the same as (default-value 'fringe-cursor-alist'). */);
5595 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5596 scroll_up_aggressively
,
5597 doc
: /* Default value of `scroll-up-aggressively'.
5598 This value applies in buffers that don't have their own local values.
5599 This is the same as (default-value 'scroll-up-aggressively). */);
5601 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5602 scroll_down_aggressively
,
5603 doc
: /* Default value of `scroll-down-aggressively'.
5604 This value applies in buffers that don't have their own local values.
5605 This is the same as (default-value 'scroll-down-aggressively). */);
5607 DEFVAR_PER_BUFFER ("header-line-format",
5608 &BVAR (current_buffer
, header_line_format
),
5610 doc
: /* Analogous to `mode-line-format', but controls the header line.
5611 The header line appears, optionally, at the top of a window;
5612 the mode line appears at the bottom. */);
5614 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer
, mode_line_format
),
5616 doc
: /* Template for displaying mode line for current buffer.
5618 The value may be nil, a string, a symbol or a list.
5620 A value of nil means don't display a mode line.
5622 For any symbol other than t or nil, the symbol's value is processed as
5623 a mode line construct. As a special exception, if that value is a
5624 string, the string is processed verbatim, without handling any
5625 %-constructs (see below). Also, unless the symbol has a non-nil
5626 `risky-local-variable' property, all properties in any strings, as
5627 well as all :eval and :propertize forms in the value, are ignored.
5629 A list whose car is a string or list is processed by processing each
5630 of the list elements recursively, as separate mode line constructs,
5631 and concatenating the results.
5633 A list of the form `(:eval FORM)' is processed by evaluating FORM and
5634 using the result as a mode line construct. Be careful--FORM should
5635 not load any files, because that can cause an infinite recursion.
5637 A list of the form `(:propertize ELT PROPS...)' is processed by
5638 processing ELT as the mode line construct, and adding the text
5639 properties PROPS to the result.
5641 A list whose car is a symbol is processed by examining the symbol's
5642 value, and, if that value is non-nil, processing the cadr of the list
5643 recursively; and if that value is nil, processing the caddr of the
5646 A list whose car is an integer is processed by processing the cadr of
5647 the list, and padding (if the number is positive) or truncating (if
5648 negative) to the width specified by that number.
5650 A string is printed verbatim in the mode line except for %-constructs:
5651 %b -- print buffer name. %f -- print visited file name.
5652 %F -- print frame name.
5653 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5654 %& is like %*, but ignore read-only-ness.
5655 % means buffer is read-only and * means it is modified.
5656 For a modified read-only buffer, %* gives % and %+ gives *.
5657 %s -- print process status. %l -- print the current line number.
5658 %c -- print the current column number (this makes editing slower).
5659 To make the column number update correctly in all cases,
5660 `column-number-mode' must be non-nil.
5661 %i -- print the size of the buffer.
5662 %I -- like %i, but use k, M, G, etc., to abbreviate.
5663 %p -- print percent of buffer above top of window, or Top, Bot or All.
5664 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5665 or print Bottom or All.
5666 %n -- print Narrow if appropriate.
5667 %t -- visited file is text or binary (if OS supports this distinction).
5668 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5669 %Z -- like %z, but including the end-of-line format.
5670 %e -- print error message about full memory.
5671 %@ -- print @ or hyphen. @ means that default-directory is on a
5673 %[ -- print one [ for each recursive editing level. %] similar.
5674 %% -- print %. %- -- print infinitely many dashes.
5675 Decimal digits after the % specify field width to which to pad. */);
5677 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode
,
5678 doc
: /* Value of `major-mode' for new buffers. */);
5680 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer
, major_mode
),
5681 make_number (Lisp_Symbol
),
5682 doc
: /* Symbol for current buffer's major mode.
5683 The default value (normally `fundamental-mode') affects new buffers.
5684 A value of nil means to use the current buffer's major mode, provided
5685 it is not marked as "special".
5687 When a mode is used by default, `find-file' switches to it before it
5688 reads the contents into the buffer and before it finishes setting up
5689 the buffer. Thus, the mode and its hooks should not expect certain
5690 variables such as `buffer-read-only' and `buffer-file-coding-system'
5693 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer
, mode_name
),
5695 doc
: /* Pretty name of current buffer's major mode.
5696 Usually a string, but can use any of the constructs for `mode-line-format',
5698 Format with `format-mode-line' to produce a string value. */);
5700 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer
, abbrev_table
), Qnil
,
5701 doc
: /* Local (mode-specific) abbrev table of current buffer. */);
5703 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer
, abbrev_mode
), Qnil
,
5704 doc
: /* Non-nil if Abbrev mode is enabled.
5705 Use the command `abbrev-mode' to change this variable. */);
5707 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer
, case_fold_search
),
5709 doc
: /* Non-nil if searches and matches should ignore case. */);
5711 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer
, fill_column
),
5712 make_number (Lisp_Int0
),
5713 doc
: /* Column beyond which automatic line-wrapping should happen.
5714 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5716 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer
, left_margin
),
5717 make_number (Lisp_Int0
),
5718 doc
: /* Column for the default `indent-line-function' to indent to.
5719 Linefeed indents to this column in Fundamental mode. */);
5721 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer
, tab_width
),
5722 make_number (Lisp_Int0
),
5723 doc
: /* Distance between tab stops (for display of tab characters), in columns.
5724 This should be an integer greater than zero. */);
5726 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer
, ctl_arrow
), Qnil
,
5727 doc
: /* Non-nil means display control chars with uparrow.
5728 A value of nil means use backslash and octal digits.
5729 This variable does not apply to characters whose display is specified
5730 in the current display table (if there is one). */);
5732 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5733 &BVAR (current_buffer
, enable_multibyte_characters
),
5735 doc
: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5736 Otherwise they are regarded as unibyte. This affects the display,
5737 file I/O and the behavior of various editing commands.
5739 This variable is buffer-local but you cannot set it directly;
5740 use the function `set-buffer-multibyte' to change a buffer's representation.
5741 See also Info node `(elisp)Text Representations'. */);
5742 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant
= 1;
5744 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5745 &BVAR (current_buffer
, buffer_file_coding_system
), Qnil
,
5746 doc
: /* Coding system to be used for encoding the buffer contents on saving.
5747 This variable applies to saving the buffer, and also to `write-region'
5748 and other functions that use `write-region'.
5749 It does not apply to sending output to subprocesses, however.
5751 If this is nil, the buffer is saved without any code conversion
5752 unless some coding system is specified in `file-coding-system-alist'
5753 for the buffer file.
5755 If the text to be saved cannot be encoded as specified by this variable,
5756 an alternative encoding is selected by `select-safe-coding-system', which see.
5758 The variable `coding-system-for-write', if non-nil, overrides this variable.
5760 This variable is never applied to a way of decoding a file while reading it. */);
5762 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5763 &BVAR (current_buffer
, bidi_display_reordering
), Qnil
,
5764 doc
: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5766 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5767 &BVAR (current_buffer
, bidi_paragraph_direction
), Qnil
,
5768 doc
: /* If non-nil, forces directionality of text paragraphs in the buffer.
5770 If this is nil (the default), the direction of each paragraph is
5771 determined by the first strong directional character of its text.
5772 The values of `right-to-left' and `left-to-right' override that.
5773 Any other value is treated as nil.
5775 This variable has no effect unless the buffer's value of
5776 \`bidi-display-reordering' is non-nil. */);
5778 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer
, truncate_lines
), Qnil
,
5779 doc
: /* Non-nil means do not display continuation lines.
5780 Instead, give each line of text just one screen line.
5782 Note that this is overridden by the variable
5783 `truncate-partial-width-windows' if that variable is non-nil
5784 and this buffer is not full-frame width.
5786 Minibuffers set this variable to nil. */);
5788 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer
, word_wrap
), Qnil
,
5789 doc
: /* Non-nil means to use word-wrapping for continuation lines.
5790 When word-wrapping is on, continuation lines are wrapped at the space
5791 or tab character nearest to the right window edge.
5792 If nil, continuation lines are wrapped at the right screen edge.
5794 This variable has no effect if long lines are truncated (see
5795 `truncate-lines' and `truncate-partial-width-windows'). If you use
5796 word-wrapping, you might want to reduce the value of
5797 `truncate-partial-width-windows', since wrapping can make text readable
5798 in narrower windows.
5800 Instead of setting this variable directly, most users should use
5801 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5802 to t, and additionally redefines simple editing commands to act on
5803 visual lines rather than logical lines. See the documentation of
5804 `visual-line-mode'. */);
5806 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer
, directory
),
5807 make_number (Lisp_String
),
5808 doc
: /* Name of default directory of current buffer. Should end with slash.
5809 To interactively change the default directory, use command `cd'. */);
5811 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer
, auto_fill_function
),
5813 doc
: /* Function called (if non-nil) to perform auto-fill.
5814 It is called after self-inserting any character specified in
5815 the `auto-fill-chars' table.
5816 NOTE: This variable is not a hook;
5817 its value may not be a list of functions. */);
5819 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer
, filename
),
5820 make_number (Lisp_String
),
5821 doc
: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5823 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer
, file_truename
),
5824 make_number (Lisp_String
),
5825 doc
: /* Abbreviated truename of file visited in current buffer, or nil if none.
5826 The truename of a file is calculated by `file-truename'
5827 and then abbreviated with `abbreviate-file-name'. */);
5829 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5830 &BVAR (current_buffer
, auto_save_file_name
),
5831 make_number (Lisp_String
),
5832 doc
: /* Name of file for auto-saving current buffer.
5833 If it is nil, that means don't auto-save this buffer. */);
5835 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer
, read_only
), Qnil
,
5836 doc
: /* Non-nil if this buffer is read-only. */);
5838 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer
, backed_up
), Qnil
,
5839 doc
: /* Non-nil if this buffer's file has been backed up.
5840 Backing up is done before the first time the file is saved. */);
5842 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer
, save_length
),
5843 make_number (Lisp_Int0
),
5844 doc
: /* Length of current buffer when last read in, saved or auto-saved.
5846 -1 means auto-saving turned off until next real save.
5848 If you set this to -2, that means don't turn off auto-saving in this buffer
5849 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5850 you probably should set this to -2 in that buffer. */);
5852 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer
, selective_display
),
5854 doc
: /* Non-nil enables selective display.
5855 An integer N as value means display only lines
5856 that start with less than N columns of space.
5857 A value of t means that the character ^M makes itself and
5858 all the rest of the line invisible; also, when saving the buffer
5859 in a file, save the ^M as a newline. */);
5861 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5862 &BVAR (current_buffer
, selective_display_ellipses
),
5864 doc
: /* Non-nil means display ... on previous line when a line is invisible. */);
5866 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer
, overwrite_mode
), Qnil
,
5867 doc
: /* Non-nil if self-insertion should replace existing text.
5868 The value should be one of `overwrite-mode-textual',
5869 `overwrite-mode-binary', or nil.
5870 If it is `overwrite-mode-textual', self-insertion still
5871 inserts at the end of a line, and inserts when point is before a tab,
5872 until the tab is filled in.
5873 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5875 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer
, display_table
),
5877 doc
: /* Display table that controls display of the contents of current buffer.
5879 If this variable is nil, the value of `standard-display-table' is used.
5880 Each window can have its own, overriding display table, see
5881 `set-window-display-table' and `window-display-table'.
5883 The display table is a char-table created with `make-display-table'.
5884 A char-table is an array indexed by character codes. Normal array
5885 primitives `aref' and `aset' can be used to access elements of a char-table.
5887 Each of the char-table elements control how to display the corresponding
5888 text character: the element at index C in the table says how to display
5889 the character whose code is C. Each element should be a vector of
5890 characters or nil. The value nil means display the character in the
5891 default fashion; otherwise, the characters from the vector are delivered
5892 to the screen instead of the original character.
5894 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5895 to display a capital Y instead of each X character.
5897 In addition, a char-table has six extra slots to control the display of:
5899 the end of a truncated screen line (extra-slot 0, a single character);
5900 the end of a continued line (extra-slot 1, a single character);
5901 the escape character used to display character codes in octal
5902 (extra-slot 2, a single character);
5903 the character used as an arrow for control characters (extra-slot 3,
5904 a single character);
5905 the decoration indicating the presence of invisible lines (extra-slot 4,
5906 a vector of characters);
5907 the character used to draw the border between side-by-side windows
5908 (extra-slot 5, a single character).
5910 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5912 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer
, left_margin_cols
),
5914 doc
: /* Width of left marginal area for display of a buffer.
5915 A value of nil means no marginal area. */);
5917 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer
, right_margin_cols
),
5919 doc
: /* Width of right marginal area for display of a buffer.
5920 A value of nil means no marginal area. */);
5922 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer
, left_fringe_width
),
5924 doc
: /* Width of this buffer's left fringe (in pixels).
5925 A value of 0 means no left fringe is shown in this buffer's window.
5926 A value of nil means to use the left fringe width from the window's frame. */);
5928 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer
, right_fringe_width
),
5930 doc
: /* Width of this buffer's right fringe (in pixels).
5931 A value of 0 means no right fringe is shown in this buffer's window.
5932 A value of nil means to use the right fringe width from the window's frame. */);
5934 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer
, fringes_outside_margins
),
5936 doc
: /* Non-nil means to display fringes outside display margins.
5937 A value of nil means to display fringes between margins and buffer text. */);
5939 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer
, scroll_bar_width
),
5941 doc
: /* Width of this buffer's scroll bars in pixels.
5942 A value of nil means to use the scroll bar width from the window's frame. */);
5944 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer
, vertical_scroll_bar_type
),
5946 doc
: /* Position of this buffer's vertical scroll bar.
5947 The value takes effect whenever you tell a window to display this buffer;
5948 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5950 A value of `left' or `right' means put the vertical scroll bar at that side
5951 of the window; a value of nil means don't show any vertical scroll bars.
5952 A value of t (the default) means do whatever the window's frame specifies. */);
5954 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5955 &BVAR (current_buffer
, indicate_empty_lines
), Qnil
,
5956 doc
: /* Visually indicate empty lines after the buffer end.
5957 If non-nil, a bitmap is displayed in the left fringe of a window on
5958 window-systems. */);
5960 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5961 &BVAR (current_buffer
, indicate_buffer_boundaries
), Qnil
,
5962 doc
: /* Visually indicate buffer boundaries and scrolling.
5963 If non-nil, the first and last line of the buffer are marked in the fringe
5964 of a window on window-systems with angle bitmaps, or if the window can be
5965 scrolled, the top and bottom line of the window are marked with up and down
5968 If value is a symbol `left' or `right', both angle and arrow bitmaps
5969 are displayed in the left or right fringe, resp. Any other value
5970 that doesn't look like an alist means display the angle bitmaps in
5971 the left fringe but no arrows.
5973 You can exercise more precise control by using an alist as the
5974 value. Each alist element (INDICATOR . POSITION) specifies
5975 where to show one of the indicators. INDICATOR is one of `top',
5976 `bottom', `up', `down', or t, which specifies the default position,
5977 and POSITION is one of `left', `right', or nil, meaning do not show
5980 For example, ((top . left) (t . right)) places the top angle bitmap in
5981 left fringe, the bottom angle bitmap in right fringe, and both arrow
5982 bitmaps in right fringe. To show just the angle bitmaps in the left
5983 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5985 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5986 &BVAR (current_buffer
, fringe_indicator_alist
), Qnil
,
5987 doc
: /* Mapping from logical to physical fringe indicator bitmaps.
5988 The value is an alist where each element (INDICATOR . BITMAPS)
5989 specifies the fringe bitmaps used to display a specific logical
5992 INDICATOR specifies the logical indicator type which is one of the
5993 following symbols: `truncation' , `continuation', `overlay-arrow',
5994 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5996 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5997 the actual bitmap shown in the left or right fringe for the logical
5998 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5999 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
6000 are used only for the `bottom' and `top-bottom' indicators when the
6001 last (only) line has no final newline. BITMAPS may also be a single
6002 symbol which is used in both left and right fringes. */);
6004 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
6005 &BVAR (current_buffer
, fringe_cursor_alist
), Qnil
,
6006 doc
: /* Mapping from logical to physical fringe cursor bitmaps.
6007 The value is an alist where each element (CURSOR . BITMAP)
6008 specifies the fringe bitmaps used to display a specific logical
6009 cursor type in the fringe.
6011 CURSOR specifies the logical cursor type which is one of the following
6012 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
6013 one is used to show a hollow cursor on narrow lines display lines
6014 where the normal hollow cursor will not fit.
6016 BITMAP is the corresponding fringe bitmap shown for the logical
6019 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
6020 &BVAR (current_buffer
, scroll_up_aggressively
), Qnil
,
6021 doc
: /* How far to scroll windows upward.
6022 If you move point off the bottom, the window scrolls automatically.
6023 This variable controls how far it scrolls. The value nil, the default,
6024 means scroll to center point. A fraction means scroll to put point
6025 that fraction of the window's height from the bottom of the window.
6026 When the value is 0.0, point goes at the bottom line, which in the
6027 simple case that you moved off with C-f means scrolling just one line.
6028 1.0 means point goes at the top, so that in that simple case, the
6029 window scrolls by a full window height. Meaningful values are
6030 between 0.0 and 1.0, inclusive. */);
6032 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
6033 &BVAR (current_buffer
, scroll_down_aggressively
), Qnil
,
6034 doc
: /* How far to scroll windows downward.
6035 If you move point off the top, the window scrolls automatically.
6036 This variable controls how far it scrolls. The value nil, the default,
6037 means scroll to center point. A fraction means scroll to put point
6038 that fraction of the window's height from the top of the window.
6039 When the value is 0.0, point goes at the top line, which in the
6040 simple case that you moved off with C-b means scrolling just one line.
6041 1.0 means point goes at the bottom, so that in that simple case, the
6042 window scrolls by a full window height. Meaningful values are
6043 between 0.0 and 1.0, inclusive. */);
6045 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
6049 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions
,
6050 doc
: /* List of functions to call before each text change.
6051 Two arguments are passed to each function: the positions of
6052 the beginning and end of the range of old text to be changed.
6053 \(For an insertion, the beginning and end are at the same place.)
6054 No information is given about the length of the text after the change.
6056 Buffer changes made while executing the `before-change-functions'
6057 don't call any before-change or after-change functions.
6058 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6060 If an unhandled error happens in running these functions,
6061 the variable's value remains nil. That prevents the error
6062 from happening repeatedly and making Emacs nonfunctional. */);
6063 Vbefore_change_functions
= Qnil
;
6065 DEFVAR_LISP ("after-change-functions", Vafter_change_functions
,
6066 doc
: /* List of functions to call after each text change.
6067 Three arguments are passed to each function: the positions of
6068 the beginning and end of the range of changed text,
6069 and the length in bytes of the pre-change text replaced by that range.
6070 \(For an insertion, the pre-change length is zero;
6071 for a deletion, that length is the number of bytes deleted,
6072 and the post-change beginning and end are at the same place.)
6074 Buffer changes made while executing the `after-change-functions'
6075 don't call any before-change or after-change functions.
6076 That's because `inhibit-modification-hooks' is temporarily set non-nil.
6078 If an unhandled error happens in running these functions,
6079 the variable's value remains nil. That prevents the error
6080 from happening repeatedly and making Emacs nonfunctional. */);
6081 Vafter_change_functions
= Qnil
;
6083 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook
,
6084 doc
: /* A list of functions to call before changing a buffer which is unmodified.
6085 The functions are run using the `run-hooks' function. */);
6086 Vfirst_change_hook
= Qnil
;
6088 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer
, undo_list
), Qnil
,
6089 doc
: /* List of undo entries in current buffer.
6090 Recent changes come first; older changes follow newer.
6092 An entry (BEG . END) represents an insertion which begins at
6093 position BEG and ends at position END.
6095 An entry (TEXT . POSITION) represents the deletion of the string TEXT
6096 from (abs POSITION). If POSITION is positive, point was at the front
6097 of the text being deleted; if negative, point was at the end.
6099 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
6100 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
6101 and is the visited file's modification time, as of that time. If the
6102 modification time of the most recent save is different, this entry is
6105 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
6106 was modified between BEG and END. PROPERTY is the property name,
6107 and VALUE is the old value.
6109 An entry (apply FUN-NAME . ARGS) means undo the change with
6110 \(apply FUN-NAME ARGS).
6112 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
6113 in the active region. BEG and END is the range affected by this entry
6114 and DELTA is the number of bytes added or deleted in that range by
6117 An entry (MARKER . DISTANCE) indicates that the marker MARKER
6118 was adjusted in position by the offset DISTANCE (an integer).
6120 An entry of the form POSITION indicates that point was at the buffer
6121 location given by the integer. Undoing an entry of this form places
6124 Entries with value `nil' mark undo boundaries. The undo command treats
6125 the changes between two undo boundaries as a single step to be undone.
6127 If the value of the variable is t, undo information is not recorded. */);
6129 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer
, mark_active
), Qnil
,
6130 doc
: /* Non-nil means the mark and region are currently active in this buffer. */);
6132 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer
, cache_long_line_scans
), Qnil
,
6133 doc
: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
6135 Normally, the line-motion functions work by scanning the buffer for
6136 newlines. Columnar operations (like `move-to-column' and
6137 `compute-motion') also work by scanning the buffer, summing character
6138 widths as they go. This works well for ordinary text, but if the
6139 buffer's lines are very long (say, more than 500 characters), these
6140 motion functions will take longer to execute. Emacs may also take
6141 longer to update the display.
6143 If `cache-long-line-scans' is non-nil, these motion functions cache the
6144 results of their scans, and consult the cache to avoid rescanning
6145 regions of the buffer until the text is modified. The caches are most
6146 beneficial when they prevent the most searching---that is, when the
6147 buffer contains long lines and large regions of characters with the
6148 same, fixed screen width.
6150 When `cache-long-line-scans' is non-nil, processing short lines will
6151 become slightly slower (because of the overhead of consulting the
6152 cache), and the caches will use memory roughly proportional to the
6153 number of newlines and characters whose screen width varies.
6155 The caches require no explicit maintenance; their accuracy is
6156 maintained internally by the Emacs primitives. Enabling or disabling
6157 the cache should not affect the behavior of any of the motion
6158 functions; it should only affect their performance. */);
6160 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer
, point_before_scroll
), Qnil
,
6161 doc
: /* Value of point before the last series of scroll operations, or nil. */);
6163 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer
, file_format
), Qnil
,
6164 doc
: /* List of formats to use when saving this buffer.
6165 Formats are defined by `format-alist'. This variable is
6166 set when a file is visited. */);
6168 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6169 &BVAR (current_buffer
, auto_save_file_format
), Qnil
,
6170 doc
: /* Format in which to write auto-save files.
6171 Should be a list of symbols naming formats that are defined in `format-alist'.
6172 If it is t, which is the default, auto-save files are written in the
6173 same format as a regular save would use. */);
6175 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6176 &BVAR (current_buffer
, invisibility_spec
), Qnil
,
6177 doc
: /* Invisibility spec of this buffer.
6178 The default is t, which means that text is invisible
6179 if it has a non-nil `invisible' property.
6180 If the value is a list, a text character is invisible if its `invisible'
6181 property is an element in that list (or is a list with members in common).
6182 If an element is a cons cell of the form (PROP . ELLIPSIS),
6183 then characters with property value PROP are invisible,
6184 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
6186 DEFVAR_PER_BUFFER ("buffer-display-count",
6187 &BVAR (current_buffer
, display_count
), Qnil
,
6188 doc
: /* A number incremented each time this buffer is displayed in a window.
6189 The function `set-window-buffer' increments it. */);
6191 DEFVAR_PER_BUFFER ("buffer-display-time",
6192 &BVAR (current_buffer
, display_time
), Qnil
,
6193 doc
: /* Time stamp updated each time this buffer is displayed in a window.
6194 The function `set-window-buffer' updates this variable
6195 to the value obtained by calling `current-time'.
6196 If the buffer has never been shown in a window, the value is nil. */);
6198 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode
,
6199 doc
: /* Non-nil if Transient Mark mode is enabled.
6200 See the command `transient-mark-mode' for a description of this minor mode.
6202 Non-nil also enables highlighting of the region whenever the mark is active.
6203 The variable `highlight-nonselected-windows' controls whether to highlight
6204 all windows or just the selected window.
6206 Lisp programs may give this variable certain special values:
6208 - A value of `lambda' enables Transient Mark mode temporarily.
6209 It is disabled again after any subsequent action that would
6210 normally deactivate the mark (e.g. buffer modification).
6212 - A value of (only . OLDVAL) enables Transient Mark mode
6213 temporarily. After any subsequent point motion command that is
6214 not shift-translated, or any other action that would normally
6215 deactivate the mark (e.g. buffer modification), the value of
6216 `transient-mark-mode' is set to OLDVAL. */);
6217 Vtransient_mark_mode
= Qnil
;
6219 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only
,
6220 doc
: /* Non-nil means disregard read-only status of buffers or characters.
6221 If the value is t, disregard `buffer-read-only' and all `read-only'
6222 text properties. If the value is a list, disregard `buffer-read-only'
6223 and disregard a `read-only' text property if the property value
6224 is a member of the list. */);
6225 Vinhibit_read_only
= Qnil
;
6227 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer
, cursor_type
), Qnil
,
6228 doc
: /* Cursor to use when this buffer is in the selected window.
6229 Values are interpreted as follows:
6231 t use the cursor specified for the frame
6232 nil don't display a cursor
6233 box display a filled box cursor
6234 hollow display a hollow box cursor
6235 bar display a vertical bar cursor with default width
6236 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6237 hbar display a horizontal bar cursor with default height
6238 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6239 ANYTHING ELSE display a hollow box cursor
6241 When the buffer is displayed in a non-selected window, the
6242 cursor's appearance is instead controlled by the variable
6243 `cursor-in-non-selected-windows'. */);
6245 DEFVAR_PER_BUFFER ("line-spacing",
6246 &BVAR (current_buffer
, extra_line_spacing
), Qnil
,
6247 doc
: /* Additional space to put between lines when displaying a buffer.
6248 The space is measured in pixels, and put below lines on graphic displays,
6249 see `display-graphic-p'.
6250 If value is a floating point number, it specifies the spacing relative
6251 to the default frame line height. A value of nil means add no extra space. */);
6253 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6254 &BVAR (current_buffer
, cursor_in_non_selected_windows
), Qnil
,
6255 doc
: /* Non-nil means show a cursor in non-selected windows.
6256 If nil, only shows a cursor in the selected window.
6257 If t, displays a cursor related to the usual cursor type
6258 \(a solid box becomes hollow, a bar becomes a narrower bar).
6259 You can also specify the cursor type as in the `cursor-type' variable.
6260 Use Custom to set this variable and update the display." */);
6262 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions
,
6263 doc
: /* List of functions called with no args to query before killing a buffer.
6264 The buffer being killed will be current while the functions are running.
6266 If any of them returns nil, the buffer is not killed. Functions run by
6267 this hook are supposed to not change the current buffer. */);
6268 Vkill_buffer_query_functions
= Qnil
;
6270 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook
,
6271 doc
: /* Normal hook run before changing the major mode of a buffer.
6272 The function `kill-all-local-variables' runs this before doing anything else. */);
6273 Vchange_major_mode_hook
= Qnil
;
6274 DEFSYM (Qchange_major_mode_hook
, "change-major-mode-hook");
6276 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook
,
6277 doc
: /* Hook run when the buffer list changes.
6278 Functions running this hook are `get-buffer-create',
6279 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6280 and `bury-buffer-internal'. */);
6281 Vbuffer_list_update_hook
= Qnil
;
6282 DEFSYM (Qbuffer_list_update_hook
, "buffer-list-update-hook");
6284 defsubr (&Sbuffer_live_p
);
6285 defsubr (&Sbuffer_list
);
6286 defsubr (&Sget_buffer
);
6287 defsubr (&Sget_file_buffer
);
6288 defsubr (&Sget_buffer_create
);
6289 defsubr (&Smake_indirect_buffer
);
6290 defsubr (&Sgenerate_new_buffer_name
);
6291 defsubr (&Sbuffer_name
);
6292 defsubr (&Sbuffer_file_name
);
6293 defsubr (&Sbuffer_base_buffer
);
6294 defsubr (&Sbuffer_local_value
);
6295 defsubr (&Sbuffer_local_variables
);
6296 defsubr (&Sbuffer_modified_p
);
6297 defsubr (&Sset_buffer_modified_p
);
6298 defsubr (&Sbuffer_modified_tick
);
6299 defsubr (&Sbuffer_chars_modified_tick
);
6300 defsubr (&Srename_buffer
);
6301 defsubr (&Sother_buffer
);
6302 defsubr (&Sbuffer_enable_undo
);
6303 defsubr (&Skill_buffer
);
6304 defsubr (&Sbury_buffer_internal
);
6305 defsubr (&Sset_buffer_major_mode
);
6306 defsubr (&Scurrent_buffer
);
6307 defsubr (&Sset_buffer
);
6308 defsubr (&Sbarf_if_buffer_read_only
);
6309 defsubr (&Serase_buffer
);
6310 defsubr (&Sbuffer_swap_text
);
6311 defsubr (&Sset_buffer_multibyte
);
6312 defsubr (&Skill_all_local_variables
);
6314 defsubr (&Soverlayp
);
6315 defsubr (&Smake_overlay
);
6316 defsubr (&Sdelete_overlay
);
6317 defsubr (&Smove_overlay
);
6318 defsubr (&Soverlay_start
);
6319 defsubr (&Soverlay_end
);
6320 defsubr (&Soverlay_buffer
);
6321 defsubr (&Soverlay_properties
);
6322 defsubr (&Soverlays_at
);
6323 defsubr (&Soverlays_in
);
6324 defsubr (&Snext_overlay_change
);
6325 defsubr (&Sprevious_overlay_change
);
6326 defsubr (&Soverlay_recenter
);
6327 defsubr (&Soverlay_lists
);
6328 defsubr (&Soverlay_get
);
6329 defsubr (&Soverlay_put
);
6330 defsubr (&Srestore_buffer_modified_p
);
6334 keys_of_buffer (void)
6336 initial_define_key (control_x_map
, 'b', "switch-to-buffer");
6337 initial_define_key (control_x_map
, 'k', "kill-buffer");
6339 /* This must not be in syms_of_buffer, because Qdisabled is not
6340 initialized when that function gets called. */
6341 Fput (intern_c_string ("erase-buffer"), Qdisabled
, Qt
);