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 #include <sys/types.h>
24 #include <sys/param.h>
33 #include "intervals.h"
36 #include "character.h"
38 #include "region-cache.h"
40 #include "blockinput.h"
45 struct buffer
*current_buffer
; /* the current buffer */
47 /* First buffer in chain of all buffers (in reverse order of creation).
48 Threaded through ->header.next.buffer. */
50 struct buffer
*all_buffers
;
52 /* This structure holds the default values of the buffer-local variables
53 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
54 The default value occupies the same slot in this structure
55 as an individual buffer's value occupies in that buffer.
56 Setting the default value also goes through the alist of buffers
57 and stores into each buffer that does not say it has a local value. */
59 DECL_ALIGN (struct buffer
, buffer_defaults
);
61 /* A Lisp_Object pointer to the above, used for staticpro */
63 static Lisp_Object Vbuffer_defaults
;
65 /* This structure marks which slots in a buffer have corresponding
66 default values in buffer_defaults.
67 Each such slot has a nonzero value in this structure.
68 The value has only one nonzero bit.
70 When a buffer has its own local value for a slot,
71 the entry for that slot (found in the same slot in this structure)
72 is turned on in the buffer's local_flags array.
74 If a slot in this structure is -1, then even though there may
75 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
76 and the corresponding slot in buffer_defaults is not used.
78 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
79 zero, that is a bug */
81 struct buffer buffer_local_flags
;
83 /* This structure holds the names of symbols whose values may be
84 buffer-local. It is indexed and accessed in the same way as the above. */
86 DECL_ALIGN (struct buffer
, buffer_local_symbols
);
88 /* A Lisp_Object pointer to the above, used for staticpro */
89 static Lisp_Object Vbuffer_local_symbols
;
91 /* Return the symbol of the per-buffer variable at offset OFFSET in
92 the buffer structure. */
94 #define PER_BUFFER_SYMBOL(OFFSET) \
95 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
97 /* Maximum length of an overlay vector. */
98 #define OVERLAY_COUNT_MAX \
99 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
100 min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)))
102 /* Flags indicating which built-in buffer-local variables
103 are permanent locals. */
104 static char buffer_permanent_local_flags
[MAX_PER_BUFFER_VARS
];
106 /* Number of per-buffer variables used. */
108 int last_per_buffer_idx
;
110 static void call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
,
111 int after
, Lisp_Object arg1
,
112 Lisp_Object arg2
, Lisp_Object arg3
);
113 static void swap_out_buffer_local_variables (struct buffer
*b
);
114 static void reset_buffer_local_variables (struct buffer
*b
, int permanent_too
);
116 /* Alist of all buffer names vs the buffers. */
117 /* This used to be a variable, but is no longer,
118 to prevent lossage due to user rplac'ing this alist or its elements. */
119 Lisp_Object Vbuffer_alist
;
121 static Lisp_Object Qkill_buffer_query_functions
;
123 /* Hook run before changing a major mode. */
124 static Lisp_Object Qchange_major_mode_hook
;
126 Lisp_Object Qfirst_change_hook
;
127 Lisp_Object Qbefore_change_functions
;
128 Lisp_Object Qafter_change_functions
;
130 static Lisp_Object Qfundamental_mode
, Qmode_class
, Qpermanent_local
;
131 static Lisp_Object Qpermanent_local_hook
;
133 static Lisp_Object Qprotected_field
;
135 static Lisp_Object QSFundamental
; /* A string "Fundamental" */
137 static Lisp_Object Qkill_buffer_hook
;
138 static Lisp_Object Qbuffer_list_update_hook
;
140 static Lisp_Object Qget_file_buffer
;
142 static Lisp_Object Qoverlayp
;
144 Lisp_Object Qpriority
, Qbefore_string
, Qafter_string
;
146 static Lisp_Object Qevaporate
;
148 Lisp_Object Qmodification_hooks
;
149 Lisp_Object Qinsert_in_front_hooks
;
150 Lisp_Object Qinsert_behind_hooks
;
152 static void alloc_buffer_text (struct buffer
*, ptrdiff_t);
153 static void free_buffer_text (struct buffer
*b
);
154 static struct Lisp_Overlay
* copy_overlays (struct buffer
*, struct Lisp_Overlay
*);
155 static void modify_overlay (struct buffer
*, ptrdiff_t, ptrdiff_t);
156 static Lisp_Object
buffer_lisp_local_variables (struct buffer
*, int);
158 /* For debugging; temporary. See set_buffer_internal. */
159 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
162 nsberror (Lisp_Object spec
)
165 error ("No buffer named %s", SDATA (spec
));
166 error ("Invalid buffer argument");
169 DEFUN ("buffer-live-p", Fbuffer_live_p
, Sbuffer_live_p
, 1, 1, 0,
170 doc
: /* Return non-nil if OBJECT is a buffer which has not been killed.
171 Value is nil if OBJECT is not a buffer or if it has been killed. */)
174 return ((BUFFERP (object
) && ! NILP (BVAR (XBUFFER (object
), name
)))
178 DEFUN ("buffer-list", Fbuffer_list
, Sbuffer_list
, 0, 1, 0,
179 doc
: /* Return a list of all existing live buffers.
180 If the optional arg FRAME is a frame, we return the buffer list in the
181 proper order for that frame: the buffers show in FRAME come first,
182 followed by the rest of the buffers. */)
186 general
= Fmapcar (Qcdr
, Vbuffer_alist
);
190 Lisp_Object framelist
, prevlist
, tail
;
194 framelist
= Fcopy_sequence (XFRAME (frame
)->buffer_list
);
195 prevlist
= Fnreverse (Fcopy_sequence
196 (XFRAME (frame
)->buried_buffer_list
));
198 /* Remove from GENERAL any buffer that duplicates one in
199 FRAMELIST or PREVLIST. */
203 general
= Fdelq (XCAR (tail
), general
);
209 general
= Fdelq (XCAR (tail
), general
);
216 return Fnconc (3, args
);
222 /* Like Fassoc, but use Fstring_equal to compare
223 (which ignores text properties),
224 and don't ever QUIT. */
227 assoc_ignore_text_properties (register Lisp_Object key
, Lisp_Object list
)
229 register Lisp_Object tail
;
230 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
232 register Lisp_Object elt
, tem
;
234 tem
= Fstring_equal (Fcar (elt
), key
);
241 DEFUN ("get-buffer", Fget_buffer
, Sget_buffer
, 1, 1, 0,
242 doc
: /* Return the buffer named BUFFER-OR-NAME.
243 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
244 is a string and there is no buffer with that name, return nil. If
245 BUFFER-OR-NAME is a buffer, return it as given. */)
246 (register Lisp_Object buffer_or_name
)
248 if (BUFFERP (buffer_or_name
))
249 return buffer_or_name
;
250 CHECK_STRING (buffer_or_name
);
252 return Fcdr (assoc_ignore_text_properties (buffer_or_name
, Vbuffer_alist
));
255 DEFUN ("get-file-buffer", Fget_file_buffer
, Sget_file_buffer
, 1, 1, 0,
256 doc
: /* Return the buffer visiting file FILENAME (a string).
257 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
258 If there is no such live buffer, return nil.
259 See also `find-buffer-visiting'. */)
260 (register Lisp_Object filename
)
262 register Lisp_Object tail
, buf
, tem
;
265 CHECK_STRING (filename
);
266 filename
= Fexpand_file_name (filename
, Qnil
);
268 /* If the file name has special constructs in it,
269 call the corresponding file handler. */
270 handler
= Ffind_file_name_handler (filename
, Qget_file_buffer
);
273 Lisp_Object handled_buf
= call2 (handler
, Qget_file_buffer
,
275 return BUFFERP (handled_buf
) ? handled_buf
: Qnil
;
278 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
280 buf
= Fcdr (XCAR (tail
));
281 if (!BUFFERP (buf
)) continue;
282 if (!STRINGP (BVAR (XBUFFER (buf
), filename
))) continue;
283 tem
= Fstring_equal (BVAR (XBUFFER (buf
), filename
), filename
);
291 get_truename_buffer (register Lisp_Object filename
)
293 register Lisp_Object tail
, buf
, tem
;
295 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
297 buf
= Fcdr (XCAR (tail
));
298 if (!BUFFERP (buf
)) continue;
299 if (!STRINGP (BVAR (XBUFFER (buf
), file_truename
))) continue;
300 tem
= Fstring_equal (BVAR (XBUFFER (buf
), file_truename
), filename
);
307 DEFUN ("get-buffer-create", Fget_buffer_create
, Sget_buffer_create
, 1, 1, 0,
308 doc
: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
309 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
310 return that buffer. If no such buffer exists, create a new buffer with
311 that name and return it. If BUFFER-OR-NAME starts with a space, the new
312 buffer does not keep undo information.
314 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
315 even if it is dead. The return value is never nil. */)
316 (register Lisp_Object buffer_or_name
)
318 register Lisp_Object buffer
, name
;
319 register struct buffer
*b
;
321 buffer
= Fget_buffer (buffer_or_name
);
325 if (SCHARS (buffer_or_name
) == 0)
326 error ("Empty string for buffer name is not allowed");
328 b
= allocate_buffer ();
330 /* An ordinary buffer uses its own struct buffer_text. */
331 b
->text
= &b
->own_text
;
334 BUF_GAP_SIZE (b
) = 20;
336 /* We allocate extra 1-byte at the tail and keep it always '\0' for
337 anchoring a search. */
338 alloc_buffer_text (b
, BUF_GAP_SIZE (b
) + 1);
340 if (! BUF_BEG_ADDR (b
))
341 buffer_memory_full (BUF_GAP_SIZE (b
) + 1);
346 b
->pt_byte
= BEG_BYTE
;
347 b
->begv_byte
= BEG_BYTE
;
348 b
->zv_byte
= BEG_BYTE
;
351 BUF_GPT_BYTE (b
) = BEG_BYTE
;
354 BUF_Z_BYTE (b
) = BEG_BYTE
;
356 BUF_CHARS_MODIFF (b
) = 1;
357 BUF_OVERLAY_MODIFF (b
) = 1;
358 BUF_SAVE_MODIFF (b
) = 1;
359 BUF_INTERVALS (b
) = 0;
360 BUF_UNCHANGED_MODIFIED (b
) = 1;
361 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = 1;
362 BUF_END_UNCHANGED (b
) = 0;
363 BUF_BEG_UNCHANGED (b
) = 0;
364 *(BUF_GPT_ADDR (b
)) = *(BUF_Z_ADDR (b
)) = 0; /* Put an anchor '\0'. */
365 b
->text
->inhibit_shrinking
= 0;
367 b
->newline_cache
= 0;
368 b
->width_run_cache
= 0;
369 BVAR (b
, width_table
) = Qnil
;
370 b
->prevent_redisplay_optimizations_p
= 1;
372 /* Put this on the chain of all buffers including killed ones. */
373 b
->header
.next
.buffer
= all_buffers
;
376 /* An ordinary buffer normally doesn't need markers
377 to handle BEGV and ZV. */
378 BVAR (b
, pt_marker
) = Qnil
;
379 BVAR (b
, begv_marker
) = Qnil
;
380 BVAR (b
, zv_marker
) = Qnil
;
382 name
= Fcopy_sequence (buffer_or_name
);
383 STRING_SET_INTERVALS (name
, NULL_INTERVAL
);
384 BVAR (b
, name
) = name
;
386 BVAR (b
, undo_list
) = (SREF (name
, 0) != ' ') ? Qnil
: Qt
;
389 reset_buffer_local_variables (b
, 1);
391 BVAR (b
, mark
) = Fmake_marker ();
392 BUF_MARKERS (b
) = NULL
;
394 /* Put this in the alist of all live buffers. */
395 XSETBUFFER (buffer
, b
);
396 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buffer
), Qnil
));
397 /* And run buffer-list-update-hook. */
398 if (!NILP (Vrun_hooks
))
399 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
405 /* Return a list of overlays which is a copy of the overlay list
406 LIST, but for buffer B. */
408 static struct Lisp_Overlay
*
409 copy_overlays (struct buffer
*b
, struct Lisp_Overlay
*list
)
412 struct Lisp_Overlay
*result
= NULL
, *tail
= NULL
;
414 XSETBUFFER (buffer
, b
);
416 for (; list
; list
= list
->next
)
418 Lisp_Object overlay
, start
, end
, old_overlay
;
421 XSETMISC (old_overlay
, list
);
422 charpos
= marker_position (OVERLAY_START (old_overlay
));
423 start
= Fmake_marker ();
424 Fset_marker (start
, make_number (charpos
), buffer
);
425 XMARKER (start
)->insertion_type
426 = XMARKER (OVERLAY_START (old_overlay
))->insertion_type
;
428 charpos
= marker_position (OVERLAY_END (old_overlay
));
429 end
= Fmake_marker ();
430 Fset_marker (end
, make_number (charpos
), buffer
);
431 XMARKER (end
)->insertion_type
432 = XMARKER (OVERLAY_END (old_overlay
))->insertion_type
;
434 overlay
= allocate_misc ();
435 XMISCTYPE (overlay
) = Lisp_Misc_Overlay
;
436 OVERLAY_START (overlay
) = start
;
437 OVERLAY_END (overlay
) = end
;
438 OVERLAY_PLIST (overlay
) = Fcopy_sequence (OVERLAY_PLIST (old_overlay
));
439 XOVERLAY (overlay
)->next
= NULL
;
442 tail
= tail
->next
= XOVERLAY (overlay
);
444 result
= tail
= XOVERLAY (overlay
);
451 /* Clone per-buffer values of buffer FROM.
453 Buffer TO gets the same per-buffer values as FROM, with the
454 following exceptions: (1) TO's name is left untouched, (2) markers
455 are copied and made to refer to TO, and (3) overlay lists are
459 clone_per_buffer_values (struct buffer
*from
, struct buffer
*to
)
463 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
467 /* Don't touch the `name' which should be unique for every buffer. */
468 if (offset
== PER_BUFFER_VAR_OFFSET (name
))
471 obj
= PER_BUFFER_VALUE (from
, offset
);
472 if (MARKERP (obj
) && XMARKER (obj
)->buffer
== from
)
474 struct Lisp_Marker
*m
= XMARKER (obj
);
476 obj
= build_marker (to
, m
->charpos
, m
->bytepos
);
477 XMARKER (obj
)->insertion_type
= m
->insertion_type
;
480 PER_BUFFER_VALUE (to
, offset
) = obj
;
483 memcpy (to
->local_flags
, from
->local_flags
, sizeof to
->local_flags
);
485 to
->overlays_before
= copy_overlays (to
, from
->overlays_before
);
486 to
->overlays_after
= copy_overlays (to
, from
->overlays_after
);
488 /* Get (a copy of) the alist of Lisp-level local variables of FROM
489 and install that in TO. */
490 BVAR (to
, local_var_alist
) = buffer_lisp_local_variables (from
, 1);
494 /* If buffer B has markers to record PT, BEGV and ZV when it is not
495 current, update these markers. */
498 record_buffer_markers (struct buffer
*b
)
500 if (! NILP (BVAR (b
, pt_marker
)))
504 eassert (!NILP (BVAR (b
, begv_marker
)));
505 eassert (!NILP (BVAR (b
, zv_marker
)));
507 XSETBUFFER (buffer
, b
);
508 set_marker_both (BVAR (b
, pt_marker
), buffer
, b
->pt
, b
->pt_byte
);
509 set_marker_both (BVAR (b
, begv_marker
), buffer
, b
->begv
, b
->begv_byte
);
510 set_marker_both (BVAR (b
, zv_marker
), buffer
, b
->zv
, b
->zv_byte
);
515 /* If buffer B has markers to record PT, BEGV and ZV when it is not
516 current, fetch these values into B->begv etc. */
519 fetch_buffer_markers (struct buffer
*b
)
521 if (! NILP (BVAR (b
, pt_marker
)))
525 eassert (!NILP (BVAR (b
, begv_marker
)));
526 eassert (!NILP (BVAR (b
, zv_marker
)));
528 m
= BVAR (b
, pt_marker
);
529 SET_BUF_PT_BOTH (b
, marker_position (m
), marker_byte_position (m
));
531 m
= BVAR (b
, begv_marker
);
532 SET_BUF_BEGV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
534 m
= BVAR (b
, zv_marker
);
535 SET_BUF_ZV_BOTH (b
, marker_position (m
), marker_byte_position (m
));
540 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer
, Smake_indirect_buffer
,
542 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
543 doc
: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
544 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
545 NAME should be a string which is not the name of an existing buffer.
546 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
547 such as major and minor modes, in the indirect buffer.
548 CLONE nil means the indirect buffer's state is reset to default values. */)
549 (Lisp_Object base_buffer
, Lisp_Object name
, Lisp_Object clone
)
551 Lisp_Object buf
, tem
;
555 buf
= Fget_buffer (name
);
557 error ("Buffer name `%s' is in use", SDATA (name
));
560 base_buffer
= Fget_buffer (base_buffer
);
561 if (NILP (base_buffer
))
562 error ("No such buffer: `%s'", SDATA (tem
));
563 if (NILP (BVAR (XBUFFER (base_buffer
), name
)))
564 error ("Base buffer has been killed");
566 if (SCHARS (name
) == 0)
567 error ("Empty string for buffer name is not allowed");
569 b
= allocate_buffer ();
571 b
->base_buffer
= (XBUFFER (base_buffer
)->base_buffer
572 ? XBUFFER (base_buffer
)->base_buffer
573 : XBUFFER (base_buffer
));
575 /* Use the base buffer's text object. */
576 b
->text
= b
->base_buffer
->text
;
578 b
->pt
= b
->base_buffer
->pt
;
579 b
->begv
= b
->base_buffer
->begv
;
580 b
->zv
= b
->base_buffer
->zv
;
581 b
->pt_byte
= b
->base_buffer
->pt_byte
;
582 b
->begv_byte
= b
->base_buffer
->begv_byte
;
583 b
->zv_byte
= b
->base_buffer
->zv_byte
;
585 b
->newline_cache
= 0;
586 b
->width_run_cache
= 0;
587 BVAR (b
, width_table
) = Qnil
;
589 /* Put this on the chain of all buffers including killed ones. */
590 b
->header
.next
.buffer
= all_buffers
;
593 name
= Fcopy_sequence (name
);
594 STRING_SET_INTERVALS (name
, NULL_INTERVAL
);
595 BVAR (b
, name
) = name
;
598 reset_buffer_local_variables (b
, 1);
600 /* Put this in the alist of all live buffers. */
602 Vbuffer_alist
= nconc2 (Vbuffer_alist
, Fcons (Fcons (name
, buf
), Qnil
));
604 BVAR (b
, mark
) = Fmake_marker ();
606 /* The multibyte status belongs to the base buffer. */
607 BVAR (b
, enable_multibyte_characters
) = BVAR (b
->base_buffer
, enable_multibyte_characters
);
609 /* Make sure the base buffer has markers for its narrowing. */
610 if (NILP (BVAR (b
->base_buffer
, pt_marker
)))
612 eassert (NILP (BVAR (b
->base_buffer
, begv_marker
)));
613 eassert (NILP (BVAR (b
->base_buffer
, zv_marker
)));
615 BVAR (b
->base_buffer
, pt_marker
)
616 = build_marker (b
->base_buffer
, b
->base_buffer
->pt
, b
->base_buffer
->pt_byte
);
618 BVAR (b
->base_buffer
, begv_marker
)
619 = build_marker (b
->base_buffer
, b
->base_buffer
->begv
, b
->base_buffer
->begv_byte
);
621 BVAR (b
->base_buffer
, zv_marker
)
622 = build_marker (b
->base_buffer
, b
->base_buffer
->zv
, b
->base_buffer
->zv_byte
);
624 XMARKER (BVAR (b
->base_buffer
, zv_marker
))->insertion_type
= 1;
629 /* Give the indirect buffer markers for its narrowing. */
630 BVAR (b
, pt_marker
) = build_marker (b
, b
->pt
, b
->pt_byte
);
631 BVAR (b
, begv_marker
) = build_marker (b
, b
->begv
, b
->begv_byte
);
632 BVAR (b
, zv_marker
) = build_marker (b
, b
->zv
, b
->zv_byte
);
633 XMARKER (BVAR (b
, zv_marker
))->insertion_type
= 1;
637 struct buffer
*old_b
= current_buffer
;
639 clone_per_buffer_values (b
->base_buffer
, b
);
640 BVAR (b
, filename
) = Qnil
;
641 BVAR (b
, file_truename
) = Qnil
;
642 BVAR (b
, display_count
) = make_number (0);
643 BVAR (b
, backed_up
) = Qnil
;
644 BVAR (b
, auto_save_file_name
) = Qnil
;
645 set_buffer_internal_1 (b
);
646 Fset (intern ("buffer-save-without-query"), Qnil
);
647 Fset (intern ("buffer-file-number"), Qnil
);
648 Fset (intern ("buffer-stale-function"), Qnil
);
649 set_buffer_internal_1 (old_b
);
652 /* Run buffer-list-update-hook. */
653 if (!NILP (Vrun_hooks
))
654 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
659 /* Mark OV as no longer associated with B. */
662 drop_overlay (struct buffer
*b
, struct Lisp_Overlay
*ov
)
664 eassert (b
== XBUFFER (Fmarker_buffer (ov
->start
)));
665 modify_overlay (b
, marker_position (ov
->start
), marker_position (ov
->end
));
666 Fset_marker (ov
->start
, Qnil
, Qnil
);
667 Fset_marker (ov
->end
, Qnil
, Qnil
);
671 /* Delete all overlays of B and reset it's overlay lists. */
674 delete_all_overlays (struct buffer
*b
)
676 struct Lisp_Overlay
*ov
, *next
;
678 for (ov
= b
->overlays_before
; ov
; ov
= next
)
680 drop_overlay (b
, ov
);
685 for (ov
= b
->overlays_after
; ov
; ov
= next
)
687 drop_overlay (b
, ov
);
692 b
->overlays_before
= b
->overlays_after
= NULL
;
695 /* Reinitialize everything about a buffer except its name and contents
697 If called on an already-initialized buffer, the list of overlays
698 should be deleted before calling this function, otherwise we end up
699 with overlays that claim to belong to the buffer but the buffer
700 claims it doesn't belong to it. */
703 reset_buffer (register struct buffer
*b
)
705 BVAR (b
, filename
) = Qnil
;
706 BVAR (b
, file_truename
) = Qnil
;
707 BVAR (b
, directory
) = (current_buffer
) ? BVAR (current_buffer
, directory
) : Qnil
;
708 b
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
709 b
->modtime_size
= -1;
710 XSETFASTINT (BVAR (b
, save_length
), 0);
711 b
->last_window_start
= 1;
712 /* It is more conservative to start out "changed" than "unchanged". */
714 b
->prevent_redisplay_optimizations_p
= 1;
715 BVAR (b
, backed_up
) = Qnil
;
716 BUF_AUTOSAVE_MODIFF (b
) = 0;
717 b
->auto_save_failure_time
= 0;
718 BVAR (b
, auto_save_file_name
) = Qnil
;
719 BVAR (b
, read_only
) = Qnil
;
720 b
->overlays_before
= NULL
;
721 b
->overlays_after
= NULL
;
722 b
->overlay_center
= BEG
;
723 BVAR (b
, mark_active
) = Qnil
;
724 BVAR (b
, point_before_scroll
) = Qnil
;
725 BVAR (b
, file_format
) = Qnil
;
726 BVAR (b
, auto_save_file_format
) = Qt
;
727 BVAR (b
, last_selected_window
) = Qnil
;
728 XSETINT (BVAR (b
, display_count
), 0);
729 BVAR (b
, display_time
) = Qnil
;
730 BVAR (b
, enable_multibyte_characters
) = BVAR (&buffer_defaults
, enable_multibyte_characters
);
731 BVAR (b
, cursor_type
) = BVAR (&buffer_defaults
, cursor_type
);
732 BVAR (b
, extra_line_spacing
) = BVAR (&buffer_defaults
, extra_line_spacing
);
734 b
->display_error_modiff
= 0;
737 /* Reset buffer B's local variables info.
738 Don't use this on a buffer that has already been in use;
739 it does not treat permanent locals consistently.
740 Instead, use Fkill_all_local_variables.
742 If PERMANENT_TOO is 1, then we reset permanent
743 buffer-local variables. If PERMANENT_TOO is 0,
744 we preserve those. */
747 reset_buffer_local_variables (register struct buffer
*b
, int permanent_too
)
752 /* Reset the major mode to Fundamental, together with all the
753 things that depend on the major mode.
754 default-major-mode is handled at a higher level.
755 We ignore it here. */
756 BVAR (b
, major_mode
) = Qfundamental_mode
;
757 BVAR (b
, keymap
) = Qnil
;
758 BVAR (b
, mode_name
) = QSFundamental
;
759 BVAR (b
, minor_modes
) = Qnil
;
761 /* If the standard case table has been altered and invalidated,
762 fix up its insides first. */
763 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[0])
764 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[1])
765 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table
)->extras
[2])))
766 Fset_standard_case_table (Vascii_downcase_table
);
768 BVAR (b
, downcase_table
) = Vascii_downcase_table
;
769 BVAR (b
, upcase_table
) = XCHAR_TABLE (Vascii_downcase_table
)->extras
[0];
770 BVAR (b
, case_canon_table
) = XCHAR_TABLE (Vascii_downcase_table
)->extras
[1];
771 BVAR (b
, case_eqv_table
) = XCHAR_TABLE (Vascii_downcase_table
)->extras
[2];
772 BVAR (b
, invisibility_spec
) = Qt
;
774 /* Reset all (or most) per-buffer variables to their defaults. */
776 BVAR (b
, local_var_alist
) = Qnil
;
779 Lisp_Object tmp
, prop
, last
= Qnil
;
780 for (tmp
= BVAR (b
, local_var_alist
); CONSP (tmp
); tmp
= XCDR (tmp
))
781 if (!NILP (prop
= Fget (XCAR (XCAR (tmp
)), Qpermanent_local
)))
783 /* If permanent-local, keep it. */
785 if (EQ (prop
, Qpermanent_local_hook
))
787 /* This is a partially permanent hook variable.
788 Preserve only the elements that want to be preserved. */
789 Lisp_Object list
, newlist
;
790 list
= XCDR (XCAR (tmp
));
794 for (newlist
= Qnil
; CONSP (list
); list
= XCDR (list
))
796 Lisp_Object elt
= XCAR (list
);
797 /* Preserve element ELT if it's t,
798 if it is a function with a `permanent-local-hook' property,
799 or if it's not a symbol. */
802 || !NILP (Fget (elt
, Qpermanent_local_hook
)))
803 newlist
= Fcons (elt
, newlist
);
805 XSETCDR (XCAR (tmp
), Fnreverse (newlist
));
808 /* Delete this local variable. */
809 else if (NILP (last
))
810 BVAR (b
, local_var_alist
) = XCDR (tmp
);
812 XSETCDR (last
, XCDR (tmp
));
815 for (i
= 0; i
< last_per_buffer_idx
; ++i
)
816 if (permanent_too
|| buffer_permanent_local_flags
[i
] == 0)
817 SET_PER_BUFFER_VALUE_P (b
, i
, 0);
819 /* For each slot that has a default value, copy that into the slot. */
820 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
822 int idx
= PER_BUFFER_IDX (offset
);
825 || buffer_permanent_local_flags
[idx
] == 0)))
826 PER_BUFFER_VALUE (b
, offset
) = PER_BUFFER_DEFAULT (offset
);
830 /* We split this away from generate-new-buffer, because rename-buffer
831 and set-visited-file-name ought to be able to use this to really
832 rename the buffer properly. */
834 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name
,
835 Sgenerate_new_buffer_name
, 1, 2, 0,
836 doc
: /* Return a string that is the name of no existing buffer based on NAME.
837 If there is no live buffer named NAME, then return NAME.
838 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
839 \(starting at 2) until an unused name is found, and then return that name.
840 Optional second argument IGNORE specifies a name that is okay to use (if
841 it is in the sequence to be tried) even if a buffer with that name exists.
843 If NAME begins with a space (i.e., a buffer that is not normally
844 visible to users), then if buffer NAME already exists a random number
845 is first appended to NAME, to speed up finding a non-existent buffer. */)
846 (register Lisp_Object name
, Lisp_Object ignore
)
848 register Lisp_Object gentemp
, tem
, tem2
;
850 char number
[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
854 tem
= Fstring_equal (name
, ignore
);
857 tem
= Fget_buffer (name
);
861 if (!strncmp (SSDATA (name
), " ", 1)) /* see bug#1229 */
863 /* Note fileio.c:make_temp_name does random differently. */
864 tem2
= concat2 (name
, make_formatted_string
866 XFASTINT (Frandom (make_number (999999)))));
867 tem
= Fget_buffer (tem2
);
877 gentemp
= concat2 (tem2
, make_formatted_string
878 (number
, "<%"pD
"d>", ++count
));
879 tem
= Fstring_equal (gentemp
, ignore
);
882 tem
= Fget_buffer (gentemp
);
889 DEFUN ("buffer-name", Fbuffer_name
, Sbuffer_name
, 0, 1, 0,
890 doc
: /* Return the name of BUFFER, as a string.
891 BUFFER defaults to the current buffer.
892 Return nil if BUFFER has been killed. */)
893 (register Lisp_Object buffer
)
896 return BVAR (current_buffer
, name
);
897 CHECK_BUFFER (buffer
);
898 return BVAR (XBUFFER (buffer
), name
);
901 DEFUN ("buffer-file-name", Fbuffer_file_name
, Sbuffer_file_name
, 0, 1, 0,
902 doc
: /* Return name of file BUFFER is visiting, or nil if none.
903 No argument or nil as argument means use the current buffer. */)
904 (register Lisp_Object buffer
)
907 return BVAR (current_buffer
, filename
);
908 CHECK_BUFFER (buffer
);
909 return BVAR (XBUFFER (buffer
), filename
);
912 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer
, Sbuffer_base_buffer
,
914 doc
: /* Return the base buffer of indirect buffer BUFFER.
915 If BUFFER is not indirect, return nil.
916 BUFFER defaults to the current buffer. */)
917 (register Lisp_Object buffer
)
920 Lisp_Object base_buffer
;
923 base
= current_buffer
->base_buffer
;
926 CHECK_BUFFER (buffer
);
927 base
= XBUFFER (buffer
)->base_buffer
;
932 XSETBUFFER (base_buffer
, base
);
936 DEFUN ("buffer-local-value", Fbuffer_local_value
,
937 Sbuffer_local_value
, 2, 2, 0,
938 doc
: /* Return the value of VARIABLE in BUFFER.
939 If VARIABLE does not have a buffer-local binding in BUFFER, the value
940 is the default binding of the variable. */)
941 (register Lisp_Object variable
, register Lisp_Object buffer
)
943 register Lisp_Object result
= buffer_local_value_1 (variable
, buffer
);
945 if (EQ (result
, Qunbound
))
946 xsignal1 (Qvoid_variable
, variable
);
952 /* Like Fbuffer_local_value, but return Qunbound if the variable is
956 buffer_local_value_1 (Lisp_Object variable
, Lisp_Object buffer
)
958 register struct buffer
*buf
;
959 register Lisp_Object result
;
960 struct Lisp_Symbol
*sym
;
962 CHECK_SYMBOL (variable
);
963 CHECK_BUFFER (buffer
);
964 buf
= XBUFFER (buffer
);
965 sym
= XSYMBOL (variable
);
968 switch (sym
->redirect
)
970 case SYMBOL_VARALIAS
: sym
= indirect_variable (sym
); goto start
;
971 case SYMBOL_PLAINVAL
: result
= SYMBOL_VAL (sym
); break;
972 case SYMBOL_LOCALIZED
:
973 { /* Look in local_var_alist. */
974 struct Lisp_Buffer_Local_Value
*blv
= SYMBOL_BLV (sym
);
975 XSETSYMBOL (variable
, sym
); /* Update In case of aliasing. */
976 result
= Fassoc (variable
, BVAR (buf
, local_var_alist
));
980 { /* What binding is loaded right now? */
981 Lisp_Object current_alist_element
= blv
->valcell
;
983 /* The value of the currently loaded binding is not
984 stored in it, but rather in the realvalue slot.
985 Store that value into the binding it belongs to
986 in case that is the one we are about to use. */
988 XSETCDR (current_alist_element
,
989 do_symval_forwarding (blv
->fwd
));
991 /* Now get the (perhaps updated) value out of the binding. */
992 result
= XCDR (result
);
995 result
= Fdefault_value (variable
);
998 case SYMBOL_FORWARDED
:
1000 union Lisp_Fwd
*fwd
= SYMBOL_FWD (sym
);
1001 if (BUFFER_OBJFWDP (fwd
))
1002 result
= PER_BUFFER_VALUE (buf
, XBUFFER_OBJFWD (fwd
)->offset
);
1004 result
= Fdefault_value (variable
);
1013 /* Return an alist of the Lisp-level buffer-local bindings of
1014 buffer BUF. That is, don't include the variables maintained
1015 in special slots in the buffer object.
1016 If CLONE is zero elements of the form (VAR . unbound) are replaced
1020 buffer_lisp_local_variables (struct buffer
*buf
, int clone
)
1022 Lisp_Object result
= Qnil
;
1023 register Lisp_Object tail
;
1024 for (tail
= BVAR (buf
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
1026 Lisp_Object val
, elt
;
1030 /* Reference each variable in the alist in buf.
1031 If inquiring about the current buffer, this gets the current values,
1032 so store them into the alist so the alist is up to date.
1033 If inquiring about some other buffer, this swaps out any values
1034 for that buffer, making the alist up to date automatically. */
1035 val
= find_symbol_value (XCAR (elt
));
1036 /* Use the current buffer value only if buf is the current buffer. */
1037 if (buf
!= current_buffer
)
1040 result
= Fcons (!clone
&& EQ (val
, Qunbound
)
1042 : Fcons (XCAR (elt
), val
),
1049 DEFUN ("buffer-local-variables", Fbuffer_local_variables
,
1050 Sbuffer_local_variables
, 0, 1, 0,
1051 doc
: /* Return an alist of variables that are buffer-local in BUFFER.
1052 Most elements look like (SYMBOL . VALUE), describing one variable.
1053 For a symbol that is locally unbound, just the symbol appears in the value.
1054 Note that storing new VALUEs in these elements doesn't change the variables.
1055 No argument or nil as argument means use current buffer as BUFFER. */)
1056 (register Lisp_Object buffer
)
1058 register struct buffer
*buf
;
1059 register Lisp_Object result
;
1062 buf
= current_buffer
;
1065 CHECK_BUFFER (buffer
);
1066 buf
= XBUFFER (buffer
);
1069 result
= buffer_lisp_local_variables (buf
, 0);
1071 /* Add on all the variables stored in special slots. */
1075 FOR_EACH_PER_BUFFER_OBJECT_AT (offset
)
1077 idx
= PER_BUFFER_IDX (offset
);
1078 if ((idx
== -1 || PER_BUFFER_VALUE_P (buf
, idx
))
1079 && SYMBOLP (PER_BUFFER_SYMBOL (offset
)))
1081 Lisp_Object sym
= PER_BUFFER_SYMBOL (offset
);
1082 Lisp_Object val
= PER_BUFFER_VALUE (buf
, offset
);
1083 result
= Fcons (EQ (val
, Qunbound
) ? sym
: Fcons (sym
, val
),
1092 DEFUN ("buffer-modified-p", Fbuffer_modified_p
, Sbuffer_modified_p
,
1094 doc
: /* Return t if BUFFER was modified since its file was last read or saved.
1095 No argument or nil as argument means use current buffer as BUFFER. */)
1096 (register Lisp_Object buffer
)
1098 register struct buffer
*buf
;
1100 buf
= current_buffer
;
1103 CHECK_BUFFER (buffer
);
1104 buf
= XBUFFER (buffer
);
1107 return BUF_SAVE_MODIFF (buf
) < BUF_MODIFF (buf
) ? Qt
: Qnil
;
1110 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p
, Sset_buffer_modified_p
,
1112 doc
: /* Mark current buffer as modified or unmodified according to FLAG.
1113 A non-nil FLAG means mark the buffer modified. */)
1114 (register Lisp_Object flag
)
1116 register int already
;
1117 register Lisp_Object fn
;
1118 Lisp_Object buffer
, window
;
1120 #ifdef CLASH_DETECTION
1121 /* If buffer becoming modified, lock the file.
1122 If buffer becoming unmodified, unlock the file. */
1124 fn
= BVAR (current_buffer
, file_truename
);
1125 /* Test buffer-file-name so that binding it to nil is effective. */
1126 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1128 already
= SAVE_MODIFF
< MODIFF
;
1129 if (!already
&& !NILP (flag
))
1131 else if (already
&& NILP (flag
))
1134 #endif /* CLASH_DETECTION */
1136 /* Here we have a problem. SAVE_MODIFF is used here to encode
1137 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1138 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1139 modify SAVE_MODIFF to affect one, we may affect the other
1141 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1142 if SAVE_MODIFF<auto_save_modified that means we risk changing
1143 recent-auto-save-p from t to nil.
1144 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1145 we risk changing recent-auto-save-p from nil to t. */
1146 SAVE_MODIFF
= (NILP (flag
)
1147 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1149 /* Let's try to preserve recent-auto-save-p. */
1150 : SAVE_MODIFF
< MODIFF
? SAVE_MODIFF
1151 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1152 we can either decrease SAVE_MODIFF and auto_save_modified
1153 or increase MODIFF. */
1156 /* Set update_mode_lines only if buffer is displayed in some window.
1157 Packages like jit-lock or lazy-lock preserve a buffer's modified
1158 state by recording/restoring the state around blocks of code.
1159 Setting update_mode_lines makes redisplay consider all windows
1160 (on all frames). Stealth fontification of buffers not displayed
1161 would incur additional redisplay costs if we'd set
1162 update_modes_lines unconditionally.
1164 Ideally, I think there should be another mechanism for fontifying
1165 buffers without "modifying" buffers, or redisplay should be
1166 smarter about updating the `*' in mode lines. --gerd */
1167 XSETBUFFER (buffer
, current_buffer
);
1168 window
= Fget_buffer_window (buffer
, Qt
);
1169 if (WINDOWP (window
))
1171 ++update_mode_lines
;
1172 current_buffer
->prevent_redisplay_optimizations_p
= 1;
1178 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p
,
1179 Srestore_buffer_modified_p
, 1, 1, 0,
1180 doc
: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1181 It is not ensured that mode lines will be updated to show the modified
1182 state of the current buffer. Use with care. */)
1185 #ifdef CLASH_DETECTION
1188 /* If buffer becoming modified, lock the file.
1189 If buffer becoming unmodified, unlock the file. */
1191 fn
= BVAR (current_buffer
, file_truename
);
1192 /* Test buffer-file-name so that binding it to nil is effective. */
1193 if (!NILP (fn
) && ! NILP (BVAR (current_buffer
, filename
)))
1195 int already
= SAVE_MODIFF
< MODIFF
;
1196 if (!already
&& !NILP (flag
))
1198 else if (already
&& NILP (flag
))
1201 #endif /* CLASH_DETECTION */
1203 SAVE_MODIFF
= NILP (flag
) ? MODIFF
: 0;
1207 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick
, Sbuffer_modified_tick
,
1209 doc
: /* Return BUFFER's tick counter, incremented for each change in text.
1210 Each buffer has a tick counter which is incremented each time the
1211 text in that buffer is changed. It wraps around occasionally.
1212 No argument or nil as argument means use current buffer as BUFFER. */)
1213 (register Lisp_Object buffer
)
1215 register struct buffer
*buf
;
1217 buf
= current_buffer
;
1220 CHECK_BUFFER (buffer
);
1221 buf
= XBUFFER (buffer
);
1224 return make_number (BUF_MODIFF (buf
));
1227 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick
,
1228 Sbuffer_chars_modified_tick
, 0, 1, 0,
1229 doc
: /* Return BUFFER's character-change tick counter.
1230 Each buffer has a character-change tick counter, which is set to the
1231 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1232 time text in that buffer is inserted or deleted. By comparing the
1233 values returned by two individual calls of `buffer-chars-modified-tick',
1234 you can tell whether a character change occurred in that buffer in
1235 between these calls. No argument or nil as argument means use current
1236 buffer as BUFFER. */)
1237 (register Lisp_Object buffer
)
1239 register struct buffer
*buf
;
1241 buf
= current_buffer
;
1244 CHECK_BUFFER (buffer
);
1245 buf
= XBUFFER (buffer
);
1248 return make_number (BUF_CHARS_MODIFF (buf
));
1251 DEFUN ("rename-buffer", Frename_buffer
, Srename_buffer
, 1, 2,
1252 "(list (read-string \"Rename buffer (to new name): \" \
1253 nil 'buffer-name-history (buffer-name (current-buffer))) \
1254 current-prefix-arg)",
1255 doc
: /* Change current buffer's name to NEWNAME (a string).
1256 If second arg UNIQUE is nil or omitted, it is an error if a
1257 buffer named NEWNAME already exists.
1258 If UNIQUE is non-nil, come up with a new name using
1259 `generate-new-buffer-name'.
1260 Interactively, you can set UNIQUE with a prefix argument.
1261 We return the name we actually gave the buffer.
1262 This does not change the name of the visited file (if any). */)
1263 (register Lisp_Object newname
, Lisp_Object unique
)
1265 register Lisp_Object tem
, buf
;
1267 CHECK_STRING (newname
);
1269 if (SCHARS (newname
) == 0)
1270 error ("Empty string is invalid as a buffer name");
1272 tem
= Fget_buffer (newname
);
1275 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1276 rename the buffer automatically so you can create another
1277 with the original name. It makes UNIQUE equivalent to
1278 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1279 if (NILP (unique
) && XBUFFER (tem
) == current_buffer
)
1280 return BVAR (current_buffer
, name
);
1282 newname
= Fgenerate_new_buffer_name (newname
, BVAR (current_buffer
, name
));
1284 error ("Buffer name `%s' is in use", SDATA (newname
));
1287 BVAR (current_buffer
, name
) = newname
;
1289 /* Catch redisplay's attention. Unless we do this, the mode lines for
1290 any windows displaying current_buffer will stay unchanged. */
1291 update_mode_lines
++;
1293 XSETBUFFER (buf
, current_buffer
);
1294 Fsetcar (Frassq (buf
, Vbuffer_alist
), newname
);
1295 if (NILP (BVAR (current_buffer
, filename
))
1296 && !NILP (BVAR (current_buffer
, auto_save_file_name
)))
1297 call0 (intern ("rename-auto-save-file"));
1299 /* Run buffer-list-update-hook. */
1300 if (!NILP (Vrun_hooks
))
1301 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1303 /* Refetch since that last call may have done GC. */
1304 return BVAR (current_buffer
, name
);
1307 DEFUN ("other-buffer", Fother_buffer
, Sother_buffer
, 0, 3, 0,
1308 doc
: /* Return most recently selected buffer other than BUFFER.
1309 Buffers not visible in windows are preferred to visible buffers, unless
1310 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1311 BUFFER unless it denotes a live buffer. If the optional third argument
1312 FRAME is non-nil, use that frame's buffer list instead of the selected
1313 frame's buffer list.
1315 The buffer is found by scanning the selected or specified frame's buffer
1316 list first, followed by the list of all buffers. If no other buffer
1317 exists, return the buffer `*scratch*' (creating it if necessary). */)
1318 (register Lisp_Object buffer
, Lisp_Object visible_ok
, Lisp_Object frame
)
1320 Lisp_Object
Fset_buffer_major_mode (Lisp_Object buffer
);
1321 Lisp_Object tail
, buf
, pred
;
1322 Lisp_Object notsogood
= Qnil
;
1325 frame
= selected_frame
;
1327 CHECK_FRAME (frame
);
1329 pred
= frame_buffer_predicate (frame
);
1330 /* Consider buffers that have been seen in the frame first. */
1331 tail
= XFRAME (frame
)->buffer_list
;
1332 for (; CONSP (tail
); tail
= XCDR (tail
))
1335 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1336 && !NILP (BVAR (XBUFFER (buf
), name
))
1337 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' ')
1338 /* If the frame has a buffer_predicate, disregard buffers that
1339 don't fit the predicate. */
1340 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1342 if (!NILP (visible_ok
)
1343 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1345 else if (NILP (notsogood
))
1350 /* Consider alist of all buffers next. */
1351 tail
= Vbuffer_alist
;
1352 for (; CONSP (tail
); tail
= XCDR (tail
))
1354 buf
= Fcdr (XCAR (tail
));
1355 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1356 && !NILP (BVAR (XBUFFER (buf
), name
))
1357 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' ')
1358 /* If the frame has a buffer_predicate, disregard buffers that
1359 don't fit the predicate. */
1360 && (NILP (pred
) || !NILP (call1 (pred
, buf
))))
1362 if (!NILP (visible_ok
)
1363 || NILP (Fget_buffer_window (buf
, Qvisible
)))
1365 else if (NILP (notsogood
))
1370 if (!NILP (notsogood
))
1374 buf
= Fget_buffer (build_string ("*scratch*"));
1377 buf
= Fget_buffer_create (build_string ("*scratch*"));
1378 Fset_buffer_major_mode (buf
);
1384 /* The following function is a safe variant of Fother_buffer: It doesn't
1385 pay attention to any frame-local buffer lists, doesn't care about
1386 visibility of buffers, and doesn't evaluate any frame predicates. */
1389 other_buffer_safely (Lisp_Object buffer
)
1391 Lisp_Object
Fset_buffer_major_mode (Lisp_Object buffer
);
1392 Lisp_Object tail
, buf
;
1394 tail
= Vbuffer_alist
;
1395 for (; CONSP (tail
); tail
= XCDR (tail
))
1397 buf
= Fcdr (XCAR (tail
));
1398 if (BUFFERP (buf
) && !EQ (buf
, buffer
)
1399 && !NILP (BVAR (XBUFFER (buf
), name
))
1400 && (SREF (BVAR (XBUFFER (buf
), name
), 0) != ' '))
1404 buf
= Fget_buffer (build_string ("*scratch*"));
1407 buf
= Fget_buffer_create (build_string ("*scratch*"));
1408 Fset_buffer_major_mode (buf
);
1414 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo
, Sbuffer_enable_undo
,
1416 doc
: /* Start keeping undo information for buffer BUFFER.
1417 No argument or nil as argument means do this for the current buffer. */)
1418 (register Lisp_Object buffer
)
1420 Lisp_Object real_buffer
;
1423 XSETBUFFER (real_buffer
, current_buffer
);
1426 real_buffer
= Fget_buffer (buffer
);
1427 if (NILP (real_buffer
))
1431 if (EQ (BVAR (XBUFFER (real_buffer
), undo_list
), Qt
))
1432 BVAR (XBUFFER (real_buffer
), undo_list
) = Qnil
;
1437 /* Truncate undo list and shrink the gap of BUFFER. */
1440 compact_buffer (struct buffer
*buffer
)
1442 /* Skip dead buffers, indirect buffers and buffers
1443 which aren't changed since last compaction. */
1444 if (!NILP (buffer
->BUFFER_INTERNAL_FIELD (name
))
1445 && (buffer
->base_buffer
== NULL
)
1446 && (buffer
->text
->compact
!= buffer
->text
->modiff
))
1448 /* If a buffer's undo list is Qt, that means that undo is
1449 turned off in that buffer. Calling truncate_undo_list on
1450 Qt tends to return NULL, which effectively turns undo back on.
1451 So don't call truncate_undo_list if undo_list is Qt. */
1452 if (!EQ (buffer
->BUFFER_INTERNAL_FIELD (undo_list
), Qt
))
1453 truncate_undo_list (buffer
);
1455 /* Shrink buffer gaps. */
1456 if (!buffer
->text
->inhibit_shrinking
)
1458 /* If a buffer's gap size is more than 10% of the buffer
1459 size, or larger than 2000 bytes, then shrink it
1460 accordingly. Keep a minimum size of 20 bytes. */
1461 int size
= min (2000, max (20, (buffer
->text
->z_byte
/ 10)));
1463 if (buffer
->text
->gap_size
> size
)
1465 struct buffer
*save_current
= current_buffer
;
1466 current_buffer
= buffer
;
1467 make_gap (-(buffer
->text
->gap_size
- size
));
1468 current_buffer
= save_current
;
1471 buffer
->text
->compact
= buffer
->text
->modiff
;
1477 DEFUN ("compact-buffer", Fcompact_buffer
, Scompact_buffer
, 0, 1, 0,
1478 doc
: /* Compact BUFFER by truncating undo list and shrinking the gap.
1479 If buffer is nil, compact current buffer. Compaction is performed
1480 only if buffer was changed since last compaction. Return t if
1481 buffer compaction was performed, and nil otherwise. */)
1482 (Lisp_Object buffer
)
1485 XSETBUFFER (buffer
, current_buffer
);
1486 CHECK_BUFFER (buffer
);
1487 return compact_buffer (XBUFFER (buffer
)) ? Qt
: Qnil
;
1490 DEFUN ("kill-buffer", Fkill_buffer
, Skill_buffer
, 0, 1, "bKill buffer: ",
1491 doc
: /* Kill the buffer specified by BUFFER-OR-NAME.
1492 The argument may be a buffer or the name of an existing buffer.
1493 Argument nil or omitted means kill the current buffer. Return t if the
1494 buffer is actually killed, nil otherwise.
1496 The functions in `kill-buffer-query-functions' are called with the
1497 buffer to be killed as the current buffer. If any of them returns nil,
1498 the buffer is not killed. The hook `kill-buffer-hook' is run before the
1499 buffer is actually killed. The buffer being killed will be current
1500 while the hook is running. Functions called by any of these hooks are
1501 supposed to not change the current buffer.
1503 Any processes that have this buffer as the `process-buffer' are killed
1504 with SIGHUP. This function calls `replace-buffer-in-windows' for
1505 cleaning up all windows currently displaying the buffer to be killed. */)
1506 (Lisp_Object buffer_or_name
)
1509 register struct buffer
*b
;
1510 register Lisp_Object tem
;
1511 register struct Lisp_Marker
*m
;
1512 struct gcpro gcpro1
;
1514 if (NILP (buffer_or_name
))
1515 buffer
= Fcurrent_buffer ();
1517 buffer
= Fget_buffer (buffer_or_name
);
1519 nsberror (buffer_or_name
);
1521 b
= XBUFFER (buffer
);
1523 /* Avoid trouble for buffer already dead. */
1524 if (NILP (BVAR (b
, name
)))
1527 /* Query if the buffer is still modified. */
1528 if (INTERACTIVE
&& !NILP (BVAR (b
, filename
))
1529 && BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
1532 tem
= do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1533 BVAR (b
, name
), make_number (0)));
1539 /* Run hooks with the buffer to be killed the current buffer. */
1541 ptrdiff_t count
= SPECPDL_INDEX ();
1542 Lisp_Object arglist
[1];
1544 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1545 set_buffer_internal (b
);
1547 /* First run the query functions; if any query is answered no,
1548 don't kill the buffer. */
1549 arglist
[0] = Qkill_buffer_query_functions
;
1550 tem
= Frun_hook_with_args_until_failure (1, arglist
);
1552 return unbind_to (count
, Qnil
);
1554 /* Then run the hooks. */
1555 Frun_hooks (1, &Qkill_buffer_hook
);
1556 unbind_to (count
, Qnil
);
1559 /* If the hooks have killed the buffer, exit now. */
1560 if (NILP (BVAR (b
, name
)))
1563 /* We have no more questions to ask. Verify that it is valid
1564 to kill the buffer. This must be done after the questions
1565 since anything can happen within do_yes_or_no_p. */
1567 /* Don't kill the minibuffer now current. */
1568 if (EQ (buffer
, XWINDOW (minibuf_window
)->buffer
))
1571 /* When we kill a base buffer, kill all its indirect buffers.
1572 We do it at this stage so nothing terrible happens if they
1573 ask questions or their hooks get errors. */
1574 if (! b
->base_buffer
)
1576 struct buffer
*other
;
1580 FOR_EACH_BUFFER (other
)
1581 if (other
->base_buffer
== b
)
1584 XSETBUFFER (buf
, other
);
1590 /* Exit if we now have killed the base buffer (Bug#11665). */
1591 if (NILP (BVAR (b
, name
)))
1595 /* Run replace_buffer_in_windows before making another buffer current
1596 since set-window-buffer-start-and-point will refuse to make another
1597 buffer current if the selected window does not show the current
1598 buffer. (Bug#10114) */
1599 replace_buffer_in_windows (buffer
);
1601 /* Exit if replacing the buffer in windows has killed our buffer. */
1602 if (NILP (BVAR (b
, name
)))
1605 /* Make this buffer not be current. Exit if it is the sole visible
1607 if (b
== current_buffer
)
1609 tem
= Fother_buffer (buffer
, Qnil
, Qnil
);
1611 if (b
== current_buffer
)
1615 /* If the buffer now current is shown in the minibuffer and our buffer
1616 is the sole other buffer give up. */
1617 XSETBUFFER (tem
, current_buffer
);
1618 if (EQ (tem
, XWINDOW (minibuf_window
)->buffer
)
1619 && EQ (buffer
, Fother_buffer (buffer
, Qnil
, Qnil
)))
1622 /* Now there is no question: we can kill the buffer. */
1624 #ifdef CLASH_DETECTION
1625 /* Unlock this buffer's file, if it is locked. */
1627 #endif /* CLASH_DETECTION */
1630 kill_buffer_processes (buffer
);
1633 /* Killing buffer processes may run sentinels which may have killed
1635 if (NILP (BVAR (b
, name
)))
1638 /* These may run Lisp code and into infinite loops (if someone
1639 insisted on circular lists) so allow quitting here. */
1640 frames_discard_buffer (buffer
);
1642 clear_charpos_cache (b
);
1644 tem
= Vinhibit_quit
;
1646 /* Remove the buffer from the list of all buffers. */
1647 Vbuffer_alist
= Fdelq (Frassq (buffer
, Vbuffer_alist
), Vbuffer_alist
);
1648 /* If replace_buffer_in_windows didn't do its job fix that now. */
1649 replace_buffer_in_windows_safely (buffer
);
1650 Vinhibit_quit
= tem
;
1652 /* Delete any auto-save file, if we saved it in this session.
1653 But not if the buffer is modified. */
1654 if (STRINGP (BVAR (b
, auto_save_file_name
))
1655 && BUF_AUTOSAVE_MODIFF (b
) != 0
1656 && BUF_SAVE_MODIFF (b
) < BUF_AUTOSAVE_MODIFF (b
)
1657 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
1658 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1661 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1662 if (! NILP (delete))
1663 internal_delete_file (BVAR (b
, auto_save_file_name
));
1666 /* Deleting an auto-save file could have killed our buffer. */
1667 if (NILP (BVAR (b
, name
)))
1672 /* Unchain all markers that belong to this indirect buffer.
1673 Don't unchain the markers that belong to the base buffer
1674 or its other indirect buffers. */
1675 for (m
= BUF_MARKERS (b
); m
; )
1677 struct Lisp_Marker
*next
= m
->next
;
1685 /* Unchain all markers of this buffer and its indirect buffers.
1686 and leave them pointing nowhere. */
1687 for (m
= BUF_MARKERS (b
); m
; )
1689 struct Lisp_Marker
*next
= m
->next
;
1694 BUF_MARKERS (b
) = NULL
;
1695 BUF_INTERVALS (b
) = NULL_INTERVAL
;
1697 /* Perhaps we should explicitly free the interval tree here... */
1700 /* Reset the local variables, so that this buffer's local values
1701 won't be protected from GC. They would be protected
1702 if they happened to remain cached in their symbols.
1703 This gets rid of them for certain. */
1704 swap_out_buffer_local_variables (b
);
1705 reset_buffer_local_variables (b
, 1);
1707 BVAR (b
, name
) = Qnil
;
1710 if (! b
->base_buffer
)
1711 free_buffer_text (b
);
1713 if (b
->newline_cache
)
1715 free_region_cache (b
->newline_cache
);
1716 b
->newline_cache
= 0;
1718 if (b
->width_run_cache
)
1720 free_region_cache (b
->width_run_cache
);
1721 b
->width_run_cache
= 0;
1723 BVAR (b
, width_table
) = Qnil
;
1725 BVAR (b
, undo_list
) = Qnil
;
1727 /* Run buffer-list-update-hook. */
1728 if (!NILP (Vrun_hooks
))
1729 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1734 /* Move association for BUFFER to the front of buffer (a)lists. Since
1735 we do this each time BUFFER is selected visibly, the more recently
1736 selected buffers are always closer to the front of those lists. This
1737 means that other_buffer is more likely to choose a relevant buffer.
1739 Note that this moves BUFFER to the front of the buffer lists of the
1740 selected frame even if BUFFER is not shown there. If BUFFER is not
1741 shown in the selected frame, consider the present behavior a feature.
1742 `select-window' gets this right since it shows BUFFER in the selected
1743 window when calling us. */
1746 record_buffer (Lisp_Object buffer
)
1748 Lisp_Object aelt
, aelt_cons
, tem
;
1749 register struct frame
*f
= XFRAME (selected_frame
);
1751 CHECK_BUFFER (buffer
);
1753 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1754 Don't allow quitting since this might leave the buffer list in an
1755 inconsistent state. */
1756 tem
= Vinhibit_quit
;
1758 aelt
= Frassq (buffer
, Vbuffer_alist
);
1759 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
1760 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
1761 XSETCDR (aelt_cons
, Vbuffer_alist
);
1762 Vbuffer_alist
= aelt_cons
;
1763 Vinhibit_quit
= tem
;
1765 /* Update buffer list of selected frame. */
1766 f
->buffer_list
= Fcons (buffer
, Fdelq (buffer
, f
->buffer_list
));
1767 f
->buried_buffer_list
= Fdelq (buffer
, f
->buried_buffer_list
);
1769 /* Run buffer-list-update-hook. */
1770 if (!NILP (Vrun_hooks
))
1771 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1775 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1776 buffer is killed. For the selected frame's buffer list this moves
1777 BUFFER to its end even if it was never shown in that frame. If
1778 this happens we have a feature, hence `bury-buffer-internal' should be
1779 called only when BUFFER was shown in the selected frame. */
1781 DEFUN ("bury-buffer-internal", Fbury_buffer_internal
, Sbury_buffer_internal
,
1783 doc
: /* Move BUFFER to the end of the buffer list. */)
1784 (Lisp_Object buffer
)
1786 Lisp_Object aelt
, aelt_cons
, tem
;
1787 register struct frame
*f
= XFRAME (selected_frame
);
1789 CHECK_BUFFER (buffer
);
1791 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1792 Don't allow quitting since this might leave the buffer list in an
1793 inconsistent state. */
1794 tem
= Vinhibit_quit
;
1796 aelt
= Frassq (buffer
, Vbuffer_alist
);
1797 aelt_cons
= Fmemq (aelt
, Vbuffer_alist
);
1798 Vbuffer_alist
= Fdelq (aelt
, Vbuffer_alist
);
1799 XSETCDR (aelt_cons
, Qnil
);
1800 Vbuffer_alist
= nconc2 (Vbuffer_alist
, aelt_cons
);
1801 Vinhibit_quit
= tem
;
1803 /* Update buffer lists of selected frame. */
1804 f
->buffer_list
= Fdelq (buffer
, f
->buffer_list
);
1805 f
->buried_buffer_list
= Fcons (buffer
, Fdelq (buffer
, f
->buried_buffer_list
));
1807 /* Run buffer-list-update-hook. */
1808 if (!NILP (Vrun_hooks
))
1809 call1 (Vrun_hooks
, Qbuffer_list_update_hook
);
1814 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode
, Sset_buffer_major_mode
, 1, 1, 0,
1815 doc
: /* Set an appropriate major mode for BUFFER.
1816 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1817 according to `default-major-mode'.
1818 Use this function before selecting the buffer, since it may need to inspect
1819 the current buffer's major mode. */)
1820 (Lisp_Object buffer
)
1823 Lisp_Object function
;
1825 CHECK_BUFFER (buffer
);
1827 if (STRINGP (BVAR (XBUFFER (buffer
), name
))
1828 && strcmp (SSDATA (BVAR (XBUFFER (buffer
), name
)), "*scratch*") == 0)
1829 function
= find_symbol_value (intern ("initial-major-mode"));
1832 function
= BVAR (&buffer_defaults
, major_mode
);
1834 && NILP (Fget (BVAR (current_buffer
, major_mode
), Qmode_class
)))
1835 function
= BVAR (current_buffer
, major_mode
);
1838 if (NILP (function
) || EQ (function
, Qfundamental_mode
))
1841 count
= SPECPDL_INDEX ();
1843 /* To select a nonfundamental mode,
1844 select the buffer temporarily and then call the mode function. */
1846 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1848 Fset_buffer (buffer
);
1851 return unbind_to (count
, Qnil
);
1854 DEFUN ("current-buffer", Fcurrent_buffer
, Scurrent_buffer
, 0, 0, 0,
1855 doc
: /* Return the current buffer as a Lisp object. */)
1858 register Lisp_Object buf
;
1859 XSETBUFFER (buf
, current_buffer
);
1863 /* Set the current buffer to B.
1865 We previously set windows_or_buffers_changed here to invalidate
1866 global unchanged information in beg_unchanged and end_unchanged.
1867 This is no longer necessary because we now compute unchanged
1868 information on a buffer-basis. Every action affecting other
1869 windows than the selected one requires a select_window at some
1870 time, and that increments windows_or_buffers_changed. */
1873 set_buffer_internal (register struct buffer
*b
)
1875 if (current_buffer
!= b
)
1876 set_buffer_internal_1 (b
);
1879 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1880 This is used by redisplay. */
1883 set_buffer_internal_1 (register struct buffer
*b
)
1885 register struct buffer
*old_buf
;
1886 register Lisp_Object tail
;
1888 #ifdef USE_MMAP_FOR_BUFFERS
1889 if (b
->text
->beg
== NULL
)
1890 enlarge_buffer_text (b
, 0);
1891 #endif /* USE_MMAP_FOR_BUFFERS */
1893 if (current_buffer
== b
)
1896 old_buf
= current_buffer
;
1898 last_known_column_point
= -1; /* invalidate indentation cache */
1902 /* Put the undo list back in the base buffer, so that it appears
1903 that an indirect buffer shares the undo list of its base. */
1904 if (old_buf
->base_buffer
)
1905 BVAR (old_buf
->base_buffer
, undo_list
) = BVAR (old_buf
, undo_list
);
1907 /* If the old current buffer has markers to record PT, BEGV and ZV
1908 when it is not current, update them now. */
1909 record_buffer_markers (old_buf
);
1912 /* Get the undo list from the base buffer, so that it appears
1913 that an indirect buffer shares the undo list of its base. */
1915 BVAR (b
, undo_list
) = BVAR (b
->base_buffer
, undo_list
);
1917 /* If the new current buffer has markers to record PT, BEGV and ZV
1918 when it is not current, fetch them now. */
1919 fetch_buffer_markers (b
);
1921 /* Look down buffer's list of local Lisp variables
1922 to find and update any that forward into C variables. */
1926 for (tail
= BVAR (b
, local_var_alist
); CONSP (tail
); tail
= XCDR (tail
))
1928 Lisp_Object var
= XCAR (XCAR (tail
));
1929 struct Lisp_Symbol
*sym
= XSYMBOL (var
);
1930 if (sym
->redirect
== SYMBOL_LOCALIZED
/* Just to be sure. */
1931 && SYMBOL_BLV (sym
)->fwd
)
1932 /* Just reference the variable
1933 to cause it to become set for this buffer. */
1934 Fsymbol_value (var
);
1937 /* Do the same with any others that were local to the previous buffer */
1938 while (b
!= old_buf
&& (b
= old_buf
, b
));
1941 /* Switch to buffer B temporarily for redisplay purposes.
1942 This avoids certain things that don't need to be done within redisplay. */
1945 set_buffer_temp (struct buffer
*b
)
1947 register struct buffer
*old_buf
;
1949 if (current_buffer
== b
)
1952 old_buf
= current_buffer
;
1955 /* If the old current buffer has markers to record PT, BEGV and ZV
1956 when it is not current, update them now. */
1957 record_buffer_markers (old_buf
);
1959 /* If the new current buffer has markers to record PT, BEGV and ZV
1960 when it is not current, fetch them now. */
1961 fetch_buffer_markers (b
);
1964 DEFUN ("set-buffer", Fset_buffer
, Sset_buffer
, 1, 1, 0,
1965 doc
: /* Make buffer BUFFER-OR-NAME current for editing operations.
1966 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1967 also `save-excursion' when you want to make a buffer current
1968 temporarily. This function does not display the buffer, so its effect
1969 ends when the current command terminates. Use `switch-to-buffer' or
1970 `pop-to-buffer' to switch buffers permanently. */)
1971 (register Lisp_Object buffer_or_name
)
1973 register Lisp_Object buffer
;
1974 buffer
= Fget_buffer (buffer_or_name
);
1976 nsberror (buffer_or_name
);
1977 if (NILP (BVAR (XBUFFER (buffer
), name
)))
1978 error ("Selecting deleted buffer");
1979 set_buffer_internal (XBUFFER (buffer
));
1983 /* Set the current buffer to BUFFER provided it is alive. */
1986 set_buffer_if_live (Lisp_Object buffer
)
1988 if (! NILP (BVAR (XBUFFER (buffer
), name
)))
1989 Fset_buffer (buffer
);
1993 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only
,
1994 Sbarf_if_buffer_read_only
, 0, 0, 0,
1995 doc
: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1998 if (!NILP (BVAR (current_buffer
, read_only
))
1999 && NILP (Vinhibit_read_only
))
2000 xsignal1 (Qbuffer_read_only
, Fcurrent_buffer ());
2004 DEFUN ("erase-buffer", Ferase_buffer
, Serase_buffer
, 0, 0, "*",
2005 doc
: /* Delete the entire contents of the current buffer.
2006 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2007 so the buffer is truly empty after this. */)
2014 current_buffer
->last_window_start
= 1;
2015 /* Prevent warnings, or suspension of auto saving, that would happen
2016 if future size is less than past size. Use of erase-buffer
2017 implies that the future text is not really related to the past text. */
2018 XSETFASTINT (BVAR (current_buffer
, save_length
), 0);
2023 validate_region (register Lisp_Object
*b
, register Lisp_Object
*e
)
2025 CHECK_NUMBER_COERCE_MARKER (*b
);
2026 CHECK_NUMBER_COERCE_MARKER (*e
);
2028 if (XINT (*b
) > XINT (*e
))
2031 tem
= *b
; *b
= *e
; *e
= tem
;
2034 if (! (BEGV
<= XINT (*b
) && XINT (*e
) <= ZV
))
2035 args_out_of_range (*b
, *e
);
2038 /* Advance BYTE_POS up to a character boundary
2039 and return the adjusted position. */
2042 advance_to_char_boundary (ptrdiff_t byte_pos
)
2046 if (byte_pos
== BEG
)
2047 /* Beginning of buffer is always a character boundary. */
2050 c
= FETCH_BYTE (byte_pos
);
2051 if (! CHAR_HEAD_P (c
))
2053 /* We should advance BYTE_POS only when C is a constituent of a
2054 multibyte sequence. */
2055 ptrdiff_t orig_byte_pos
= byte_pos
;
2060 c
= FETCH_BYTE (byte_pos
);
2062 while (! CHAR_HEAD_P (c
) && byte_pos
> BEG
);
2064 if (byte_pos
< orig_byte_pos
)
2065 byte_pos
= orig_byte_pos
;
2066 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2067 surely advance to the correct character boundary. If C is
2068 not, BYTE_POS was unchanged. */
2074 DEFUN ("buffer-swap-text", Fbuffer_swap_text
, Sbuffer_swap_text
,
2076 doc
: /* Swap the text between current buffer and BUFFER. */)
2077 (Lisp_Object buffer
)
2079 struct buffer
*other_buffer
;
2080 CHECK_BUFFER (buffer
);
2081 other_buffer
= XBUFFER (buffer
);
2083 if (NILP (BVAR (other_buffer
, name
)))
2084 error ("Cannot swap a dead buffer's text");
2086 /* Actually, it probably works just fine.
2087 * if (other_buffer == current_buffer)
2088 * error ("Cannot swap a buffer's text with itself"); */
2090 /* Actually, this may be workable as well, tho probably only if they're
2092 if (other_buffer
->base_buffer
2093 || current_buffer
->base_buffer
)
2094 error ("Cannot swap indirect buffers's text");
2096 { /* This is probably harder to make work. */
2097 struct buffer
*other
;
2098 FOR_EACH_BUFFER (other
)
2099 if (other
->base_buffer
== other_buffer
2100 || other
->base_buffer
== current_buffer
)
2101 error ("One of the buffers to swap has indirect buffers");
2104 #define swapfield(field, type) \
2106 type tmp##field = other_buffer->field; \
2107 other_buffer->field = current_buffer->field; \
2108 current_buffer->field = tmp##field; \
2110 #define swapfield_(field, type) \
2112 type tmp##field = BVAR (other_buffer, field); \
2113 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2114 BVAR (current_buffer, field) = tmp##field; \
2117 swapfield (own_text
, struct buffer_text
);
2118 eassert (current_buffer
->text
== ¤t_buffer
->own_text
);
2119 eassert (other_buffer
->text
== &other_buffer
->own_text
);
2121 r_alloc_reset_variable ((void **) ¤t_buffer
->own_text
.beg
,
2122 (void **) &other_buffer
->own_text
.beg
);
2123 r_alloc_reset_variable ((void **) &other_buffer
->own_text
.beg
,
2124 (void **) ¤t_buffer
->own_text
.beg
);
2125 #endif /* REL_ALLOC */
2127 swapfield (pt
, ptrdiff_t);
2128 swapfield (pt_byte
, ptrdiff_t);
2129 swapfield (begv
, ptrdiff_t);
2130 swapfield (begv_byte
, ptrdiff_t);
2131 swapfield (zv
, ptrdiff_t);
2132 swapfield (zv_byte
, ptrdiff_t);
2133 eassert (!current_buffer
->base_buffer
);
2134 eassert (!other_buffer
->base_buffer
);
2135 current_buffer
->clip_changed
= 1; other_buffer
->clip_changed
= 1;
2136 swapfield (newline_cache
, struct region_cache
*);
2137 swapfield (width_run_cache
, struct region_cache
*);
2138 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2139 other_buffer
->prevent_redisplay_optimizations_p
= 1;
2140 swapfield (overlays_before
, struct Lisp_Overlay
*);
2141 swapfield (overlays_after
, struct Lisp_Overlay
*);
2142 swapfield (overlay_center
, ptrdiff_t);
2143 swapfield_ (undo_list
, Lisp_Object
);
2144 swapfield_ (mark
, Lisp_Object
);
2145 swapfield_ (enable_multibyte_characters
, Lisp_Object
);
2146 swapfield_ (bidi_display_reordering
, Lisp_Object
);
2147 swapfield_ (bidi_paragraph_direction
, Lisp_Object
);
2148 /* FIXME: Not sure what we should do with these *_marker fields.
2149 Hopefully they're just nil anyway. */
2150 swapfield_ (pt_marker
, Lisp_Object
);
2151 swapfield_ (begv_marker
, Lisp_Object
);
2152 swapfield_ (zv_marker
, Lisp_Object
);
2153 BVAR (current_buffer
, point_before_scroll
) = Qnil
;
2154 BVAR (other_buffer
, point_before_scroll
) = Qnil
;
2156 current_buffer
->text
->modiff
++; other_buffer
->text
->modiff
++;
2157 current_buffer
->text
->chars_modiff
++; other_buffer
->text
->chars_modiff
++;
2158 current_buffer
->text
->overlay_modiff
++; other_buffer
->text
->overlay_modiff
++;
2159 current_buffer
->text
->beg_unchanged
= current_buffer
->text
->gpt
;
2160 current_buffer
->text
->end_unchanged
= current_buffer
->text
->gpt
;
2161 other_buffer
->text
->beg_unchanged
= other_buffer
->text
->gpt
;
2162 other_buffer
->text
->end_unchanged
= other_buffer
->text
->gpt
;
2164 struct Lisp_Marker
*m
;
2165 for (m
= BUF_MARKERS (current_buffer
); m
; m
= m
->next
)
2166 if (m
->buffer
== other_buffer
)
2167 m
->buffer
= current_buffer
;
2169 /* Since there's no indirect buffer in sight, markers on
2170 BUF_MARKERS(buf) should either be for `buf' or dead. */
2171 eassert (!m
->buffer
);
2172 for (m
= BUF_MARKERS (other_buffer
); m
; m
= m
->next
)
2173 if (m
->buffer
== current_buffer
)
2174 m
->buffer
= other_buffer
;
2176 /* Since there's no indirect buffer in sight, markers on
2177 BUF_MARKERS(buf) should either be for `buf' or dead. */
2178 eassert (!m
->buffer
);
2180 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2181 So since we just swapped the markers between the two buffers, we need
2182 to undo the effect of this swap for window markers. */
2183 Lisp_Object w
= Fselected_window (), ws
= Qnil
;
2184 Lisp_Object buf1
, buf2
;
2185 XSETBUFFER (buf1
, current_buffer
); XSETBUFFER (buf2
, other_buffer
);
2187 while (NILP (Fmemq (w
, ws
)))
2190 if (MARKERP (XWINDOW (w
)->pointm
)
2191 && (EQ (XWINDOW (w
)->buffer
, buf1
)
2192 || EQ (XWINDOW (w
)->buffer
, buf2
)))
2193 Fset_marker (XWINDOW (w
)->pointm
,
2194 make_number (BUF_BEGV (XBUFFER (XWINDOW (w
)->buffer
))),
2195 XWINDOW (w
)->buffer
);
2196 w
= Fnext_window (w
, Qt
, Qt
);
2200 if (current_buffer
->text
->intervals
)
2201 (eassert (EQ (current_buffer
->text
->intervals
->up
.obj
, buffer
)),
2202 XSETBUFFER (current_buffer
->text
->intervals
->up
.obj
, current_buffer
));
2203 if (other_buffer
->text
->intervals
)
2204 (eassert (EQ (other_buffer
->text
->intervals
->up
.obj
, Fcurrent_buffer ())),
2205 XSETBUFFER (other_buffer
->text
->intervals
->up
.obj
, other_buffer
));
2210 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte
, Sset_buffer_multibyte
,
2212 doc
: /* Set the multibyte flag of the current buffer to FLAG.
2213 If FLAG is t, this makes the buffer a multibyte buffer.
2214 If FLAG is nil, this makes the buffer a single-byte buffer.
2215 In these cases, the buffer contents remain unchanged as a sequence of
2216 bytes but the contents viewed as characters do change.
2217 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2218 all eight-bit bytes to eight-bit characters.
2219 If the multibyte flag was really changed, undo information of the
2220 current buffer is cleared. */)
2223 struct Lisp_Marker
*tail
, *markers
;
2224 struct buffer
*other
;
2226 int narrowed
= (BEG
!= BEGV
|| Z
!= ZV
);
2227 int modified_p
= !NILP (Fbuffer_modified_p (Qnil
));
2228 Lisp_Object old_undo
= BVAR (current_buffer
, undo_list
);
2229 struct gcpro gcpro1
;
2231 if (current_buffer
->base_buffer
)
2232 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2234 /* Do nothing if nothing actually changes. */
2235 if (NILP (flag
) == NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2240 /* Don't record these buffer changes. We will put a special undo entry
2242 BVAR (current_buffer
, undo_list
) = Qt
;
2244 /* If the cached position is for this buffer, clear it out. */
2245 clear_charpos_cache (current_buffer
);
2248 begv
= BEGV_BYTE
, zv
= ZV_BYTE
;
2250 begv
= BEGV
, zv
= ZV
;
2257 ptrdiff_t pos
, stop
;
2260 /* Do this first, so it can use CHAR_TO_BYTE
2261 to calculate the old correspondences. */
2262 set_intervals_multibyte (0);
2264 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
2270 TEMP_SET_PT_BOTH (PT_BYTE
, PT_BYTE
);
2273 for (tail
= BUF_MARKERS (current_buffer
); tail
; tail
= tail
->next
)
2274 tail
->charpos
= tail
->bytepos
;
2276 /* Convert multibyte form of 8-bit characters to unibyte. */
2291 if (ASCII_BYTE_P (*p
))
2293 else if (CHAR_BYTE8_HEAD_P (*p
))
2295 c
= STRING_CHAR_AND_LENGTH (p
, bytes
);
2296 /* Delete all bytes for this 8-bit character but the
2297 last one, and change the last one to the character
2300 del_range_2 (pos
, pos
, pos
+ bytes
, pos
+ bytes
, 0);
2312 bytes
= BYTES_BY_CHAR_HEAD (*p
);
2313 p
+= bytes
, pos
+= bytes
;
2317 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2322 ptrdiff_t pos
, stop
;
2323 unsigned char *p
, *pend
;
2325 /* Be sure not to have a multibyte sequence striding over the GAP.
2326 Ex: We change this: "...abc\302 _GAP_ \241def..."
2327 to: "...abc _GAP_ \302\241def..." */
2330 && GPT_BYTE
> 1 && GPT_BYTE
< Z_BYTE
2331 && ! CHAR_HEAD_P (*(GAP_END_ADDR
)))
2333 unsigned char *q
= GPT_ADDR
- 1;
2335 while (! CHAR_HEAD_P (*q
) && q
> BEG_ADDR
) q
--;
2336 if (LEADING_CODE_P (*q
))
2338 ptrdiff_t new_gpt
= GPT_BYTE
- (GPT_ADDR
- q
);
2340 move_gap_both (new_gpt
, new_gpt
);
2344 /* Make the buffer contents valid as multibyte by converting
2345 8-bit characters to multibyte form. */
2363 if (ASCII_BYTE_P (*p
))
2365 else if (EQ (flag
, Qt
)
2366 && ! CHAR_BYTE8_HEAD_P (*p
)
2367 && (bytes
= MULTIBYTE_LENGTH (p
, pend
)) > 0)
2368 p
+= bytes
, pos
+= bytes
;
2371 unsigned char tmp
[MAX_MULTIBYTE_LENGTH
];
2374 c
= BYTE8_TO_CHAR (*p
);
2375 bytes
= CHAR_STRING (c
, tmp
);
2377 TEMP_SET_PT_BOTH (pos
+ 1, pos
+ 1);
2379 insert_1_both ((char *) tmp
+ 1, bytes
, bytes
, 1, 0, 0);
2380 /* Now the gap is after the just inserted data. */
2398 Fnarrow_to_region (make_number (begv
), make_number (zv
));
2400 /* Do this first, so that chars_in_text asks the right question.
2401 set_intervals_multibyte needs it too. */
2402 BVAR (current_buffer
, enable_multibyte_characters
) = Qt
;
2404 GPT_BYTE
= advance_to_char_boundary (GPT_BYTE
);
2405 GPT
= chars_in_text (BEG_ADDR
, GPT_BYTE
- BEG_BYTE
) + BEG
;
2407 Z
= chars_in_text (GAP_END_ADDR
, Z_BYTE
- GPT_BYTE
) + GPT
;
2409 BEGV_BYTE
= advance_to_char_boundary (BEGV_BYTE
);
2410 if (BEGV_BYTE
> GPT_BYTE
)
2411 BEGV
= chars_in_text (GAP_END_ADDR
, BEGV_BYTE
- GPT_BYTE
) + GPT
;
2413 BEGV
= chars_in_text (BEG_ADDR
, BEGV_BYTE
- BEG_BYTE
) + BEG
;
2415 ZV_BYTE
= advance_to_char_boundary (ZV_BYTE
);
2416 if (ZV_BYTE
> GPT_BYTE
)
2417 ZV
= chars_in_text (GAP_END_ADDR
, ZV_BYTE
- GPT_BYTE
) + GPT
;
2419 ZV
= chars_in_text (BEG_ADDR
, ZV_BYTE
- BEG_BYTE
) + BEG
;
2422 ptrdiff_t byte
= advance_to_char_boundary (PT_BYTE
);
2425 if (byte
> GPT_BYTE
)
2426 position
= chars_in_text (GAP_END_ADDR
, byte
- GPT_BYTE
) + GPT
;
2428 position
= chars_in_text (BEG_ADDR
, byte
- BEG_BYTE
) + BEG
;
2429 TEMP_SET_PT_BOTH (position
, byte
);
2432 tail
= markers
= BUF_MARKERS (current_buffer
);
2434 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2435 getting confused by the markers that have not yet been updated.
2436 It is also a signal that it should never create a marker. */
2437 BUF_MARKERS (current_buffer
) = NULL
;
2439 for (; tail
; tail
= tail
->next
)
2441 tail
->bytepos
= advance_to_char_boundary (tail
->bytepos
);
2442 tail
->charpos
= BYTE_TO_CHAR (tail
->bytepos
);
2445 /* Make sure no markers were put on the chain
2446 while the chain value was incorrect. */
2447 if (BUF_MARKERS (current_buffer
))
2450 BUF_MARKERS (current_buffer
) = markers
;
2452 /* Do this last, so it can calculate the new correspondences
2453 between chars and bytes. */
2454 set_intervals_multibyte (1);
2457 if (!EQ (old_undo
, Qt
))
2459 /* Represent all the above changes by a special undo entry. */
2460 BVAR (current_buffer
, undo_list
) = Fcons (list3 (Qapply
,
2461 intern ("set-buffer-multibyte"),
2462 NILP (flag
) ? Qt
: Qnil
),
2468 /* Changing the multibyteness of a buffer means that all windows
2469 showing that buffer must be updated thoroughly. */
2470 current_buffer
->prevent_redisplay_optimizations_p
= 1;
2471 ++windows_or_buffers_changed
;
2473 /* Copy this buffer's new multibyte status
2474 into all of its indirect buffers. */
2475 FOR_EACH_BUFFER (other
)
2476 if (other
->base_buffer
== current_buffer
&& !NILP (BVAR (other
, name
)))
2478 BVAR (other
, enable_multibyte_characters
)
2479 = BVAR (current_buffer
, enable_multibyte_characters
);
2480 other
->prevent_redisplay_optimizations_p
= 1;
2483 /* Restore the modifiedness of the buffer. */
2484 if (!modified_p
&& !NILP (Fbuffer_modified_p (Qnil
)))
2485 Fset_buffer_modified_p (Qnil
);
2487 /* Update coding systems of this buffer's process (if any). */
2489 Lisp_Object process
;
2491 process
= Fget_buffer_process (Fcurrent_buffer ());
2492 if (PROCESSP (process
))
2493 setup_process_coding_systems (process
);
2499 DEFUN ("kill-all-local-variables", Fkill_all_local_variables
,
2500 Skill_all_local_variables
, 0, 0, 0,
2501 doc
: /* Switch to Fundamental mode by killing current buffer's local variables.
2502 Most local variable bindings are eliminated so that the default values
2503 become effective once more. Also, the syntax table is set from
2504 `standard-syntax-table', the local keymap is set to nil,
2505 and the abbrev table from `fundamental-mode-abbrev-table'.
2506 This function also forces redisplay of the mode line.
2508 Every function to select a new major mode starts by
2509 calling this function.
2511 As a special exception, local variables whose names have
2512 a non-nil `permanent-local' property are not eliminated by this function.
2514 The first thing this function does is run
2515 the normal hook `change-major-mode-hook'. */)
2518 Frun_hooks (1, &Qchange_major_mode_hook
);
2520 /* Make sure none of the bindings in local_var_alist
2521 remain swapped in, in their symbols. */
2523 swap_out_buffer_local_variables (current_buffer
);
2525 /* Actually eliminate all local bindings of this buffer. */
2527 reset_buffer_local_variables (current_buffer
, 0);
2529 /* Force mode-line redisplay. Useful here because all major mode
2530 commands call this function. */
2531 update_mode_lines
++;
2536 /* Make sure no local variables remain set up with buffer B
2537 for their current values. */
2540 swap_out_buffer_local_variables (struct buffer
*b
)
2542 Lisp_Object oalist
, alist
, buffer
;
2544 XSETBUFFER (buffer
, b
);
2545 oalist
= BVAR (b
, local_var_alist
);
2547 for (alist
= oalist
; CONSP (alist
); alist
= XCDR (alist
))
2549 Lisp_Object sym
= XCAR (XCAR (alist
));
2550 eassert (XSYMBOL (sym
)->redirect
== SYMBOL_LOCALIZED
);
2551 /* Need not do anything if some other buffer's binding is
2553 if (EQ (SYMBOL_BLV (XSYMBOL (sym
))->where
, buffer
))
2555 /* Symbol is set up for this buffer's old local value:
2557 swap_in_global_binding (XSYMBOL (sym
));
2562 /* Find all the overlays in the current buffer that contain position POS.
2563 Return the number found, and store them in a vector in *VEC_PTR.
2564 Store in *LEN_PTR the size allocated for the vector.
2565 Store in *NEXT_PTR the next position after POS where an overlay starts,
2566 or ZV if there are no more overlays between POS and ZV.
2567 Store in *PREV_PTR the previous position before POS where an overlay ends,
2568 or where an overlay starts which ends at or after POS;
2569 or BEGV if there are no such overlays from BEGV to POS.
2570 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2572 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2573 when this function is called.
2575 If EXTEND is non-zero, we make the vector bigger if necessary.
2576 If EXTEND is zero, we never extend the vector,
2577 and we store only as many overlays as will fit.
2578 But we still return the total number of overlays.
2580 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2581 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2582 default (BEGV or ZV). */
2585 overlays_at (EMACS_INT pos
, int extend
, Lisp_Object
**vec_ptr
,
2587 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
, int change_req
)
2589 Lisp_Object overlay
, start
, end
;
2590 struct Lisp_Overlay
*tail
;
2592 ptrdiff_t len
= *len_ptr
;
2593 Lisp_Object
*vec
= *vec_ptr
;
2594 ptrdiff_t next
= ZV
;
2595 ptrdiff_t prev
= BEGV
;
2596 int inhibit_storing
= 0;
2598 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2600 ptrdiff_t startpos
, endpos
;
2602 XSETMISC (overlay
, tail
);
2604 start
= OVERLAY_START (overlay
);
2605 end
= OVERLAY_END (overlay
);
2606 endpos
= OVERLAY_POSITION (end
);
2613 startpos
= OVERLAY_POSITION (start
);
2614 /* This one ends at or after POS
2615 so its start counts for PREV_PTR if it's before POS. */
2616 if (prev
< startpos
&& startpos
< pos
)
2620 if (startpos
<= pos
)
2624 /* The supplied vector is full.
2625 Either make it bigger, or don't store any more in it. */
2628 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2634 inhibit_storing
= 1;
2637 if (!inhibit_storing
)
2639 /* Keep counting overlays even if we can't return them all. */
2642 else if (startpos
< next
)
2646 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2648 ptrdiff_t startpos
, endpos
;
2650 XSETMISC (overlay
, tail
);
2652 start
= OVERLAY_START (overlay
);
2653 end
= OVERLAY_END (overlay
);
2654 startpos
= OVERLAY_POSITION (start
);
2657 if (startpos
< next
)
2661 endpos
= OVERLAY_POSITION (end
);
2668 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2674 inhibit_storing
= 1;
2677 if (!inhibit_storing
)
2681 if (startpos
< pos
&& startpos
> prev
)
2684 else if (endpos
< pos
&& endpos
> prev
)
2686 else if (endpos
== pos
&& startpos
> prev
2687 && (!change_req
|| startpos
< pos
))
2698 /* Find all the overlays in the current buffer that overlap the range
2699 BEG-END, or are empty at BEG, or are empty at END provided END
2700 denotes the position at the end of the current buffer.
2702 Return the number found, and store them in a vector in *VEC_PTR.
2703 Store in *LEN_PTR the size allocated for the vector.
2704 Store in *NEXT_PTR the next position after POS where an overlay starts,
2705 or ZV if there are no more overlays.
2706 Store in *PREV_PTR the previous position before POS where an overlay ends,
2707 or BEGV if there are no previous overlays.
2708 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2710 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2711 when this function is called.
2713 If EXTEND is non-zero, we make the vector bigger if necessary.
2714 If EXTEND is zero, we never extend the vector,
2715 and we store only as many overlays as will fit.
2716 But we still return the total number of overlays. */
2719 overlays_in (EMACS_INT beg
, EMACS_INT end
, int extend
,
2720 Lisp_Object
**vec_ptr
, ptrdiff_t *len_ptr
,
2721 ptrdiff_t *next_ptr
, ptrdiff_t *prev_ptr
)
2723 Lisp_Object overlay
, ostart
, oend
;
2724 struct Lisp_Overlay
*tail
;
2726 ptrdiff_t len
= *len_ptr
;
2727 Lisp_Object
*vec
= *vec_ptr
;
2728 ptrdiff_t next
= ZV
;
2729 ptrdiff_t prev
= BEGV
;
2730 int inhibit_storing
= 0;
2731 int end_is_Z
= end
== Z
;
2733 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2735 ptrdiff_t startpos
, endpos
;
2737 XSETMISC (overlay
, tail
);
2739 ostart
= OVERLAY_START (overlay
);
2740 oend
= OVERLAY_END (overlay
);
2741 endpos
= OVERLAY_POSITION (oend
);
2748 startpos
= OVERLAY_POSITION (ostart
);
2749 /* Count an interval if it overlaps the range, is empty at the
2750 start of the range, or is empty at END provided END denotes the
2751 end of the buffer. */
2752 if ((beg
< endpos
&& startpos
< end
)
2753 || (startpos
== endpos
2754 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
2758 /* The supplied vector is full.
2759 Either make it bigger, or don't store any more in it. */
2762 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2768 inhibit_storing
= 1;
2771 if (!inhibit_storing
)
2773 /* Keep counting overlays even if we can't return them all. */
2776 else if (startpos
< next
)
2780 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2782 ptrdiff_t startpos
, endpos
;
2784 XSETMISC (overlay
, tail
);
2786 ostart
= OVERLAY_START (overlay
);
2787 oend
= OVERLAY_END (overlay
);
2788 startpos
= OVERLAY_POSITION (ostart
);
2791 if (startpos
< next
)
2795 endpos
= OVERLAY_POSITION (oend
);
2796 /* Count an interval if it overlaps the range, is empty at the
2797 start of the range, or is empty at END provided END denotes the
2798 end of the buffer. */
2799 if ((beg
< endpos
&& startpos
< end
)
2800 || (startpos
== endpos
2801 && (beg
== endpos
|| (end_is_Z
&& endpos
== end
))))
2807 vec
= xpalloc (vec
, len_ptr
, 1, OVERLAY_COUNT_MAX
,
2813 inhibit_storing
= 1;
2816 if (!inhibit_storing
)
2820 else if (endpos
< beg
&& endpos
> prev
)
2832 /* Return non-zero if there exists an overlay with a non-nil
2833 `mouse-face' property overlapping OVERLAY. */
2836 mouse_face_overlay_overlaps (Lisp_Object overlay
)
2838 ptrdiff_t start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
2839 ptrdiff_t end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
2840 ptrdiff_t n
, i
, size
;
2841 Lisp_Object
*v
, tem
;
2844 v
= alloca (size
* sizeof *v
);
2845 n
= overlays_in (start
, end
, 0, &v
, &size
, NULL
, NULL
);
2848 v
= alloca (n
* sizeof *v
);
2849 overlays_in (start
, end
, 0, &v
, &n
, NULL
, NULL
);
2852 for (i
= 0; i
< n
; ++i
)
2853 if (!EQ (v
[i
], overlay
)
2854 && (tem
= Foverlay_get (overlay
, Qmouse_face
),
2863 /* Fast function to just test if we're at an overlay boundary. */
2865 overlay_touches_p (ptrdiff_t pos
)
2867 Lisp_Object overlay
;
2868 struct Lisp_Overlay
*tail
;
2870 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
2874 XSETMISC (overlay
,tail
);
2875 eassert (OVERLAYP (overlay
));
2877 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
2880 if (endpos
== pos
|| OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
)
2884 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
2888 XSETMISC (overlay
, tail
);
2889 eassert (OVERLAYP (overlay
));
2891 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
2894 if (startpos
== pos
|| OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
)
2902 Lisp_Object overlay
;
2908 compare_overlays (const void *v1
, const void *v2
)
2910 const struct sortvec
*s1
= (const struct sortvec
*) v1
;
2911 const struct sortvec
*s2
= (const struct sortvec
*) v2
;
2912 if (s1
->priority
!= s2
->priority
)
2913 return s1
->priority
< s2
->priority
? -1 : 1;
2914 if (s1
->beg
!= s2
->beg
)
2915 return s1
->beg
< s2
->beg
? -1 : 1;
2916 if (s1
->end
!= s2
->end
)
2917 return s2
->end
< s1
->end
? -1 : 1;
2918 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
2919 between "equal" overlays. The result can still change between
2920 invocations of Emacs, but it won't change in the middle of
2921 `find_field' (bug#6830). */
2922 if (XHASH (s1
->overlay
) != XHASH (s2
->overlay
))
2923 return XHASH (s1
->overlay
) < XHASH (s2
->overlay
) ? -1 : 1;
2927 /* Sort an array of overlays by priority. The array is modified in place.
2928 The return value is the new size; this may be smaller than the original
2929 size if some of the overlays were invalid or were window-specific. */
2931 sort_overlays (Lisp_Object
*overlay_vec
, ptrdiff_t noverlays
, struct window
*w
)
2934 struct sortvec
*sortvec
= alloca (noverlays
* sizeof *sortvec
);
2936 /* Put the valid and relevant overlays into sortvec. */
2938 for (i
= 0, j
= 0; i
< noverlays
; i
++)
2941 Lisp_Object overlay
;
2943 overlay
= overlay_vec
[i
];
2944 if (OVERLAYP (overlay
)
2945 && OVERLAY_POSITION (OVERLAY_START (overlay
)) > 0
2946 && OVERLAY_POSITION (OVERLAY_END (overlay
)) > 0)
2948 /* If we're interested in a specific window, then ignore
2949 overlays that are limited to some other window. */
2954 window
= Foverlay_get (overlay
, Qwindow
);
2955 if (WINDOWP (window
) && XWINDOW (window
) != w
)
2959 /* This overlay is good and counts: put it into sortvec. */
2960 sortvec
[j
].overlay
= overlay
;
2961 sortvec
[j
].beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
2962 sortvec
[j
].end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
2963 tem
= Foverlay_get (overlay
, Qpriority
);
2965 sortvec
[j
].priority
= XINT (tem
);
2967 sortvec
[j
].priority
= 0;
2973 /* Sort the overlays into the proper order: increasing priority. */
2976 qsort (sortvec
, noverlays
, sizeof (struct sortvec
), compare_overlays
);
2978 for (i
= 0; i
< noverlays
; i
++)
2979 overlay_vec
[i
] = sortvec
[i
].overlay
;
2985 Lisp_Object string
, string2
;
2992 struct sortstr
*buf
; /* An array that expands as needed; never freed. */
2993 ptrdiff_t size
; /* Allocated length of that array. */
2994 ptrdiff_t used
; /* How much of the array is currently in use. */
2995 ptrdiff_t bytes
; /* Total length of the strings in buf. */
2998 /* Buffers for storing information about the overlays touching a given
2999 position. These could be automatic variables in overlay_strings, but
3000 it's more efficient to hold onto the memory instead of repeatedly
3001 allocating and freeing it. */
3002 static struct sortstrlist overlay_heads
, overlay_tails
;
3003 static unsigned char *overlay_str_buf
;
3005 /* Allocated length of overlay_str_buf. */
3006 static ptrdiff_t overlay_str_len
;
3008 /* A comparison function suitable for passing to qsort. */
3010 cmp_for_strings (const void *as1
, const void *as2
)
3012 struct sortstr
*s1
= (struct sortstr
*)as1
;
3013 struct sortstr
*s2
= (struct sortstr
*)as2
;
3014 if (s1
->size
!= s2
->size
)
3015 return s2
->size
< s1
->size
? -1 : 1;
3016 if (s1
->priority
!= s2
->priority
)
3017 return s1
->priority
< s2
->priority
? -1 : 1;
3022 record_overlay_string (struct sortstrlist
*ssl
, Lisp_Object str
,
3023 Lisp_Object str2
, Lisp_Object pri
, ptrdiff_t size
)
3027 if (ssl
->used
== ssl
->size
)
3028 ssl
->buf
= xpalloc (ssl
->buf
, &ssl
->size
, 5, -1, sizeof *ssl
->buf
);
3029 ssl
->buf
[ssl
->used
].string
= str
;
3030 ssl
->buf
[ssl
->used
].string2
= str2
;
3031 ssl
->buf
[ssl
->used
].size
= size
;
3032 ssl
->buf
[ssl
->used
].priority
= (INTEGERP (pri
) ? XINT (pri
) : 0);
3035 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3036 nbytes
= SCHARS (str
);
3037 else if (! STRING_MULTIBYTE (str
))
3038 nbytes
= count_size_as_multibyte (SDATA (str
),
3041 nbytes
= SBYTES (str
);
3043 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3044 memory_full (SIZE_MAX
);
3045 ssl
->bytes
+= nbytes
;
3049 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3050 nbytes
= SCHARS (str2
);
3051 else if (! STRING_MULTIBYTE (str2
))
3052 nbytes
= count_size_as_multibyte (SDATA (str2
),
3055 nbytes
= SBYTES (str2
);
3057 if (INT_ADD_OVERFLOW (ssl
->bytes
, nbytes
))
3058 memory_full (SIZE_MAX
);
3059 ssl
->bytes
+= nbytes
;
3063 /* Return the concatenation of the strings associated with overlays that
3064 begin or end at POS, ignoring overlays that are specific to a window
3065 other than W. The strings are concatenated in the appropriate order:
3066 shorter overlays nest inside longer ones, and higher priority inside
3067 lower. Normally all of the after-strings come first, but zero-sized
3068 overlays have their after-strings ride along with the before-strings
3069 because it would look strange to print them inside-out.
3071 Returns the string length, and stores the contents indirectly through
3072 PSTR, if that variable is non-null. The string may be overwritten by
3073 subsequent calls. */
3076 overlay_strings (ptrdiff_t pos
, struct window
*w
, unsigned char **pstr
)
3078 Lisp_Object overlay
, window
, str
;
3079 struct Lisp_Overlay
*ov
;
3080 ptrdiff_t startpos
, endpos
;
3081 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3083 overlay_heads
.used
= overlay_heads
.bytes
= 0;
3084 overlay_tails
.used
= overlay_tails
.bytes
= 0;
3085 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
3087 XSETMISC (overlay
, ov
);
3088 eassert (OVERLAYP (overlay
));
3090 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3091 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3094 if (endpos
!= pos
&& startpos
!= pos
)
3096 window
= Foverlay_get (overlay
, Qwindow
);
3097 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3100 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3101 record_overlay_string (&overlay_heads
, str
,
3103 ? Foverlay_get (overlay
, Qafter_string
)
3105 Foverlay_get (overlay
, Qpriority
),
3107 else if (endpos
== pos
3108 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3109 record_overlay_string (&overlay_tails
, str
, Qnil
,
3110 Foverlay_get (overlay
, Qpriority
),
3113 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
3115 XSETMISC (overlay
, ov
);
3116 eassert (OVERLAYP (overlay
));
3118 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3119 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3122 if (endpos
!= pos
&& startpos
!= pos
)
3124 window
= Foverlay_get (overlay
, Qwindow
);
3125 if (WINDOWP (window
) && XWINDOW (window
) != w
)
3128 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
)))
3129 record_overlay_string (&overlay_heads
, str
,
3131 ? Foverlay_get (overlay
, Qafter_string
)
3133 Foverlay_get (overlay
, Qpriority
),
3135 else if (endpos
== pos
3136 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
)))
3137 record_overlay_string (&overlay_tails
, str
, Qnil
,
3138 Foverlay_get (overlay
, Qpriority
),
3141 if (overlay_tails
.used
> 1)
3142 qsort (overlay_tails
.buf
, overlay_tails
.used
, sizeof (struct sortstr
),
3144 if (overlay_heads
.used
> 1)
3145 qsort (overlay_heads
.buf
, overlay_heads
.used
, sizeof (struct sortstr
),
3147 if (overlay_heads
.bytes
|| overlay_tails
.bytes
)
3154 if (INT_ADD_OVERFLOW (overlay_heads
.bytes
, overlay_tails
.bytes
))
3155 memory_full (SIZE_MAX
);
3156 total
= overlay_heads
.bytes
+ overlay_tails
.bytes
;
3157 if (total
> overlay_str_len
)
3158 overlay_str_buf
= xpalloc (overlay_str_buf
, &overlay_str_len
,
3159 total
- overlay_str_len
, -1, 1);
3161 p
= overlay_str_buf
;
3162 for (i
= overlay_tails
.used
; --i
>= 0;)
3165 tem
= overlay_tails
.buf
[i
].string
;
3166 nbytes
= copy_text (SDATA (tem
), p
,
3168 STRING_MULTIBYTE (tem
), multibyte
);
3171 for (i
= 0; i
< overlay_heads
.used
; ++i
)
3174 tem
= overlay_heads
.buf
[i
].string
;
3175 nbytes
= copy_text (SDATA (tem
), p
,
3177 STRING_MULTIBYTE (tem
), multibyte
);
3179 tem
= overlay_heads
.buf
[i
].string2
;
3182 nbytes
= copy_text (SDATA (tem
), p
,
3184 STRING_MULTIBYTE (tem
), multibyte
);
3188 if (p
!= overlay_str_buf
+ total
)
3191 *pstr
= overlay_str_buf
;
3197 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3200 recenter_overlay_lists (struct buffer
*buf
, ptrdiff_t pos
)
3202 Lisp_Object overlay
, beg
, end
;
3203 struct Lisp_Overlay
*prev
, *tail
, *next
;
3205 /* See if anything in overlays_before should move to overlays_after. */
3207 /* We don't strictly need prev in this loop; it should always be nil.
3208 But we use it for symmetry and in case that should cease to be true
3209 with some future change. */
3211 for (tail
= buf
->overlays_before
; tail
; prev
= tail
, tail
= next
)
3214 XSETMISC (overlay
, tail
);
3215 eassert (OVERLAYP (overlay
));
3217 beg
= OVERLAY_START (overlay
);
3218 end
= OVERLAY_END (overlay
);
3220 if (OVERLAY_POSITION (end
) > pos
)
3222 /* OVERLAY needs to be moved. */
3223 ptrdiff_t where
= OVERLAY_POSITION (beg
);
3224 struct Lisp_Overlay
*other
, *other_prev
;
3226 /* Splice the cons cell TAIL out of overlays_before. */
3230 buf
->overlays_before
= next
;
3232 /* Search thru overlays_after for where to put it. */
3234 for (other
= buf
->overlays_after
; other
;
3235 other_prev
= other
, other
= other
->next
)
3237 Lisp_Object otherbeg
, otheroverlay
;
3239 XSETMISC (otheroverlay
, other
);
3240 eassert (OVERLAYP (otheroverlay
));
3242 otherbeg
= OVERLAY_START (otheroverlay
);
3243 if (OVERLAY_POSITION (otherbeg
) >= where
)
3247 /* Add TAIL to overlays_after before OTHER. */
3250 other_prev
->next
= tail
;
3252 buf
->overlays_after
= tail
;
3256 /* We've reached the things that should stay in overlays_before.
3257 All the rest of overlays_before must end even earlier,
3262 /* See if anything in overlays_after should be in overlays_before. */
3264 for (tail
= buf
->overlays_after
; tail
; prev
= tail
, tail
= next
)
3267 XSETMISC (overlay
, tail
);
3268 eassert (OVERLAYP (overlay
));
3270 beg
= OVERLAY_START (overlay
);
3271 end
= OVERLAY_END (overlay
);
3273 /* Stop looking, when we know that nothing further
3274 can possibly end before POS. */
3275 if (OVERLAY_POSITION (beg
) > pos
)
3278 if (OVERLAY_POSITION (end
) <= pos
)
3280 /* OVERLAY needs to be moved. */
3281 ptrdiff_t where
= OVERLAY_POSITION (end
);
3282 struct Lisp_Overlay
*other
, *other_prev
;
3284 /* Splice the cons cell TAIL out of overlays_after. */
3288 buf
->overlays_after
= next
;
3290 /* Search thru overlays_before for where to put it. */
3292 for (other
= buf
->overlays_before
; other
;
3293 other_prev
= other
, other
= other
->next
)
3295 Lisp_Object otherend
, otheroverlay
;
3297 XSETMISC (otheroverlay
, other
);
3298 eassert (OVERLAYP (otheroverlay
));
3300 otherend
= OVERLAY_END (otheroverlay
);
3301 if (OVERLAY_POSITION (otherend
) <= where
)
3305 /* Add TAIL to overlays_before before OTHER. */
3308 other_prev
->next
= tail
;
3310 buf
->overlays_before
= tail
;
3315 buf
->overlay_center
= pos
;
3319 adjust_overlays_for_insert (ptrdiff_t pos
, ptrdiff_t length
)
3321 /* After an insertion, the lists are still sorted properly,
3322 but we may need to update the value of the overlay center. */
3323 if (current_buffer
->overlay_center
>= pos
)
3324 current_buffer
->overlay_center
+= length
;
3328 adjust_overlays_for_delete (ptrdiff_t pos
, ptrdiff_t length
)
3330 if (current_buffer
->overlay_center
< pos
)
3331 /* The deletion was to our right. No change needed; the before- and
3332 after-lists are still consistent. */
3334 else if (current_buffer
->overlay_center
- pos
> length
)
3335 /* The deletion was to our left. We need to adjust the center value
3336 to account for the change in position, but the lists are consistent
3337 given the new value. */
3338 current_buffer
->overlay_center
-= length
;
3340 /* We're right in the middle. There might be things on the after-list
3341 that now belong on the before-list. Recentering will move them,
3342 and also update the center point. */
3343 recenter_overlay_lists (current_buffer
, pos
);
3346 /* Fix up overlays that were garbled as a result of permuting markers
3347 in the range START through END. Any overlay with at least one
3348 endpoint in this range will need to be unlinked from the overlay
3349 list and reinserted in its proper place.
3350 Such an overlay might even have negative size at this point.
3351 If so, we'll make the overlay empty. */
3353 fix_start_end_in_overlays (register ptrdiff_t start
, register ptrdiff_t end
)
3355 Lisp_Object overlay
;
3356 struct Lisp_Overlay
*before_list
IF_LINT (= NULL
);
3357 struct Lisp_Overlay
*after_list
IF_LINT (= NULL
);
3358 /* These are either nil, indicating that before_list or after_list
3359 should be assigned, or the cons cell the cdr of which should be
3361 struct Lisp_Overlay
*beforep
= NULL
, *afterp
= NULL
;
3362 /* 'Parent', likewise, indicates a cons cell or
3363 current_buffer->overlays_before or overlays_after, depending
3364 which loop we're in. */
3365 struct Lisp_Overlay
*tail
, *parent
;
3366 ptrdiff_t startpos
, endpos
;
3368 /* This algorithm shifts links around instead of consing and GCing.
3369 The loop invariant is that before_list (resp. after_list) is a
3370 well-formed list except that its last element, the CDR of beforep
3371 (resp. afterp) if beforep (afterp) isn't nil or before_list
3372 (after_list) if it is, is still uninitialized. So it's not a bug
3373 that before_list isn't initialized, although it may look
3375 for (parent
= NULL
, tail
= current_buffer
->overlays_before
; tail
;)
3377 XSETMISC (overlay
, tail
);
3379 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3380 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3382 /* If the overlay is backwards, make it empty. */
3383 if (endpos
< startpos
)
3386 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3394 || (startpos
>= start
&& startpos
< end
))
3396 /* Add it to the end of the wrong list. Later on,
3397 recenter_overlay_lists will move it to the right place. */
3398 if (endpos
< current_buffer
->overlay_center
)
3403 afterp
->next
= tail
;
3411 beforep
->next
= tail
;
3415 current_buffer
->overlays_before
= tail
->next
;
3417 parent
->next
= tail
->next
;
3421 parent
= tail
, tail
= parent
->next
;
3423 for (parent
= NULL
, tail
= current_buffer
->overlays_after
; tail
;)
3425 XSETMISC (overlay
, tail
);
3427 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3428 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3430 /* If the overlay is backwards, make it empty. */
3431 if (endpos
< startpos
)
3434 Fset_marker (OVERLAY_START (overlay
), make_number (startpos
),
3438 if (startpos
>= end
)
3441 if (startpos
>= start
3442 || (endpos
>= start
&& endpos
< end
))
3444 if (endpos
< current_buffer
->overlay_center
)
3449 afterp
->next
= tail
;
3457 beforep
->next
= tail
;
3461 current_buffer
->overlays_after
= tail
->next
;
3463 parent
->next
= tail
->next
;
3467 parent
= tail
, tail
= parent
->next
;
3470 /* Splice the constructed (wrong) lists into the buffer's lists,
3471 and let the recenter function make it sane again. */
3474 beforep
->next
= current_buffer
->overlays_before
;
3475 current_buffer
->overlays_before
= before_list
;
3477 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3481 afterp
->next
= current_buffer
->overlays_after
;
3482 current_buffer
->overlays_after
= after_list
;
3484 recenter_overlay_lists (current_buffer
, current_buffer
->overlay_center
);
3487 /* We have two types of overlay: the one whose ending marker is
3488 after-insertion-marker (this is the usual case) and the one whose
3489 ending marker is before-insertion-marker. When `overlays_before'
3490 contains overlays of the latter type and the former type in this
3491 order and both overlays end at inserting position, inserting a text
3492 increases only the ending marker of the latter type, which results
3493 in incorrect ordering of `overlays_before'.
3495 This function fixes ordering of overlays in the slot
3496 `overlays_before' of the buffer *BP. Before the insertion, `point'
3497 was at PREV, and now is at POS. */
3500 fix_overlays_before (struct buffer
*bp
, ptrdiff_t prev
, ptrdiff_t pos
)
3502 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3503 struct Lisp_Overlay
*tail
= bp
->overlays_before
, *parent
= NULL
, *right_pair
;
3505 ptrdiff_t end
IF_LINT (= 0);
3507 /* After the insertion, the several overlays may be in incorrect
3508 order. The possibility is that, in the list `overlays_before',
3509 an overlay which ends at POS appears after an overlay which ends
3510 at PREV. Since POS is greater than PREV, we must fix the
3511 ordering of these overlays, by moving overlays ends at POS before
3512 the overlays ends at PREV. */
3514 /* At first, find a place where disordered overlays should be linked
3515 in. It is where an overlay which end before POS exists. (i.e. an
3516 overlay whose ending marker is after-insertion-marker if disorder
3519 && (XSETMISC (tem
, tail
),
3520 (end
= OVERLAY_POSITION (OVERLAY_END (tem
))) >= pos
))
3526 /* If we don't find such an overlay,
3527 or the found one ends before PREV,
3528 or the found one is the last one in the list,
3529 we don't have to fix anything. */
3530 if (!tail
|| end
< prev
|| !tail
->next
)
3533 right_pair
= parent
;
3537 /* Now, end position of overlays in the list TAIL should be before
3538 or equal to PREV. In the loop, an overlay which ends at POS is
3539 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3540 we found an overlay which ends before PREV, the remaining
3541 overlays are in correct order. */
3544 XSETMISC (tem
, tail
);
3545 end
= OVERLAY_POSITION (OVERLAY_END (tem
));
3548 { /* This overlay is disordered. */
3549 struct Lisp_Overlay
*found
= tail
;
3551 /* Unlink the found overlay. */
3553 parent
->next
= tail
;
3554 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3555 and link it into the right place. */
3558 found
->next
= bp
->overlays_before
;
3559 bp
->overlays_before
= found
;
3563 found
->next
= right_pair
->next
;
3564 right_pair
->next
= found
;
3567 else if (end
== prev
)
3572 else /* No more disordered overlay. */
3577 DEFUN ("overlayp", Foverlayp
, Soverlayp
, 1, 1, 0,
3578 doc
: /* Return t if OBJECT is an overlay. */)
3579 (Lisp_Object object
)
3581 return (OVERLAYP (object
) ? Qt
: Qnil
);
3584 DEFUN ("make-overlay", Fmake_overlay
, Smake_overlay
, 2, 5, 0,
3585 doc
: /* Create a new overlay with range BEG to END in BUFFER.
3586 If omitted, BUFFER defaults to the current buffer.
3587 BEG and END may be integers or markers.
3588 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3589 for the front of the overlay advance when text is inserted there
3590 \(which means the text *is not* included in the overlay).
3591 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3592 for the rear of the overlay advance when text is inserted there
3593 \(which means the text *is* included in the overlay). */)
3594 (Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
, Lisp_Object front_advance
, Lisp_Object rear_advance
)
3596 Lisp_Object overlay
;
3600 XSETBUFFER (buffer
, current_buffer
);
3602 CHECK_BUFFER (buffer
);
3604 && ! EQ (Fmarker_buffer (beg
), buffer
))
3605 error ("Marker points into wrong buffer");
3607 && ! EQ (Fmarker_buffer (end
), buffer
))
3608 error ("Marker points into wrong buffer");
3610 CHECK_NUMBER_COERCE_MARKER (beg
);
3611 CHECK_NUMBER_COERCE_MARKER (end
);
3613 if (XINT (beg
) > XINT (end
))
3616 temp
= beg
; beg
= end
; end
= temp
;
3619 b
= XBUFFER (buffer
);
3621 beg
= Fset_marker (Fmake_marker (), beg
, buffer
);
3622 end
= Fset_marker (Fmake_marker (), end
, buffer
);
3624 if (!NILP (front_advance
))
3625 XMARKER (beg
)->insertion_type
= 1;
3626 if (!NILP (rear_advance
))
3627 XMARKER (end
)->insertion_type
= 1;
3629 overlay
= allocate_misc ();
3630 XMISCTYPE (overlay
) = Lisp_Misc_Overlay
;
3631 XOVERLAY (overlay
)->start
= beg
;
3632 XOVERLAY (overlay
)->end
= end
;
3633 XOVERLAY (overlay
)->plist
= Qnil
;
3634 XOVERLAY (overlay
)->next
= NULL
;
3636 /* Put the new overlay on the wrong list. */
3637 end
= OVERLAY_END (overlay
);
3638 if (OVERLAY_POSITION (end
) < b
->overlay_center
)
3640 if (b
->overlays_after
)
3641 XOVERLAY (overlay
)->next
= b
->overlays_after
;
3642 b
->overlays_after
= XOVERLAY (overlay
);
3646 if (b
->overlays_before
)
3647 XOVERLAY (overlay
)->next
= b
->overlays_before
;
3648 b
->overlays_before
= XOVERLAY (overlay
);
3651 /* This puts it in the right list, and in the right order. */
3652 recenter_overlay_lists (b
, b
->overlay_center
);
3654 /* We don't need to redisplay the region covered by the overlay, because
3655 the overlay has no properties at the moment. */
3660 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3663 modify_overlay (struct buffer
*buf
, ptrdiff_t start
, ptrdiff_t end
)
3667 ptrdiff_t temp
= start
;
3672 BUF_COMPUTE_UNCHANGED (buf
, start
, end
);
3674 /* If this is a buffer not in the selected window,
3675 we must do other windows. */
3676 if (buf
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
3677 windows_or_buffers_changed
= 1;
3678 /* If multiple windows show this buffer, we must do other windows. */
3679 else if (buffer_shared
> 1)
3680 windows_or_buffers_changed
= 1;
3681 /* If we modify an overlay at the end of the buffer, we cannot
3682 be sure that window end is still valid. */
3683 else if (end
>= ZV
&& start
<= ZV
)
3684 windows_or_buffers_changed
= 1;
3686 ++BUF_OVERLAY_MODIFF (buf
);
3689 /* Remove OVERLAY from LIST. */
3691 static struct Lisp_Overlay
*
3692 unchain_overlay (struct Lisp_Overlay
*list
, struct Lisp_Overlay
*overlay
)
3694 register struct Lisp_Overlay
*tail
, **prev
= &list
;
3696 for (tail
= list
; tail
; prev
= &tail
->next
, tail
= *prev
)
3697 if (tail
== overlay
)
3699 *prev
= overlay
->next
;
3700 overlay
->next
= NULL
;
3706 DEFUN ("move-overlay", Fmove_overlay
, Smove_overlay
, 3, 4, 0,
3707 doc
: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3708 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3709 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3711 (Lisp_Object overlay
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object buffer
)
3713 struct buffer
*b
, *ob
= 0;
3714 Lisp_Object obuffer
;
3715 ptrdiff_t count
= SPECPDL_INDEX ();
3716 ptrdiff_t n_beg
, n_end
, o_beg
IF_LINT (= 0), o_end
IF_LINT (= 0);
3718 CHECK_OVERLAY (overlay
);
3720 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3722 XSETBUFFER (buffer
, current_buffer
);
3723 CHECK_BUFFER (buffer
);
3725 if (NILP (Fbuffer_live_p (buffer
)))
3726 error ("Attempt to move overlay to a dead buffer");
3729 && ! EQ (Fmarker_buffer (beg
), buffer
))
3730 error ("Marker points into wrong buffer");
3732 && ! EQ (Fmarker_buffer (end
), buffer
))
3733 error ("Marker points into wrong buffer");
3735 CHECK_NUMBER_COERCE_MARKER (beg
);
3736 CHECK_NUMBER_COERCE_MARKER (end
);
3738 if (XINT (beg
) > XINT (end
))
3741 temp
= beg
; beg
= end
; end
= temp
;
3744 specbind (Qinhibit_quit
, Qt
);
3746 obuffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3747 b
= XBUFFER (buffer
);
3749 if (!NILP (obuffer
))
3751 ob
= XBUFFER (obuffer
);
3753 o_beg
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3754 o_end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3756 ob
->overlays_before
=
3757 unchain_overlay (ob
->overlays_before
, XOVERLAY (overlay
));
3758 ob
->overlays_after
=
3759 unchain_overlay (ob
->overlays_after
, XOVERLAY (overlay
));
3760 eassert (XOVERLAY (overlay
)->next
== NULL
);
3763 /* Set the overlay boundaries, which may clip them. */
3764 Fset_marker (OVERLAY_START (overlay
), beg
, buffer
);
3765 Fset_marker (OVERLAY_END (overlay
), end
, buffer
);
3767 n_beg
= marker_position (OVERLAY_START (overlay
));
3768 n_end
= marker_position (OVERLAY_END (overlay
));
3770 /* If the overlay has changed buffers, do a thorough redisplay. */
3771 if (!EQ (buffer
, obuffer
))
3773 /* Redisplay where the overlay was. */
3775 modify_overlay (ob
, o_beg
, o_end
);
3777 /* Redisplay where the overlay is going to be. */
3778 modify_overlay (b
, n_beg
, n_end
);
3781 /* Redisplay the area the overlay has just left, or just enclosed. */
3784 modify_overlay (b
, o_end
, n_end
);
3785 else if (o_end
== n_end
)
3786 modify_overlay (b
, o_beg
, n_beg
);
3788 modify_overlay (b
, min (o_beg
, n_beg
), max (o_end
, n_end
));
3791 /* Delete the overlay if it is empty after clipping and has the
3792 evaporate property. */
3793 if (n_beg
== n_end
&& !NILP (Foverlay_get (overlay
, Qevaporate
)))
3794 return unbind_to (count
, Fdelete_overlay (overlay
));
3796 /* Put the overlay into the new buffer's overlay lists, first on the
3798 if (n_end
< b
->overlay_center
)
3800 XOVERLAY (overlay
)->next
= b
->overlays_after
;
3801 b
->overlays_after
= XOVERLAY (overlay
);
3805 XOVERLAY (overlay
)->next
= b
->overlays_before
;
3806 b
->overlays_before
= XOVERLAY (overlay
);
3809 /* This puts it in the right list, and in the right order. */
3810 recenter_overlay_lists (b
, b
->overlay_center
);
3812 return unbind_to (count
, overlay
);
3815 DEFUN ("delete-overlay", Fdelete_overlay
, Sdelete_overlay
, 1, 1, 0,
3816 doc
: /* Delete the overlay OVERLAY from its buffer. */)
3817 (Lisp_Object overlay
)
3821 ptrdiff_t count
= SPECPDL_INDEX ();
3823 CHECK_OVERLAY (overlay
);
3825 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
3829 b
= XBUFFER (buffer
);
3830 specbind (Qinhibit_quit
, Qt
);
3833 = unchain_overlay (b
->overlays_before
, XOVERLAY (overlay
));
3835 = unchain_overlay (b
->overlays_after
, XOVERLAY (overlay
));
3836 eassert (XOVERLAY (overlay
)->next
== NULL
);
3838 drop_overlay (b
, XOVERLAY (overlay
));
3840 /* When deleting an overlay with before or after strings, turn off
3841 display optimizations for the affected buffer, on the basis that
3842 these strings may contain newlines. This is easier to do than to
3843 check for that situation during redisplay. */
3844 if (!windows_or_buffers_changed
3845 && (!NILP (Foverlay_get (overlay
, Qbefore_string
))
3846 || !NILP (Foverlay_get (overlay
, Qafter_string
))))
3847 b
->prevent_redisplay_optimizations_p
= 1;
3849 return unbind_to (count
, Qnil
);
3852 /* Overlay dissection functions. */
3854 DEFUN ("overlay-start", Foverlay_start
, Soverlay_start
, 1, 1, 0,
3855 doc
: /* Return the position at which OVERLAY starts. */)
3856 (Lisp_Object overlay
)
3858 CHECK_OVERLAY (overlay
);
3860 return (Fmarker_position (OVERLAY_START (overlay
)));
3863 DEFUN ("overlay-end", Foverlay_end
, Soverlay_end
, 1, 1, 0,
3864 doc
: /* Return the position at which OVERLAY ends. */)
3865 (Lisp_Object overlay
)
3867 CHECK_OVERLAY (overlay
);
3869 return (Fmarker_position (OVERLAY_END (overlay
)));
3872 DEFUN ("overlay-buffer", Foverlay_buffer
, Soverlay_buffer
, 1, 1, 0,
3873 doc
: /* Return the buffer OVERLAY belongs to.
3874 Return nil if OVERLAY has been deleted. */)
3875 (Lisp_Object overlay
)
3877 CHECK_OVERLAY (overlay
);
3879 return Fmarker_buffer (OVERLAY_START (overlay
));
3882 DEFUN ("overlay-properties", Foverlay_properties
, Soverlay_properties
, 1, 1, 0,
3883 doc
: /* Return a list of the properties on OVERLAY.
3884 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3886 (Lisp_Object overlay
)
3888 CHECK_OVERLAY (overlay
);
3890 return Fcopy_sequence (XOVERLAY (overlay
)->plist
);
3894 DEFUN ("overlays-at", Foverlays_at
, Soverlays_at
, 1, 1, 0,
3895 doc
: /* Return a list of the overlays that contain the character at POS. */)
3898 ptrdiff_t len
, noverlays
;
3899 Lisp_Object
*overlay_vec
;
3902 CHECK_NUMBER_COERCE_MARKER (pos
);
3905 /* We can't use alloca here because overlays_at can call xrealloc. */
3906 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
3908 /* Put all the overlays we want in a vector in overlay_vec.
3909 Store the length in len. */
3910 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
3913 /* Make a list of them all. */
3914 result
= Flist (noverlays
, overlay_vec
);
3916 xfree (overlay_vec
);
3920 DEFUN ("overlays-in", Foverlays_in
, Soverlays_in
, 2, 2, 0,
3921 doc
: /* Return a list of the overlays that overlap the region BEG ... END.
3922 Overlap means that at least one character is contained within the overlay
3923 and also contained within the specified region.
3924 Empty overlays are included in the result if they are located at BEG,
3925 between BEG and END, or at END provided END denotes the position at the
3926 end of the buffer. */)
3927 (Lisp_Object beg
, Lisp_Object end
)
3929 ptrdiff_t len
, noverlays
;
3930 Lisp_Object
*overlay_vec
;
3933 CHECK_NUMBER_COERCE_MARKER (beg
);
3934 CHECK_NUMBER_COERCE_MARKER (end
);
3937 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
3939 /* Put all the overlays we want in a vector in overlay_vec.
3940 Store the length in len. */
3941 noverlays
= overlays_in (XINT (beg
), XINT (end
), 1, &overlay_vec
, &len
,
3944 /* Make a list of them all. */
3945 result
= Flist (noverlays
, overlay_vec
);
3947 xfree (overlay_vec
);
3951 DEFUN ("next-overlay-change", Fnext_overlay_change
, Snext_overlay_change
,
3953 doc
: /* Return the next position after POS where an overlay starts or ends.
3954 If there are no overlay boundaries from POS to (point-max),
3955 the value is (point-max). */)
3958 ptrdiff_t i
, len
, noverlays
;
3960 Lisp_Object
*overlay_vec
;
3962 CHECK_NUMBER_COERCE_MARKER (pos
);
3965 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
3967 /* Put all the overlays we want in a vector in overlay_vec.
3968 Store the length in len.
3969 endpos gets the position where the next overlay starts. */
3970 noverlays
= overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
3973 /* If any of these overlays ends before endpos,
3974 use its ending point instead. */
3975 for (i
= 0; i
< noverlays
; i
++)
3980 oend
= OVERLAY_END (overlay_vec
[i
]);
3981 oendpos
= OVERLAY_POSITION (oend
);
3982 if (oendpos
< endpos
)
3986 xfree (overlay_vec
);
3987 return make_number (endpos
);
3990 DEFUN ("previous-overlay-change", Fprevious_overlay_change
,
3991 Sprevious_overlay_change
, 1, 1, 0,
3992 doc
: /* Return the previous position before POS where an overlay starts or ends.
3993 If there are no overlay boundaries from (point-min) to POS,
3994 the value is (point-min). */)
3998 Lisp_Object
*overlay_vec
;
4001 CHECK_NUMBER_COERCE_MARKER (pos
);
4003 /* At beginning of buffer, we know the answer;
4004 avoid bug subtracting 1 below. */
4005 if (XINT (pos
) == BEGV
)
4009 overlay_vec
= xmalloc (len
* sizeof *overlay_vec
);
4011 /* Put all the overlays we want in a vector in overlay_vec.
4012 Store the length in len.
4013 prevpos gets the position of the previous change. */
4014 overlays_at (XINT (pos
), 1, &overlay_vec
, &len
,
4017 xfree (overlay_vec
);
4018 return make_number (prevpos
);
4021 /* These functions are for debugging overlays. */
4023 DEFUN ("overlay-lists", Foverlay_lists
, Soverlay_lists
, 0, 0, 0,
4024 doc
: /* Return a pair of lists giving all the overlays of the current buffer.
4025 The car has all the overlays before the overlay center;
4026 the cdr has all the overlays after the overlay center.
4027 Recentering overlays moves overlays between these lists.
4028 The lists you get are copies, so that changing them has no effect.
4029 However, the overlays you get are the real objects that the buffer uses. */)
4032 struct Lisp_Overlay
*ol
;
4033 Lisp_Object before
= Qnil
, after
= Qnil
, tmp
;
4034 for (ol
= current_buffer
->overlays_before
; ol
; ol
= ol
->next
)
4037 before
= Fcons (tmp
, before
);
4039 for (ol
= current_buffer
->overlays_after
; ol
; ol
= ol
->next
)
4042 after
= Fcons (tmp
, after
);
4044 return Fcons (Fnreverse (before
), Fnreverse (after
));
4047 DEFUN ("overlay-recenter", Foverlay_recenter
, Soverlay_recenter
, 1, 1, 0,
4048 doc
: /* Recenter the overlays of the current buffer around position POS.
4049 That makes overlay lookup faster for positions near POS (but perhaps slower
4050 for positions far away from POS). */)
4054 CHECK_NUMBER_COERCE_MARKER (pos
);
4056 p
= clip_to_bounds (PTRDIFF_MIN
, XINT (pos
), PTRDIFF_MAX
);
4057 recenter_overlay_lists (current_buffer
, p
);
4061 DEFUN ("overlay-get", Foverlay_get
, Soverlay_get
, 2, 2, 0,
4062 doc
: /* Get the property of overlay OVERLAY with property name PROP. */)
4063 (Lisp_Object overlay
, Lisp_Object prop
)
4065 CHECK_OVERLAY (overlay
);
4066 return lookup_char_property (XOVERLAY (overlay
)->plist
, prop
, 0);
4069 DEFUN ("overlay-put", Foverlay_put
, Soverlay_put
, 3, 3, 0,
4070 doc
: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4071 VALUE will be returned.*/)
4072 (Lisp_Object overlay
, Lisp_Object prop
, Lisp_Object value
)
4074 Lisp_Object tail
, buffer
;
4077 CHECK_OVERLAY (overlay
);
4079 buffer
= Fmarker_buffer (OVERLAY_START (overlay
));
4081 for (tail
= XOVERLAY (overlay
)->plist
;
4082 CONSP (tail
) && CONSP (XCDR (tail
));
4083 tail
= XCDR (XCDR (tail
)))
4084 if (EQ (XCAR (tail
), prop
))
4086 changed
= !EQ (XCAR (XCDR (tail
)), value
);
4087 XSETCAR (XCDR (tail
), value
);
4090 /* It wasn't in the list, so add it to the front. */
4091 changed
= !NILP (value
);
4092 XOVERLAY (overlay
)->plist
4093 = Fcons (prop
, Fcons (value
, XOVERLAY (overlay
)->plist
));
4095 if (! NILP (buffer
))
4098 modify_overlay (XBUFFER (buffer
),
4099 marker_position (OVERLAY_START (overlay
)),
4100 marker_position (OVERLAY_END (overlay
)));
4101 if (EQ (prop
, Qevaporate
) && ! NILP (value
)
4102 && (OVERLAY_POSITION (OVERLAY_START (overlay
))
4103 == OVERLAY_POSITION (OVERLAY_END (overlay
))))
4104 Fdelete_overlay (overlay
);
4110 /* Subroutine of report_overlay_modification. */
4112 /* Lisp vector holding overlay hook functions to call.
4113 Vector elements come in pairs.
4114 Each even-index element is a list of hook functions.
4115 The following odd-index element is the overlay they came from.
4117 Before the buffer change, we fill in this vector
4118 as we call overlay hook functions.
4119 After the buffer change, we get the functions to call from this vector.
4120 This way we always call the same functions before and after the change. */
4121 static Lisp_Object last_overlay_modification_hooks
;
4123 /* Number of elements actually used in last_overlay_modification_hooks. */
4124 static ptrdiff_t last_overlay_modification_hooks_used
;
4126 /* Add one functionlist/overlay pair
4127 to the end of last_overlay_modification_hooks. */
4130 add_overlay_mod_hooklist (Lisp_Object functionlist
, Lisp_Object overlay
)
4132 ptrdiff_t oldsize
= ASIZE (last_overlay_modification_hooks
);
4134 if (oldsize
- 1 <= last_overlay_modification_hooks_used
)
4135 last_overlay_modification_hooks
=
4136 larger_vector (last_overlay_modification_hooks
, 2, -1);
4137 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4138 functionlist
); last_overlay_modification_hooks_used
++;
4139 ASET (last_overlay_modification_hooks
, last_overlay_modification_hooks_used
,
4140 overlay
); last_overlay_modification_hooks_used
++;
4143 /* Run the modification-hooks of overlays that include
4144 any part of the text in START to END.
4145 If this change is an insertion, also
4146 run the insert-before-hooks of overlay starting at END,
4147 and the insert-after-hooks of overlay ending at START.
4149 This is called both before and after the modification.
4150 AFTER is nonzero when we call after the modification.
4152 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4153 When AFTER is nonzero, they are the start position,
4154 the position after the inserted new text,
4155 and the length of deleted or replaced old text. */
4158 report_overlay_modification (Lisp_Object start
, Lisp_Object end
, int after
,
4159 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4161 Lisp_Object prop
, overlay
;
4162 struct Lisp_Overlay
*tail
;
4163 /* 1 if this change is an insertion. */
4164 int insertion
= (after
? XFASTINT (arg3
) == 0 : EQ (start
, end
));
4165 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4170 /* We used to run the functions as soon as we found them and only register
4171 them in last_overlay_modification_hooks for the purpose of the `after'
4172 case. But running elisp code as we traverse the list of overlays is
4173 painful because the list can be modified by the elisp code so we had to
4174 copy at several places. We now simply do a read-only traversal that
4175 only collects the functions to run and we run them afterwards. It's
4176 simpler, especially since all the code was already there. -stef */
4180 /* We are being called before a change.
4181 Scan the overlays to find the functions to call. */
4182 last_overlay_modification_hooks_used
= 0;
4183 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4185 ptrdiff_t startpos
, endpos
;
4186 Lisp_Object ostart
, oend
;
4188 XSETMISC (overlay
, tail
);
4190 ostart
= OVERLAY_START (overlay
);
4191 oend
= OVERLAY_END (overlay
);
4192 endpos
= OVERLAY_POSITION (oend
);
4193 if (XFASTINT (start
) > endpos
)
4195 startpos
= OVERLAY_POSITION (ostart
);
4196 if (insertion
&& (XFASTINT (start
) == startpos
4197 || XFASTINT (end
) == startpos
))
4199 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4201 add_overlay_mod_hooklist (prop
, overlay
);
4203 if (insertion
&& (XFASTINT (start
) == endpos
4204 || XFASTINT (end
) == endpos
))
4206 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4208 add_overlay_mod_hooklist (prop
, overlay
);
4210 /* Test for intersecting intervals. This does the right thing
4211 for both insertion and deletion. */
4212 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4214 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4216 add_overlay_mod_hooklist (prop
, overlay
);
4220 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4222 ptrdiff_t startpos
, endpos
;
4223 Lisp_Object ostart
, oend
;
4225 XSETMISC (overlay
, tail
);
4227 ostart
= OVERLAY_START (overlay
);
4228 oend
= OVERLAY_END (overlay
);
4229 startpos
= OVERLAY_POSITION (ostart
);
4230 endpos
= OVERLAY_POSITION (oend
);
4231 if (XFASTINT (end
) < startpos
)
4233 if (insertion
&& (XFASTINT (start
) == startpos
4234 || XFASTINT (end
) == startpos
))
4236 prop
= Foverlay_get (overlay
, Qinsert_in_front_hooks
);
4238 add_overlay_mod_hooklist (prop
, overlay
);
4240 if (insertion
&& (XFASTINT (start
) == endpos
4241 || XFASTINT (end
) == endpos
))
4243 prop
= Foverlay_get (overlay
, Qinsert_behind_hooks
);
4245 add_overlay_mod_hooklist (prop
, overlay
);
4247 /* Test for intersecting intervals. This does the right thing
4248 for both insertion and deletion. */
4249 if (XFASTINT (end
) > startpos
&& XFASTINT (start
) < endpos
)
4251 prop
= Foverlay_get (overlay
, Qmodification_hooks
);
4253 add_overlay_mod_hooklist (prop
, overlay
);
4258 GCPRO4 (overlay
, arg1
, arg2
, arg3
);
4260 /* Call the functions recorded in last_overlay_modification_hooks.
4261 First copy the vector contents, in case some of these hooks
4262 do subsequent modification of the buffer. */
4263 ptrdiff_t size
= last_overlay_modification_hooks_used
;
4264 Lisp_Object
*copy
= alloca (size
* sizeof *copy
);
4267 memcpy (copy
, XVECTOR (last_overlay_modification_hooks
)->contents
,
4268 size
* sizeof (Lisp_Object
));
4270 gcpro1
.nvars
= size
;
4272 for (i
= 0; i
< size
;)
4274 Lisp_Object prop_i
, overlay_i
;
4276 overlay_i
= copy
[i
++];
4277 call_overlay_mod_hooks (prop_i
, overlay_i
, after
, arg1
, arg2
, arg3
);
4284 call_overlay_mod_hooks (Lisp_Object list
, Lisp_Object overlay
, int after
,
4285 Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
4287 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
4289 GCPRO4 (list
, arg1
, arg2
, arg3
);
4291 while (CONSP (list
))
4294 call4 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
);
4296 call5 (XCAR (list
), overlay
, after
? Qt
: Qnil
, arg1
, arg2
, arg3
);
4302 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4305 evaporate_overlays (ptrdiff_t pos
)
4307 Lisp_Object overlay
, hit_list
;
4308 struct Lisp_Overlay
*tail
;
4311 if (pos
<= current_buffer
->overlay_center
)
4312 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
4315 XSETMISC (overlay
, tail
);
4316 endpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4319 if (endpos
== pos
&& OVERLAY_POSITION (OVERLAY_START (overlay
)) == pos
4320 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4321 hit_list
= Fcons (overlay
, hit_list
);
4324 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
4327 XSETMISC (overlay
, tail
);
4328 startpos
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4331 if (startpos
== pos
&& OVERLAY_POSITION (OVERLAY_END (overlay
)) == pos
4332 && ! NILP (Foverlay_get (overlay
, Qevaporate
)))
4333 hit_list
= Fcons (overlay
, hit_list
);
4335 for (; CONSP (hit_list
); hit_list
= XCDR (hit_list
))
4336 Fdelete_overlay (XCAR (hit_list
));
4339 /* Somebody has tried to store a value with an unacceptable type
4340 in the slot with offset OFFSET. */
4343 buffer_slot_type_mismatch (Lisp_Object newval
, int type
)
4345 Lisp_Object predicate
;
4349 case_Lisp_Int
: predicate
= Qintegerp
; break;
4350 case Lisp_String
: predicate
= Qstringp
; break;
4351 case Lisp_Symbol
: predicate
= Qsymbolp
; break;
4355 wrong_type_argument (predicate
, newval
);
4359 /***********************************************************************
4360 Allocation with mmap
4361 ***********************************************************************/
4363 #ifdef USE_MMAP_FOR_BUFFERS
4365 #include <sys/types.h>
4366 #include <sys/mman.h>
4369 #ifdef MAP_ANONYMOUS
4370 #define MAP_ANON MAP_ANONYMOUS
4377 #define MAP_FAILED ((void *) -1)
4389 /* Memory is allocated in regions which are mapped using mmap(2).
4390 The current implementation lets the system select mapped
4391 addresses; we're not using MAP_FIXED in general, except when
4392 trying to enlarge regions.
4394 Each mapped region starts with a mmap_region structure, the user
4395 area starts after that structure, aligned to MEM_ALIGN.
4397 +-----------------------+
4398 | struct mmap_info + |
4400 +-----------------------+
4404 +-----------------------+ */
4408 /* User-specified size. */
4409 size_t nbytes_specified
;
4411 /* Number of bytes mapped */
4412 size_t nbytes_mapped
;
4414 /* Pointer to the location holding the address of the memory
4415 allocated with the mmap'd block. The variable actually points
4416 after this structure. */
4419 /* Next and previous in list of all mmap'd regions. */
4420 struct mmap_region
*next
, *prev
;
4423 /* Doubly-linked list of mmap'd regions. */
4425 static struct mmap_region
*mmap_regions
;
4427 /* File descriptor for mmap. If we don't have anonymous mapping,
4428 /dev/zero will be opened on it. */
4432 /* Temporary storage for mmap_set_vars, see there. */
4434 static struct mmap_region
*mmap_regions_1
;
4435 static int mmap_fd_1
;
4437 /* Page size on this system. */
4439 static int mmap_page_size
;
4441 /* 1 means mmap has been initialized. */
4443 static int mmap_initialized_p
;
4445 /* Value is X rounded up to the next multiple of N. */
4447 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4449 /* Size of mmap_region structure plus padding. */
4451 #define MMAP_REGION_STRUCT_SIZE \
4452 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4454 /* Given a pointer P to the start of the user-visible part of a mapped
4455 region, return a pointer to the start of the region. */
4457 #define MMAP_REGION(P) \
4458 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4460 /* Given a pointer P to the start of a mapped region, return a pointer
4461 to the start of the user-visible part of the region. */
4463 #define MMAP_USER_AREA(P) \
4464 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4466 #define MEM_ALIGN sizeof (double)
4468 /* Predicate returning true if part of the address range [START .. END]
4469 is currently mapped. Used to prevent overwriting an existing
4472 Default is to conservatively assume the address range is occupied by
4473 something else. This can be overridden by system configuration
4474 files if system-specific means to determine this exists. */
4476 #ifndef MMAP_ALLOCATED_P
4477 #define MMAP_ALLOCATED_P(start, end) 1
4480 /* Perform necessary initializations for the use of mmap. */
4486 /* The value of mmap_fd is initially 0 in temacs, and -1
4487 in a dumped Emacs. */
4490 /* No anonymous mmap -- we need the file descriptor. */
4491 mmap_fd
= open ("/dev/zero", O_RDONLY
);
4493 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno
));
4495 #endif /* MAP_ANON == 0 */
4497 if (mmap_initialized_p
)
4499 mmap_initialized_p
= 1;
4505 mmap_page_size
= getpagesize ();
4508 /* Return a region overlapping address range START...END, or null if
4509 none. END is not including, i.e. the last byte in the range
4512 static struct mmap_region
*
4513 mmap_find (void *start
, void *end
)
4515 struct mmap_region
*r
;
4516 char *s
= (char *) start
, *e
= (char *) end
;
4518 for (r
= mmap_regions
; r
; r
= r
->next
)
4520 char *rstart
= (char *) r
;
4521 char *rend
= rstart
+ r
->nbytes_mapped
;
4523 if (/* First byte of range, i.e. START, in this region? */
4524 (s
>= rstart
&& s
< rend
)
4525 /* Last byte of range, i.e. END - 1, in this region? */
4526 || (e
> rstart
&& e
<= rend
)
4527 /* First byte of this region in the range? */
4528 || (rstart
>= s
&& rstart
< e
)
4529 /* Last byte of this region in the range? */
4530 || (rend
> s
&& rend
<= e
))
4538 /* Unmap a region. P is a pointer to the start of the user-araa of
4539 the region. Value is non-zero if successful. */
4542 mmap_free_1 (struct mmap_region
*r
)
4545 r
->next
->prev
= r
->prev
;
4547 r
->prev
->next
= r
->next
;
4549 mmap_regions
= r
->next
;
4551 if (munmap (r
, r
->nbytes_mapped
) == -1)
4553 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4561 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4562 Value is non-zero if successful. */
4565 mmap_enlarge (struct mmap_region
*r
, int npages
)
4567 char *region_end
= (char *) r
+ r
->nbytes_mapped
;
4573 /* Unmap pages at the end of the region. */
4574 nbytes
= - npages
* mmap_page_size
;
4575 if (munmap (region_end
- nbytes
, nbytes
) == -1)
4576 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4579 r
->nbytes_mapped
-= nbytes
;
4583 else if (npages
> 0)
4585 nbytes
= npages
* mmap_page_size
;
4587 /* Try to map additional pages at the end of the region. We
4588 cannot do this if the address range is already occupied by
4589 something else because mmap deletes any previous mapping.
4590 I'm not sure this is worth doing, let's see. */
4591 if (!MMAP_ALLOCATED_P (region_end
, region_end
+ nbytes
))
4595 p
= mmap (region_end
, nbytes
, PROT_READ
| PROT_WRITE
,
4596 MAP_ANON
| MAP_PRIVATE
| MAP_FIXED
, mmap_fd
, 0);
4597 if (p
== MAP_FAILED
)
4598 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4599 else if (p
!= region_end
)
4601 /* Kernels are free to choose a different address. In
4602 that case, unmap what we've mapped above; we have
4604 if (munmap (p
, nbytes
) == -1)
4605 fprintf (stderr
, "munmap: %s\n", emacs_strerror (errno
));
4609 r
->nbytes_mapped
+= nbytes
;
4619 /* Set or reset variables holding references to mapped regions. If
4620 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4621 non-zero, set all variables to the start of the user-areas
4624 This function is called from Fdump_emacs to ensure that the dumped
4625 Emacs doesn't contain references to memory that won't be mapped
4626 when Emacs starts. */
4629 mmap_set_vars (int restore_p
)
4631 struct mmap_region
*r
;
4635 mmap_regions
= mmap_regions_1
;
4636 mmap_fd
= mmap_fd_1
;
4637 for (r
= mmap_regions
; r
; r
= r
->next
)
4638 *r
->var
= MMAP_USER_AREA (r
);
4642 for (r
= mmap_regions
; r
; r
= r
->next
)
4644 mmap_regions_1
= mmap_regions
;
4645 mmap_regions
= NULL
;
4646 mmap_fd_1
= mmap_fd
;
4652 /* Allocate a block of storage large enough to hold NBYTES bytes of
4653 data. A pointer to the data is returned in *VAR. VAR is thus the
4654 address of some variable which will use the data area.
4656 The allocation of 0 bytes is valid.
4658 If we can't allocate the necessary memory, set *VAR to null, and
4662 mmap_alloc (void **var
, size_t nbytes
)
4669 map
= ROUND (nbytes
+ MMAP_REGION_STRUCT_SIZE
, mmap_page_size
);
4670 p
= mmap (NULL
, map
, PROT_READ
| PROT_WRITE
, MAP_ANON
| MAP_PRIVATE
,
4673 if (p
== MAP_FAILED
)
4675 if (errno
!= ENOMEM
)
4676 fprintf (stderr
, "mmap: %s\n", emacs_strerror (errno
));
4681 struct mmap_region
*r
= (struct mmap_region
*) p
;
4683 r
->nbytes_specified
= nbytes
;
4684 r
->nbytes_mapped
= map
;
4687 r
->next
= mmap_regions
;
4692 p
= MMAP_USER_AREA (p
);
4699 /* Free a block of relocatable storage whose data is pointed to by
4700 PTR. Store 0 in *PTR to show there's no block allocated. */
4703 mmap_free (void **var
)
4709 mmap_free_1 (MMAP_REGION (*var
));
4715 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4716 resize it to size NBYTES. Change *VAR to reflect the new block,
4717 and return this value. If more memory cannot be allocated, then
4718 leave *VAR unchanged, and return null. */
4721 mmap_realloc (void **var
, size_t nbytes
)
4728 result
= mmap_alloc (var
, nbytes
);
4729 else if (nbytes
== 0)
4732 result
= mmap_alloc (var
, nbytes
);
4736 struct mmap_region
*r
= MMAP_REGION (*var
);
4737 size_t room
= r
->nbytes_mapped
- MMAP_REGION_STRUCT_SIZE
;
4742 void *old_ptr
= *var
;
4744 /* Try to map additional pages at the end of the region.
4745 If that fails, allocate a new region, copy data
4746 from the old region, then free it. */
4747 if (mmap_enlarge (r
, (ROUND (nbytes
- room
, mmap_page_size
)
4750 r
->nbytes_specified
= nbytes
;
4751 *var
= result
= old_ptr
;
4753 else if (mmap_alloc (var
, nbytes
))
4755 memcpy (*var
, old_ptr
, r
->nbytes_specified
);
4756 mmap_free_1 (MMAP_REGION (old_ptr
));
4758 r
= MMAP_REGION (result
);
4759 r
->nbytes_specified
= nbytes
;
4767 else if (room
- nbytes
>= mmap_page_size
)
4769 /* Shrinking by at least a page. Let's give some
4770 memory back to the system.
4772 The extra parens are to make the division happens first,
4773 on positive values, so we know it will round towards
4775 mmap_enlarge (r
, - ((room
- nbytes
) / mmap_page_size
));
4777 r
->nbytes_specified
= nbytes
;
4781 /* Leave it alone. */
4783 r
->nbytes_specified
= nbytes
;
4791 #endif /* USE_MMAP_FOR_BUFFERS */
4795 /***********************************************************************
4796 Buffer-text Allocation
4797 ***********************************************************************/
4799 /* Allocate NBYTES bytes for buffer B's text buffer. */
4802 alloc_buffer_text (struct buffer
*b
, ptrdiff_t nbytes
)
4807 #if defined USE_MMAP_FOR_BUFFERS
4808 p
= mmap_alloc ((void **) &b
->text
->beg
, nbytes
);
4809 #elif defined REL_ALLOC
4810 p
= r_alloc ((void **) &b
->text
->beg
, nbytes
);
4812 p
= xmalloc (nbytes
);
4818 memory_full (nbytes
);
4821 b
->text
->beg
= (unsigned char *) p
;
4825 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4829 enlarge_buffer_text (struct buffer
*b
, ptrdiff_t delta
)
4832 ptrdiff_t nbytes
= (BUF_Z_BYTE (b
) - BUF_BEG_BYTE (b
) + BUF_GAP_SIZE (b
) + 1
4835 #if defined USE_MMAP_FOR_BUFFERS
4836 p
= mmap_realloc ((void **) &b
->text
->beg
, nbytes
);
4837 #elif defined REL_ALLOC
4838 p
= r_re_alloc ((void **) &b
->text
->beg
, nbytes
);
4840 p
= xrealloc (b
->text
->beg
, nbytes
);
4846 memory_full (nbytes
);
4849 BUF_BEG_ADDR (b
) = (unsigned char *) p
;
4854 /* Free buffer B's text buffer. */
4857 free_buffer_text (struct buffer
*b
)
4861 #if defined USE_MMAP_FOR_BUFFERS
4862 mmap_free ((void **) &b
->text
->beg
);
4863 #elif defined REL_ALLOC
4864 r_alloc_free ((void **) &b
->text
->beg
);
4866 xfree (b
->text
->beg
);
4869 BUF_BEG_ADDR (b
) = NULL
;
4875 /***********************************************************************
4877 ***********************************************************************/
4880 init_buffer_once (void)
4883 /* If you add, remove, or reorder Lisp_Objects in a struct buffer, make
4884 sure that this is still correct. Otherwise, mark_vectorlike may not
4885 trace all Lisp_Objects in buffer_defaults and buffer_local_symbols. */
4887 = (offsetof (struct buffer
, own_text
) - sizeof (struct vectorlike_header
))
4888 / sizeof (Lisp_Object
);
4890 memset (buffer_permanent_local_flags
, 0, sizeof buffer_permanent_local_flags
);
4892 /* Make sure all markable slots in buffer_defaults
4893 are initialized reasonably, so mark_buffer won't choke. */
4894 reset_buffer (&buffer_defaults
);
4895 eassert (EQ (BVAR (&buffer_defaults
, name
), make_number (0)));
4896 reset_buffer_local_variables (&buffer_defaults
, 1);
4897 eassert (EQ (BVAR (&buffer_local_symbols
, name
), make_number (0)));
4898 reset_buffer (&buffer_local_symbols
);
4899 reset_buffer_local_variables (&buffer_local_symbols
, 1);
4900 /* Prevent GC from getting confused. */
4901 buffer_defaults
.text
= &buffer_defaults
.own_text
;
4902 buffer_local_symbols
.text
= &buffer_local_symbols
.own_text
;
4903 BUF_INTERVALS (&buffer_defaults
) = 0;
4904 BUF_INTERVALS (&buffer_local_symbols
) = 0;
4905 XSETPVECTYPESIZE (&buffer_defaults
, PVEC_BUFFER
, pvecsize
);
4906 XSETBUFFER (Vbuffer_defaults
, &buffer_defaults
);
4907 XSETPVECTYPESIZE (&buffer_local_symbols
, PVEC_BUFFER
, pvecsize
);
4908 XSETBUFFER (Vbuffer_local_symbols
, &buffer_local_symbols
);
4910 /* Set up the default values of various buffer slots. */
4911 /* Must do these before making the first buffer! */
4913 /* real setup is done in bindings.el */
4914 BVAR (&buffer_defaults
, mode_line_format
) = build_pure_c_string ("%-");
4915 BVAR (&buffer_defaults
, header_line_format
) = Qnil
;
4916 BVAR (&buffer_defaults
, abbrev_mode
) = Qnil
;
4917 BVAR (&buffer_defaults
, overwrite_mode
) = Qnil
;
4918 BVAR (&buffer_defaults
, case_fold_search
) = Qt
;
4919 BVAR (&buffer_defaults
, auto_fill_function
) = Qnil
;
4920 BVAR (&buffer_defaults
, selective_display
) = Qnil
;
4921 BVAR (&buffer_defaults
, selective_display_ellipses
) = Qt
;
4922 BVAR (&buffer_defaults
, abbrev_table
) = Qnil
;
4923 BVAR (&buffer_defaults
, display_table
) = Qnil
;
4924 BVAR (&buffer_defaults
, undo_list
) = Qnil
;
4925 BVAR (&buffer_defaults
, mark_active
) = Qnil
;
4926 BVAR (&buffer_defaults
, file_format
) = Qnil
;
4927 BVAR (&buffer_defaults
, auto_save_file_format
) = Qt
;
4928 buffer_defaults
.overlays_before
= NULL
;
4929 buffer_defaults
.overlays_after
= NULL
;
4930 buffer_defaults
.overlay_center
= BEG
;
4932 XSETFASTINT (BVAR (&buffer_defaults
, tab_width
), 8);
4933 BVAR (&buffer_defaults
, truncate_lines
) = Qnil
;
4934 BVAR (&buffer_defaults
, word_wrap
) = Qnil
;
4935 BVAR (&buffer_defaults
, ctl_arrow
) = Qt
;
4936 BVAR (&buffer_defaults
, bidi_display_reordering
) = Qt
;
4937 BVAR (&buffer_defaults
, bidi_paragraph_direction
) = Qnil
;
4938 BVAR (&buffer_defaults
, cursor_type
) = Qt
;
4939 BVAR (&buffer_defaults
, extra_line_spacing
) = Qnil
;
4940 BVAR (&buffer_defaults
, cursor_in_non_selected_windows
) = Qt
;
4942 BVAR (&buffer_defaults
, enable_multibyte_characters
) = Qt
;
4943 BVAR (&buffer_defaults
, buffer_file_coding_system
) = Qnil
;
4944 XSETFASTINT (BVAR (&buffer_defaults
, fill_column
), 70);
4945 XSETFASTINT (BVAR (&buffer_defaults
, left_margin
), 0);
4946 BVAR (&buffer_defaults
, cache_long_line_scans
) = Qnil
;
4947 BVAR (&buffer_defaults
, file_truename
) = Qnil
;
4948 XSETFASTINT (BVAR (&buffer_defaults
, display_count
), 0);
4949 XSETFASTINT (BVAR (&buffer_defaults
, left_margin_cols
), 0);
4950 XSETFASTINT (BVAR (&buffer_defaults
, right_margin_cols
), 0);
4951 BVAR (&buffer_defaults
, left_fringe_width
) = Qnil
;
4952 BVAR (&buffer_defaults
, right_fringe_width
) = Qnil
;
4953 BVAR (&buffer_defaults
, fringes_outside_margins
) = Qnil
;
4954 BVAR (&buffer_defaults
, scroll_bar_width
) = Qnil
;
4955 BVAR (&buffer_defaults
, vertical_scroll_bar_type
) = Qt
;
4956 BVAR (&buffer_defaults
, indicate_empty_lines
) = Qnil
;
4957 BVAR (&buffer_defaults
, indicate_buffer_boundaries
) = Qnil
;
4958 BVAR (&buffer_defaults
, fringe_indicator_alist
) = Qnil
;
4959 BVAR (&buffer_defaults
, fringe_cursor_alist
) = Qnil
;
4960 BVAR (&buffer_defaults
, scroll_up_aggressively
) = Qnil
;
4961 BVAR (&buffer_defaults
, scroll_down_aggressively
) = Qnil
;
4962 BVAR (&buffer_defaults
, display_time
) = Qnil
;
4964 /* Assign the local-flags to the slots that have default values.
4965 The local flag is a bit that is used in the buffer
4966 to say that it has its own local value for the slot.
4967 The local flag bits are in the local_var_flags slot of the buffer. */
4969 /* Nothing can work if this isn't true */
4970 { verify (sizeof (EMACS_INT
) == sizeof (Lisp_Object
)); }
4972 /* 0 means not a lisp var, -1 means always local, else mask */
4973 memset (&buffer_local_flags
, 0, sizeof buffer_local_flags
);
4974 XSETINT (BVAR (&buffer_local_flags
, filename
), -1);
4975 XSETINT (BVAR (&buffer_local_flags
, directory
), -1);
4976 XSETINT (BVAR (&buffer_local_flags
, backed_up
), -1);
4977 XSETINT (BVAR (&buffer_local_flags
, save_length
), -1);
4978 XSETINT (BVAR (&buffer_local_flags
, auto_save_file_name
), -1);
4979 XSETINT (BVAR (&buffer_local_flags
, read_only
), -1);
4980 XSETINT (BVAR (&buffer_local_flags
, major_mode
), -1);
4981 XSETINT (BVAR (&buffer_local_flags
, mode_name
), -1);
4982 XSETINT (BVAR (&buffer_local_flags
, undo_list
), -1);
4983 XSETINT (BVAR (&buffer_local_flags
, mark_active
), -1);
4984 XSETINT (BVAR (&buffer_local_flags
, point_before_scroll
), -1);
4985 XSETINT (BVAR (&buffer_local_flags
, file_truename
), -1);
4986 XSETINT (BVAR (&buffer_local_flags
, invisibility_spec
), -1);
4987 XSETINT (BVAR (&buffer_local_flags
, file_format
), -1);
4988 XSETINT (BVAR (&buffer_local_flags
, auto_save_file_format
), -1);
4989 XSETINT (BVAR (&buffer_local_flags
, display_count
), -1);
4990 XSETINT (BVAR (&buffer_local_flags
, display_time
), -1);
4991 XSETINT (BVAR (&buffer_local_flags
, enable_multibyte_characters
), -1);
4994 XSETFASTINT (BVAR (&buffer_local_flags
, mode_line_format
), idx
); ++idx
;
4995 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_mode
), idx
); ++idx
;
4996 XSETFASTINT (BVAR (&buffer_local_flags
, overwrite_mode
), idx
); ++idx
;
4997 XSETFASTINT (BVAR (&buffer_local_flags
, case_fold_search
), idx
); ++idx
;
4998 XSETFASTINT (BVAR (&buffer_local_flags
, auto_fill_function
), idx
); ++idx
;
4999 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display
), idx
); ++idx
;
5000 XSETFASTINT (BVAR (&buffer_local_flags
, selective_display_ellipses
), idx
); ++idx
;
5001 XSETFASTINT (BVAR (&buffer_local_flags
, tab_width
), idx
); ++idx
;
5002 XSETFASTINT (BVAR (&buffer_local_flags
, truncate_lines
), idx
); ++idx
;
5003 XSETFASTINT (BVAR (&buffer_local_flags
, word_wrap
), idx
); ++idx
;
5004 XSETFASTINT (BVAR (&buffer_local_flags
, ctl_arrow
), idx
); ++idx
;
5005 XSETFASTINT (BVAR (&buffer_local_flags
, fill_column
), idx
); ++idx
;
5006 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin
), idx
); ++idx
;
5007 XSETFASTINT (BVAR (&buffer_local_flags
, abbrev_table
), idx
); ++idx
;
5008 XSETFASTINT (BVAR (&buffer_local_flags
, display_table
), idx
); ++idx
;
5009 XSETFASTINT (BVAR (&buffer_local_flags
, syntax_table
), idx
); ++idx
;
5010 XSETFASTINT (BVAR (&buffer_local_flags
, cache_long_line_scans
), idx
); ++idx
;
5011 XSETFASTINT (BVAR (&buffer_local_flags
, category_table
), idx
); ++idx
;
5012 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_display_reordering
), idx
); ++idx
;
5013 XSETFASTINT (BVAR (&buffer_local_flags
, bidi_paragraph_direction
), idx
); ++idx
;
5014 XSETFASTINT (BVAR (&buffer_local_flags
, buffer_file_coding_system
), idx
);
5015 /* Make this one a permanent local. */
5016 buffer_permanent_local_flags
[idx
++] = 1;
5017 XSETFASTINT (BVAR (&buffer_local_flags
, left_margin_cols
), idx
); ++idx
;
5018 XSETFASTINT (BVAR (&buffer_local_flags
, right_margin_cols
), idx
); ++idx
;
5019 XSETFASTINT (BVAR (&buffer_local_flags
, left_fringe_width
), idx
); ++idx
;
5020 XSETFASTINT (BVAR (&buffer_local_flags
, right_fringe_width
), idx
); ++idx
;
5021 XSETFASTINT (BVAR (&buffer_local_flags
, fringes_outside_margins
), idx
); ++idx
;
5022 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_bar_width
), idx
); ++idx
;
5023 XSETFASTINT (BVAR (&buffer_local_flags
, vertical_scroll_bar_type
), idx
); ++idx
;
5024 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_empty_lines
), idx
); ++idx
;
5025 XSETFASTINT (BVAR (&buffer_local_flags
, indicate_buffer_boundaries
), idx
); ++idx
;
5026 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_indicator_alist
), idx
); ++idx
;
5027 XSETFASTINT (BVAR (&buffer_local_flags
, fringe_cursor_alist
), idx
); ++idx
;
5028 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_up_aggressively
), idx
); ++idx
;
5029 XSETFASTINT (BVAR (&buffer_local_flags
, scroll_down_aggressively
), idx
); ++idx
;
5030 XSETFASTINT (BVAR (&buffer_local_flags
, header_line_format
), idx
); ++idx
;
5031 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_type
), idx
); ++idx
;
5032 XSETFASTINT (BVAR (&buffer_local_flags
, extra_line_spacing
), idx
); ++idx
;
5033 XSETFASTINT (BVAR (&buffer_local_flags
, cursor_in_non_selected_windows
), idx
); ++idx
;
5035 /* Need more room? */
5036 if (idx
>= MAX_PER_BUFFER_VARS
)
5038 last_per_buffer_idx
= idx
;
5040 Vbuffer_alist
= Qnil
;
5044 QSFundamental
= build_pure_c_string ("Fundamental");
5046 Qfundamental_mode
= intern_c_string ("fundamental-mode");
5047 BVAR (&buffer_defaults
, major_mode
) = Qfundamental_mode
;
5049 Qmode_class
= intern_c_string ("mode-class");
5051 Qprotected_field
= intern_c_string ("protected-field");
5053 Qpermanent_local
= intern_c_string ("permanent-local");
5055 Qkill_buffer_hook
= intern_c_string ("kill-buffer-hook");
5056 Fput (Qkill_buffer_hook
, Qpermanent_local
, Qt
);
5058 /* super-magic invisible buffer */
5059 Vprin1_to_string_buffer
= Fget_buffer_create (build_pure_c_string (" prin1"));
5060 Vbuffer_alist
= Qnil
;
5062 Fset_buffer (Fget_buffer_create (build_pure_c_string ("*scratch*")));
5064 inhibit_modification_hooks
= 0;
5074 #ifdef USE_MMAP_FOR_BUFFERS
5076 /* When using the ralloc implementation based on mmap(2), buffer
5077 text pointers will have been set to null in the dumped Emacs.
5082 if (b
->text
->beg
== NULL
)
5083 enlarge_buffer_text (b
, 0);
5085 #endif /* USE_MMAP_FOR_BUFFERS */
5087 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5088 if (NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5089 Fset_buffer_multibyte (Qnil
);
5091 pwd
= get_current_dir_name ();
5094 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5096 /* Maybe this should really use some standard subroutine
5097 whose definition is filename syntax dependent. */
5099 if (!(IS_DIRECTORY_SEP (pwd
[len
- 1])))
5101 /* Grow buffer to add directory separator and '\0'. */
5102 pwd
= realloc (pwd
, len
+ 2);
5104 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno
));
5105 pwd
[len
] = DIRECTORY_SEP
;
5106 pwd
[len
+ 1] = '\0';
5110 BVAR (current_buffer
, directory
) = make_unibyte_string (pwd
, len
);
5111 if (! NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
)))
5112 /* At this moment, we still don't know how to decode the
5113 directory name. So, we keep the bytes in multibyte form so
5114 that ENCODE_FILE correctly gets the original bytes. */
5115 BVAR (current_buffer
, directory
)
5116 = string_to_multibyte (BVAR (current_buffer
, directory
));
5118 /* Add /: to the front of the name
5119 if it would otherwise be treated as magic. */
5120 temp
= Ffind_file_name_handler (BVAR (current_buffer
, directory
), Qt
);
5122 /* If the default dir is just /, TEMP is non-nil
5123 because of the ange-ftp completion handler.
5124 However, it is not necessary to turn / into /:/.
5125 So avoid doing that. */
5126 && strcmp ("/", SSDATA (BVAR (current_buffer
, directory
))))
5127 BVAR (current_buffer
, directory
)
5128 = concat2 (build_string ("/:"), BVAR (current_buffer
, directory
));
5130 temp
= get_minibuffer (0);
5131 BVAR (XBUFFER (temp
), directory
) = BVAR (current_buffer
, directory
);
5136 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5137 Object stored in the current buffer. address is the address of the slot
5138 in the buffer that is current now. */
5140 /* TYPE is nil for a general Lisp variable.
5141 An integer specifies a type; then only Lisp values
5142 with that type code are allowed (except that nil is allowed too).
5143 LNAME is the Lisp-level variable name.
5144 VNAME is the name of the buffer slot.
5145 DOC is a dummy where you write the doc string as a comment. */
5146 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5148 static struct Lisp_Buffer_Objfwd bo_fwd; \
5149 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5153 defvar_per_buffer (struct Lisp_Buffer_Objfwd
*bo_fwd
, const char *namestring
,
5154 Lisp_Object
*address
, Lisp_Object type
)
5156 struct Lisp_Symbol
*sym
;
5159 sym
= XSYMBOL (intern (namestring
));
5160 offset
= (char *)address
- (char *)current_buffer
;
5162 bo_fwd
->type
= Lisp_Fwd_Buffer_Obj
;
5163 bo_fwd
->offset
= offset
;
5164 bo_fwd
->slottype
= type
;
5165 sym
->declared_special
= 1;
5166 sym
->redirect
= SYMBOL_FORWARDED
;
5168 /* I tried to do the job without a cast, but it seems impossible.
5169 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5170 SET_SYMBOL_FWD (sym
, (union Lisp_Fwd
*)bo_fwd
);
5172 XSETSYMBOL (PER_BUFFER_SYMBOL (offset
), sym
);
5174 if (PER_BUFFER_IDX (offset
) == 0)
5175 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5176 slot of buffer_local_flags */
5181 /* initialize the buffer routines */
5183 syms_of_buffer (void)
5185 staticpro (&last_overlay_modification_hooks
);
5186 last_overlay_modification_hooks
5187 = Fmake_vector (make_number (10), Qnil
);
5189 staticpro (&Vbuffer_defaults
);
5190 staticpro (&Vbuffer_local_symbols
);
5191 staticpro (&Qfundamental_mode
);
5192 staticpro (&Qmode_class
);
5193 staticpro (&QSFundamental
);
5194 staticpro (&Vbuffer_alist
);
5195 staticpro (&Qprotected_field
);
5196 staticpro (&Qpermanent_local
);
5197 staticpro (&Qkill_buffer_hook
);
5199 DEFSYM (Qpermanent_local_hook
, "permanent-local-hook");
5200 DEFSYM (Qoverlayp
, "overlayp");
5201 DEFSYM (Qevaporate
, "evaporate");
5202 DEFSYM (Qmodification_hooks
, "modification-hooks");
5203 DEFSYM (Qinsert_in_front_hooks
, "insert-in-front-hooks");
5204 DEFSYM (Qinsert_behind_hooks
, "insert-behind-hooks");
5205 DEFSYM (Qget_file_buffer
, "get-file-buffer");
5206 DEFSYM (Qpriority
, "priority");
5207 DEFSYM (Qbefore_string
, "before-string");
5208 DEFSYM (Qafter_string
, "after-string");
5209 DEFSYM (Qfirst_change_hook
, "first-change-hook");
5210 DEFSYM (Qbefore_change_functions
, "before-change-functions");
5211 DEFSYM (Qafter_change_functions
, "after-change-functions");
5212 DEFSYM (Qkill_buffer_query_functions
, "kill-buffer-query-functions");
5214 Fput (Qprotected_field
, Qerror_conditions
,
5215 pure_cons (Qprotected_field
, pure_cons (Qerror
, Qnil
)));
5216 Fput (Qprotected_field
, Qerror_message
,
5217 build_pure_c_string ("Attempt to modify a protected field"));
5219 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5221 doc
: /* Default value of `mode-line-format' for buffers that don't override it.
5222 This is the same as (default-value 'mode-line-format). */);
5224 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5226 doc
: /* Default value of `header-line-format' for buffers that don't override it.
5227 This is the same as (default-value 'header-line-format). */);
5229 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type
,
5230 doc
: /* Default value of `cursor-type' for buffers that don't override it.
5231 This is the same as (default-value 'cursor-type). */);
5233 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5235 doc
: /* Default value of `line-spacing' for buffers that don't override it.
5236 This is the same as (default-value 'line-spacing). */);
5238 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5239 cursor_in_non_selected_windows
,
5240 doc
: /* Default value of `cursor-in-non-selected-windows'.
5241 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5243 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5245 doc
: /* Default value of `abbrev-mode' for buffers that do not override it.
5246 This is the same as (default-value 'abbrev-mode). */);
5248 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5250 doc
: /* Default value of `ctl-arrow' for buffers that do not override it.
5251 This is the same as (default-value 'ctl-arrow). */);
5253 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5254 enable_multibyte_characters
,
5255 doc
: /* Default value of `enable-multibyte-characters' for buffers not overriding it.
5256 This is the same as (default-value 'enable-multibyte-characters). */);
5258 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5259 buffer_file_coding_system
,
5260 doc
: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5261 This is the same as (default-value 'buffer-file-coding-system). */);
5263 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5265 doc
: /* Default value of `truncate-lines' for buffers that do not override it.
5266 This is the same as (default-value 'truncate-lines). */);
5268 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5270 doc
: /* Default value of `fill-column' for buffers that do not override it.
5271 This is the same as (default-value 'fill-column). */);
5273 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5275 doc
: /* Default value of `left-margin' for buffers that do not override it.
5276 This is the same as (default-value 'left-margin). */);
5278 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5280 doc
: /* Default value of `tab-width' for buffers that do not override it.
5281 This is the same as (default-value 'tab-width). */);
5283 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5285 doc
: /* Default value of `case-fold-search' for buffers that don't override it.
5286 This is the same as (default-value 'case-fold-search). */);
5288 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5290 doc
: /* Default value of `left-margin-width' for buffers that don't override it.
5291 This is the same as (default-value 'left-margin-width). */);
5293 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5295 doc
: /* Default value of `right-margin-width' for buffers that don't override it.
5296 This is the same as (default-value 'right-margin-width). */);
5298 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5300 doc
: /* Default value of `left-fringe-width' for buffers that don't override it.
5301 This is the same as (default-value 'left-fringe-width). */);
5303 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5305 doc
: /* Default value of `right-fringe-width' for buffers that don't override it.
5306 This is the same as (default-value 'right-fringe-width). */);
5308 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5309 fringes_outside_margins
,
5310 doc
: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5311 This is the same as (default-value 'fringes-outside-margins). */);
5313 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5315 doc
: /* Default value of `scroll-bar-width' for buffers that don't override it.
5316 This is the same as (default-value 'scroll-bar-width). */);
5318 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5319 vertical_scroll_bar_type
,
5320 doc
: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5321 This is the same as (default-value 'vertical-scroll-bar). */);
5323 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5324 indicate_empty_lines
,
5325 doc
: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5326 This is the same as (default-value 'indicate-empty-lines). */);
5328 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5329 indicate_buffer_boundaries
,
5330 doc
: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5331 This is the same as (default-value 'indicate-buffer-boundaries). */);
5333 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5334 fringe_indicator_alist
,
5335 doc
: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5336 This is the same as (default-value 'fringe-indicator-alist'). */);
5338 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5339 fringe_cursor_alist
,
5340 doc
: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5341 This is the same as (default-value 'fringe-cursor-alist'). */);
5343 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5344 scroll_up_aggressively
,
5345 doc
: /* Default value of `scroll-up-aggressively'.
5346 This value applies in buffers that don't have their own local values.
5347 This is the same as (default-value 'scroll-up-aggressively). */);
5349 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5350 scroll_down_aggressively
,
5351 doc
: /* Default value of `scroll-down-aggressively'.
5352 This value applies in buffers that don't have their own local values.
5353 This is the same as (default-value 'scroll-down-aggressively). */);
5355 DEFVAR_PER_BUFFER ("header-line-format",
5356 &BVAR (current_buffer
, header_line_format
),
5358 doc
: /* Analogous to `mode-line-format', but controls the header line.
5359 The header line appears, optionally, at the top of a window;
5360 the mode line appears at the bottom. */);
5362 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer
, mode_line_format
),
5364 doc
: /* Template for displaying mode line for current buffer.
5366 The value may be nil, a string, a symbol or a list.
5368 A value of nil means don't display a mode line.
5370 For any symbol other than t or nil, the symbol's value is processed as
5371 a mode line construct. As a special exception, if that value is a
5372 string, the string is processed verbatim, without handling any
5373 %-constructs (see below). Also, unless the symbol has a non-nil
5374 `risky-local-variable' property, all properties in any strings, as
5375 well as all :eval and :propertize forms in the value, are ignored.
5377 A list whose car is a string or list is processed by processing each
5378 of the list elements recursively, as separate mode line constructs,
5379 and concatenating the results.
5381 A list of the form `(:eval FORM)' is processed by evaluating FORM and
5382 using the result as a mode line construct. Be careful--FORM should
5383 not load any files, because that can cause an infinite recursion.
5385 A list of the form `(:propertize ELT PROPS...)' is processed by
5386 processing ELT as the mode line construct, and adding the text
5387 properties PROPS to the result.
5389 A list whose car is a symbol is processed by examining the symbol's
5390 value, and, if that value is non-nil, processing the cadr of the list
5391 recursively; and if that value is nil, processing the caddr of the
5394 A list whose car is an integer is processed by processing the cadr of
5395 the list, and padding (if the number is positive) or truncating (if
5396 negative) to the width specified by that number.
5398 A string is printed verbatim in the mode line except for %-constructs:
5399 %b -- print buffer name. %f -- print visited file name.
5400 %F -- print frame name.
5401 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5402 %& is like %*, but ignore read-only-ness.
5403 % means buffer is read-only and * means it is modified.
5404 For a modified read-only buffer, %* gives % and %+ gives *.
5405 %s -- print process status. %l -- print the current line number.
5406 %c -- print the current column number (this makes editing slower).
5407 To make the column number update correctly in all cases,
5408 `column-number-mode' must be non-nil.
5409 %i -- print the size of the buffer.
5410 %I -- like %i, but use k, M, G, etc., to abbreviate.
5411 %p -- print percent of buffer above top of window, or Top, Bot or All.
5412 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5413 or print Bottom or All.
5414 %n -- print Narrow if appropriate.
5415 %t -- visited file is text or binary (if OS supports this distinction).
5416 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5417 %Z -- like %z, but including the end-of-line format.
5418 %e -- print error message about full memory.
5419 %@ -- print @ or hyphen. @ means that default-directory is on a
5421 %[ -- print one [ for each recursive editing level. %] similar.
5422 %% -- print %. %- -- print infinitely many dashes.
5423 Decimal digits after the % specify field width to which to pad. */);
5425 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode
,
5426 doc
: /* Value of `major-mode' for new buffers. */);
5428 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer
, major_mode
),
5429 make_number (Lisp_Symbol
),
5430 doc
: /* Symbol for current buffer's major mode.
5431 The default value (normally `fundamental-mode') affects new buffers.
5432 A value of nil means to use the current buffer's major mode, provided
5433 it is not marked as "special".
5435 When a mode is used by default, `find-file' switches to it before it
5436 reads the contents into the buffer and before it finishes setting up
5437 the buffer. Thus, the mode and its hooks should not expect certain
5438 variables such as `buffer-read-only' and `buffer-file-coding-system'
5441 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer
, mode_name
),
5443 doc
: /* Pretty name of current buffer's major mode.
5444 Usually a string, but can use any of the constructs for `mode-line-format',
5446 Format with `format-mode-line' to produce a string value. */);
5448 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer
, abbrev_table
), Qnil
,
5449 doc
: /* Local (mode-specific) abbrev table of current buffer. */);
5451 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer
, abbrev_mode
), Qnil
,
5452 doc
: /* Non-nil if Abbrev mode is enabled.
5453 Use the command `abbrev-mode' to change this variable. */);
5455 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer
, case_fold_search
),
5457 doc
: /* Non-nil if searches and matches should ignore case. */);
5459 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer
, fill_column
),
5460 make_number (LISP_INT_TAG
),
5461 doc
: /* Column beyond which automatic line-wrapping should happen.
5462 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5464 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer
, left_margin
),
5465 make_number (LISP_INT_TAG
),
5466 doc
: /* Column for the default `indent-line-function' to indent to.
5467 Linefeed indents to this column in Fundamental mode. */);
5469 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer
, tab_width
),
5470 make_number (LISP_INT_TAG
),
5471 doc
: /* Distance between tab stops (for display of tab characters), in columns.
5472 This should be an integer greater than zero. */);
5474 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer
, ctl_arrow
), Qnil
,
5475 doc
: /* Non-nil means display control chars with uparrow.
5476 A value of nil means use backslash and octal digits.
5477 This variable does not apply to characters whose display is specified
5478 in the current display table (if there is one). */);
5480 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5481 &BVAR (current_buffer
, enable_multibyte_characters
),
5483 doc
: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5484 Otherwise they are regarded as unibyte. This affects the display,
5485 file I/O and the behavior of various editing commands.
5487 This variable is buffer-local but you cannot set it directly;
5488 use the function `set-buffer-multibyte' to change a buffer's representation.
5489 See also Info node `(elisp)Text Representations'. */);
5490 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant
= 1;
5492 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5493 &BVAR (current_buffer
, buffer_file_coding_system
), Qnil
,
5494 doc
: /* Coding system to be used for encoding the buffer contents on saving.
5495 This variable applies to saving the buffer, and also to `write-region'
5496 and other functions that use `write-region'.
5497 It does not apply to sending output to subprocesses, however.
5499 If this is nil, the buffer is saved without any code conversion
5500 unless some coding system is specified in `file-coding-system-alist'
5501 for the buffer file.
5503 If the text to be saved cannot be encoded as specified by this variable,
5504 an alternative encoding is selected by `select-safe-coding-system', which see.
5506 The variable `coding-system-for-write', if non-nil, overrides this variable.
5508 This variable is never applied to a way of decoding a file while reading it. */);
5510 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5511 &BVAR (current_buffer
, bidi_display_reordering
), Qnil
,
5512 doc
: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5514 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5515 &BVAR (current_buffer
, bidi_paragraph_direction
), Qnil
,
5516 doc
: /* If non-nil, forces directionality of text paragraphs in the buffer.
5518 If this is nil (the default), the direction of each paragraph is
5519 determined by the first strong directional character of its text.
5520 The values of `right-to-left' and `left-to-right' override that.
5521 Any other value is treated as nil.
5523 This variable has no effect unless the buffer's value of
5524 \`bidi-display-reordering' is non-nil. */);
5526 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer
, truncate_lines
), Qnil
,
5527 doc
: /* Non-nil means do not display continuation lines.
5528 Instead, give each line of text just one screen line.
5530 Note that this is overridden by the variable
5531 `truncate-partial-width-windows' if that variable is non-nil
5532 and this buffer is not full-frame width.
5534 Minibuffers set this variable to nil. */);
5536 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer
, word_wrap
), Qnil
,
5537 doc
: /* Non-nil means to use word-wrapping for continuation lines.
5538 When word-wrapping is on, continuation lines are wrapped at the space
5539 or tab character nearest to the right window edge.
5540 If nil, continuation lines are wrapped at the right screen edge.
5542 This variable has no effect if long lines are truncated (see
5543 `truncate-lines' and `truncate-partial-width-windows'). If you use
5544 word-wrapping, you might want to reduce the value of
5545 `truncate-partial-width-windows', since wrapping can make text readable
5546 in narrower windows.
5548 Instead of setting this variable directly, most users should use
5549 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5550 to t, and additionally redefines simple editing commands to act on
5551 visual lines rather than logical lines. See the documentation of
5552 `visual-line-mode'. */);
5554 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer
, directory
),
5555 make_number (Lisp_String
),
5556 doc
: /* Name of default directory of current buffer. Should end with slash.
5557 To interactively change the default directory, use command `cd'. */);
5559 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer
, auto_fill_function
),
5561 doc
: /* Function called (if non-nil) to perform auto-fill.
5562 It is called after self-inserting any character specified in
5563 the `auto-fill-chars' table.
5564 NOTE: This variable is not a hook;
5565 its value may not be a list of functions. */);
5567 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer
, filename
),
5568 make_number (Lisp_String
),
5569 doc
: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5571 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer
, file_truename
),
5572 make_number (Lisp_String
),
5573 doc
: /* Abbreviated truename of file visited in current buffer, or nil if none.
5574 The truename of a file is calculated by `file-truename'
5575 and then abbreviated with `abbreviate-file-name'. */);
5577 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5578 &BVAR (current_buffer
, auto_save_file_name
),
5579 make_number (Lisp_String
),
5580 doc
: /* Name of file for auto-saving current buffer.
5581 If it is nil, that means don't auto-save this buffer. */);
5583 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer
, read_only
), Qnil
,
5584 doc
: /* Non-nil if this buffer is read-only. */);
5586 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer
, backed_up
), Qnil
,
5587 doc
: /* Non-nil if this buffer's file has been backed up.
5588 Backing up is done before the first time the file is saved. */);
5590 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer
, save_length
),
5591 make_number (LISP_INT_TAG
),
5592 doc
: /* Length of current buffer when last read in, saved or auto-saved.
5594 -1 means auto-saving turned off until next real save.
5596 If you set this to -2, that means don't turn off auto-saving in this buffer
5597 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5598 you probably should set this to -2 in that buffer. */);
5600 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer
, selective_display
),
5602 doc
: /* Non-nil enables selective display.
5603 An integer N as value means display only lines
5604 that start with less than N columns of space.
5605 A value of t means that the character ^M makes itself and
5606 all the rest of the line invisible; also, when saving the buffer
5607 in a file, save the ^M as a newline. */);
5609 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5610 &BVAR (current_buffer
, selective_display_ellipses
),
5612 doc
: /* Non-nil means display ... on previous line when a line is invisible. */);
5614 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer
, overwrite_mode
), Qnil
,
5615 doc
: /* Non-nil if self-insertion should replace existing text.
5616 The value should be one of `overwrite-mode-textual',
5617 `overwrite-mode-binary', or nil.
5618 If it is `overwrite-mode-textual', self-insertion still
5619 inserts at the end of a line, and inserts when point is before a tab,
5620 until the tab is filled in.
5621 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5623 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer
, display_table
),
5625 doc
: /* Display table that controls display of the contents of current buffer.
5627 If this variable is nil, the value of `standard-display-table' is used.
5628 Each window can have its own, overriding display table, see
5629 `set-window-display-table' and `window-display-table'.
5631 The display table is a char-table created with `make-display-table'.
5632 A char-table is an array indexed by character codes. Normal array
5633 primitives `aref' and `aset' can be used to access elements of a char-table.
5635 Each of the char-table elements control how to display the corresponding
5636 text character: the element at index C in the table says how to display
5637 the character whose code is C. Each element should be a vector of
5638 characters or nil. The value nil means display the character in the
5639 default fashion; otherwise, the characters from the vector are delivered
5640 to the screen instead of the original character.
5642 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5643 to display a capital Y instead of each X character.
5645 In addition, a char-table has six extra slots to control the display of:
5647 the end of a truncated screen line (extra-slot 0, a single character);
5648 the end of a continued line (extra-slot 1, a single character);
5649 the escape character used to display character codes in octal
5650 (extra-slot 2, a single character);
5651 the character used as an arrow for control characters (extra-slot 3,
5652 a single character);
5653 the decoration indicating the presence of invisible lines (extra-slot 4,
5654 a vector of characters);
5655 the character used to draw the border between side-by-side windows
5656 (extra-slot 5, a single character).
5658 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5660 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer
, left_margin_cols
),
5662 doc
: /* Width of left marginal area for display of a buffer.
5663 A value of nil means no marginal area. */);
5665 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer
, right_margin_cols
),
5667 doc
: /* Width of right marginal area for display of a buffer.
5668 A value of nil means no marginal area. */);
5670 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer
, left_fringe_width
),
5672 doc
: /* Width of this buffer's left fringe (in pixels).
5673 A value of 0 means no left fringe is shown in this buffer's window.
5674 A value of nil means to use the left fringe width from the window's frame. */);
5676 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer
, right_fringe_width
),
5678 doc
: /* Width of this buffer's right fringe (in pixels).
5679 A value of 0 means no right fringe is shown in this buffer's window.
5680 A value of nil means to use the right fringe width from the window's frame. */);
5682 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer
, fringes_outside_margins
),
5684 doc
: /* Non-nil means to display fringes outside display margins.
5685 A value of nil means to display fringes between margins and buffer text. */);
5687 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer
, scroll_bar_width
),
5689 doc
: /* Width of this buffer's scroll bars in pixels.
5690 A value of nil means to use the scroll bar width from the window's frame. */);
5692 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer
, vertical_scroll_bar_type
),
5694 doc
: /* Position of this buffer's vertical scroll bar.
5695 The value takes effect whenever you tell a window to display this buffer;
5696 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5698 A value of `left' or `right' means put the vertical scroll bar at that side
5699 of the window; a value of nil means don't show any vertical scroll bars.
5700 A value of t (the default) means do whatever the window's frame specifies. */);
5702 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5703 &BVAR (current_buffer
, indicate_empty_lines
), Qnil
,
5704 doc
: /* Visually indicate empty lines after the buffer end.
5705 If non-nil, a bitmap is displayed in the left fringe of a window on
5706 window-systems. */);
5708 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5709 &BVAR (current_buffer
, indicate_buffer_boundaries
), Qnil
,
5710 doc
: /* Visually indicate buffer boundaries and scrolling.
5711 If non-nil, the first and last line of the buffer are marked in the fringe
5712 of a window on window-systems with angle bitmaps, or if the window can be
5713 scrolled, the top and bottom line of the window are marked with up and down
5716 If value is a symbol `left' or `right', both angle and arrow bitmaps
5717 are displayed in the left or right fringe, resp. Any other value
5718 that doesn't look like an alist means display the angle bitmaps in
5719 the left fringe but no arrows.
5721 You can exercise more precise control by using an alist as the
5722 value. Each alist element (INDICATOR . POSITION) specifies
5723 where to show one of the indicators. INDICATOR is one of `top',
5724 `bottom', `up', `down', or t, which specifies the default position,
5725 and POSITION is one of `left', `right', or nil, meaning do not show
5728 For example, ((top . left) (t . right)) places the top angle bitmap in
5729 left fringe, the bottom angle bitmap in right fringe, and both arrow
5730 bitmaps in right fringe. To show just the angle bitmaps in the left
5731 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5733 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5734 &BVAR (current_buffer
, fringe_indicator_alist
), Qnil
,
5735 doc
: /* Mapping from logical to physical fringe indicator bitmaps.
5736 The value is an alist where each element (INDICATOR . BITMAPS)
5737 specifies the fringe bitmaps used to display a specific logical
5740 INDICATOR specifies the logical indicator type which is one of the
5741 following symbols: `truncation' , `continuation', `overlay-arrow',
5742 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5744 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5745 the actual bitmap shown in the left or right fringe for the logical
5746 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5747 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5748 are used only for the `bottom' and `top-bottom' indicators when the
5749 last (only) line has no final newline. BITMAPS may also be a single
5750 symbol which is used in both left and right fringes. */);
5752 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5753 &BVAR (current_buffer
, fringe_cursor_alist
), Qnil
,
5754 doc
: /* Mapping from logical to physical fringe cursor bitmaps.
5755 The value is an alist where each element (CURSOR . BITMAP)
5756 specifies the fringe bitmaps used to display a specific logical
5757 cursor type in the fringe.
5759 CURSOR specifies the logical cursor type which is one of the following
5760 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5761 one is used to show a hollow cursor on narrow lines display lines
5762 where the normal hollow cursor will not fit.
5764 BITMAP is the corresponding fringe bitmap shown for the logical
5767 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5768 &BVAR (current_buffer
, scroll_up_aggressively
), Qnil
,
5769 doc
: /* How far to scroll windows upward.
5770 If you move point off the bottom, the window scrolls automatically.
5771 This variable controls how far it scrolls. The value nil, the default,
5772 means scroll to center point. A fraction means scroll to put point
5773 that fraction of the window's height from the bottom of the window.
5774 When the value is 0.0, point goes at the bottom line, which in the
5775 simple case that you moved off with C-f means scrolling just one line.
5776 1.0 means point goes at the top, so that in that simple case, the
5777 window scrolls by a full window height. Meaningful values are
5778 between 0.0 and 1.0, inclusive. */);
5780 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5781 &BVAR (current_buffer
, scroll_down_aggressively
), Qnil
,
5782 doc
: /* How far to scroll windows downward.
5783 If you move point off the top, the window scrolls automatically.
5784 This variable controls how far it scrolls. The value nil, the default,
5785 means scroll to center point. A fraction means scroll to put point
5786 that fraction of the window's height from the top of the window.
5787 When the value is 0.0, point goes at the top line, which in the
5788 simple case that you moved off with C-b means scrolling just one line.
5789 1.0 means point goes at the bottom, so that in that simple case, the
5790 window scrolls by a full window height. Meaningful values are
5791 between 0.0 and 1.0, inclusive. */);
5793 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5797 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions
,
5798 doc
: /* List of functions to call before each text change.
5799 Two arguments are passed to each function: the positions of
5800 the beginning and end of the range of old text to be changed.
5801 \(For an insertion, the beginning and end are at the same place.)
5802 No information is given about the length of the text after the change.
5804 Buffer changes made while executing the `before-change-functions'
5805 don't call any before-change or after-change functions.
5806 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5808 If an unhandled error happens in running these functions,
5809 the variable's value remains nil. That prevents the error
5810 from happening repeatedly and making Emacs nonfunctional. */);
5811 Vbefore_change_functions
= Qnil
;
5813 DEFVAR_LISP ("after-change-functions", Vafter_change_functions
,
5814 doc
: /* List of functions to call after each text change.
5815 Three arguments are passed to each function: the positions of
5816 the beginning and end of the range of changed text,
5817 and the length in bytes of the pre-change text replaced by that range.
5818 \(For an insertion, the pre-change length is zero;
5819 for a deletion, that length is the number of bytes deleted,
5820 and the post-change beginning and end are at the same place.)
5822 Buffer changes made while executing the `after-change-functions'
5823 don't call any before-change or after-change functions.
5824 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5826 If an unhandled error happens in running these functions,
5827 the variable's value remains nil. That prevents the error
5828 from happening repeatedly and making Emacs nonfunctional. */);
5829 Vafter_change_functions
= Qnil
;
5831 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook
,
5832 doc
: /* A list of functions to call before changing a buffer which is unmodified.
5833 The functions are run using the `run-hooks' function. */);
5834 Vfirst_change_hook
= Qnil
;
5836 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer
, undo_list
), Qnil
,
5837 doc
: /* List of undo entries in current buffer.
5838 Recent changes come first; older changes follow newer.
5840 An entry (BEG . END) represents an insertion which begins at
5841 position BEG and ends at position END.
5843 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5844 from (abs POSITION). If POSITION is positive, point was at the front
5845 of the text being deleted; if negative, point was at the end.
5847 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
5848 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
5849 and is the visited file's modification time, as of that time. If the
5850 modification time of the most recent save is different, this entry is
5853 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5854 was modified between BEG and END. PROPERTY is the property name,
5855 and VALUE is the old value.
5857 An entry (apply FUN-NAME . ARGS) means undo the change with
5858 \(apply FUN-NAME ARGS).
5860 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5861 in the active region. BEG and END is the range affected by this entry
5862 and DELTA is the number of bytes added or deleted in that range by
5865 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5866 was adjusted in position by the offset DISTANCE (an integer).
5868 An entry of the form POSITION indicates that point was at the buffer
5869 location given by the integer. Undoing an entry of this form places
5872 Entries with value `nil' mark undo boundaries. The undo command treats
5873 the changes between two undo boundaries as a single step to be undone.
5875 If the value of the variable is t, undo information is not recorded. */);
5877 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer
, mark_active
), Qnil
,
5878 doc
: /* Non-nil means the mark and region are currently active in this buffer. */);
5880 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer
, cache_long_line_scans
), Qnil
,
5881 doc
: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5883 Normally, the line-motion functions work by scanning the buffer for
5884 newlines. Columnar operations (like `move-to-column' and
5885 `compute-motion') also work by scanning the buffer, summing character
5886 widths as they go. This works well for ordinary text, but if the
5887 buffer's lines are very long (say, more than 500 characters), these
5888 motion functions will take longer to execute. Emacs may also take
5889 longer to update the display.
5891 If `cache-long-line-scans' is non-nil, these motion functions cache the
5892 results of their scans, and consult the cache to avoid rescanning
5893 regions of the buffer until the text is modified. The caches are most
5894 beneficial when they prevent the most searching---that is, when the
5895 buffer contains long lines and large regions of characters with the
5896 same, fixed screen width.
5898 When `cache-long-line-scans' is non-nil, processing short lines will
5899 become slightly slower (because of the overhead of consulting the
5900 cache), and the caches will use memory roughly proportional to the
5901 number of newlines and characters whose screen width varies.
5903 The caches require no explicit maintenance; their accuracy is
5904 maintained internally by the Emacs primitives. Enabling or disabling
5905 the cache should not affect the behavior of any of the motion
5906 functions; it should only affect their performance. */);
5908 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer
, point_before_scroll
), Qnil
,
5909 doc
: /* Value of point before the last series of scroll operations, or nil. */);
5911 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer
, file_format
), Qnil
,
5912 doc
: /* List of formats to use when saving this buffer.
5913 Formats are defined by `format-alist'. This variable is
5914 set when a file is visited. */);
5916 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5917 &BVAR (current_buffer
, auto_save_file_format
), Qnil
,
5918 doc
: /* Format in which to write auto-save files.
5919 Should be a list of symbols naming formats that are defined in `format-alist'.
5920 If it is t, which is the default, auto-save files are written in the
5921 same format as a regular save would use. */);
5923 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5924 &BVAR (current_buffer
, invisibility_spec
), Qnil
,
5925 doc
: /* Invisibility spec of this buffer.
5926 The default is t, which means that text is invisible
5927 if it has a non-nil `invisible' property.
5928 If the value is a list, a text character is invisible if its `invisible'
5929 property is an element in that list (or is a list with members in common).
5930 If an element is a cons cell of the form (PROP . ELLIPSIS),
5931 then characters with property value PROP are invisible,
5932 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5934 DEFVAR_PER_BUFFER ("buffer-display-count",
5935 &BVAR (current_buffer
, display_count
), Qnil
,
5936 doc
: /* A number incremented each time this buffer is displayed in a window.
5937 The function `set-window-buffer' increments it. */);
5939 DEFVAR_PER_BUFFER ("buffer-display-time",
5940 &BVAR (current_buffer
, display_time
), Qnil
,
5941 doc
: /* Time stamp updated each time this buffer is displayed in a window.
5942 The function `set-window-buffer' updates this variable
5943 to the value obtained by calling `current-time'.
5944 If the buffer has never been shown in a window, the value is nil. */);
5946 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode
,
5947 doc
: /* Non-nil if Transient Mark mode is enabled.
5948 See the command `transient-mark-mode' for a description of this minor mode.
5950 Non-nil also enables highlighting of the region whenever the mark is active.
5951 The variable `highlight-nonselected-windows' controls whether to highlight
5952 all windows or just the selected window.
5954 Lisp programs may give this variable certain special values:
5956 - A value of `lambda' enables Transient Mark mode temporarily.
5957 It is disabled again after any subsequent action that would
5958 normally deactivate the mark (e.g. buffer modification).
5960 - A value of (only . OLDVAL) enables Transient Mark mode
5961 temporarily. After any subsequent point motion command that is
5962 not shift-translated, or any other action that would normally
5963 deactivate the mark (e.g. buffer modification), the value of
5964 `transient-mark-mode' is set to OLDVAL. */);
5965 Vtransient_mark_mode
= Qnil
;
5967 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only
,
5968 doc
: /* Non-nil means disregard read-only status of buffers or characters.
5969 If the value is t, disregard `buffer-read-only' and all `read-only'
5970 text properties. If the value is a list, disregard `buffer-read-only'
5971 and disregard a `read-only' text property if the property value
5972 is a member of the list. */);
5973 Vinhibit_read_only
= Qnil
;
5975 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer
, cursor_type
), Qnil
,
5976 doc
: /* Cursor to use when this buffer is in the selected window.
5977 Values are interpreted as follows:
5979 t use the cursor specified for the frame
5980 nil don't display a cursor
5981 box display a filled box cursor
5982 hollow display a hollow box cursor
5983 bar display a vertical bar cursor with default width
5984 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5985 hbar display a horizontal bar cursor with default height
5986 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5987 ANYTHING ELSE display a hollow box cursor
5989 When the buffer is displayed in a non-selected window, the
5990 cursor's appearance is instead controlled by the variable
5991 `cursor-in-non-selected-windows'. */);
5993 DEFVAR_PER_BUFFER ("line-spacing",
5994 &BVAR (current_buffer
, extra_line_spacing
), Qnil
,
5995 doc
: /* Additional space to put between lines when displaying a buffer.
5996 The space is measured in pixels, and put below lines on graphic displays,
5997 see `display-graphic-p'.
5998 If value is a floating point number, it specifies the spacing relative
5999 to the default frame line height. A value of nil means add no extra space. */);
6001 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6002 &BVAR (current_buffer
, cursor_in_non_selected_windows
), Qnil
,
6003 doc
: /* Non-nil means show a cursor in non-selected windows.
6004 If nil, only shows a cursor in the selected window.
6005 If t, displays a cursor related to the usual cursor type
6006 \(a solid box becomes hollow, a bar becomes a narrower bar).
6007 You can also specify the cursor type as in the `cursor-type' variable.
6008 Use Custom to set this variable and update the display." */);
6010 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions
,
6011 doc
: /* List of functions called with no args to query before killing a buffer.
6012 The buffer being killed will be current while the functions are running.
6014 If any of them returns nil, the buffer is not killed. Functions run by
6015 this hook are supposed to not change the current buffer. */);
6016 Vkill_buffer_query_functions
= Qnil
;
6018 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook
,
6019 doc
: /* Normal hook run before changing the major mode of a buffer.
6020 The function `kill-all-local-variables' runs this before doing anything else. */);
6021 Vchange_major_mode_hook
= Qnil
;
6022 DEFSYM (Qchange_major_mode_hook
, "change-major-mode-hook");
6024 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook
,
6025 doc
: /* Hook run when the buffer list changes.
6026 Functions running this hook are `get-buffer-create',
6027 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6028 and `bury-buffer-internal'. */);
6029 Vbuffer_list_update_hook
= Qnil
;
6030 DEFSYM (Qbuffer_list_update_hook
, "buffer-list-update-hook");
6032 defsubr (&Sbuffer_live_p
);
6033 defsubr (&Sbuffer_list
);
6034 defsubr (&Sget_buffer
);
6035 defsubr (&Sget_file_buffer
);
6036 defsubr (&Sget_buffer_create
);
6037 defsubr (&Smake_indirect_buffer
);
6038 defsubr (&Sgenerate_new_buffer_name
);
6039 defsubr (&Sbuffer_name
);
6040 defsubr (&Sbuffer_file_name
);
6041 defsubr (&Sbuffer_base_buffer
);
6042 defsubr (&Sbuffer_local_value
);
6043 defsubr (&Sbuffer_local_variables
);
6044 defsubr (&Sbuffer_modified_p
);
6045 defsubr (&Sset_buffer_modified_p
);
6046 defsubr (&Sbuffer_modified_tick
);
6047 defsubr (&Sbuffer_chars_modified_tick
);
6048 defsubr (&Srename_buffer
);
6049 defsubr (&Sother_buffer
);
6050 defsubr (&Sbuffer_enable_undo
);
6051 defsubr (&Scompact_buffer
);
6052 defsubr (&Skill_buffer
);
6053 defsubr (&Sbury_buffer_internal
);
6054 defsubr (&Sset_buffer_major_mode
);
6055 defsubr (&Scurrent_buffer
);
6056 defsubr (&Sset_buffer
);
6057 defsubr (&Sbarf_if_buffer_read_only
);
6058 defsubr (&Serase_buffer
);
6059 defsubr (&Sbuffer_swap_text
);
6060 defsubr (&Sset_buffer_multibyte
);
6061 defsubr (&Skill_all_local_variables
);
6063 defsubr (&Soverlayp
);
6064 defsubr (&Smake_overlay
);
6065 defsubr (&Sdelete_overlay
);
6066 defsubr (&Smove_overlay
);
6067 defsubr (&Soverlay_start
);
6068 defsubr (&Soverlay_end
);
6069 defsubr (&Soverlay_buffer
);
6070 defsubr (&Soverlay_properties
);
6071 defsubr (&Soverlays_at
);
6072 defsubr (&Soverlays_in
);
6073 defsubr (&Snext_overlay_change
);
6074 defsubr (&Sprevious_overlay_change
);
6075 defsubr (&Soverlay_recenter
);
6076 defsubr (&Soverlay_lists
);
6077 defsubr (&Soverlay_get
);
6078 defsubr (&Soverlay_put
);
6079 defsubr (&Srestore_buffer_modified_p
);
6083 keys_of_buffer (void)
6085 initial_define_key (control_x_map
, 'b', "switch-to-buffer");
6086 initial_define_key (control_x_map
, 'k', "kill-buffer");
6088 /* This must not be in syms_of_buffer, because Qdisabled is not
6089 initialized when that function gets called. */
6090 Fput (intern_c_string ("erase-buffer"), Qdisabled
, Qt
);