Fix problems with line-number updates in Follow mode
[emacs.git] / src / buffer.c
blob80dbd3318dc06380dc6cd09cf5db03d5670bee48
1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2017 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #include <sys/param.h>
26 #include <errno.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <unistd.h>
31 #include <verify.h>
33 #include "lisp.h"
34 #include "intervals.h"
35 #include "process.h"
36 #include "systime.h"
37 #include "window.h"
38 #include "commands.h"
39 #include "character.h"
40 #include "buffer.h"
41 #include "region-cache.h"
42 #include "indent.h"
43 #include "blockinput.h"
44 #include "keymap.h"
45 #include "frame.h"
46 #include "xwidget.h"
48 #ifdef WINDOWSNT
49 #include "w32heap.h" /* for mmap_* */
50 #endif
52 /* First buffer in chain of all buffers (in reverse order of creation).
53 Threaded through ->header.next.buffer. */
55 struct buffer *all_buffers;
57 /* This structure holds the default values of the buffer-local variables
58 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
59 The default value occupies the same slot in this structure
60 as an individual buffer's value occupies in that buffer.
61 Setting the default value also goes through the alist of buffers
62 and stores into each buffer that does not say it has a local value. */
64 struct buffer alignas (GCALIGNMENT) buffer_defaults;
66 /* This structure marks which slots in a buffer have corresponding
67 default values in buffer_defaults.
68 Each such slot has a nonzero value in this structure.
69 The value has only one nonzero bit.
71 When a buffer has its own local value for a slot,
72 the entry for that slot (found in the same slot in this structure)
73 is turned on in the buffer's local_flags array.
75 If a slot in this structure is -1, then even though there may
76 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
77 and the corresponding slot in buffer_defaults is not used.
79 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
80 zero, that is a bug. */
82 struct buffer buffer_local_flags;
84 /* This structure holds the names of symbols whose values may be
85 buffer-local. It is indexed and accessed in the same way as the above. */
87 struct buffer alignas (GCALIGNMENT) buffer_local_symbols;
89 /* Return the symbol of the per-buffer variable at offset OFFSET in
90 the buffer structure. */
92 #define PER_BUFFER_SYMBOL(OFFSET) \
93 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
95 /* Maximum length of an overlay vector. */
96 #define OVERLAY_COUNT_MAX \
97 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
98 min (PTRDIFF_MAX, SIZE_MAX) / word_size))
100 /* Flags indicating which built-in buffer-local variables
101 are permanent locals. */
102 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
104 /* Number of per-buffer variables used. */
106 int last_per_buffer_idx;
108 static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
109 bool after, Lisp_Object arg1,
110 Lisp_Object arg2, Lisp_Object arg3);
111 static void swap_out_buffer_local_variables (struct buffer *b);
112 static void reset_buffer_local_variables (struct buffer *, bool);
114 /* Alist of all buffer names vs the buffers. This used to be
115 a Lisp-visible variable, but is no longer, to prevent lossage
116 due to user rplac'ing this alist or its elements. */
117 Lisp_Object Vbuffer_alist;
119 static Lisp_Object QSFundamental; /* A string "Fundamental". */
121 static void alloc_buffer_text (struct buffer *, ptrdiff_t);
122 static void free_buffer_text (struct buffer *b);
123 static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
124 static void modify_overlay (struct buffer *, ptrdiff_t, ptrdiff_t);
125 static Lisp_Object buffer_lisp_local_variables (struct buffer *, bool);
127 static void
128 CHECK_OVERLAY (Lisp_Object x)
130 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x);
133 /* These setters are used only in this file, so they can be private.
134 The public setters are inline functions defined in buffer.h. */
135 static void
136 bset_abbrev_mode (struct buffer *b, Lisp_Object val)
138 b->abbrev_mode_ = val;
140 static void
141 bset_abbrev_table (struct buffer *b, Lisp_Object val)
143 b->abbrev_table_ = val;
145 static void
146 bset_auto_fill_function (struct buffer *b, Lisp_Object val)
148 b->auto_fill_function_ = val;
150 static void
151 bset_auto_save_file_format (struct buffer *b, Lisp_Object val)
153 b->auto_save_file_format_ = val;
155 static void
156 bset_auto_save_file_name (struct buffer *b, Lisp_Object val)
158 b->auto_save_file_name_ = val;
160 static void
161 bset_backed_up (struct buffer *b, Lisp_Object val)
163 b->backed_up_ = val;
165 static void
166 bset_begv_marker (struct buffer *b, Lisp_Object val)
168 b->begv_marker_ = val;
170 static void
171 bset_bidi_display_reordering (struct buffer *b, Lisp_Object val)
173 b->bidi_display_reordering_ = val;
175 static void
176 bset_buffer_file_coding_system (struct buffer *b, Lisp_Object val)
178 b->buffer_file_coding_system_ = val;
180 static void
181 bset_case_fold_search (struct buffer *b, Lisp_Object val)
183 b->case_fold_search_ = val;
185 static void
186 bset_ctl_arrow (struct buffer *b, Lisp_Object val)
188 b->ctl_arrow_ = val;
190 static void
191 bset_cursor_in_non_selected_windows (struct buffer *b, Lisp_Object val)
193 b->cursor_in_non_selected_windows_ = val;
195 static void
196 bset_cursor_type (struct buffer *b, Lisp_Object val)
198 b->cursor_type_ = val;
200 static void
201 bset_display_table (struct buffer *b, Lisp_Object val)
203 b->display_table_ = val;
205 static void
206 bset_extra_line_spacing (struct buffer *b, Lisp_Object val)
208 b->extra_line_spacing_ = val;
210 static void
211 bset_file_format (struct buffer *b, Lisp_Object val)
213 b->file_format_ = val;
215 static void
216 bset_file_truename (struct buffer *b, Lisp_Object val)
218 b->file_truename_ = val;
220 static void
221 bset_fringe_cursor_alist (struct buffer *b, Lisp_Object val)
223 b->fringe_cursor_alist_ = val;
225 static void
226 bset_fringe_indicator_alist (struct buffer *b, Lisp_Object val)
228 b->fringe_indicator_alist_ = val;
230 static void
231 bset_fringes_outside_margins (struct buffer *b, Lisp_Object val)
233 b->fringes_outside_margins_ = val;
235 static void
236 bset_header_line_format (struct buffer *b, Lisp_Object val)
238 b->header_line_format_ = val;
240 static void
241 bset_indicate_buffer_boundaries (struct buffer *b, Lisp_Object val)
243 b->indicate_buffer_boundaries_ = val;
245 static void
246 bset_indicate_empty_lines (struct buffer *b, Lisp_Object val)
248 b->indicate_empty_lines_ = val;
250 static void
251 bset_invisibility_spec (struct buffer *b, Lisp_Object val)
253 b->invisibility_spec_ = val;
255 static void
256 bset_left_fringe_width (struct buffer *b, Lisp_Object val)
258 b->left_fringe_width_ = val;
260 static void
261 bset_major_mode (struct buffer *b, Lisp_Object val)
263 b->major_mode_ = val;
265 static void
266 bset_mark (struct buffer *b, Lisp_Object val)
268 b->mark_ = val;
270 static void
271 bset_minor_modes (struct buffer *b, Lisp_Object val)
273 b->minor_modes_ = val;
275 static void
276 bset_mode_line_format (struct buffer *b, Lisp_Object val)
278 b->mode_line_format_ = val;
280 static void
281 bset_mode_name (struct buffer *b, Lisp_Object val)
283 b->mode_name_ = val;
285 static void
286 bset_name (struct buffer *b, Lisp_Object val)
288 b->name_ = val;
290 static void
291 bset_overwrite_mode (struct buffer *b, Lisp_Object val)
293 b->overwrite_mode_ = val;
295 static void
296 bset_pt_marker (struct buffer *b, Lisp_Object val)
298 b->pt_marker_ = val;
300 static void
301 bset_right_fringe_width (struct buffer *b, Lisp_Object val)
303 b->right_fringe_width_ = val;
305 static void
306 bset_save_length (struct buffer *b, Lisp_Object val)
308 b->save_length_ = val;
310 static void
311 bset_scroll_bar_width (struct buffer *b, Lisp_Object val)
313 b->scroll_bar_width_ = val;
315 static void
316 bset_scroll_bar_height (struct buffer *b, Lisp_Object val)
318 b->scroll_bar_height_ = val;
320 static void
321 bset_scroll_down_aggressively (struct buffer *b, Lisp_Object val)
323 b->scroll_down_aggressively_ = val;
325 static void
326 bset_scroll_up_aggressively (struct buffer *b, Lisp_Object val)
328 b->scroll_up_aggressively_ = val;
330 static void
331 bset_selective_display (struct buffer *b, Lisp_Object val)
333 b->selective_display_ = val;
335 static void
336 bset_selective_display_ellipses (struct buffer *b, Lisp_Object val)
338 b->selective_display_ellipses_ = val;
340 static void
341 bset_vertical_scroll_bar_type (struct buffer *b, Lisp_Object val)
343 b->vertical_scroll_bar_type_ = val;
345 static void
346 bset_horizontal_scroll_bar_type (struct buffer *b, Lisp_Object val)
348 b->horizontal_scroll_bar_type_ = val;
350 static void
351 bset_word_wrap (struct buffer *b, Lisp_Object val)
353 b->word_wrap_ = val;
355 static void
356 bset_zv_marker (struct buffer *b, Lisp_Object val)
358 b->zv_marker_ = val;
361 void
362 nsberror (Lisp_Object spec)
364 if (STRINGP (spec))
365 error ("No buffer named %s", SDATA (spec));
366 error ("Invalid buffer argument");
369 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
370 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
371 Value is nil if OBJECT is not a buffer or if it has been killed. */)
372 (Lisp_Object object)
374 return ((BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object)))
375 ? Qt : Qnil);
378 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
379 doc: /* Return a list of all existing live buffers.
380 If the optional arg FRAME is a frame, we return the buffer list in the
381 proper order for that frame: the buffers show in FRAME come first,
382 followed by the rest of the buffers. */)
383 (Lisp_Object frame)
385 Lisp_Object general;
386 general = Fmapcar (Qcdr, Vbuffer_alist);
388 if (FRAMEP (frame))
390 Lisp_Object framelist, prevlist, tail;
392 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
393 prevlist = Fnreverse (Fcopy_sequence
394 (XFRAME (frame)->buried_buffer_list));
396 /* Remove from GENERAL any buffer that duplicates one in
397 FRAMELIST or PREVLIST. */
398 tail = framelist;
399 while (CONSP (tail))
401 general = Fdelq (XCAR (tail), general);
402 tail = XCDR (tail);
404 tail = prevlist;
405 while (CONSP (tail))
407 general = Fdelq (XCAR (tail), general);
408 tail = XCDR (tail);
411 return CALLN (Fnconc, framelist, general, prevlist);
413 else
414 return general;
417 /* Like Fassoc, but use Fstring_equal to compare
418 (which ignores text properties), and don't ever quit. */
420 static Lisp_Object
421 assoc_ignore_text_properties (Lisp_Object key, Lisp_Object list)
423 Lisp_Object tail;
424 for (tail = list; CONSP (tail); tail = XCDR (tail))
426 Lisp_Object elt = XCAR (tail);
427 if (!NILP (Fstring_equal (Fcar (elt), key)))
428 return elt;
430 return Qnil;
433 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
434 doc: /* Return the buffer named BUFFER-OR-NAME.
435 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
436 is a string and there is no buffer with that name, return nil. If
437 BUFFER-OR-NAME is a buffer, return it as given. */)
438 (register Lisp_Object buffer_or_name)
440 if (BUFFERP (buffer_or_name))
441 return buffer_or_name;
442 CHECK_STRING (buffer_or_name);
444 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
447 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
448 doc: /* Return the buffer visiting file FILENAME (a string).
449 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
450 If there is no such live buffer, return nil.
451 See also `find-buffer-visiting'. */)
452 (register Lisp_Object filename)
454 register Lisp_Object tail, buf, handler;
456 CHECK_STRING (filename);
457 filename = Fexpand_file_name (filename, Qnil);
459 /* If the file name has special constructs in it,
460 call the corresponding file handler. */
461 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
462 if (!NILP (handler))
464 Lisp_Object handled_buf = call2 (handler, Qget_file_buffer,
465 filename);
466 return BUFFERP (handled_buf) ? handled_buf : Qnil;
469 FOR_EACH_LIVE_BUFFER (tail, buf)
471 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
472 if (!NILP (Fstring_equal (BVAR (XBUFFER (buf), filename), filename)))
473 return buf;
475 return Qnil;
478 Lisp_Object
479 get_truename_buffer (register Lisp_Object filename)
481 register Lisp_Object tail, buf;
483 FOR_EACH_LIVE_BUFFER (tail, buf)
485 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
486 if (!NILP (Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename)))
487 return buf;
489 return Qnil;
492 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
493 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
494 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
495 return that buffer. If no such buffer exists, create a new buffer with
496 that name and return it. If BUFFER-OR-NAME starts with a space, the new
497 buffer does not keep undo information.
499 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
500 even if it is dead. The return value is never nil. */)
501 (register Lisp_Object buffer_or_name)
503 register Lisp_Object buffer, name;
504 register struct buffer *b;
506 buffer = Fget_buffer (buffer_or_name);
507 if (!NILP (buffer))
508 return buffer;
510 if (SCHARS (buffer_or_name) == 0)
511 error ("Empty string for buffer name is not allowed");
513 b = allocate_buffer ();
515 /* An ordinary buffer uses its own struct buffer_text. */
516 b->text = &b->own_text;
517 b->base_buffer = NULL;
518 /* No one shares the text with us now. */
519 b->indirections = 0;
520 /* No one shows us now. */
521 b->window_count = 0;
523 BUF_GAP_SIZE (b) = 20;
524 block_input ();
525 /* We allocate extra 1-byte at the tail and keep it always '\0' for
526 anchoring a search. */
527 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
528 unblock_input ();
529 if (! BUF_BEG_ADDR (b))
530 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
532 b->pt = BEG;
533 b->begv = BEG;
534 b->zv = BEG;
535 b->pt_byte = BEG_BYTE;
536 b->begv_byte = BEG_BYTE;
537 b->zv_byte = BEG_BYTE;
539 BUF_GPT (b) = BEG;
540 BUF_GPT_BYTE (b) = BEG_BYTE;
542 BUF_Z (b) = BEG;
543 BUF_Z_BYTE (b) = BEG_BYTE;
544 BUF_MODIFF (b) = 1;
545 BUF_CHARS_MODIFF (b) = 1;
546 BUF_OVERLAY_MODIFF (b) = 1;
547 BUF_SAVE_MODIFF (b) = 1;
548 BUF_COMPACT (b) = 1;
549 set_buffer_intervals (b, NULL);
550 BUF_UNCHANGED_MODIFIED (b) = 1;
551 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
552 BUF_END_UNCHANGED (b) = 0;
553 BUF_BEG_UNCHANGED (b) = 0;
554 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
555 b->text->inhibit_shrinking = false;
556 b->text->redisplay = false;
558 b->newline_cache = 0;
559 b->width_run_cache = 0;
560 b->bidi_paragraph_cache = 0;
561 bset_width_table (b, Qnil);
562 b->prevent_redisplay_optimizations_p = 1;
564 /* An ordinary buffer normally doesn't need markers
565 to handle BEGV and ZV. */
566 bset_pt_marker (b, Qnil);
567 bset_begv_marker (b, Qnil);
568 bset_zv_marker (b, Qnil);
570 name = Fcopy_sequence (buffer_or_name);
571 set_string_intervals (name, NULL);
572 bset_name (b, name);
574 bset_undo_list (b, SREF (name, 0) != ' ' ? Qnil : Qt);
576 reset_buffer (b);
577 reset_buffer_local_variables (b, 1);
579 bset_mark (b, Fmake_marker ());
580 BUF_MARKERS (b) = NULL;
582 /* Put this in the alist of all live buffers. */
583 XSETBUFFER (buffer, b);
584 Vbuffer_alist = nconc2 (Vbuffer_alist, list1 (Fcons (name, buffer)));
585 /* And run buffer-list-update-hook. */
586 if (!NILP (Vrun_hooks))
587 call1 (Vrun_hooks, Qbuffer_list_update_hook);
589 return buffer;
593 /* Return a list of overlays which is a copy of the overlay list
594 LIST, but for buffer B. */
596 static struct Lisp_Overlay *
597 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
599 struct Lisp_Overlay *result = NULL, *tail = NULL;
601 for (; list; list = list->next)
603 Lisp_Object overlay, start, end;
604 struct Lisp_Marker *m;
606 eassert (MARKERP (list->start));
607 m = XMARKER (list->start);
608 start = build_marker (b, m->charpos, m->bytepos);
609 XMARKER (start)->insertion_type = m->insertion_type;
611 eassert (MARKERP (list->end));
612 m = XMARKER (list->end);
613 end = build_marker (b, m->charpos, m->bytepos);
614 XMARKER (end)->insertion_type = m->insertion_type;
616 overlay = build_overlay (start, end, Fcopy_sequence (list->plist));
617 if (tail)
618 tail = tail->next = XOVERLAY (overlay);
619 else
620 result = tail = XOVERLAY (overlay);
623 return result;
626 /* Set an appropriate overlay of B. */
628 static void
629 set_buffer_overlays_before (struct buffer *b, struct Lisp_Overlay *o)
631 b->overlays_before = o;
634 static void
635 set_buffer_overlays_after (struct buffer *b, struct Lisp_Overlay *o)
637 b->overlays_after = o;
640 /* Clone per-buffer values of buffer FROM.
642 Buffer TO gets the same per-buffer values as FROM, with the
643 following exceptions: (1) TO's name is left untouched, (2) markers
644 are copied and made to refer to TO, and (3) overlay lists are
645 copied. */
647 static void
648 clone_per_buffer_values (struct buffer *from, struct buffer *to)
650 int offset;
652 FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
654 Lisp_Object obj;
656 /* Don't touch the `name' which should be unique for every buffer. */
657 if (offset == PER_BUFFER_VAR_OFFSET (name))
658 continue;
660 obj = per_buffer_value (from, offset);
661 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
663 struct Lisp_Marker *m = XMARKER (obj);
665 obj = build_marker (to, m->charpos, m->bytepos);
666 XMARKER (obj)->insertion_type = m->insertion_type;
669 set_per_buffer_value (to, offset, obj);
672 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
674 set_buffer_overlays_before (to, copy_overlays (to, from->overlays_before));
675 set_buffer_overlays_after (to, copy_overlays (to, from->overlays_after));
677 /* Get (a copy of) the alist of Lisp-level local variables of FROM
678 and install that in TO. */
679 bset_local_var_alist (to, buffer_lisp_local_variables (from, 1));
683 /* If buffer B has markers to record PT, BEGV and ZV when it is not
684 current, update these markers. */
686 static void
687 record_buffer_markers (struct buffer *b)
689 if (! NILP (BVAR (b, pt_marker)))
691 Lisp_Object buffer;
693 eassert (!NILP (BVAR (b, begv_marker)));
694 eassert (!NILP (BVAR (b, zv_marker)));
696 XSETBUFFER (buffer, b);
697 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
698 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
699 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
704 /* If buffer B has markers to record PT, BEGV and ZV when it is not
705 current, fetch these values into B->begv etc. */
707 static void
708 fetch_buffer_markers (struct buffer *b)
710 if (! NILP (BVAR (b, pt_marker)))
712 Lisp_Object m;
714 eassert (!NILP (BVAR (b, begv_marker)));
715 eassert (!NILP (BVAR (b, zv_marker)));
717 m = BVAR (b, pt_marker);
718 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
720 m = BVAR (b, begv_marker);
721 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
723 m = BVAR (b, zv_marker);
724 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
729 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
730 2, 3,
731 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
732 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
733 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
734 NAME should be a string which is not the name of an existing buffer.
735 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
736 such as major and minor modes, in the indirect buffer.
737 CLONE nil means the indirect buffer's state is reset to default values. */)
738 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
740 Lisp_Object buf, tem;
741 struct buffer *b;
743 CHECK_STRING (name);
744 buf = Fget_buffer (name);
745 if (!NILP (buf))
746 error ("Buffer name `%s' is in use", SDATA (name));
748 tem = base_buffer;
749 base_buffer = Fget_buffer (base_buffer);
750 if (NILP (base_buffer))
751 error ("No such buffer: `%s'", SDATA (tem));
752 if (!BUFFER_LIVE_P (XBUFFER (base_buffer)))
753 error ("Base buffer has been killed");
755 if (SCHARS (name) == 0)
756 error ("Empty string for buffer name is not allowed");
758 b = allocate_buffer ();
760 /* No double indirection - if base buffer is indirect,
761 new buffer becomes an indirect to base's base. */
762 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
763 ? XBUFFER (base_buffer)->base_buffer
764 : XBUFFER (base_buffer));
766 /* Use the base buffer's text object. */
767 b->text = b->base_buffer->text;
768 /* We have no own text. */
769 b->indirections = -1;
770 /* Notify base buffer that we share the text now. */
771 b->base_buffer->indirections++;
772 /* Always -1 for an indirect buffer. */
773 b->window_count = -1;
775 b->pt = b->base_buffer->pt;
776 b->begv = b->base_buffer->begv;
777 b->zv = b->base_buffer->zv;
778 b->pt_byte = b->base_buffer->pt_byte;
779 b->begv_byte = b->base_buffer->begv_byte;
780 b->zv_byte = b->base_buffer->zv_byte;
782 b->newline_cache = 0;
783 b->width_run_cache = 0;
784 b->bidi_paragraph_cache = 0;
785 bset_width_table (b, Qnil);
787 name = Fcopy_sequence (name);
788 set_string_intervals (name, NULL);
789 bset_name (b, name);
791 /* An indirect buffer shares undo list of its base (Bug#18180). */
792 bset_undo_list (b, BVAR (b->base_buffer, undo_list));
794 reset_buffer (b);
795 reset_buffer_local_variables (b, 1);
797 /* Put this in the alist of all live buffers. */
798 XSETBUFFER (buf, b);
799 Vbuffer_alist = nconc2 (Vbuffer_alist, list1 (Fcons (name, buf)));
801 bset_mark (b, Fmake_marker ());
803 /* The multibyte status belongs to the base buffer. */
804 bset_enable_multibyte_characters
805 (b, BVAR (b->base_buffer, enable_multibyte_characters));
807 /* Make sure the base buffer has markers for its narrowing. */
808 if (NILP (BVAR (b->base_buffer, pt_marker)))
810 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
811 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
813 bset_pt_marker (b->base_buffer,
814 build_marker (b->base_buffer, b->base_buffer->pt,
815 b->base_buffer->pt_byte));
817 bset_begv_marker (b->base_buffer,
818 build_marker (b->base_buffer, b->base_buffer->begv,
819 b->base_buffer->begv_byte));
821 bset_zv_marker (b->base_buffer,
822 build_marker (b->base_buffer, b->base_buffer->zv,
823 b->base_buffer->zv_byte));
825 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
828 if (NILP (clone))
830 /* Give the indirect buffer markers for its narrowing. */
831 bset_pt_marker (b, build_marker (b, b->pt, b->pt_byte));
832 bset_begv_marker (b, build_marker (b, b->begv, b->begv_byte));
833 bset_zv_marker (b, build_marker (b, b->zv, b->zv_byte));
834 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
836 else
838 struct buffer *old_b = current_buffer;
840 clone_per_buffer_values (b->base_buffer, b);
841 bset_filename (b, Qnil);
842 bset_file_truename (b, Qnil);
843 bset_display_count (b, make_number (0));
844 bset_backed_up (b, Qnil);
845 bset_auto_save_file_name (b, Qnil);
846 set_buffer_internal_1 (b);
847 Fset (intern ("buffer-save-without-query"), Qnil);
848 Fset (intern ("buffer-file-number"), Qnil);
849 Fset (intern ("buffer-stale-function"), Qnil);
850 set_buffer_internal_1 (old_b);
853 /* Run buffer-list-update-hook. */
854 if (!NILP (Vrun_hooks))
855 call1 (Vrun_hooks, Qbuffer_list_update_hook);
857 return buf;
860 /* Mark OV as no longer associated with B. */
862 static void
863 drop_overlay (struct buffer *b, struct Lisp_Overlay *ov)
865 eassert (b == XBUFFER (Fmarker_buffer (ov->start)));
866 modify_overlay (b, marker_position (ov->start),
867 marker_position (ov->end));
868 unchain_marker (XMARKER (ov->start));
869 unchain_marker (XMARKER (ov->end));
873 /* Delete all overlays of B and reset its overlay lists. */
875 void
876 delete_all_overlays (struct buffer *b)
878 struct Lisp_Overlay *ov, *next;
880 /* FIXME: Since each drop_overlay will scan BUF_MARKERS to unlink its
881 markers, we have an unneeded O(N^2) behavior here. */
882 for (ov = b->overlays_before; ov; ov = next)
884 drop_overlay (b, ov);
885 next = ov->next;
886 ov->next = NULL;
889 for (ov = b->overlays_after; ov; ov = next)
891 drop_overlay (b, ov);
892 next = ov->next;
893 ov->next = NULL;
896 set_buffer_overlays_before (b, NULL);
897 set_buffer_overlays_after (b, NULL);
900 /* Reinitialize everything about a buffer except its name and contents
901 and local variables.
902 If called on an already-initialized buffer, the list of overlays
903 should be deleted before calling this function, otherwise we end up
904 with overlays that claim to belong to the buffer but the buffer
905 claims it doesn't belong to it. */
907 void
908 reset_buffer (register struct buffer *b)
910 bset_filename (b, Qnil);
911 bset_file_truename (b, Qnil);
912 bset_directory (b, current_buffer ? BVAR (current_buffer, directory) : Qnil);
913 b->modtime = make_timespec (0, UNKNOWN_MODTIME_NSECS);
914 b->modtime_size = -1;
915 XSETFASTINT (BVAR (b, save_length), 0);
916 b->last_window_start = 1;
917 /* It is more conservative to start out "changed" than "unchanged". */
918 b->clip_changed = 0;
919 b->prevent_redisplay_optimizations_p = 1;
920 bset_backed_up (b, Qnil);
921 BUF_AUTOSAVE_MODIFF (b) = 0;
922 b->auto_save_failure_time = 0;
923 bset_auto_save_file_name (b, Qnil);
924 bset_read_only (b, Qnil);
925 set_buffer_overlays_before (b, NULL);
926 set_buffer_overlays_after (b, NULL);
927 b->overlay_center = BEG;
928 bset_mark_active (b, Qnil);
929 bset_point_before_scroll (b, Qnil);
930 bset_file_format (b, Qnil);
931 bset_auto_save_file_format (b, Qt);
932 bset_last_selected_window (b, Qnil);
933 bset_display_count (b, make_number (0));
934 bset_display_time (b, Qnil);
935 bset_enable_multibyte_characters
936 (b, BVAR (&buffer_defaults, enable_multibyte_characters));
937 bset_cursor_type (b, BVAR (&buffer_defaults, cursor_type));
938 bset_extra_line_spacing (b, BVAR (&buffer_defaults, extra_line_spacing));
940 b->display_error_modiff = 0;
943 /* Reset buffer B's local variables info.
944 Don't use this on a buffer that has already been in use;
945 it does not treat permanent locals consistently.
946 Instead, use Fkill_all_local_variables.
948 If PERMANENT_TOO, reset permanent buffer-local variables.
949 If not, preserve those. */
951 static void
952 reset_buffer_local_variables (struct buffer *b, bool permanent_too)
954 int offset, i;
956 /* Reset the major mode to Fundamental, together with all the
957 things that depend on the major mode.
958 default-major-mode is handled at a higher level.
959 We ignore it here. */
960 bset_major_mode (b, Qfundamental_mode);
961 bset_keymap (b, Qnil);
962 bset_mode_name (b, QSFundamental);
963 bset_minor_modes (b, Qnil);
965 /* If the standard case table has been altered and invalidated,
966 fix up its insides first. */
967 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
968 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
969 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
970 Fset_standard_case_table (Vascii_downcase_table);
972 bset_downcase_table (b, Vascii_downcase_table);
973 bset_upcase_table (b, XCHAR_TABLE (Vascii_downcase_table)->extras[0]);
974 bset_case_canon_table (b, XCHAR_TABLE (Vascii_downcase_table)->extras[1]);
975 bset_case_eqv_table (b, XCHAR_TABLE (Vascii_downcase_table)->extras[2]);
976 bset_invisibility_spec (b, Qt);
978 /* Reset all (or most) per-buffer variables to their defaults. */
979 if (permanent_too)
980 bset_local_var_alist (b, Qnil);
981 else
983 Lisp_Object tmp, last = Qnil;
984 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
986 Lisp_Object local_var = XCAR (XCAR (tmp));
987 Lisp_Object prop = Fget (local_var, Qpermanent_local);
989 if (!NILP (prop))
991 /* If permanent-local, keep it. */
992 last = tmp;
993 if (EQ (prop, Qpermanent_local_hook))
995 /* This is a partially permanent hook variable.
996 Preserve only the elements that want to be preserved. */
997 Lisp_Object list, newlist;
998 list = XCDR (XCAR (tmp));
999 if (!CONSP (list))
1000 newlist = list;
1001 else
1002 for (newlist = Qnil; CONSP (list); list = XCDR (list))
1004 Lisp_Object elt = XCAR (list);
1005 /* Preserve element ELT if it's t,
1006 if it is a function with a `permanent-local-hook' property,
1007 or if it's not a symbol. */
1008 if (! SYMBOLP (elt)
1009 || EQ (elt, Qt)
1010 || !NILP (Fget (elt, Qpermanent_local_hook)))
1011 newlist = Fcons (elt, newlist);
1013 newlist = Fnreverse (newlist);
1014 if (XSYMBOL (local_var)->trapped_write == SYMBOL_TRAPPED_WRITE)
1015 notify_variable_watchers (local_var, newlist,
1016 Qmakunbound, Fcurrent_buffer ());
1017 XSETCDR (XCAR (tmp), newlist);
1018 continue; /* Don't do variable write trapping twice. */
1021 /* Delete this local variable. */
1022 else if (NILP (last))
1023 bset_local_var_alist (b, XCDR (tmp));
1024 else
1025 XSETCDR (last, XCDR (tmp));
1027 if (XSYMBOL (local_var)->trapped_write == SYMBOL_TRAPPED_WRITE)
1028 notify_variable_watchers (local_var, Qnil,
1029 Qmakunbound, Fcurrent_buffer ());
1033 for (i = 0; i < last_per_buffer_idx; ++i)
1034 if (permanent_too || buffer_permanent_local_flags[i] == 0)
1035 SET_PER_BUFFER_VALUE_P (b, i, 0);
1037 /* For each slot that has a default value, copy that into the slot. */
1038 FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
1040 int idx = PER_BUFFER_IDX (offset);
1041 if ((idx > 0
1042 && (permanent_too
1043 || buffer_permanent_local_flags[idx] == 0)))
1044 set_per_buffer_value (b, offset, per_buffer_default (offset));
1048 /* We split this away from generate-new-buffer, because rename-buffer
1049 and set-visited-file-name ought to be able to use this to really
1050 rename the buffer properly. */
1052 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
1053 Sgenerate_new_buffer_name, 1, 2, 0,
1054 doc: /* Return a string that is the name of no existing buffer based on NAME.
1055 If there is no live buffer named NAME, then return NAME.
1056 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
1057 \(starting at 2) until an unused name is found, and then return that name.
1058 Optional second argument IGNORE specifies a name that is okay to use (if
1059 it is in the sequence to be tried) even if a buffer with that name exists.
1061 If NAME begins with a space (i.e., a buffer that is not normally
1062 visible to users), then if buffer NAME already exists a random number
1063 is first appended to NAME, to speed up finding a non-existent buffer. */)
1064 (Lisp_Object name, Lisp_Object ignore)
1066 Lisp_Object genbase;
1068 CHECK_STRING (name);
1070 if (!NILP (Fstring_equal (name, ignore)) || NILP (Fget_buffer (name)))
1071 return name;
1073 if (SREF (name, 0) != ' ') /* See bug#1229. */
1074 genbase = name;
1075 else
1077 /* Note fileio.c:make_temp_name does random differently. */
1078 char number[sizeof "-999999"];
1079 int i = XFASTINT (Frandom (make_number (999999)));
1080 AUTO_STRING_WITH_LEN (lnumber, number, sprintf (number, "-%d", i));
1081 genbase = concat2 (name, lnumber);
1082 if (NILP (Fget_buffer (genbase)))
1083 return genbase;
1086 for (ptrdiff_t count = 2; ; count++)
1088 char number[INT_BUFSIZE_BOUND (ptrdiff_t) + sizeof "<>"];
1089 AUTO_STRING_WITH_LEN (lnumber, number,
1090 sprintf (number, "<%"pD"d>", count));
1091 Lisp_Object gentemp = concat2 (genbase, lnumber);
1092 if (!NILP (Fstring_equal (gentemp, ignore))
1093 || NILP (Fget_buffer (gentemp)))
1094 return gentemp;
1099 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
1100 doc: /* Return the name of BUFFER, as a string.
1101 BUFFER defaults to the current buffer.
1102 Return nil if BUFFER has been killed. */)
1103 (register Lisp_Object buffer)
1105 return BVAR (decode_buffer (buffer), name);
1108 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
1109 doc: /* Return name of file BUFFER is visiting, or nil if none.
1110 No argument or nil as argument means use the current buffer. */)
1111 (register Lisp_Object buffer)
1113 return BVAR (decode_buffer (buffer), filename);
1116 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
1117 0, 1, 0,
1118 doc: /* Return the base buffer of indirect buffer BUFFER.
1119 If BUFFER is not indirect, return nil.
1120 BUFFER defaults to the current buffer. */)
1121 (register Lisp_Object buffer)
1123 struct buffer *base = decode_buffer (buffer)->base_buffer;
1124 return base ? (XSETBUFFER (buffer, base), buffer) : Qnil;
1127 DEFUN ("buffer-local-value", Fbuffer_local_value,
1128 Sbuffer_local_value, 2, 2, 0,
1129 doc: /* Return the value of VARIABLE in BUFFER.
1130 If VARIABLE does not have a buffer-local binding in BUFFER, the value
1131 is the default binding of the variable. */)
1132 (register Lisp_Object variable, register Lisp_Object buffer)
1134 register Lisp_Object result = buffer_local_value (variable, buffer);
1136 if (EQ (result, Qunbound))
1137 xsignal1 (Qvoid_variable, variable);
1139 return result;
1143 /* Like Fbuffer_local_value, but return Qunbound if the variable is
1144 locally unbound. */
1146 Lisp_Object
1147 buffer_local_value (Lisp_Object variable, Lisp_Object buffer)
1149 register struct buffer *buf;
1150 register Lisp_Object result;
1151 struct Lisp_Symbol *sym;
1153 CHECK_SYMBOL (variable);
1154 CHECK_BUFFER (buffer);
1155 buf = XBUFFER (buffer);
1156 sym = XSYMBOL (variable);
1158 start:
1159 switch (sym->redirect)
1161 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1162 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
1163 case SYMBOL_LOCALIZED:
1164 { /* Look in local_var_alist. */
1165 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1166 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
1167 result = Fassoc (variable, BVAR (buf, local_var_alist));
1168 if (!NILP (result))
1170 if (blv->fwd)
1171 { /* What binding is loaded right now? */
1172 Lisp_Object current_alist_element = blv->valcell;
1174 /* The value of the currently loaded binding is not
1175 stored in it, but rather in the realvalue slot.
1176 Store that value into the binding it belongs to
1177 in case that is the one we are about to use. */
1179 XSETCDR (current_alist_element,
1180 do_symval_forwarding (blv->fwd));
1182 /* Now get the (perhaps updated) value out of the binding. */
1183 result = XCDR (result);
1185 else
1186 result = Fdefault_value (variable);
1187 break;
1189 case SYMBOL_FORWARDED:
1191 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
1192 if (BUFFER_OBJFWDP (fwd))
1193 result = per_buffer_value (buf, XBUFFER_OBJFWD (fwd)->offset);
1194 else
1195 result = Fdefault_value (variable);
1196 break;
1198 default: emacs_abort ();
1201 return result;
1204 /* Return an alist of the Lisp-level buffer-local bindings of
1205 buffer BUF. That is, don't include the variables maintained
1206 in special slots in the buffer object.
1207 If not CLONE, replace elements of the form (VAR . unbound)
1208 by VAR. */
1210 static Lisp_Object
1211 buffer_lisp_local_variables (struct buffer *buf, bool clone)
1213 Lisp_Object result = Qnil;
1214 Lisp_Object tail;
1215 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1217 Lisp_Object val, elt;
1219 elt = XCAR (tail);
1221 /* Reference each variable in the alist in buf.
1222 If inquiring about the current buffer, this gets the current values,
1223 so store them into the alist so the alist is up to date.
1224 If inquiring about some other buffer, this swaps out any values
1225 for that buffer, making the alist up to date automatically. */
1226 val = find_symbol_value (XCAR (elt));
1227 /* Use the current buffer value only if buf is the current buffer. */
1228 if (buf != current_buffer)
1229 val = XCDR (elt);
1231 result = Fcons (!clone && EQ (val, Qunbound)
1232 ? XCAR (elt)
1233 : Fcons (XCAR (elt), val),
1234 result);
1237 return result;
1240 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1241 Sbuffer_local_variables, 0, 1, 0,
1242 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1243 Most elements look like (SYMBOL . VALUE), describing one variable.
1244 For a symbol that is locally unbound, just the symbol appears in the value.
1245 Note that storing new VALUEs in these elements doesn't change the variables.
1246 No argument or nil as argument means use current buffer as BUFFER. */)
1247 (Lisp_Object buffer)
1249 struct buffer *buf = decode_buffer (buffer);
1250 Lisp_Object result = buffer_lisp_local_variables (buf, 0);
1252 /* Add on all the variables stored in special slots. */
1254 int offset, idx;
1256 FOR_EACH_PER_BUFFER_OBJECT_AT (offset)
1258 idx = PER_BUFFER_IDX (offset);
1259 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1260 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1262 Lisp_Object sym = PER_BUFFER_SYMBOL (offset);
1263 Lisp_Object val = per_buffer_value (buf, offset);
1264 result = Fcons (EQ (val, Qunbound) ? sym : Fcons (sym, val),
1265 result);
1270 return result;
1273 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1274 0, 1, 0,
1275 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1276 No argument or nil as argument means use current buffer as BUFFER. */)
1277 (Lisp_Object buffer)
1279 struct buffer *buf = decode_buffer (buffer);
1280 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1283 DEFUN ("force-mode-line-update", Fforce_mode_line_update,
1284 Sforce_mode_line_update, 0, 1, 0,
1285 doc: /* Force redisplay of the current buffer's mode line and header line.
1286 With optional non-nil ALL, force redisplay of all mode lines and
1287 header lines. This function also forces recomputation of the
1288 menu bar menus and the frame title. */)
1289 (Lisp_Object all)
1291 if (!NILP (all))
1293 update_mode_lines = 10;
1294 /* FIXME: This can't be right. */
1295 current_buffer->prevent_redisplay_optimizations_p = true;
1297 else if (buffer_window_count (current_buffer))
1299 bset_update_mode_line (current_buffer);
1300 current_buffer->prevent_redisplay_optimizations_p = true;
1302 return all;
1305 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1306 1, 1, 0,
1307 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1308 A non-nil FLAG means mark the buffer modified. */)
1309 (Lisp_Object flag)
1311 Frestore_buffer_modified_p (flag);
1313 /* Set update_mode_lines only if buffer is displayed in some window.
1314 Packages like jit-lock or lazy-lock preserve a buffer's modified
1315 state by recording/restoring the state around blocks of code.
1316 Setting update_mode_lines makes redisplay consider all windows
1317 (on all frames). Stealth fontification of buffers not displayed
1318 would incur additional redisplay costs if we'd set
1319 update_modes_lines unconditionally.
1321 Ideally, I think there should be another mechanism for fontifying
1322 buffers without "modifying" buffers, or redisplay should be
1323 smarter about updating the `*' in mode lines. --gerd */
1324 return Fforce_mode_line_update (Qnil);
1327 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1328 Srestore_buffer_modified_p, 1, 1, 0,
1329 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1330 It is not ensured that mode lines will be updated to show the modified
1331 state of the current buffer. Use with care. */)
1332 (Lisp_Object flag)
1334 Lisp_Object fn;
1336 /* If buffer becoming modified, lock the file.
1337 If buffer becoming unmodified, unlock the file. */
1339 struct buffer *b = current_buffer->base_buffer
1340 ? current_buffer->base_buffer
1341 : current_buffer;
1343 fn = BVAR (b, file_truename);
1344 /* Test buffer-file-name so that binding it to nil is effective. */
1345 if (!NILP (fn) && ! NILP (BVAR (b, filename)))
1347 bool already = SAVE_MODIFF < MODIFF;
1348 if (!already && !NILP (flag))
1349 lock_file (fn);
1350 else if (already && NILP (flag))
1351 unlock_file (fn);
1354 /* Here we have a problem. SAVE_MODIFF is used here to encode
1355 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1356 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1357 modify SAVE_MODIFF to affect one, we may affect the other
1358 as well.
1359 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1360 if SAVE_MODIFF<auto_save_modified that means we risk changing
1361 recent-auto-save-p from t to nil.
1362 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1363 we risk changing recent-auto-save-p from nil to t. */
1364 SAVE_MODIFF = (NILP (flag)
1365 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1366 ? MODIFF
1367 /* Let's try to preserve recent-auto-save-p. */
1368 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1369 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1370 we can either decrease SAVE_MODIFF and auto_save_modified
1371 or increase MODIFF. */
1372 : MODIFF++);
1374 return flag;
1377 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1378 0, 1, 0,
1379 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1380 Each buffer has a tick counter which is incremented each time the
1381 text in that buffer is changed. It wraps around occasionally.
1382 No argument or nil as argument means use current buffer as BUFFER. */)
1383 (register Lisp_Object buffer)
1385 return make_number (BUF_MODIFF (decode_buffer (buffer)));
1388 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1389 Sbuffer_chars_modified_tick, 0, 1, 0,
1390 doc: /* Return BUFFER's character-change tick counter.
1391 Each buffer has a character-change tick counter, which is set to the
1392 value of the buffer's tick counter (see `buffer-modified-tick'), each
1393 time text in that buffer is inserted or deleted. By comparing the
1394 values returned by two individual calls of `buffer-chars-modified-tick',
1395 you can tell whether a character change occurred in that buffer in
1396 between these calls. No argument or nil as argument means use current
1397 buffer as BUFFER. */)
1398 (register Lisp_Object buffer)
1400 return make_number (BUF_CHARS_MODIFF (decode_buffer (buffer)));
1403 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1404 "(list (read-string \"Rename buffer (to new name): \" \
1405 nil 'buffer-name-history (buffer-name (current-buffer))) \
1406 current-prefix-arg)",
1407 doc: /* Change current buffer's name to NEWNAME (a string).
1408 If second arg UNIQUE is nil or omitted, it is an error if a
1409 buffer named NEWNAME already exists.
1410 If UNIQUE is non-nil, come up with a new name using
1411 `generate-new-buffer-name'.
1412 Interactively, you can set UNIQUE with a prefix argument.
1413 We return the name we actually gave the buffer.
1414 This does not change the name of the visited file (if any). */)
1415 (register Lisp_Object newname, Lisp_Object unique)
1417 register Lisp_Object tem, buf;
1419 CHECK_STRING (newname);
1421 if (SCHARS (newname) == 0)
1422 error ("Empty string is invalid as a buffer name");
1424 tem = Fget_buffer (newname);
1425 if (!NILP (tem))
1427 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1428 rename the buffer automatically so you can create another
1429 with the original name. It makes UNIQUE equivalent to
1430 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1431 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1432 return BVAR (current_buffer, name);
1433 if (!NILP (unique))
1434 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1435 else
1436 error ("Buffer name `%s' is in use", SDATA (newname));
1439 bset_name (current_buffer, newname);
1441 /* Catch redisplay's attention. Unless we do this, the mode lines for
1442 any windows displaying current_buffer will stay unchanged. */
1443 update_mode_lines = 11;
1445 XSETBUFFER (buf, current_buffer);
1446 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1447 if (NILP (BVAR (current_buffer, filename))
1448 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1449 call0 (intern ("rename-auto-save-file"));
1451 /* Run buffer-list-update-hook. */
1452 if (!NILP (Vrun_hooks))
1453 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1455 /* Refetch since that last call may have done GC. */
1456 return BVAR (current_buffer, name);
1459 /* True if B can be used as 'other-than-BUFFER' buffer. */
1461 static bool
1462 candidate_buffer (Lisp_Object b, Lisp_Object buffer)
1464 return (BUFFERP (b) && !EQ (b, buffer)
1465 && BUFFER_LIVE_P (XBUFFER (b))
1466 && !BUFFER_HIDDEN_P (XBUFFER (b)));
1469 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1470 doc: /* Return most recently selected buffer other than BUFFER.
1471 Buffers not visible in windows are preferred to visible buffers, unless
1472 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1473 BUFFER unless it denotes a live buffer. If the optional third argument
1474 FRAME specifies a live frame, then use that frame's buffer list instead
1475 of the selected frame's buffer list.
1477 The buffer is found by scanning the selected or specified frame's buffer
1478 list first, followed by the list of all buffers. If no other buffer
1479 exists, return the buffer `*scratch*' (creating it if necessary). */)
1480 (Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1482 struct frame *f = decode_live_frame (frame);
1483 Lisp_Object tail = f->buffer_list, pred = f->buffer_predicate;
1484 Lisp_Object buf, notsogood = Qnil;
1486 /* Consider buffers that have been seen in the frame first. */
1487 for (; CONSP (tail); tail = XCDR (tail))
1489 buf = XCAR (tail);
1490 if (candidate_buffer (buf, buffer)
1491 /* If the frame has a buffer_predicate, disregard buffers that
1492 don't fit the predicate. */
1493 && (NILP (pred) || !NILP (call1 (pred, buf))))
1495 if (!NILP (visible_ok)
1496 || NILP (Fget_buffer_window (buf, Qvisible)))
1497 return buf;
1498 else if (NILP (notsogood))
1499 notsogood = buf;
1503 /* Consider alist of all buffers next. */
1504 FOR_EACH_LIVE_BUFFER (tail, buf)
1506 if (candidate_buffer (buf, buffer)
1507 /* If the frame has a buffer_predicate, disregard buffers that
1508 don't fit the predicate. */
1509 && (NILP (pred) || !NILP (call1 (pred, buf))))
1511 if (!NILP (visible_ok)
1512 || NILP (Fget_buffer_window (buf, Qvisible)))
1513 return buf;
1514 else if (NILP (notsogood))
1515 notsogood = buf;
1519 if (!NILP (notsogood))
1520 return notsogood;
1521 else
1523 AUTO_STRING (scratch, "*scratch*");
1524 buf = Fget_buffer (scratch);
1525 if (NILP (buf))
1527 buf = Fget_buffer_create (scratch);
1528 Fset_buffer_major_mode (buf);
1530 return buf;
1534 /* The following function is a safe variant of Fother_buffer: It doesn't
1535 pay attention to any frame-local buffer lists, doesn't care about
1536 visibility of buffers, and doesn't evaluate any frame predicates. */
1538 Lisp_Object
1539 other_buffer_safely (Lisp_Object buffer)
1541 Lisp_Object tail, buf;
1543 FOR_EACH_LIVE_BUFFER (tail, buf)
1544 if (candidate_buffer (buf, buffer))
1545 return buf;
1547 AUTO_STRING (scratch, "*scratch*");
1548 buf = Fget_buffer (scratch);
1549 if (NILP (buf))
1551 buf = Fget_buffer_create (scratch);
1552 Fset_buffer_major_mode (buf);
1555 return buf;
1558 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1559 0, 1, "",
1560 doc: /* Start keeping undo information for buffer BUFFER.
1561 No argument or nil as argument means do this for the current buffer. */)
1562 (register Lisp_Object buffer)
1564 Lisp_Object real_buffer;
1566 if (NILP (buffer))
1567 XSETBUFFER (real_buffer, current_buffer);
1568 else
1570 real_buffer = Fget_buffer (buffer);
1571 if (NILP (real_buffer))
1572 nsberror (buffer);
1575 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1576 bset_undo_list (XBUFFER (real_buffer), Qnil);
1578 return Qnil;
1581 /* Truncate undo list and shrink the gap of BUFFER. */
1583 void
1584 compact_buffer (struct buffer *buffer)
1586 BUFFER_CHECK_INDIRECTION (buffer);
1588 /* Skip dead buffers, indirect buffers and buffers
1589 which aren't changed since last compaction. */
1590 if (BUFFER_LIVE_P (buffer)
1591 && (buffer->base_buffer == NULL)
1592 && (BUF_COMPACT (buffer) != BUF_MODIFF (buffer)))
1594 /* If a buffer's undo list is Qt, that means that undo is
1595 turned off in that buffer. Calling truncate_undo_list on
1596 Qt tends to return NULL, which effectively turns undo back on.
1597 So don't call truncate_undo_list if undo_list is Qt. */
1598 if (!EQ (BVAR(buffer, undo_list), Qt))
1599 truncate_undo_list (buffer);
1601 /* Shrink buffer gaps. */
1602 if (!buffer->text->inhibit_shrinking)
1604 /* If a buffer's gap size is more than 10% of the buffer
1605 size, or larger than GAP_BYTES_DFL bytes, then shrink it
1606 accordingly. Keep a minimum size of GAP_BYTES_MIN bytes. */
1607 ptrdiff_t size = clip_to_bounds (GAP_BYTES_MIN,
1608 BUF_Z_BYTE (buffer) / 10,
1609 GAP_BYTES_DFL);
1610 if (BUF_GAP_SIZE (buffer) > size)
1611 make_gap_1 (buffer, -(BUF_GAP_SIZE (buffer) - size));
1613 BUF_COMPACT (buffer) = BUF_MODIFF (buffer);
1617 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1618 doc: /* Kill the buffer specified by BUFFER-OR-NAME.
1619 The argument may be a buffer or the name of an existing buffer.
1620 Argument nil or omitted means kill the current buffer. Return t if the
1621 buffer is actually killed, nil otherwise.
1623 The functions in `kill-buffer-query-functions' are called with the
1624 buffer to be killed as the current buffer. If any of them returns nil,
1625 the buffer is not killed. The hook `kill-buffer-hook' is run before the
1626 buffer is actually killed. The buffer being killed will be current
1627 while the hook is running. Functions called by any of these hooks are
1628 supposed to not change the current buffer.
1630 Any processes that have this buffer as the `process-buffer' are killed
1631 with SIGHUP. This function calls `replace-buffer-in-windows' for
1632 cleaning up all windows currently displaying the buffer to be killed. */)
1633 (Lisp_Object buffer_or_name)
1635 Lisp_Object buffer;
1636 struct buffer *b;
1637 Lisp_Object tem;
1638 struct Lisp_Marker *m;
1640 if (NILP (buffer_or_name))
1641 buffer = Fcurrent_buffer ();
1642 else
1643 buffer = Fget_buffer (buffer_or_name);
1644 if (NILP (buffer))
1645 nsberror (buffer_or_name);
1647 b = XBUFFER (buffer);
1649 /* Avoid trouble for buffer already dead. */
1650 if (!BUFFER_LIVE_P (b))
1651 return Qnil;
1653 if (thread_check_current_buffer (b))
1654 return Qnil;
1656 /* Run hooks with the buffer to be killed the current buffer. */
1658 ptrdiff_t count = SPECPDL_INDEX ();
1660 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1661 set_buffer_internal (b);
1663 /* First run the query functions; if any query is answered no,
1664 don't kill the buffer. */
1665 tem = CALLN (Frun_hook_with_args_until_failure,
1666 Qkill_buffer_query_functions);
1667 if (NILP (tem))
1668 return unbind_to (count, Qnil);
1670 /* Query if the buffer is still modified. */
1671 if (INTERACTIVE && !NILP (BVAR (b, filename))
1672 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1674 AUTO_STRING (format, "Buffer %s modified; kill anyway? ");
1675 tem = do_yes_or_no_p (CALLN (Fformat, format, BVAR (b, name)));
1676 if (NILP (tem))
1677 return unbind_to (count, Qnil);
1680 /* If the hooks have killed the buffer, exit now. */
1681 if (!BUFFER_LIVE_P (b))
1682 return unbind_to (count, Qt);
1684 /* Then run the hooks. */
1685 run_hook (Qkill_buffer_hook);
1686 unbind_to (count, Qnil);
1689 /* If the hooks have killed the buffer, exit now. */
1690 if (!BUFFER_LIVE_P (b))
1691 return Qt;
1693 /* We have no more questions to ask. Verify that it is valid
1694 to kill the buffer. This must be done after the questions
1695 since anything can happen within do_yes_or_no_p. */
1697 /* Don't kill the minibuffer now current. */
1698 if (EQ (buffer, XWINDOW (minibuf_window)->contents))
1699 return Qnil;
1701 /* When we kill an ordinary buffer which shares its buffer text
1702 with indirect buffer(s), we must kill indirect buffer(s) too.
1703 We do it at this stage so nothing terrible happens if they
1704 ask questions or their hooks get errors. */
1705 if (!b->base_buffer && b->indirections > 0)
1707 struct buffer *other;
1709 FOR_EACH_BUFFER (other)
1710 if (other->base_buffer == b)
1712 Lisp_Object buf;
1713 XSETBUFFER (buf, other);
1714 Fkill_buffer (buf);
1717 /* Exit if we now have killed the base buffer (Bug#11665). */
1718 if (!BUFFER_LIVE_P (b))
1719 return Qt;
1722 /* Run replace_buffer_in_windows before making another buffer current
1723 since set-window-buffer-start-and-point will refuse to make another
1724 buffer current if the selected window does not show the current
1725 buffer (bug#10114). */
1726 replace_buffer_in_windows (buffer);
1728 /* Exit if replacing the buffer in windows has killed our buffer. */
1729 if (!BUFFER_LIVE_P (b))
1730 return Qt;
1732 /* Make this buffer not be current. Exit if it is the sole visible
1733 buffer. */
1734 if (b == current_buffer)
1736 tem = Fother_buffer (buffer, Qnil, Qnil);
1737 Fset_buffer (tem);
1738 if (b == current_buffer)
1739 return Qnil;
1742 /* If the buffer now current is shown in the minibuffer and our buffer
1743 is the sole other buffer give up. */
1744 XSETBUFFER (tem, current_buffer);
1745 if (EQ (tem, XWINDOW (minibuf_window)->contents)
1746 && EQ (buffer, Fother_buffer (buffer, Qnil, Qnil)))
1747 return Qnil;
1749 /* Now there is no question: we can kill the buffer. */
1751 /* Unlock this buffer's file, if it is locked. */
1752 unlock_buffer (b);
1754 kill_buffer_processes (buffer);
1755 kill_buffer_xwidgets (buffer);
1757 /* Killing buffer processes may run sentinels which may have killed
1758 our buffer. */
1759 if (!BUFFER_LIVE_P (b))
1760 return Qt;
1762 /* These may run Lisp code and into infinite loops (if someone
1763 insisted on circular lists) so allow quitting here. */
1764 frames_discard_buffer (buffer);
1766 clear_charpos_cache (b);
1768 tem = Vinhibit_quit;
1769 Vinhibit_quit = Qt;
1770 /* Remove the buffer from the list of all buffers. */
1771 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1772 /* If replace_buffer_in_windows didn't do its job fix that now. */
1773 replace_buffer_in_windows_safely (buffer);
1774 Vinhibit_quit = tem;
1776 /* Delete any auto-save file, if we saved it in this session.
1777 But not if the buffer is modified. */
1778 if (STRINGP (BVAR (b, auto_save_file_name))
1779 && BUF_AUTOSAVE_MODIFF (b) != 0
1780 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1781 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1782 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1784 Lisp_Object delete;
1785 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1786 if (! NILP (delete))
1787 internal_delete_file (BVAR (b, auto_save_file_name));
1790 /* Deleting an auto-save file could have killed our buffer. */
1791 if (!BUFFER_LIVE_P (b))
1792 return Qt;
1794 if (b->base_buffer)
1796 INTERVAL i;
1797 /* Unchain all markers that belong to this indirect buffer.
1798 Don't unchain the markers that belong to the base buffer
1799 or its other indirect buffers. */
1800 struct Lisp_Marker **mp = &BUF_MARKERS (b);
1801 while ((m = *mp))
1803 if (m->buffer == b)
1805 m->buffer = NULL;
1806 *mp = m->next;
1808 else
1809 mp = &m->next;
1811 /* Intervals should be owned by the base buffer (Bug#16502). */
1812 i = buffer_intervals (b);
1813 if (i)
1815 Lisp_Object owner;
1816 XSETBUFFER (owner, b->base_buffer);
1817 set_interval_object (i, owner);
1820 else
1822 /* Unchain all markers of this buffer and its indirect buffers.
1823 and leave them pointing nowhere. */
1824 for (m = BUF_MARKERS (b); m; )
1826 struct Lisp_Marker *next = m->next;
1827 m->buffer = 0;
1828 m->next = NULL;
1829 m = next;
1831 BUF_MARKERS (b) = NULL;
1832 set_buffer_intervals (b, NULL);
1834 /* Perhaps we should explicitly free the interval tree here... */
1836 /* Since we've unlinked the markers, the overlays can't be here any more
1837 either. */
1838 b->overlays_before = NULL;
1839 b->overlays_after = NULL;
1841 /* Reset the local variables, so that this buffer's local values
1842 won't be protected from GC. They would be protected
1843 if they happened to remain cached in their symbols.
1844 This gets rid of them for certain. */
1845 swap_out_buffer_local_variables (b);
1846 reset_buffer_local_variables (b, 1);
1848 bset_name (b, Qnil);
1850 block_input ();
1851 if (b->base_buffer)
1853 /* Notify our base buffer that we don't share the text anymore. */
1854 eassert (b->indirections == -1);
1855 b->base_buffer->indirections--;
1856 eassert (b->base_buffer->indirections >= 0);
1857 /* Make sure that we wasn't confused. */
1858 eassert (b->window_count == -1);
1860 else
1862 /* Make sure that no one shows us. */
1863 eassert (b->window_count == 0);
1864 /* No one shares our buffer text, can free it. */
1865 free_buffer_text (b);
1868 if (b->newline_cache)
1870 free_region_cache (b->newline_cache);
1871 b->newline_cache = 0;
1873 if (b->width_run_cache)
1875 free_region_cache (b->width_run_cache);
1876 b->width_run_cache = 0;
1878 if (b->bidi_paragraph_cache)
1880 free_region_cache (b->bidi_paragraph_cache);
1881 b->bidi_paragraph_cache = 0;
1883 bset_width_table (b, Qnil);
1884 unblock_input ();
1885 bset_undo_list (b, Qnil);
1887 /* Run buffer-list-update-hook. */
1888 if (!NILP (Vrun_hooks))
1889 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1891 return Qt;
1894 /* Move association for BUFFER to the front of buffer (a)lists. Since
1895 we do this each time BUFFER is selected visibly, the more recently
1896 selected buffers are always closer to the front of those lists. This
1897 means that other_buffer is more likely to choose a relevant buffer.
1899 Note that this moves BUFFER to the front of the buffer lists of the
1900 selected frame even if BUFFER is not shown there. If BUFFER is not
1901 shown in the selected frame, consider the present behavior a feature.
1902 `select-window' gets this right since it shows BUFFER in the selected
1903 window when calling us. */
1905 void
1906 record_buffer (Lisp_Object buffer)
1908 Lisp_Object aelt, aelt_cons, tem;
1909 register struct frame *f = XFRAME (selected_frame);
1911 CHECK_BUFFER (buffer);
1913 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1914 Don't allow quitting since this might leave the buffer list in an
1915 inconsistent state. */
1916 tem = Vinhibit_quit;
1917 Vinhibit_quit = Qt;
1918 aelt = Frassq (buffer, Vbuffer_alist);
1919 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1920 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1921 XSETCDR (aelt_cons, Vbuffer_alist);
1922 Vbuffer_alist = aelt_cons;
1923 Vinhibit_quit = tem;
1925 /* Update buffer list of selected frame. */
1926 fset_buffer_list (f, Fcons (buffer, Fdelq (buffer, f->buffer_list)));
1927 fset_buried_buffer_list (f, Fdelq (buffer, f->buried_buffer_list));
1929 /* Run buffer-list-update-hook. */
1930 if (!NILP (Vrun_hooks))
1931 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1935 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1936 buffer is killed. For the selected frame's buffer list this moves
1937 BUFFER to its end even if it was never shown in that frame. If
1938 this happens we have a feature, hence `bury-buffer-internal' should be
1939 called only when BUFFER was shown in the selected frame. */
1941 DEFUN ("bury-buffer-internal", Fbury_buffer_internal, Sbury_buffer_internal,
1942 1, 1, 0,
1943 doc: /* Move BUFFER to the end of the buffer list. */)
1944 (Lisp_Object buffer)
1946 Lisp_Object aelt, aelt_cons, tem;
1947 register struct frame *f = XFRAME (selected_frame);
1949 CHECK_BUFFER (buffer);
1951 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1952 Don't allow quitting since this might leave the buffer list in an
1953 inconsistent state. */
1954 tem = Vinhibit_quit;
1955 Vinhibit_quit = Qt;
1956 aelt = Frassq (buffer, Vbuffer_alist);
1957 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1958 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1959 XSETCDR (aelt_cons, Qnil);
1960 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1961 Vinhibit_quit = tem;
1963 /* Update buffer lists of selected frame. */
1964 fset_buffer_list (f, Fdelq (buffer, f->buffer_list));
1965 fset_buried_buffer_list
1966 (f, Fcons (buffer, Fdelq (buffer, f->buried_buffer_list)));
1968 /* Run buffer-list-update-hook. */
1969 if (!NILP (Vrun_hooks))
1970 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1972 return Qnil;
1975 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1976 doc: /* Set an appropriate major mode for BUFFER.
1977 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1978 according to the default value of `major-mode'.
1979 Use this function before selecting the buffer, since it may need to inspect
1980 the current buffer's major mode. */)
1981 (Lisp_Object buffer)
1983 ptrdiff_t count;
1984 Lisp_Object function;
1986 CHECK_BUFFER (buffer);
1988 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
1989 error ("Attempt to set major mode for a dead buffer");
1991 if (strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1992 function = find_symbol_value (intern ("initial-major-mode"));
1993 else
1995 function = BVAR (&buffer_defaults, major_mode);
1996 if (NILP (function)
1997 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1998 function = BVAR (current_buffer, major_mode);
2001 if (NILP (function)) /* If function is `fundamental-mode', allow it to run
2002 so that `run-mode-hooks' and thus
2003 `hack-local-variables' get run. */
2004 return Qnil;
2006 count = SPECPDL_INDEX ();
2008 /* To select a nonfundamental mode,
2009 select the buffer temporarily and then call the mode function. */
2011 record_unwind_current_buffer ();
2013 Fset_buffer (buffer);
2014 call0 (function);
2016 return unbind_to (count, Qnil);
2019 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
2020 doc: /* Return the current buffer as a Lisp object. */)
2021 (void)
2023 register Lisp_Object buf;
2024 XSETBUFFER (buf, current_buffer);
2025 return buf;
2028 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
2029 This is used by redisplay. */
2031 void
2032 set_buffer_internal_1 (register struct buffer *b)
2034 #ifdef USE_MMAP_FOR_BUFFERS
2035 if (b->text->beg == NULL)
2036 enlarge_buffer_text (b, 0);
2037 #endif /* USE_MMAP_FOR_BUFFERS */
2039 if (current_buffer == b)
2040 return;
2042 set_buffer_internal_2 (b);
2045 /* Like set_buffer_internal_1, but doesn't check whether B is already
2046 the current buffer. Called upon switch of the current thread, see
2047 post_acquire_global_lock. */
2048 void set_buffer_internal_2 (register struct buffer *b)
2050 register struct buffer *old_buf;
2051 register Lisp_Object tail;
2053 BUFFER_CHECK_INDIRECTION (b);
2055 old_buf = current_buffer;
2056 current_buffer = b;
2057 last_known_column_point = -1; /* Invalidate indentation cache. */
2059 if (old_buf)
2061 /* Put the undo list back in the base buffer, so that it appears
2062 that an indirect buffer shares the undo list of its base. */
2063 if (old_buf->base_buffer)
2064 bset_undo_list (old_buf->base_buffer, BVAR (old_buf, undo_list));
2066 /* If the old current buffer has markers to record PT, BEGV and ZV
2067 when it is not current, update them now. */
2068 record_buffer_markers (old_buf);
2071 /* Get the undo list from the base buffer, so that it appears
2072 that an indirect buffer shares the undo list of its base. */
2073 if (b->base_buffer)
2074 bset_undo_list (b, BVAR (b->base_buffer, undo_list));
2076 /* If the new current buffer has markers to record PT, BEGV and ZV
2077 when it is not current, fetch them now. */
2078 fetch_buffer_markers (b);
2080 /* Look down buffer's list of local Lisp variables
2081 to find and update any that forward into C variables. */
2085 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
2087 Lisp_Object var = XCAR (XCAR (tail));
2088 struct Lisp_Symbol *sym = XSYMBOL (var);
2089 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
2090 && SYMBOL_BLV (sym)->fwd)
2091 /* Just reference the variable
2092 to cause it to become set for this buffer. */
2093 Fsymbol_value (var);
2096 /* Do the same with any others that were local to the previous buffer */
2097 while (b != old_buf && (b = old_buf, b));
2100 /* Switch to buffer B temporarily for redisplay purposes.
2101 This avoids certain things that don't need to be done within redisplay. */
2103 void
2104 set_buffer_temp (struct buffer *b)
2106 register struct buffer *old_buf;
2108 if (current_buffer == b)
2109 return;
2111 old_buf = current_buffer;
2112 current_buffer = b;
2114 /* If the old current buffer has markers to record PT, BEGV and ZV
2115 when it is not current, update them now. */
2116 record_buffer_markers (old_buf);
2118 /* If the new current buffer has markers to record PT, BEGV and ZV
2119 when it is not current, fetch them now. */
2120 fetch_buffer_markers (b);
2123 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
2124 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
2125 BUFFER-OR-NAME may be a buffer or the name of an existing buffer.
2126 See also `with-current-buffer' when you want to make a buffer current
2127 temporarily. This function does not display the buffer, so its effect
2128 ends when the current command terminates. Use `switch-to-buffer' or
2129 `pop-to-buffer' to switch buffers permanently.
2130 The return value is the buffer made current. */)
2131 (register Lisp_Object buffer_or_name)
2133 register Lisp_Object buffer;
2134 buffer = Fget_buffer (buffer_or_name);
2135 if (NILP (buffer))
2136 nsberror (buffer_or_name);
2137 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
2138 error ("Selecting deleted buffer");
2139 set_buffer_internal (XBUFFER (buffer));
2140 return buffer;
2143 void
2144 restore_buffer (Lisp_Object buffer_or_name)
2146 Fset_buffer (buffer_or_name);
2149 /* Set the current buffer to BUFFER provided if it is alive. */
2151 void
2152 set_buffer_if_live (Lisp_Object buffer)
2154 if (BUFFER_LIVE_P (XBUFFER (buffer)))
2155 set_buffer_internal (XBUFFER (buffer));
2158 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
2159 Sbarf_if_buffer_read_only, 0, 1, 0,
2160 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only.
2161 If the text under POSITION (which defaults to point) has the
2162 `inhibit-read-only' text property set, the error will not be raised. */)
2163 (Lisp_Object position)
2165 if (NILP (position))
2166 XSETFASTINT (position, PT);
2167 else
2168 CHECK_NUMBER (position);
2170 if (!NILP (BVAR (current_buffer, read_only))
2171 && NILP (Vinhibit_read_only)
2172 && NILP (Fget_text_property (position, Qinhibit_read_only, Qnil)))
2173 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2174 return Qnil;
2177 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2178 doc: /* Delete the entire contents of the current buffer.
2179 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2180 so the buffer is truly empty after this. */)
2181 (void)
2183 Fwiden ();
2185 del_range (BEG, Z);
2187 current_buffer->last_window_start = 1;
2188 /* Prevent warnings, or suspension of auto saving, that would happen
2189 if future size is less than past size. Use of erase-buffer
2190 implies that the future text is not really related to the past text. */
2191 XSETFASTINT (BVAR (current_buffer, save_length), 0);
2192 return Qnil;
2195 void
2196 validate_region (register Lisp_Object *b, register Lisp_Object *e)
2198 CHECK_NUMBER_COERCE_MARKER (*b);
2199 CHECK_NUMBER_COERCE_MARKER (*e);
2201 if (XINT (*b) > XINT (*e))
2203 Lisp_Object tem;
2204 tem = *b; *b = *e; *e = tem;
2207 if (! (BEGV <= XINT (*b) && XINT (*e) <= ZV))
2208 args_out_of_range_3 (Fcurrent_buffer (), *b, *e);
2211 /* Advance BYTE_POS up to a character boundary
2212 and return the adjusted position. */
2214 static ptrdiff_t
2215 advance_to_char_boundary (ptrdiff_t byte_pos)
2217 int c;
2219 if (byte_pos == BEG)
2220 /* Beginning of buffer is always a character boundary. */
2221 return BEG;
2223 c = FETCH_BYTE (byte_pos);
2224 if (! CHAR_HEAD_P (c))
2226 /* We should advance BYTE_POS only when C is a constituent of a
2227 multibyte sequence. */
2228 ptrdiff_t orig_byte_pos = byte_pos;
2232 byte_pos--;
2233 c = FETCH_BYTE (byte_pos);
2235 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2236 INC_POS (byte_pos);
2237 if (byte_pos < orig_byte_pos)
2238 byte_pos = orig_byte_pos;
2239 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2240 surely advance to the correct character boundary. If C is
2241 not, BYTE_POS was unchanged. */
2244 return byte_pos;
2247 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2248 1, 1, 0,
2249 doc: /* Swap the text between current buffer and BUFFER.
2250 Using this function from `save-excursion' might produce surprising
2251 results, see Info node `(elisp)Swapping Text'. */)
2252 (Lisp_Object buffer)
2254 struct buffer *other_buffer;
2255 CHECK_BUFFER (buffer);
2256 other_buffer = XBUFFER (buffer);
2258 if (!BUFFER_LIVE_P (other_buffer))
2259 error ("Cannot swap a dead buffer's text");
2261 /* Actually, it probably works just fine.
2262 * if (other_buffer == current_buffer)
2263 * error ("Cannot swap a buffer's text with itself"); */
2265 /* Actually, this may be workable as well, tho probably only if they're
2266 *both* indirect. */
2267 if (other_buffer->base_buffer
2268 || current_buffer->base_buffer)
2269 error ("Cannot swap indirect buffers's text");
2271 { /* This is probably harder to make work. */
2272 struct buffer *other;
2273 FOR_EACH_BUFFER (other)
2274 if (other->base_buffer == other_buffer
2275 || other->base_buffer == current_buffer)
2276 error ("One of the buffers to swap has indirect buffers");
2279 #define swapfield(field, type) \
2280 do { \
2281 type tmp##field = other_buffer->field; \
2282 other_buffer->field = current_buffer->field; \
2283 current_buffer->field = tmp##field; \
2284 } while (0)
2285 #define swapfield_(field, type) \
2286 do { \
2287 type tmp##field = BVAR (other_buffer, field); \
2288 bset_##field (other_buffer, BVAR (current_buffer, field)); \
2289 bset_##field (current_buffer, tmp##field); \
2290 } while (0)
2292 swapfield (own_text, struct buffer_text);
2293 eassert (current_buffer->text == &current_buffer->own_text);
2294 eassert (other_buffer->text == &other_buffer->own_text);
2295 #ifdef REL_ALLOC
2296 r_alloc_reset_variable ((void **) &current_buffer->own_text.beg,
2297 (void **) &other_buffer->own_text.beg);
2298 r_alloc_reset_variable ((void **) &other_buffer->own_text.beg,
2299 (void **) &current_buffer->own_text.beg);
2300 #endif /* REL_ALLOC */
2302 swapfield (pt, ptrdiff_t);
2303 swapfield (pt_byte, ptrdiff_t);
2304 swapfield (begv, ptrdiff_t);
2305 swapfield (begv_byte, ptrdiff_t);
2306 swapfield (zv, ptrdiff_t);
2307 swapfield (zv_byte, ptrdiff_t);
2308 eassert (!current_buffer->base_buffer);
2309 eassert (!other_buffer->base_buffer);
2310 swapfield (indirections, ptrdiff_t);
2311 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2312 swapfield (newline_cache, struct region_cache *);
2313 swapfield (width_run_cache, struct region_cache *);
2314 swapfield (bidi_paragraph_cache, struct region_cache *);
2315 current_buffer->prevent_redisplay_optimizations_p = 1;
2316 other_buffer->prevent_redisplay_optimizations_p = 1;
2317 swapfield (overlays_before, struct Lisp_Overlay *);
2318 swapfield (overlays_after, struct Lisp_Overlay *);
2319 swapfield (overlay_center, ptrdiff_t);
2320 swapfield_ (undo_list, Lisp_Object);
2321 swapfield_ (mark, Lisp_Object);
2322 swapfield_ (enable_multibyte_characters, Lisp_Object);
2323 swapfield_ (bidi_display_reordering, Lisp_Object);
2324 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2325 /* FIXME: Not sure what we should do with these *_marker fields.
2326 Hopefully they're just nil anyway. */
2327 swapfield_ (pt_marker, Lisp_Object);
2328 swapfield_ (begv_marker, Lisp_Object);
2329 swapfield_ (zv_marker, Lisp_Object);
2330 bset_point_before_scroll (current_buffer, Qnil);
2331 bset_point_before_scroll (other_buffer, Qnil);
2333 current_buffer->text->modiff++; other_buffer->text->modiff++;
2334 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2335 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2336 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2337 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2338 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2339 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2341 struct Lisp_Marker *m;
2342 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2343 if (m->buffer == other_buffer)
2344 m->buffer = current_buffer;
2345 else
2346 /* Since there's no indirect buffer in sight, markers on
2347 BUF_MARKERS(buf) should either be for `buf' or dead. */
2348 eassert (!m->buffer);
2349 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2350 if (m->buffer == current_buffer)
2351 m->buffer = other_buffer;
2352 else
2353 /* Since there's no indirect buffer in sight, markers on
2354 BUF_MARKERS(buf) should either be for `buf' or dead. */
2355 eassert (!m->buffer);
2357 { /* Some of the C code expects that both window markers of a
2358 live window points to that window's buffer. So since we
2359 just swapped the markers between the two buffers, we need
2360 to undo the effect of this swap for window markers. */
2361 Lisp_Object w = selected_window, ws = Qnil;
2362 Lisp_Object buf1, buf2;
2363 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2365 while (NILP (Fmemq (w, ws)))
2367 ws = Fcons (w, ws);
2368 if (MARKERP (XWINDOW (w)->pointm)
2369 && (EQ (XWINDOW (w)->contents, buf1)
2370 || EQ (XWINDOW (w)->contents, buf2)))
2371 Fset_marker (XWINDOW (w)->pointm,
2372 make_number
2373 (BUF_BEGV (XBUFFER (XWINDOW (w)->contents))),
2374 XWINDOW (w)->contents);
2375 /* Blindly copied from pointm part. */
2376 if (MARKERP (XWINDOW (w)->old_pointm)
2377 && (EQ (XWINDOW (w)->contents, buf1)
2378 || EQ (XWINDOW (w)->contents, buf2)))
2379 Fset_marker (XWINDOW (w)->old_pointm,
2380 make_number
2381 (BUF_BEGV (XBUFFER (XWINDOW (w)->contents))),
2382 XWINDOW (w)->contents);
2383 if (MARKERP (XWINDOW (w)->start)
2384 && (EQ (XWINDOW (w)->contents, buf1)
2385 || EQ (XWINDOW (w)->contents, buf2)))
2386 Fset_marker (XWINDOW (w)->start,
2387 make_number
2388 (XBUFFER (XWINDOW (w)->contents)->last_window_start),
2389 XWINDOW (w)->contents);
2390 w = Fnext_window (w, Qt, Qt);
2394 if (current_buffer->text->intervals)
2395 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2396 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2397 if (other_buffer->text->intervals)
2398 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2399 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2401 return Qnil;
2404 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2405 1, 1, 0,
2406 doc: /* Set the multibyte flag of the current buffer to FLAG.
2407 If FLAG is t, this makes the buffer a multibyte buffer.
2408 If FLAG is nil, this makes the buffer a single-byte buffer.
2409 In these cases, the buffer contents remain unchanged as a sequence of
2410 bytes but the contents viewed as characters do change.
2411 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2412 all eight-bit bytes to eight-bit characters.
2413 If the multibyte flag was really changed, undo information of the
2414 current buffer is cleared. */)
2415 (Lisp_Object flag)
2417 struct Lisp_Marker *tail, *markers;
2418 struct buffer *other;
2419 ptrdiff_t begv, zv;
2420 bool narrowed = (BEG != BEGV || Z != ZV);
2421 bool modified_p = !NILP (Fbuffer_modified_p (Qnil));
2422 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2424 if (current_buffer->base_buffer)
2425 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2427 /* Do nothing if nothing actually changes. */
2428 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2429 return flag;
2431 /* Don't record these buffer changes. We will put a special undo entry
2432 instead. */
2433 bset_undo_list (current_buffer, Qt);
2435 /* If the cached position is for this buffer, clear it out. */
2436 clear_charpos_cache (current_buffer);
2438 if (NILP (flag))
2439 begv = BEGV_BYTE, zv = ZV_BYTE;
2440 else
2441 begv = BEGV, zv = ZV;
2443 if (narrowed)
2444 error ("Changing multibyteness in a narrowed buffer");
2446 invalidate_buffer_caches (current_buffer, BEGV, ZV);
2448 if (NILP (flag))
2450 ptrdiff_t pos, stop;
2451 unsigned char *p;
2453 /* Do this first, so it can use CHAR_TO_BYTE
2454 to calculate the old correspondences. */
2455 set_intervals_multibyte (0);
2457 bset_enable_multibyte_characters (current_buffer, Qnil);
2459 Z = Z_BYTE;
2460 BEGV = BEGV_BYTE;
2461 ZV = ZV_BYTE;
2462 GPT = GPT_BYTE;
2463 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2466 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2467 tail->charpos = tail->bytepos;
2469 /* Convert multibyte form of 8-bit characters to unibyte. */
2470 pos = BEG;
2471 stop = GPT;
2472 p = BEG_ADDR;
2473 while (1)
2475 int c, bytes;
2477 if (pos == stop)
2479 if (pos == Z)
2480 break;
2481 p = GAP_END_ADDR;
2482 stop = Z;
2484 if (ASCII_CHAR_P (*p))
2485 p++, pos++;
2486 else if (CHAR_BYTE8_HEAD_P (*p))
2488 c = STRING_CHAR_AND_LENGTH (p, bytes);
2489 /* Delete all bytes for this 8-bit character but the
2490 last one, and change the last one to the character
2491 code. */
2492 bytes--;
2493 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2494 p = GAP_END_ADDR;
2495 *p++ = c;
2496 pos++;
2497 if (begv > pos)
2498 begv -= bytes;
2499 if (zv > pos)
2500 zv -= bytes;
2501 stop = Z;
2503 else
2505 bytes = BYTES_BY_CHAR_HEAD (*p);
2506 p += bytes, pos += bytes;
2509 if (narrowed)
2510 Fnarrow_to_region (make_number (begv), make_number (zv));
2512 else
2514 ptrdiff_t pt = PT;
2515 ptrdiff_t pos, stop;
2516 unsigned char *p, *pend;
2518 /* Be sure not to have a multibyte sequence striding over the GAP.
2519 Ex: We change this: "...abc\302 _GAP_ \241def..."
2520 to: "...abc _GAP_ \302\241def..." */
2522 if (EQ (flag, Qt)
2523 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2524 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2526 unsigned char *q = GPT_ADDR - 1;
2528 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2529 if (LEADING_CODE_P (*q))
2531 ptrdiff_t new_gpt = GPT_BYTE - (GPT_ADDR - q);
2533 move_gap_both (new_gpt, new_gpt);
2537 /* Make the buffer contents valid as multibyte by converting
2538 8-bit characters to multibyte form. */
2539 pos = BEG;
2540 stop = GPT;
2541 p = BEG_ADDR;
2542 pend = GPT_ADDR;
2543 while (1)
2545 int bytes;
2547 if (pos == stop)
2549 if (pos == Z)
2550 break;
2551 p = GAP_END_ADDR;
2552 pend = Z_ADDR;
2553 stop = Z;
2556 if (ASCII_CHAR_P (*p))
2557 p++, pos++;
2558 else if (EQ (flag, Qt)
2559 && ! CHAR_BYTE8_HEAD_P (*p)
2560 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2561 p += bytes, pos += bytes;
2562 else
2564 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2565 int c;
2567 c = BYTE8_TO_CHAR (*p);
2568 bytes = CHAR_STRING (c, tmp);
2569 *p = tmp[0];
2570 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2571 bytes--;
2572 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2573 /* Now the gap is after the just inserted data. */
2574 pos = GPT;
2575 p = GAP_END_ADDR;
2576 if (pos <= begv)
2577 begv += bytes;
2578 if (pos <= zv)
2579 zv += bytes;
2580 if (pos <= pt)
2581 pt += bytes;
2582 pend = Z_ADDR;
2583 stop = Z;
2587 if (pt != PT)
2588 TEMP_SET_PT (pt);
2590 if (narrowed)
2591 Fnarrow_to_region (make_number (begv), make_number (zv));
2593 /* Do this first, so that chars_in_text asks the right question.
2594 set_intervals_multibyte needs it too. */
2595 bset_enable_multibyte_characters (current_buffer, Qt);
2597 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2598 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2600 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2602 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2603 if (BEGV_BYTE > GPT_BYTE)
2604 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2605 else
2606 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2608 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2609 if (ZV_BYTE > GPT_BYTE)
2610 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2611 else
2612 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2615 ptrdiff_t byte = advance_to_char_boundary (PT_BYTE);
2616 ptrdiff_t position;
2618 if (byte > GPT_BYTE)
2619 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2620 else
2621 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2622 TEMP_SET_PT_BOTH (position, byte);
2625 tail = markers = BUF_MARKERS (current_buffer);
2627 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2628 getting confused by the markers that have not yet been updated.
2629 It is also a signal that it should never create a marker. */
2630 BUF_MARKERS (current_buffer) = NULL;
2632 for (; tail; tail = tail->next)
2634 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2635 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2638 /* Make sure no markers were put on the chain
2639 while the chain value was incorrect. */
2640 if (BUF_MARKERS (current_buffer))
2641 emacs_abort ();
2643 BUF_MARKERS (current_buffer) = markers;
2645 /* Do this last, so it can calculate the new correspondences
2646 between chars and bytes. */
2647 set_intervals_multibyte (1);
2650 if (!EQ (old_undo, Qt))
2652 /* Represent all the above changes by a special undo entry. */
2653 bset_undo_list (current_buffer,
2654 Fcons (list3 (Qapply,
2655 intern ("set-buffer-multibyte"),
2656 NILP (flag) ? Qt : Qnil),
2657 old_undo));
2660 current_buffer->prevent_redisplay_optimizations_p = 1;
2662 /* If buffer is shown in a window, let redisplay consider other windows. */
2663 if (buffer_window_count (current_buffer))
2664 windows_or_buffers_changed = 10;
2666 /* Copy this buffer's new multibyte status
2667 into all of its indirect buffers. */
2668 FOR_EACH_BUFFER (other)
2669 if (other->base_buffer == current_buffer && BUFFER_LIVE_P (other))
2671 BVAR (other, enable_multibyte_characters)
2672 = BVAR (current_buffer, enable_multibyte_characters);
2673 other->prevent_redisplay_optimizations_p = 1;
2676 /* Restore the modifiedness of the buffer. */
2677 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2678 Fset_buffer_modified_p (Qnil);
2680 /* Update coding systems of this buffer's process (if any). */
2682 Lisp_Object process;
2684 process = Fget_buffer_process (Fcurrent_buffer ());
2685 if (PROCESSP (process))
2686 setup_process_coding_systems (process);
2689 return flag;
2692 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2693 Skill_all_local_variables, 0, 0, 0,
2694 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2695 Most local variable bindings are eliminated so that the default values
2696 become effective once more. Also, the syntax table is set from
2697 `standard-syntax-table', the local keymap is set to nil,
2698 and the abbrev table from `fundamental-mode-abbrev-table'.
2699 This function also forces redisplay of the mode line.
2701 Every function to select a new major mode starts by
2702 calling this function.
2704 As a special exception, local variables whose names have
2705 a non-nil `permanent-local' property are not eliminated by this function.
2707 The first thing this function does is run
2708 the normal hook `change-major-mode-hook'. */)
2709 (void)
2711 run_hook (Qchange_major_mode_hook);
2713 /* Make sure none of the bindings in local_var_alist
2714 remain swapped in, in their symbols. */
2716 swap_out_buffer_local_variables (current_buffer);
2718 /* Actually eliminate all local bindings of this buffer. */
2720 reset_buffer_local_variables (current_buffer, 0);
2722 /* Force mode-line redisplay. Useful here because all major mode
2723 commands call this function. */
2724 update_mode_lines = 12;
2726 return Qnil;
2729 /* Make sure no local variables remain set up with buffer B
2730 for their current values. */
2732 static void
2733 swap_out_buffer_local_variables (struct buffer *b)
2735 Lisp_Object oalist, alist, buffer;
2737 XSETBUFFER (buffer, b);
2738 oalist = BVAR (b, local_var_alist);
2740 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2742 Lisp_Object sym = XCAR (XCAR (alist));
2743 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2744 /* Need not do anything if some other buffer's binding is
2745 now cached. */
2746 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2748 /* Symbol is set up for this buffer's old local value:
2749 swap it out! */
2750 swap_in_global_binding (XSYMBOL (sym));
2755 /* Find all the overlays in the current buffer that contain position POS.
2756 Return the number found, and store them in a vector in *VEC_PTR.
2757 Store in *LEN_PTR the size allocated for the vector.
2758 Store in *NEXT_PTR the next position after POS where an overlay starts,
2759 or ZV if there are no more overlays between POS and ZV.
2760 Store in *PREV_PTR the previous position before POS where an overlay ends,
2761 or where an overlay starts which ends at or after POS;
2762 or BEGV if there are no such overlays from BEGV to POS.
2763 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2765 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2766 when this function is called.
2768 If EXTEND, make the vector bigger if necessary.
2769 If not, never extend the vector,
2770 and store only as many overlays as will fit.
2771 But still return the total number of overlays.
2773 If CHANGE_REQ, any position written into *PREV_PTR or
2774 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2775 default (BEGV or ZV). */
2777 ptrdiff_t
2778 overlays_at (EMACS_INT pos, bool extend, Lisp_Object **vec_ptr,
2779 ptrdiff_t *len_ptr,
2780 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr, bool change_req)
2782 Lisp_Object overlay, start, end;
2783 struct Lisp_Overlay *tail;
2784 ptrdiff_t idx = 0;
2785 ptrdiff_t len = *len_ptr;
2786 Lisp_Object *vec = *vec_ptr;
2787 ptrdiff_t next = ZV;
2788 ptrdiff_t prev = BEGV;
2789 bool inhibit_storing = 0;
2791 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2793 ptrdiff_t startpos, endpos;
2795 XSETMISC (overlay, tail);
2797 start = OVERLAY_START (overlay);
2798 end = OVERLAY_END (overlay);
2799 endpos = OVERLAY_POSITION (end);
2800 if (endpos < pos)
2802 if (prev < endpos)
2803 prev = endpos;
2804 break;
2806 startpos = OVERLAY_POSITION (start);
2807 /* This one ends at or after POS
2808 so its start counts for PREV_PTR if it's before POS. */
2809 if (prev < startpos && startpos < pos)
2810 prev = startpos;
2811 if (endpos == pos)
2812 continue;
2813 if (startpos <= pos)
2815 if (idx == len)
2817 /* The supplied vector is full.
2818 Either make it bigger, or don't store any more in it. */
2819 if (extend)
2821 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2822 sizeof *vec);
2823 *vec_ptr = vec;
2824 len = *len_ptr;
2826 else
2827 inhibit_storing = 1;
2830 if (!inhibit_storing)
2831 vec[idx] = overlay;
2832 /* Keep counting overlays even if we can't return them all. */
2833 idx++;
2835 else if (startpos < next)
2836 next = startpos;
2839 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2841 ptrdiff_t startpos, endpos;
2843 XSETMISC (overlay, tail);
2845 start = OVERLAY_START (overlay);
2846 end = OVERLAY_END (overlay);
2847 startpos = OVERLAY_POSITION (start);
2848 if (pos < startpos)
2850 if (startpos < next)
2851 next = startpos;
2852 break;
2854 endpos = OVERLAY_POSITION (end);
2855 if (pos < endpos)
2857 if (idx == len)
2859 if (extend)
2861 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2862 sizeof *vec);
2863 *vec_ptr = vec;
2864 len = *len_ptr;
2866 else
2867 inhibit_storing = 1;
2870 if (!inhibit_storing)
2871 vec[idx] = overlay;
2872 idx++;
2874 if (startpos < pos && startpos > prev)
2875 prev = startpos;
2877 else if (endpos < pos && endpos > prev)
2878 prev = endpos;
2879 else if (endpos == pos && startpos > prev
2880 && (!change_req || startpos < pos))
2881 prev = startpos;
2884 if (next_ptr)
2885 *next_ptr = next;
2886 if (prev_ptr)
2887 *prev_ptr = prev;
2888 return idx;
2891 /* Find all the overlays in the current buffer that overlap the range
2892 BEG-END, or are empty at BEG, or are empty at END provided END
2893 denotes the position at the end of the current buffer.
2895 Return the number found, and store them in a vector in *VEC_PTR.
2896 Store in *LEN_PTR the size allocated for the vector.
2897 Store in *NEXT_PTR the next position after POS where an overlay starts,
2898 or ZV if there are no more overlays.
2899 Store in *PREV_PTR the previous position before POS where an overlay ends,
2900 or BEGV if there are no previous overlays.
2901 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2903 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2904 when this function is called.
2906 If EXTEND, make the vector bigger if necessary.
2907 If not, never extend the vector,
2908 and store only as many overlays as will fit.
2909 But still return the total number of overlays. */
2911 static ptrdiff_t
2912 overlays_in (EMACS_INT beg, EMACS_INT end, bool extend,
2913 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2914 ptrdiff_t *next_ptr, ptrdiff_t *prev_ptr)
2916 Lisp_Object overlay, ostart, oend;
2917 struct Lisp_Overlay *tail;
2918 ptrdiff_t idx = 0;
2919 ptrdiff_t len = *len_ptr;
2920 Lisp_Object *vec = *vec_ptr;
2921 ptrdiff_t next = ZV;
2922 ptrdiff_t prev = BEGV;
2923 bool inhibit_storing = 0;
2924 bool end_is_Z = end == Z;
2926 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2928 ptrdiff_t startpos, endpos;
2930 XSETMISC (overlay, tail);
2932 ostart = OVERLAY_START (overlay);
2933 oend = OVERLAY_END (overlay);
2934 endpos = OVERLAY_POSITION (oend);
2935 if (endpos < beg)
2937 if (prev < endpos)
2938 prev = endpos;
2939 break;
2941 startpos = OVERLAY_POSITION (ostart);
2942 /* Count an interval if it overlaps the range, is empty at the
2943 start of the range, or is empty at END provided END denotes the
2944 end of the buffer. */
2945 if ((beg < endpos && startpos < end)
2946 || (startpos == endpos
2947 && (beg == endpos || (end_is_Z && endpos == end))))
2949 if (idx == len)
2951 /* The supplied vector is full.
2952 Either make it bigger, or don't store any more in it. */
2953 if (extend)
2955 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2956 sizeof *vec);
2957 *vec_ptr = vec;
2958 len = *len_ptr;
2960 else
2961 inhibit_storing = 1;
2964 if (!inhibit_storing)
2965 vec[idx] = overlay;
2966 /* Keep counting overlays even if we can't return them all. */
2967 idx++;
2969 else if (startpos < next)
2970 next = startpos;
2973 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2975 ptrdiff_t startpos, endpos;
2977 XSETMISC (overlay, tail);
2979 ostart = OVERLAY_START (overlay);
2980 oend = OVERLAY_END (overlay);
2981 startpos = OVERLAY_POSITION (ostart);
2982 if (end < startpos)
2984 if (startpos < next)
2985 next = startpos;
2986 break;
2988 endpos = OVERLAY_POSITION (oend);
2989 /* Count an interval if it overlaps the range, is empty at the
2990 start of the range, or is empty at END provided END denotes the
2991 end of the buffer. */
2992 if ((beg < endpos && startpos < end)
2993 || (startpos == endpos
2994 && (beg == endpos || (end_is_Z && endpos == end))))
2996 if (idx == len)
2998 if (extend)
3000 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
3001 sizeof *vec);
3002 *vec_ptr = vec;
3003 len = *len_ptr;
3005 else
3006 inhibit_storing = 1;
3009 if (!inhibit_storing)
3010 vec[idx] = overlay;
3011 idx++;
3013 else if (endpos < beg && endpos > prev)
3014 prev = endpos;
3017 if (next_ptr)
3018 *next_ptr = next;
3019 if (prev_ptr)
3020 *prev_ptr = prev;
3021 return idx;
3025 /* Return true if there exists an overlay with a non-nil
3026 `mouse-face' property overlapping OVERLAY. */
3028 bool
3029 mouse_face_overlay_overlaps (Lisp_Object overlay)
3031 ptrdiff_t start = OVERLAY_POSITION (OVERLAY_START (overlay));
3032 ptrdiff_t end = OVERLAY_POSITION (OVERLAY_END (overlay));
3033 ptrdiff_t n, i, size;
3034 Lisp_Object *v, tem;
3035 Lisp_Object vbuf[10];
3036 USE_SAFE_ALLOCA;
3038 size = ARRAYELTS (vbuf);
3039 v = vbuf;
3040 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
3041 if (n > size)
3043 SAFE_NALLOCA (v, 1, n);
3044 overlays_in (start, end, 0, &v, &n, NULL, NULL);
3047 for (i = 0; i < n; ++i)
3048 if (!EQ (v[i], overlay)
3049 && (tem = Foverlay_get (overlay, Qmouse_face),
3050 !NILP (tem)))
3051 break;
3053 SAFE_FREE ();
3054 return i < n;
3059 /* Fast function to just test if we're at an overlay boundary. */
3060 bool
3061 overlay_touches_p (ptrdiff_t pos)
3063 Lisp_Object overlay;
3064 struct Lisp_Overlay *tail;
3066 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
3068 ptrdiff_t endpos;
3070 XSETMISC (overlay ,tail);
3071 eassert (OVERLAYP (overlay));
3073 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3074 if (endpos < pos)
3075 break;
3076 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
3077 return 1;
3080 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
3082 ptrdiff_t startpos;
3084 XSETMISC (overlay, tail);
3085 eassert (OVERLAYP (overlay));
3087 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3088 if (pos < startpos)
3089 break;
3090 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
3091 return 1;
3093 return 0;
3096 struct sortvec
3098 Lisp_Object overlay;
3099 ptrdiff_t beg, end;
3100 EMACS_INT priority;
3101 EMACS_INT spriority; /* Secondary priority. */
3104 static int
3105 compare_overlays (const void *v1, const void *v2)
3107 const struct sortvec *s1 = v1;
3108 const struct sortvec *s2 = v2;
3109 /* Return 1 if s1 should take precedence, -1 if v2 should take precedence,
3110 and 0 if they're equal. */
3111 if (s1->priority != s2->priority)
3112 return s1->priority < s2->priority ? -1 : 1;
3113 /* If the priority is equal, give precedence to the one not covered by the
3114 other. If neither covers the other, obey spriority. */
3115 else if (s1->beg < s2->beg)
3116 return (s1->end < s2->end && s1->spriority > s2->spriority ? 1 : -1);
3117 else if (s1->beg > s2->beg)
3118 return (s1->end > s2->end && s1->spriority < s2->spriority ? -1 : 1);
3119 else if (s1->end != s2->end)
3120 return s2->end < s1->end ? -1 : 1;
3121 else if (s1->spriority != s2->spriority)
3122 return (s1->spriority < s2->spriority ? -1 : 1);
3123 else if (EQ (s1->overlay, s2->overlay))
3124 return 0;
3125 else
3126 /* Avoid the non-determinism of qsort by choosing an arbitrary ordering
3127 between "equal" overlays. The result can still change between
3128 invocations of Emacs, but it won't change in the middle of
3129 `find_field' (bug#6830). */
3130 return XLI (s1->overlay) < XLI (s2->overlay) ? -1 : 1;
3133 /* Sort an array of overlays by priority. The array is modified in place.
3134 The return value is the new size; this may be smaller than the original
3135 size if some of the overlays were invalid or were window-specific. */
3136 ptrdiff_t
3137 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
3139 ptrdiff_t i, j;
3140 USE_SAFE_ALLOCA;
3141 struct sortvec *sortvec;
3143 SAFE_NALLOCA (sortvec, 1, noverlays);
3145 /* Put the valid and relevant overlays into sortvec. */
3147 for (i = 0, j = 0; i < noverlays; i++)
3149 Lisp_Object tem;
3150 Lisp_Object overlay;
3152 overlay = overlay_vec[i];
3153 if (OVERLAYP (overlay)
3154 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
3155 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
3157 /* If we're interested in a specific window, then ignore
3158 overlays that are limited to some other window. */
3159 if (w)
3161 Lisp_Object window;
3163 window = Foverlay_get (overlay, Qwindow);
3164 if (WINDOWP (window) && XWINDOW (window) != w)
3165 continue;
3168 /* This overlay is good and counts: put it into sortvec. */
3169 sortvec[j].overlay = overlay;
3170 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3171 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
3172 tem = Foverlay_get (overlay, Qpriority);
3173 if (NILP (tem))
3175 sortvec[j].priority = 0;
3176 sortvec[j].spriority = 0;
3178 else if (INTEGERP (tem))
3180 sortvec[j].priority = XINT (tem);
3181 sortvec[j].spriority = 0;
3183 else if (CONSP (tem))
3185 Lisp_Object car = XCAR (tem);
3186 Lisp_Object cdr = XCDR (tem);
3187 sortvec[j].priority = INTEGERP (car) ? XINT (car) : 0;
3188 sortvec[j].spriority = INTEGERP (cdr) ? XINT (cdr) : 0;
3190 j++;
3193 noverlays = j;
3195 /* Sort the overlays into the proper order: increasing priority. */
3197 if (noverlays > 1)
3198 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
3200 for (i = 0; i < noverlays; i++)
3201 overlay_vec[i] = sortvec[i].overlay;
3203 SAFE_FREE ();
3204 return (noverlays);
3207 struct sortstr
3209 Lisp_Object string, string2;
3210 ptrdiff_t size;
3211 EMACS_INT priority;
3214 struct sortstrlist
3216 struct sortstr *buf; /* An array that expands as needed; never freed. */
3217 ptrdiff_t size; /* Allocated length of that array. */
3218 ptrdiff_t used; /* How much of the array is currently in use. */
3219 ptrdiff_t bytes; /* Total length of the strings in buf. */
3222 /* Buffers for storing information about the overlays touching a given
3223 position. These could be automatic variables in overlay_strings, but
3224 it's more efficient to hold onto the memory instead of repeatedly
3225 allocating and freeing it. */
3226 static struct sortstrlist overlay_heads, overlay_tails;
3227 static unsigned char *overlay_str_buf;
3229 /* Allocated length of overlay_str_buf. */
3230 static ptrdiff_t overlay_str_len;
3232 /* A comparison function suitable for passing to qsort. */
3233 static int
3234 cmp_for_strings (const void *as1, const void *as2)
3236 struct sortstr const *s1 = as1;
3237 struct sortstr const *s2 = as2;
3238 if (s1->size != s2->size)
3239 return s2->size < s1->size ? -1 : 1;
3240 if (s1->priority != s2->priority)
3241 return s1->priority < s2->priority ? -1 : 1;
3242 return 0;
3245 static void
3246 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
3247 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
3249 ptrdiff_t nbytes;
3251 if (ssl->used == ssl->size)
3252 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
3253 ssl->buf[ssl->used].string = str;
3254 ssl->buf[ssl->used].string2 = str2;
3255 ssl->buf[ssl->used].size = size;
3256 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3257 ssl->used++;
3259 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3260 nbytes = SCHARS (str);
3261 else if (! STRING_MULTIBYTE (str))
3262 nbytes = count_size_as_multibyte (SDATA (str),
3263 SBYTES (str));
3264 else
3265 nbytes = SBYTES (str);
3267 if (INT_ADD_WRAPV (ssl->bytes, nbytes, &nbytes))
3268 memory_full (SIZE_MAX);
3269 ssl->bytes = nbytes;
3271 if (STRINGP (str2))
3273 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3274 nbytes = SCHARS (str2);
3275 else if (! STRING_MULTIBYTE (str2))
3276 nbytes = count_size_as_multibyte (SDATA (str2),
3277 SBYTES (str2));
3278 else
3279 nbytes = SBYTES (str2);
3281 if (INT_ADD_WRAPV (ssl->bytes, nbytes, &nbytes))
3282 memory_full (SIZE_MAX);
3283 ssl->bytes = nbytes;
3287 /* Concatenate the strings associated with overlays that begin or end
3288 at POS, ignoring overlays that are specific to windows other than W.
3289 The strings are concatenated in the appropriate order: shorter
3290 overlays nest inside longer ones, and higher priority inside lower.
3291 Normally all of the after-strings come first, but zero-sized
3292 overlays have their after-strings ride along with the
3293 before-strings because it would look strange to print them
3294 inside-out.
3296 Returns the concatenated string's length, and return the pointer to
3297 that string via PSTR, if that variable is non-NULL. The storage of
3298 the concatenated strings may be overwritten by subsequent calls. */
3300 ptrdiff_t
3301 overlay_strings (ptrdiff_t pos, struct window *w, unsigned char **pstr)
3303 Lisp_Object overlay, window, str;
3304 struct Lisp_Overlay *ov;
3305 ptrdiff_t startpos, endpos;
3306 bool multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3308 overlay_heads.used = overlay_heads.bytes = 0;
3309 overlay_tails.used = overlay_tails.bytes = 0;
3310 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3312 XSETMISC (overlay, ov);
3313 eassert (OVERLAYP (overlay));
3315 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3316 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3317 if (endpos < pos)
3318 break;
3319 if (endpos != pos && startpos != pos)
3320 continue;
3321 window = Foverlay_get (overlay, Qwindow);
3322 if (WINDOWP (window) && XWINDOW (window) != w)
3323 continue;
3324 if (startpos == pos
3325 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3326 record_overlay_string (&overlay_heads, str,
3327 (startpos == endpos
3328 ? Foverlay_get (overlay, Qafter_string)
3329 : Qnil),
3330 Foverlay_get (overlay, Qpriority),
3331 endpos - startpos);
3332 else if (endpos == pos
3333 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3334 record_overlay_string (&overlay_tails, str, Qnil,
3335 Foverlay_get (overlay, Qpriority),
3336 endpos - startpos);
3338 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3340 XSETMISC (overlay, ov);
3341 eassert (OVERLAYP (overlay));
3343 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3344 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3345 if (startpos > pos)
3346 break;
3347 if (endpos != pos && startpos != pos)
3348 continue;
3349 window = Foverlay_get (overlay, Qwindow);
3350 if (WINDOWP (window) && XWINDOW (window) != w)
3351 continue;
3352 if (startpos == pos
3353 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3354 record_overlay_string (&overlay_heads, str,
3355 (startpos == endpos
3356 ? Foverlay_get (overlay, Qafter_string)
3357 : Qnil),
3358 Foverlay_get (overlay, Qpriority),
3359 endpos - startpos);
3360 else if (endpos == pos
3361 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3362 record_overlay_string (&overlay_tails, str, Qnil,
3363 Foverlay_get (overlay, Qpriority),
3364 endpos - startpos);
3366 if (overlay_tails.used > 1)
3367 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3368 cmp_for_strings);
3369 if (overlay_heads.used > 1)
3370 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3371 cmp_for_strings);
3372 if (overlay_heads.bytes || overlay_tails.bytes)
3374 Lisp_Object tem;
3375 ptrdiff_t i;
3376 unsigned char *p;
3377 ptrdiff_t total;
3379 if (INT_ADD_WRAPV (overlay_heads.bytes, overlay_tails.bytes, &total))
3380 memory_full (SIZE_MAX);
3381 if (total > overlay_str_len)
3382 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3383 total - overlay_str_len, -1, 1);
3385 p = overlay_str_buf;
3386 for (i = overlay_tails.used; --i >= 0;)
3388 ptrdiff_t nbytes;
3389 tem = overlay_tails.buf[i].string;
3390 nbytes = copy_text (SDATA (tem), p,
3391 SBYTES (tem),
3392 STRING_MULTIBYTE (tem), multibyte);
3393 p += nbytes;
3395 for (i = 0; i < overlay_heads.used; ++i)
3397 ptrdiff_t nbytes;
3398 tem = overlay_heads.buf[i].string;
3399 nbytes = copy_text (SDATA (tem), p,
3400 SBYTES (tem),
3401 STRING_MULTIBYTE (tem), multibyte);
3402 p += nbytes;
3403 tem = overlay_heads.buf[i].string2;
3404 if (STRINGP (tem))
3406 nbytes = copy_text (SDATA (tem), p,
3407 SBYTES (tem),
3408 STRING_MULTIBYTE (tem), multibyte);
3409 p += nbytes;
3412 if (p != overlay_str_buf + total)
3413 emacs_abort ();
3414 if (pstr)
3415 *pstr = overlay_str_buf;
3416 return total;
3418 return 0;
3421 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3423 void
3424 recenter_overlay_lists (struct buffer *buf, ptrdiff_t pos)
3426 Lisp_Object overlay, beg, end;
3427 struct Lisp_Overlay *prev, *tail, *next;
3429 /* See if anything in overlays_before should move to overlays_after. */
3431 /* We don't strictly need prev in this loop; it should always be nil.
3432 But we use it for symmetry and in case that should cease to be true
3433 with some future change. */
3434 prev = NULL;
3435 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3437 next = tail->next;
3438 XSETMISC (overlay, tail);
3439 eassert (OVERLAYP (overlay));
3441 beg = OVERLAY_START (overlay);
3442 end = OVERLAY_END (overlay);
3444 if (OVERLAY_POSITION (end) > pos)
3446 /* OVERLAY needs to be moved. */
3447 ptrdiff_t where = OVERLAY_POSITION (beg);
3448 struct Lisp_Overlay *other, *other_prev;
3450 /* Splice the cons cell TAIL out of overlays_before. */
3451 if (prev)
3452 prev->next = next;
3453 else
3454 set_buffer_overlays_before (buf, next);
3456 /* Search thru overlays_after for where to put it. */
3457 other_prev = NULL;
3458 for (other = buf->overlays_after; other;
3459 other_prev = other, other = other->next)
3461 Lisp_Object otherbeg, otheroverlay;
3463 XSETMISC (otheroverlay, other);
3464 eassert (OVERLAYP (otheroverlay));
3466 otherbeg = OVERLAY_START (otheroverlay);
3467 if (OVERLAY_POSITION (otherbeg) >= where)
3468 break;
3471 /* Add TAIL to overlays_after before OTHER. */
3472 tail->next = other;
3473 if (other_prev)
3474 other_prev->next = tail;
3475 else
3476 set_buffer_overlays_after (buf, tail);
3477 tail = prev;
3479 else
3480 /* We've reached the things that should stay in overlays_before.
3481 All the rest of overlays_before must end even earlier,
3482 so stop now. */
3483 break;
3486 /* See if anything in overlays_after should be in overlays_before. */
3487 prev = NULL;
3488 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3490 next = tail->next;
3491 XSETMISC (overlay, tail);
3492 eassert (OVERLAYP (overlay));
3494 beg = OVERLAY_START (overlay);
3495 end = OVERLAY_END (overlay);
3497 /* Stop looking, when we know that nothing further
3498 can possibly end before POS. */
3499 if (OVERLAY_POSITION (beg) > pos)
3500 break;
3502 if (OVERLAY_POSITION (end) <= pos)
3504 /* OVERLAY needs to be moved. */
3505 ptrdiff_t where = OVERLAY_POSITION (end);
3506 struct Lisp_Overlay *other, *other_prev;
3508 /* Splice the cons cell TAIL out of overlays_after. */
3509 if (prev)
3510 prev->next = next;
3511 else
3512 set_buffer_overlays_after (buf, next);
3514 /* Search thru overlays_before for where to put it. */
3515 other_prev = NULL;
3516 for (other = buf->overlays_before; other;
3517 other_prev = other, other = other->next)
3519 Lisp_Object otherend, otheroverlay;
3521 XSETMISC (otheroverlay, other);
3522 eassert (OVERLAYP (otheroverlay));
3524 otherend = OVERLAY_END (otheroverlay);
3525 if (OVERLAY_POSITION (otherend) <= where)
3526 break;
3529 /* Add TAIL to overlays_before before OTHER. */
3530 tail->next = other;
3531 if (other_prev)
3532 other_prev->next = tail;
3533 else
3534 set_buffer_overlays_before (buf, tail);
3535 tail = prev;
3539 buf->overlay_center = pos;
3542 void
3543 adjust_overlays_for_insert (ptrdiff_t pos, ptrdiff_t length)
3545 /* After an insertion, the lists are still sorted properly,
3546 but we may need to update the value of the overlay center. */
3547 if (current_buffer->overlay_center >= pos)
3548 current_buffer->overlay_center += length;
3551 void
3552 adjust_overlays_for_delete (ptrdiff_t pos, ptrdiff_t length)
3554 if (current_buffer->overlay_center < pos)
3555 /* The deletion was to our right. No change needed; the before- and
3556 after-lists are still consistent. */
3558 else if (current_buffer->overlay_center - pos > length)
3559 /* The deletion was to our left. We need to adjust the center value
3560 to account for the change in position, but the lists are consistent
3561 given the new value. */
3562 current_buffer->overlay_center -= length;
3563 else
3564 /* We're right in the middle. There might be things on the after-list
3565 that now belong on the before-list. Recentering will move them,
3566 and also update the center point. */
3567 recenter_overlay_lists (current_buffer, pos);
3570 /* Fix up overlays that were garbled as a result of permuting markers
3571 in the range START through END. Any overlay with at least one
3572 endpoint in this range will need to be unlinked from the overlay
3573 list and reinserted in its proper place.
3574 Such an overlay might even have negative size at this point.
3575 If so, we'll make the overlay empty. */
3576 void
3577 fix_start_end_in_overlays (register ptrdiff_t start, register ptrdiff_t end)
3579 Lisp_Object overlay;
3580 struct Lisp_Overlay *before_list;
3581 struct Lisp_Overlay *after_list;
3582 /* These are either nil, indicating that before_list or after_list
3583 should be assigned, or the cons cell the cdr of which should be
3584 assigned. */
3585 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3586 /* 'Parent', likewise, indicates a cons cell or
3587 current_buffer->overlays_before or overlays_after, depending
3588 which loop we're in. */
3589 struct Lisp_Overlay *tail, *parent;
3590 ptrdiff_t startpos, endpos;
3592 /* This algorithm shifts links around instead of consing and GCing.
3593 The loop invariant is that before_list (resp. after_list) is a
3594 well-formed list except that its last element, the CDR of beforep
3595 (resp. afterp) if beforep (afterp) isn't nil or before_list
3596 (after_list) if it is, is still uninitialized. So it's not a bug
3597 that before_list isn't initialized, although it may look
3598 strange. */
3599 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3601 XSETMISC (overlay, tail);
3603 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3604 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3606 /* If the overlay is backwards, make it empty. */
3607 if (endpos < startpos)
3609 startpos = endpos;
3610 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3611 Qnil);
3614 if (endpos < start)
3615 break;
3617 if (endpos < end
3618 || (startpos >= start && startpos < end))
3620 /* Add it to the end of the wrong list. Later on,
3621 recenter_overlay_lists will move it to the right place. */
3622 if (endpos < current_buffer->overlay_center)
3624 if (!afterp)
3625 after_list = tail;
3626 else
3627 afterp->next = tail;
3628 afterp = tail;
3630 else
3632 if (!beforep)
3633 before_list = tail;
3634 else
3635 beforep->next = tail;
3636 beforep = tail;
3638 if (!parent)
3639 set_buffer_overlays_before (current_buffer, tail->next);
3640 else
3641 parent->next = tail->next;
3642 tail = tail->next;
3644 else
3645 parent = tail, tail = parent->next;
3647 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3649 XSETMISC (overlay, tail);
3651 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3652 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3654 /* If the overlay is backwards, make it empty. */
3655 if (endpos < startpos)
3657 startpos = endpos;
3658 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3659 Qnil);
3662 if (startpos >= end)
3663 break;
3665 if (startpos >= start
3666 || (endpos >= start && endpos < end))
3668 if (endpos < current_buffer->overlay_center)
3670 if (!afterp)
3671 after_list = tail;
3672 else
3673 afterp->next = tail;
3674 afterp = tail;
3676 else
3678 if (!beforep)
3679 before_list = tail;
3680 else
3681 beforep->next = tail;
3682 beforep = tail;
3684 if (!parent)
3685 set_buffer_overlays_after (current_buffer, tail->next);
3686 else
3687 parent->next = tail->next;
3688 tail = tail->next;
3690 else
3691 parent = tail, tail = parent->next;
3694 /* Splice the constructed (wrong) lists into the buffer's lists,
3695 and let the recenter function make it sane again. */
3696 if (beforep)
3698 beforep->next = current_buffer->overlays_before;
3699 set_buffer_overlays_before (current_buffer, before_list);
3702 if (afterp)
3704 afterp->next = current_buffer->overlays_after;
3705 set_buffer_overlays_after (current_buffer, after_list);
3707 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3710 /* We have two types of overlay: the one whose ending marker is
3711 after-insertion-marker (this is the usual case) and the one whose
3712 ending marker is before-insertion-marker. When `overlays_before'
3713 contains overlays of the latter type and the former type in this
3714 order and both overlays end at inserting position, inserting a text
3715 increases only the ending marker of the latter type, which results
3716 in incorrect ordering of `overlays_before'.
3718 This function fixes ordering of overlays in the slot
3719 `overlays_before' of the buffer *BP. Before the insertion, `point'
3720 was at PREV, and now is at POS. */
3722 void
3723 fix_overlays_before (struct buffer *bp, ptrdiff_t prev, ptrdiff_t pos)
3725 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3726 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3727 Lisp_Object tem;
3728 ptrdiff_t end;
3730 /* After the insertion, the several overlays may be in incorrect
3731 order. The possibility is that, in the list `overlays_before',
3732 an overlay which ends at POS appears after an overlay which ends
3733 at PREV. Since POS is greater than PREV, we must fix the
3734 ordering of these overlays, by moving overlays ends at POS before
3735 the overlays ends at PREV. */
3737 /* At first, find a place where disordered overlays should be linked
3738 in. It is where an overlay which end before POS exists. (i.e. an
3739 overlay whose ending marker is after-insertion-marker if disorder
3740 exists). */
3741 while (tail
3742 && (XSETMISC (tem, tail),
3743 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3745 parent = tail;
3746 tail = tail->next;
3749 /* If we don't find such an overlay,
3750 or the found one ends before PREV,
3751 or the found one is the last one in the list,
3752 we don't have to fix anything. */
3753 if (!tail || end < prev || !tail->next)
3754 return;
3756 right_pair = parent;
3757 parent = tail;
3758 tail = tail->next;
3760 /* Now, end position of overlays in the list TAIL should be before
3761 or equal to PREV. In the loop, an overlay which ends at POS is
3762 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3763 we found an overlay which ends before PREV, the remaining
3764 overlays are in correct order. */
3765 while (tail)
3767 XSETMISC (tem, tail);
3768 end = OVERLAY_POSITION (OVERLAY_END (tem));
3770 if (end == pos)
3771 { /* This overlay is disordered. */
3772 struct Lisp_Overlay *found = tail;
3774 /* Unlink the found overlay. */
3775 tail = found->next;
3776 parent->next = tail;
3777 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3778 and link it into the right place. */
3779 if (!right_pair)
3781 found->next = bp->overlays_before;
3782 set_buffer_overlays_before (bp, found);
3784 else
3786 found->next = right_pair->next;
3787 right_pair->next = found;
3790 else if (end == prev)
3792 parent = tail;
3793 tail = tail->next;
3795 else /* No more disordered overlay. */
3796 break;
3800 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3801 doc: /* Return t if OBJECT is an overlay. */)
3802 (Lisp_Object object)
3804 return (OVERLAYP (object) ? Qt : Qnil);
3807 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3808 doc: /* Create a new overlay with range BEG to END in BUFFER and return it.
3809 If omitted, BUFFER defaults to the current buffer.
3810 BEG and END may be integers or markers.
3811 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3812 for the front of the overlay advance when text is inserted there
3813 \(which means the text *is not* included in the overlay).
3814 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3815 for the rear of the overlay advance when text is inserted there
3816 \(which means the text *is* included in the overlay). */)
3817 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer,
3818 Lisp_Object front_advance, Lisp_Object rear_advance)
3820 Lisp_Object overlay;
3821 struct buffer *b;
3823 if (NILP (buffer))
3824 XSETBUFFER (buffer, current_buffer);
3825 else
3826 CHECK_BUFFER (buffer);
3828 if (MARKERP (beg) && !EQ (Fmarker_buffer (beg), buffer))
3829 signal_error ("Marker points into wrong buffer", beg);
3830 if (MARKERP (end) && !EQ (Fmarker_buffer (end), buffer))
3831 signal_error ("Marker points into wrong buffer", end);
3833 CHECK_NUMBER_COERCE_MARKER (beg);
3834 CHECK_NUMBER_COERCE_MARKER (end);
3836 if (XINT (beg) > XINT (end))
3838 Lisp_Object temp;
3839 temp = beg; beg = end; end = temp;
3842 b = XBUFFER (buffer);
3844 beg = Fset_marker (Fmake_marker (), beg, buffer);
3845 end = Fset_marker (Fmake_marker (), end, buffer);
3847 if (!NILP (front_advance))
3848 XMARKER (beg)->insertion_type = 1;
3849 if (!NILP (rear_advance))
3850 XMARKER (end)->insertion_type = 1;
3852 overlay = build_overlay (beg, end, Qnil);
3854 /* Put the new overlay on the wrong list. */
3855 end = OVERLAY_END (overlay);
3856 if (OVERLAY_POSITION (end) < b->overlay_center)
3858 eassert (b->overlays_after || (XOVERLAY (overlay)->next == NULL));
3859 XOVERLAY (overlay)->next = b->overlays_after;
3860 set_buffer_overlays_after (b, XOVERLAY (overlay));
3862 else
3864 eassert (b->overlays_before || (XOVERLAY (overlay)->next == NULL));
3865 XOVERLAY (overlay)->next = b->overlays_before;
3866 set_buffer_overlays_before (b, XOVERLAY (overlay));
3868 /* This puts it in the right list, and in the right order. */
3869 recenter_overlay_lists (b, b->overlay_center);
3871 /* We don't need to redisplay the region covered by the overlay, because
3872 the overlay has no properties at the moment. */
3874 return overlay;
3877 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3879 static void
3880 modify_overlay (struct buffer *buf, ptrdiff_t start, ptrdiff_t end)
3882 if (start > end)
3884 ptrdiff_t temp = start;
3885 start = end;
3886 end = temp;
3889 BUF_COMPUTE_UNCHANGED (buf, start, end);
3891 bset_redisplay (buf);
3893 ++BUF_OVERLAY_MODIFF (buf);
3896 /* Remove OVERLAY from LIST. */
3898 static struct Lisp_Overlay *
3899 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3901 register struct Lisp_Overlay *tail, **prev = &list;
3903 for (tail = list; tail; prev = &tail->next, tail = *prev)
3904 if (tail == overlay)
3906 *prev = overlay->next;
3907 overlay->next = NULL;
3908 break;
3910 return list;
3913 /* Remove OVERLAY from both overlay lists of B. */
3915 static void
3916 unchain_both (struct buffer *b, Lisp_Object overlay)
3918 struct Lisp_Overlay *ov = XOVERLAY (overlay);
3920 set_buffer_overlays_before (b, unchain_overlay (b->overlays_before, ov));
3921 set_buffer_overlays_after (b, unchain_overlay (b->overlays_after, ov));
3922 eassert (XOVERLAY (overlay)->next == NULL);
3925 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3926 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3927 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3928 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3929 buffer. */)
3930 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3932 struct buffer *b, *ob = 0;
3933 Lisp_Object obuffer;
3934 ptrdiff_t count = SPECPDL_INDEX ();
3935 ptrdiff_t n_beg, n_end;
3936 ptrdiff_t o_beg UNINIT, o_end UNINIT;
3938 CHECK_OVERLAY (overlay);
3939 if (NILP (buffer))
3940 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3941 if (NILP (buffer))
3942 XSETBUFFER (buffer, current_buffer);
3943 CHECK_BUFFER (buffer);
3945 if (NILP (Fbuffer_live_p (buffer)))
3946 error ("Attempt to move overlay to a dead buffer");
3948 if (MARKERP (beg) && !EQ (Fmarker_buffer (beg), buffer))
3949 signal_error ("Marker points into wrong buffer", beg);
3950 if (MARKERP (end) && !EQ (Fmarker_buffer (end), buffer))
3951 signal_error ("Marker points into wrong buffer", end);
3953 CHECK_NUMBER_COERCE_MARKER (beg);
3954 CHECK_NUMBER_COERCE_MARKER (end);
3956 if (XINT (beg) > XINT (end))
3958 Lisp_Object temp;
3959 temp = beg; beg = end; end = temp;
3962 specbind (Qinhibit_quit, Qt);
3964 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3965 b = XBUFFER (buffer);
3967 if (!NILP (obuffer))
3969 ob = XBUFFER (obuffer);
3971 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3972 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3974 unchain_both (ob, overlay);
3977 /* Set the overlay boundaries, which may clip them. */
3978 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3979 Fset_marker (OVERLAY_END (overlay), end, buffer);
3981 n_beg = marker_position (OVERLAY_START (overlay));
3982 n_end = marker_position (OVERLAY_END (overlay));
3984 /* If the overlay has changed buffers, do a thorough redisplay. */
3985 if (!EQ (buffer, obuffer))
3987 /* Redisplay where the overlay was. */
3988 if (ob)
3989 modify_overlay (ob, o_beg, o_end);
3991 /* Redisplay where the overlay is going to be. */
3992 modify_overlay (b, n_beg, n_end);
3994 else
3995 /* Redisplay the area the overlay has just left, or just enclosed. */
3997 if (o_beg == n_beg)
3998 modify_overlay (b, o_end, n_end);
3999 else if (o_end == n_end)
4000 modify_overlay (b, o_beg, n_beg);
4001 else
4002 modify_overlay (b, min (o_beg, n_beg), max (o_end, n_end));
4005 /* Delete the overlay if it is empty after clipping and has the
4006 evaporate property. */
4007 if (n_beg == n_end && !NILP (Foverlay_get (overlay, Qevaporate)))
4008 return unbind_to (count, Fdelete_overlay (overlay));
4010 /* Put the overlay into the new buffer's overlay lists, first on the
4011 wrong list. */
4012 if (n_end < b->overlay_center)
4014 XOVERLAY (overlay)->next = b->overlays_after;
4015 set_buffer_overlays_after (b, XOVERLAY (overlay));
4017 else
4019 XOVERLAY (overlay)->next = b->overlays_before;
4020 set_buffer_overlays_before (b, XOVERLAY (overlay));
4023 /* This puts it in the right list, and in the right order. */
4024 recenter_overlay_lists (b, b->overlay_center);
4026 return unbind_to (count, overlay);
4029 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
4030 doc: /* Delete the overlay OVERLAY from its buffer. */)
4031 (Lisp_Object overlay)
4033 Lisp_Object buffer;
4034 struct buffer *b;
4035 ptrdiff_t count = SPECPDL_INDEX ();
4037 CHECK_OVERLAY (overlay);
4039 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4040 if (NILP (buffer))
4041 return Qnil;
4043 b = XBUFFER (buffer);
4044 specbind (Qinhibit_quit, Qt);
4046 unchain_both (b, overlay);
4047 drop_overlay (b, XOVERLAY (overlay));
4049 /* When deleting an overlay with before or after strings, turn off
4050 display optimizations for the affected buffer, on the basis that
4051 these strings may contain newlines. This is easier to do than to
4052 check for that situation during redisplay. */
4053 if (!windows_or_buffers_changed
4054 && (!NILP (Foverlay_get (overlay, Qbefore_string))
4055 || !NILP (Foverlay_get (overlay, Qafter_string))))
4056 b->prevent_redisplay_optimizations_p = 1;
4058 return unbind_to (count, Qnil);
4061 DEFUN ("delete-all-overlays", Fdelete_all_overlays, Sdelete_all_overlays, 0, 1, 0,
4062 doc: /* Delete all overlays of BUFFER.
4063 BUFFER omitted or nil means delete all overlays of the current
4064 buffer. */)
4065 (Lisp_Object buffer)
4067 delete_all_overlays (decode_buffer (buffer));
4068 return Qnil;
4071 /* Overlay dissection functions. */
4073 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
4074 doc: /* Return the position at which OVERLAY starts. */)
4075 (Lisp_Object overlay)
4077 CHECK_OVERLAY (overlay);
4079 return (Fmarker_position (OVERLAY_START (overlay)));
4082 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
4083 doc: /* Return the position at which OVERLAY ends. */)
4084 (Lisp_Object overlay)
4086 CHECK_OVERLAY (overlay);
4088 return (Fmarker_position (OVERLAY_END (overlay)));
4091 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
4092 doc: /* Return the buffer OVERLAY belongs to.
4093 Return nil if OVERLAY has been deleted. */)
4094 (Lisp_Object overlay)
4096 CHECK_OVERLAY (overlay);
4098 return Fmarker_buffer (OVERLAY_START (overlay));
4101 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
4102 doc: /* Return a list of the properties on OVERLAY.
4103 This is a copy of OVERLAY's plist; modifying its conses has no effect on
4104 OVERLAY. */)
4105 (Lisp_Object overlay)
4107 CHECK_OVERLAY (overlay);
4109 return Fcopy_sequence (XOVERLAY (overlay)->plist);
4113 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 2, 0,
4114 doc: /* Return a list of the overlays that contain the character at POS.
4115 If SORTED is non-nil, then sort them by decreasing priority. */)
4116 (Lisp_Object pos, Lisp_Object sorted)
4118 ptrdiff_t len, noverlays;
4119 Lisp_Object *overlay_vec;
4120 Lisp_Object result;
4122 CHECK_NUMBER_COERCE_MARKER (pos);
4124 if (!buffer_has_overlays ())
4125 return Qnil;
4127 len = 10;
4128 /* We can't use alloca here because overlays_at can call xrealloc. */
4129 overlay_vec = xmalloc (len * sizeof *overlay_vec);
4131 /* Put all the overlays we want in a vector in overlay_vec.
4132 Store the length in len. */
4133 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4134 NULL, NULL, 0);
4136 if (!NILP (sorted))
4137 noverlays = sort_overlays (overlay_vec, noverlays,
4138 WINDOWP (sorted) ? XWINDOW (sorted) : NULL);
4140 /* Make a list of them all. */
4141 result = Flist (noverlays, overlay_vec);
4143 xfree (overlay_vec);
4144 return result;
4147 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
4148 doc: /* Return a list of the overlays that overlap the region BEG ... END.
4149 Overlap means that at least one character is contained within the overlay
4150 and also contained within the specified region.
4151 Empty overlays are included in the result if they are located at BEG,
4152 between BEG and END, or at END provided END denotes the position at the
4153 end of the buffer. */)
4154 (Lisp_Object beg, Lisp_Object end)
4156 ptrdiff_t len, noverlays;
4157 Lisp_Object *overlay_vec;
4158 Lisp_Object result;
4160 CHECK_NUMBER_COERCE_MARKER (beg);
4161 CHECK_NUMBER_COERCE_MARKER (end);
4163 if (!buffer_has_overlays ())
4164 return Qnil;
4166 len = 10;
4167 overlay_vec = xmalloc (len * sizeof *overlay_vec);
4169 /* Put all the overlays we want in a vector in overlay_vec.
4170 Store the length in len. */
4171 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
4172 NULL, NULL);
4174 /* Make a list of them all. */
4175 result = Flist (noverlays, overlay_vec);
4177 xfree (overlay_vec);
4178 return result;
4181 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
4182 1, 1, 0,
4183 doc: /* Return the next position after POS where an overlay starts or ends.
4184 If there are no overlay boundaries from POS to (point-max),
4185 the value is (point-max). */)
4186 (Lisp_Object pos)
4188 ptrdiff_t i, len, noverlays;
4189 ptrdiff_t endpos;
4190 Lisp_Object *overlay_vec;
4192 CHECK_NUMBER_COERCE_MARKER (pos);
4194 if (!buffer_has_overlays ())
4195 return make_number (ZV);
4197 len = 10;
4198 overlay_vec = xmalloc (len * sizeof *overlay_vec);
4200 /* Put all the overlays we want in a vector in overlay_vec.
4201 Store the length in len.
4202 endpos gets the position where the next overlay starts. */
4203 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4204 &endpos, 0, 1);
4206 /* If any of these overlays ends before endpos,
4207 use its ending point instead. */
4208 for (i = 0; i < noverlays; i++)
4210 Lisp_Object oend;
4211 ptrdiff_t oendpos;
4213 oend = OVERLAY_END (overlay_vec[i]);
4214 oendpos = OVERLAY_POSITION (oend);
4215 if (oendpos < endpos)
4216 endpos = oendpos;
4219 xfree (overlay_vec);
4220 return make_number (endpos);
4223 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
4224 Sprevious_overlay_change, 1, 1, 0,
4225 doc: /* Return the previous position before POS where an overlay starts or ends.
4226 If there are no overlay boundaries from (point-min) to POS,
4227 the value is (point-min). */)
4228 (Lisp_Object pos)
4230 ptrdiff_t prevpos;
4231 Lisp_Object *overlay_vec;
4232 ptrdiff_t len;
4234 CHECK_NUMBER_COERCE_MARKER (pos);
4236 if (!buffer_has_overlays ())
4237 return make_number (BEGV);
4239 /* At beginning of buffer, we know the answer;
4240 avoid bug subtracting 1 below. */
4241 if (XINT (pos) == BEGV)
4242 return pos;
4244 len = 10;
4245 overlay_vec = xmalloc (len * sizeof *overlay_vec);
4247 /* Put all the overlays we want in a vector in overlay_vec.
4248 Store the length in len.
4249 prevpos gets the position of the previous change. */
4250 overlays_at (XINT (pos), 1, &overlay_vec, &len,
4251 0, &prevpos, 1);
4253 xfree (overlay_vec);
4254 return make_number (prevpos);
4257 /* These functions are for debugging overlays. */
4259 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4260 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4261 The car has all the overlays before the overlay center;
4262 the cdr has all the overlays after the overlay center.
4263 Recentering overlays moves overlays between these lists.
4264 The lists you get are copies, so that changing them has no effect.
4265 However, the overlays you get are the real objects that the buffer uses. */)
4266 (void)
4268 struct Lisp_Overlay *ol;
4269 Lisp_Object before = Qnil, after = Qnil, tmp;
4271 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4273 XSETMISC (tmp, ol);
4274 before = Fcons (tmp, before);
4276 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4278 XSETMISC (tmp, ol);
4279 after = Fcons (tmp, after);
4282 return Fcons (Fnreverse (before), Fnreverse (after));
4285 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4286 doc: /* Recenter the overlays of the current buffer around position POS.
4287 That makes overlay lookup faster for positions near POS (but perhaps slower
4288 for positions far away from POS). */)
4289 (Lisp_Object pos)
4291 ptrdiff_t p;
4292 CHECK_NUMBER_COERCE_MARKER (pos);
4294 p = clip_to_bounds (PTRDIFF_MIN, XINT (pos), PTRDIFF_MAX);
4295 recenter_overlay_lists (current_buffer, p);
4296 return Qnil;
4299 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4300 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4301 (Lisp_Object overlay, Lisp_Object prop)
4303 CHECK_OVERLAY (overlay);
4304 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4307 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4308 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4309 VALUE will be returned.*/)
4310 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4312 Lisp_Object tail, buffer;
4313 bool changed;
4315 CHECK_OVERLAY (overlay);
4317 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4319 for (tail = XOVERLAY (overlay)->plist;
4320 CONSP (tail) && CONSP (XCDR (tail));
4321 tail = XCDR (XCDR (tail)))
4322 if (EQ (XCAR (tail), prop))
4324 changed = !EQ (XCAR (XCDR (tail)), value);
4325 XSETCAR (XCDR (tail), value);
4326 goto found;
4328 /* It wasn't in the list, so add it to the front. */
4329 changed = !NILP (value);
4330 set_overlay_plist
4331 (overlay, Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist)));
4332 found:
4333 if (! NILP (buffer))
4335 if (changed)
4336 modify_overlay (XBUFFER (buffer),
4337 marker_position (OVERLAY_START (overlay)),
4338 marker_position (OVERLAY_END (overlay)));
4339 if (EQ (prop, Qevaporate) && ! NILP (value)
4340 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4341 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4342 Fdelete_overlay (overlay);
4345 return value;
4348 /* Subroutine of report_overlay_modification. */
4350 /* Lisp vector holding overlay hook functions to call.
4351 Vector elements come in pairs.
4352 Each even-index element is a list of hook functions.
4353 The following odd-index element is the overlay they came from.
4355 Before the buffer change, we fill in this vector
4356 as we call overlay hook functions.
4357 After the buffer change, we get the functions to call from this vector.
4358 This way we always call the same functions before and after the change. */
4359 static Lisp_Object last_overlay_modification_hooks;
4361 /* Number of elements actually used in last_overlay_modification_hooks. */
4362 static ptrdiff_t last_overlay_modification_hooks_used;
4364 /* Add one functionlist/overlay pair
4365 to the end of last_overlay_modification_hooks. */
4367 static void
4368 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4370 ptrdiff_t oldsize = ASIZE (last_overlay_modification_hooks);
4372 if (oldsize - 1 <= last_overlay_modification_hooks_used)
4373 last_overlay_modification_hooks =
4374 larger_vector (last_overlay_modification_hooks, 2, -1);
4375 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4376 functionlist); last_overlay_modification_hooks_used++;
4377 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4378 overlay); last_overlay_modification_hooks_used++;
4381 /* Run the modification-hooks of overlays that include
4382 any part of the text in START to END.
4383 If this change is an insertion, also
4384 run the insert-before-hooks of overlay starting at END,
4385 and the insert-after-hooks of overlay ending at START.
4387 This is called both before and after the modification.
4388 AFTER is true when we call after the modification.
4390 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4391 When AFTER is nonzero, they are the start position,
4392 the position after the inserted new text,
4393 and the length of deleted or replaced old text. */
4395 void
4396 report_overlay_modification (Lisp_Object start, Lisp_Object end, bool after,
4397 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4399 Lisp_Object prop, overlay;
4400 struct Lisp_Overlay *tail;
4401 /* True if this change is an insertion. */
4402 bool insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4404 overlay = Qnil;
4405 tail = NULL;
4407 /* We used to run the functions as soon as we found them and only register
4408 them in last_overlay_modification_hooks for the purpose of the `after'
4409 case. But running elisp code as we traverse the list of overlays is
4410 painful because the list can be modified by the elisp code so we had to
4411 copy at several places. We now simply do a read-only traversal that
4412 only collects the functions to run and we run them afterwards. It's
4413 simpler, especially since all the code was already there. -stef */
4415 if (!after)
4417 /* We are being called before a change.
4418 Scan the overlays to find the functions to call. */
4419 last_overlay_modification_hooks_used = 0;
4420 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4422 ptrdiff_t startpos, endpos;
4423 Lisp_Object ostart, oend;
4425 XSETMISC (overlay, tail);
4427 ostart = OVERLAY_START (overlay);
4428 oend = OVERLAY_END (overlay);
4429 endpos = OVERLAY_POSITION (oend);
4430 if (XFASTINT (start) > endpos)
4431 break;
4432 startpos = OVERLAY_POSITION (ostart);
4433 if (insertion && (XFASTINT (start) == startpos
4434 || XFASTINT (end) == startpos))
4436 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4437 if (!NILP (prop))
4438 add_overlay_mod_hooklist (prop, overlay);
4440 if (insertion && (XFASTINT (start) == endpos
4441 || XFASTINT (end) == endpos))
4443 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4444 if (!NILP (prop))
4445 add_overlay_mod_hooklist (prop, overlay);
4447 /* Test for intersecting intervals. This does the right thing
4448 for both insertion and deletion. */
4449 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4451 prop = Foverlay_get (overlay, Qmodification_hooks);
4452 if (!NILP (prop))
4453 add_overlay_mod_hooklist (prop, overlay);
4457 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4459 ptrdiff_t startpos, endpos;
4460 Lisp_Object ostart, oend;
4462 XSETMISC (overlay, tail);
4464 ostart = OVERLAY_START (overlay);
4465 oend = OVERLAY_END (overlay);
4466 startpos = OVERLAY_POSITION (ostart);
4467 endpos = OVERLAY_POSITION (oend);
4468 if (XFASTINT (end) < startpos)
4469 break;
4470 if (insertion && (XFASTINT (start) == startpos
4471 || XFASTINT (end) == startpos))
4473 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4474 if (!NILP (prop))
4475 add_overlay_mod_hooklist (prop, overlay);
4477 if (insertion && (XFASTINT (start) == endpos
4478 || XFASTINT (end) == endpos))
4480 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4481 if (!NILP (prop))
4482 add_overlay_mod_hooklist (prop, overlay);
4484 /* Test for intersecting intervals. This does the right thing
4485 for both insertion and deletion. */
4486 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4488 prop = Foverlay_get (overlay, Qmodification_hooks);
4489 if (!NILP (prop))
4490 add_overlay_mod_hooklist (prop, overlay);
4496 /* Call the functions recorded in last_overlay_modification_hooks.
4497 First copy the vector contents, in case some of these hooks
4498 do subsequent modification of the buffer. */
4499 ptrdiff_t size = last_overlay_modification_hooks_used;
4500 Lisp_Object *copy;
4501 ptrdiff_t i;
4503 if (size)
4505 Lisp_Object ovl
4506 = XVECTOR (last_overlay_modification_hooks)->contents[1];
4508 /* If the buffer of the first overlay in the array doesn't
4509 match the current buffer, then these modification hooks
4510 should not be run in this buffer. This could happen when
4511 some code calls some insdel functions, such as del_range_1,
4512 with the PREPARE argument false -- in that case this
4513 function is never called to record the overlay modification
4514 hook functions in the last_overlay_modification_hooks
4515 array, so anything we find there is not ours. */
4516 if (XMARKER (OVERLAY_START (ovl))->buffer != current_buffer)
4517 return;
4520 USE_SAFE_ALLOCA;
4521 SAFE_ALLOCA_LISP (copy, size);
4522 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4523 size * word_size);
4525 for (i = 0; i < size;)
4527 Lisp_Object prop_i, overlay_i;
4528 prop_i = copy[i++];
4529 overlay_i = copy[i++];
4530 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4533 SAFE_FREE ();
4537 static void
4538 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, bool after,
4539 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4541 while (CONSP (list))
4543 if (NILP (arg3))
4544 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4545 else
4546 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4547 list = XCDR (list);
4551 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4552 property is set. */
4553 void
4554 evaporate_overlays (ptrdiff_t pos)
4556 Lisp_Object overlay, hit_list;
4557 struct Lisp_Overlay *tail;
4559 hit_list = Qnil;
4560 if (pos <= current_buffer->overlay_center)
4561 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4563 ptrdiff_t endpos;
4564 XSETMISC (overlay, tail);
4565 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4566 if (endpos < pos)
4567 break;
4568 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4569 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4570 hit_list = Fcons (overlay, hit_list);
4572 else
4573 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4575 ptrdiff_t startpos;
4576 XSETMISC (overlay, tail);
4577 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4578 if (startpos > pos)
4579 break;
4580 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4581 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4582 hit_list = Fcons (overlay, hit_list);
4584 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4585 Fdelete_overlay (XCAR (hit_list));
4588 /***********************************************************************
4589 Allocation with mmap
4590 ***********************************************************************/
4592 /* Note: WINDOWSNT implements this stuff on w32heap.c. */
4593 #if defined USE_MMAP_FOR_BUFFERS && !defined WINDOWSNT
4595 #include <sys/mman.h>
4597 #ifndef MAP_ANON
4598 #ifdef MAP_ANONYMOUS
4599 #define MAP_ANON MAP_ANONYMOUS
4600 #else
4601 #define MAP_ANON 0
4602 #endif
4603 #endif
4605 #ifndef MAP_FAILED
4606 #define MAP_FAILED ((void *) -1)
4607 #endif
4609 #if MAP_ANON == 0
4610 #include <fcntl.h>
4611 #endif
4614 /* Memory is allocated in regions which are mapped using mmap(2).
4615 The current implementation lets the system select mapped
4616 addresses; we're not using MAP_FIXED in general, except when
4617 trying to enlarge regions.
4619 Each mapped region starts with a mmap_region structure, the user
4620 area starts after that structure, aligned to MEM_ALIGN.
4622 +-----------------------+
4623 | struct mmap_info + |
4624 | padding |
4625 +-----------------------+
4626 | user data |
4629 +-----------------------+ */
4631 struct mmap_region
4633 /* User-specified size. */
4634 size_t nbytes_specified;
4636 /* Number of bytes mapped */
4637 size_t nbytes_mapped;
4639 /* Pointer to the location holding the address of the memory
4640 allocated with the mmap'd block. The variable actually points
4641 after this structure. */
4642 void **var;
4644 /* Next and previous in list of all mmap'd regions. */
4645 struct mmap_region *next, *prev;
4648 /* Doubly-linked list of mmap'd regions. */
4650 static struct mmap_region *mmap_regions;
4652 /* File descriptor for mmap. If we don't have anonymous mapping,
4653 /dev/zero will be opened on it. */
4655 static int mmap_fd;
4657 /* Page size on this system. */
4659 static int mmap_page_size;
4661 /* 1 means mmap has been initialized. */
4663 static bool mmap_initialized_p;
4665 /* Value is X rounded up to the next multiple of N. */
4667 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4669 /* Size of mmap_region structure plus padding. */
4671 #define MMAP_REGION_STRUCT_SIZE \
4672 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4674 /* Given a pointer P to the start of the user-visible part of a mapped
4675 region, return a pointer to the start of the region. */
4677 #define MMAP_REGION(P) \
4678 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4680 /* Given a pointer P to the start of a mapped region, return a pointer
4681 to the start of the user-visible part of the region. */
4683 #define MMAP_USER_AREA(P) \
4684 ((void *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4686 #define MEM_ALIGN sizeof (double)
4688 /* Predicate returning true if part of the address range [START .. END]
4689 is currently mapped. Used to prevent overwriting an existing
4690 memory mapping.
4692 Default is to conservatively assume the address range is occupied by
4693 something else. This can be overridden by system configuration
4694 files if system-specific means to determine this exists. */
4696 #ifndef MMAP_ALLOCATED_P
4697 #define MMAP_ALLOCATED_P(start, end) 1
4698 #endif
4700 /* Perform necessary initializations for the use of mmap. */
4702 static void
4703 mmap_init (void)
4705 #if MAP_ANON == 0
4706 /* The value of mmap_fd is initially 0 in temacs, and -1
4707 in a dumped Emacs. */
4708 if (mmap_fd <= 0)
4710 /* No anonymous mmap -- we need the file descriptor. */
4711 mmap_fd = emacs_open ("/dev/zero", O_RDONLY, 0);
4712 if (mmap_fd == -1)
4713 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4715 #endif /* MAP_ANON == 0 */
4717 if (mmap_initialized_p)
4718 return;
4719 mmap_initialized_p = 1;
4721 #if MAP_ANON != 0
4722 mmap_fd = -1;
4723 #endif
4725 mmap_page_size = getpagesize ();
4728 /* Unmap a region. P is a pointer to the start of the user-araa of
4729 the region. */
4731 static void
4732 mmap_free_1 (struct mmap_region *r)
4734 if (r->next)
4735 r->next->prev = r->prev;
4736 if (r->prev)
4737 r->prev->next = r->next;
4738 else
4739 mmap_regions = r->next;
4741 if (munmap (r, r->nbytes_mapped) == -1)
4742 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4746 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4747 Value is true if successful. */
4749 static bool
4750 mmap_enlarge (struct mmap_region *r, int npages)
4752 char *region_end = (char *) r + r->nbytes_mapped;
4753 size_t nbytes;
4754 bool success = 0;
4756 if (npages < 0)
4758 /* Unmap pages at the end of the region. */
4759 nbytes = - npages * mmap_page_size;
4760 if (munmap (region_end - nbytes, nbytes) == -1)
4761 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4762 else
4764 r->nbytes_mapped -= nbytes;
4765 success = 1;
4768 else if (npages > 0)
4770 nbytes = npages * mmap_page_size;
4772 /* Try to map additional pages at the end of the region. We
4773 cannot do this if the address range is already occupied by
4774 something else because mmap deletes any previous mapping.
4775 I'm not sure this is worth doing, let's see. */
4776 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4778 void *p;
4780 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4781 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4782 if (p == MAP_FAILED)
4783 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4784 else if (p != region_end)
4786 /* Kernels are free to choose a different address. In
4787 that case, unmap what we've mapped above; we have
4788 no use for it. */
4789 if (munmap (p, nbytes) == -1)
4790 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4792 else
4794 r->nbytes_mapped += nbytes;
4795 success = 1;
4800 return success;
4804 /* Allocate a block of storage large enough to hold NBYTES bytes of
4805 data. A pointer to the data is returned in *VAR. VAR is thus the
4806 address of some variable which will use the data area.
4808 The allocation of 0 bytes is valid.
4810 If we can't allocate the necessary memory, set *VAR to null, and
4811 return null. */
4813 static void *
4814 mmap_alloc (void **var, size_t nbytes)
4816 void *p;
4817 size_t map;
4819 mmap_init ();
4821 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4822 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4823 mmap_fd, 0);
4825 if (p == MAP_FAILED)
4827 if (errno != ENOMEM)
4828 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4829 p = NULL;
4831 else
4833 struct mmap_region *r = p;
4835 r->nbytes_specified = nbytes;
4836 r->nbytes_mapped = map;
4837 r->var = var;
4838 r->prev = NULL;
4839 r->next = mmap_regions;
4840 if (r->next)
4841 r->next->prev = r;
4842 mmap_regions = r;
4844 p = MMAP_USER_AREA (p);
4847 return *var = p;
4851 /* Free a block of relocatable storage whose data is pointed to by
4852 PTR. Store 0 in *PTR to show there's no block allocated. */
4854 static void
4855 mmap_free (void **var)
4857 mmap_init ();
4859 if (*var)
4861 mmap_free_1 (MMAP_REGION (*var));
4862 *var = NULL;
4867 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4868 resize it to size NBYTES. Change *VAR to reflect the new block,
4869 and return this value. If more memory cannot be allocated, then
4870 leave *VAR unchanged, and return null. */
4872 static void *
4873 mmap_realloc (void **var, size_t nbytes)
4875 void *result;
4877 mmap_init ();
4879 if (*var == NULL)
4880 result = mmap_alloc (var, nbytes);
4881 else if (nbytes == 0)
4883 mmap_free (var);
4884 result = mmap_alloc (var, nbytes);
4886 else
4888 struct mmap_region *r = MMAP_REGION (*var);
4889 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4891 if (room < nbytes)
4893 /* Must enlarge. */
4894 void *old_ptr = *var;
4896 /* Try to map additional pages at the end of the region.
4897 If that fails, allocate a new region, copy data
4898 from the old region, then free it. */
4899 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4900 / mmap_page_size)))
4902 r->nbytes_specified = nbytes;
4903 *var = result = old_ptr;
4905 else if (mmap_alloc (var, nbytes))
4907 memcpy (*var, old_ptr, r->nbytes_specified);
4908 mmap_free_1 (MMAP_REGION (old_ptr));
4909 result = *var;
4910 r = MMAP_REGION (result);
4911 r->nbytes_specified = nbytes;
4913 else
4915 *var = old_ptr;
4916 result = NULL;
4919 else if (room - nbytes >= mmap_page_size)
4921 /* Shrinking by at least a page. Let's give some
4922 memory back to the system.
4924 The extra parens are to make the division happens first,
4925 on positive values, so we know it will round towards
4926 zero. */
4927 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4928 result = *var;
4929 r->nbytes_specified = nbytes;
4931 else
4933 /* Leave it alone. */
4934 result = *var;
4935 r->nbytes_specified = nbytes;
4939 return result;
4943 #endif /* USE_MMAP_FOR_BUFFERS */
4947 /***********************************************************************
4948 Buffer-text Allocation
4949 ***********************************************************************/
4951 /* Allocate NBYTES bytes for buffer B's text buffer. */
4953 static void
4954 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4956 void *p;
4958 block_input ();
4959 #if defined USE_MMAP_FOR_BUFFERS
4960 p = mmap_alloc ((void **) &b->text->beg, nbytes);
4961 #elif defined REL_ALLOC
4962 p = r_alloc ((void **) &b->text->beg, nbytes);
4963 #else
4964 p = xmalloc (nbytes);
4965 #endif
4967 if (p == NULL)
4969 unblock_input ();
4970 memory_full (nbytes);
4973 b->text->beg = p;
4974 unblock_input ();
4977 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4978 shrink it. */
4980 void
4981 enlarge_buffer_text (struct buffer *b, ptrdiff_t delta)
4983 void *p;
4984 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4985 + delta);
4986 block_input ();
4987 #if defined USE_MMAP_FOR_BUFFERS
4988 p = mmap_realloc ((void **) &b->text->beg, nbytes);
4989 #elif defined REL_ALLOC
4990 p = r_re_alloc ((void **) &b->text->beg, nbytes);
4991 #else
4992 p = xrealloc (b->text->beg, nbytes);
4993 #endif
4995 if (p == NULL)
4997 unblock_input ();
4998 memory_full (nbytes);
5001 BUF_BEG_ADDR (b) = p;
5002 unblock_input ();
5006 /* Free buffer B's text buffer. */
5008 static void
5009 free_buffer_text (struct buffer *b)
5011 block_input ();
5013 #if defined USE_MMAP_FOR_BUFFERS
5014 mmap_free ((void **) &b->text->beg);
5015 #elif defined REL_ALLOC
5016 r_alloc_free ((void **) &b->text->beg);
5017 #else
5018 xfree (b->text->beg);
5019 #endif
5021 BUF_BEG_ADDR (b) = NULL;
5022 unblock_input ();
5027 /***********************************************************************
5028 Initialization
5029 ***********************************************************************/
5031 void
5032 init_buffer_once (void)
5034 int idx;
5036 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
5038 /* 0 means not a lisp var, -1 means always local, else mask. */
5039 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
5040 bset_filename (&buffer_local_flags, make_number (-1));
5041 bset_directory (&buffer_local_flags, make_number (-1));
5042 bset_backed_up (&buffer_local_flags, make_number (-1));
5043 bset_save_length (&buffer_local_flags, make_number (-1));
5044 bset_auto_save_file_name (&buffer_local_flags, make_number (-1));
5045 bset_read_only (&buffer_local_flags, make_number (-1));
5046 bset_major_mode (&buffer_local_flags, make_number (-1));
5047 bset_mode_name (&buffer_local_flags, make_number (-1));
5048 bset_undo_list (&buffer_local_flags, make_number (-1));
5049 bset_mark_active (&buffer_local_flags, make_number (-1));
5050 bset_point_before_scroll (&buffer_local_flags, make_number (-1));
5051 bset_file_truename (&buffer_local_flags, make_number (-1));
5052 bset_invisibility_spec (&buffer_local_flags, make_number (-1));
5053 bset_file_format (&buffer_local_flags, make_number (-1));
5054 bset_auto_save_file_format (&buffer_local_flags, make_number (-1));
5055 bset_display_count (&buffer_local_flags, make_number (-1));
5056 bset_display_time (&buffer_local_flags, make_number (-1));
5057 bset_enable_multibyte_characters (&buffer_local_flags, make_number (-1));
5059 /* These used to be stuck at 0 by default, but now that the all-zero value
5060 means Qnil, we have to initialize them explicitly. */
5061 bset_name (&buffer_local_flags, make_number (0));
5062 bset_mark (&buffer_local_flags, make_number (0));
5063 bset_local_var_alist (&buffer_local_flags, make_number (0));
5064 bset_keymap (&buffer_local_flags, make_number (0));
5065 bset_downcase_table (&buffer_local_flags, make_number (0));
5066 bset_upcase_table (&buffer_local_flags, make_number (0));
5067 bset_case_canon_table (&buffer_local_flags, make_number (0));
5068 bset_case_eqv_table (&buffer_local_flags, make_number (0));
5069 bset_minor_modes (&buffer_local_flags, make_number (0));
5070 bset_width_table (&buffer_local_flags, make_number (0));
5071 bset_pt_marker (&buffer_local_flags, make_number (0));
5072 bset_begv_marker (&buffer_local_flags, make_number (0));
5073 bset_zv_marker (&buffer_local_flags, make_number (0));
5074 bset_last_selected_window (&buffer_local_flags, make_number (0));
5076 idx = 1;
5077 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
5078 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
5079 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
5080 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
5081 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
5082 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
5083 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
5084 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
5085 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
5086 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
5087 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
5088 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5089 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5090 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5091 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
5092 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5093 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_scans), idx); ++idx;
5094 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5095 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5096 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5097 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5098 /* Make this one a permanent local. */
5099 buffer_permanent_local_flags[idx++] = 1;
5100 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5101 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5102 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5103 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5104 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5105 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5106 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_height), idx); ++idx;
5107 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5108 XSETFASTINT (BVAR (&buffer_local_flags, horizontal_scroll_bar_type), idx); ++idx;
5109 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5110 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5111 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5112 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5113 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5114 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5115 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5116 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5117 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5118 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5120 /* Need more room? */
5121 if (idx >= MAX_PER_BUFFER_VARS)
5122 emacs_abort ();
5123 last_per_buffer_idx = idx;
5125 /* Make sure all markable slots in buffer_defaults
5126 are initialized reasonably, so mark_buffer won't choke. */
5127 reset_buffer (&buffer_defaults);
5128 eassert (NILP (BVAR (&buffer_defaults, name)));
5129 reset_buffer_local_variables (&buffer_defaults, 1);
5130 eassert (NILP (BVAR (&buffer_local_symbols, name)));
5131 reset_buffer (&buffer_local_symbols);
5132 reset_buffer_local_variables (&buffer_local_symbols, 1);
5133 /* Prevent GC from getting confused. */
5134 buffer_defaults.text = &buffer_defaults.own_text;
5135 buffer_local_symbols.text = &buffer_local_symbols.own_text;
5136 /* No one will share the text with these buffers, but let's play it safe. */
5137 buffer_defaults.indirections = 0;
5138 buffer_local_symbols.indirections = 0;
5139 /* Likewise no one will display them. */
5140 buffer_defaults.window_count = 0;
5141 buffer_local_symbols.window_count = 0;
5142 set_buffer_intervals (&buffer_defaults, NULL);
5143 set_buffer_intervals (&buffer_local_symbols, NULL);
5144 /* This is not strictly necessary, but let's make them initialized. */
5145 bset_name (&buffer_defaults, build_pure_c_string (" *buffer-defaults*"));
5146 bset_name (&buffer_local_symbols, build_pure_c_string (" *buffer-local-symbols*"));
5147 BUFFER_PVEC_INIT (&buffer_defaults);
5148 BUFFER_PVEC_INIT (&buffer_local_symbols);
5150 /* Set up the default values of various buffer slots. */
5151 /* Must do these before making the first buffer! */
5153 /* real setup is done in bindings.el */
5154 bset_mode_line_format (&buffer_defaults, build_pure_c_string ("%-"));
5155 bset_header_line_format (&buffer_defaults, Qnil);
5156 bset_abbrev_mode (&buffer_defaults, Qnil);
5157 bset_overwrite_mode (&buffer_defaults, Qnil);
5158 bset_case_fold_search (&buffer_defaults, Qt);
5159 bset_auto_fill_function (&buffer_defaults, Qnil);
5160 bset_selective_display (&buffer_defaults, Qnil);
5161 bset_selective_display_ellipses (&buffer_defaults, Qt);
5162 bset_abbrev_table (&buffer_defaults, Qnil);
5163 bset_display_table (&buffer_defaults, Qnil);
5164 bset_undo_list (&buffer_defaults, Qnil);
5165 bset_mark_active (&buffer_defaults, Qnil);
5166 bset_file_format (&buffer_defaults, Qnil);
5167 bset_auto_save_file_format (&buffer_defaults, Qt);
5168 set_buffer_overlays_before (&buffer_defaults, NULL);
5169 set_buffer_overlays_after (&buffer_defaults, NULL);
5170 buffer_defaults.overlay_center = BEG;
5172 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
5173 bset_truncate_lines (&buffer_defaults, Qnil);
5174 bset_word_wrap (&buffer_defaults, Qnil);
5175 bset_ctl_arrow (&buffer_defaults, Qt);
5176 bset_bidi_display_reordering (&buffer_defaults, Qt);
5177 bset_bidi_paragraph_direction (&buffer_defaults, Qnil);
5178 bset_cursor_type (&buffer_defaults, Qt);
5179 bset_extra_line_spacing (&buffer_defaults, Qnil);
5180 bset_cursor_in_non_selected_windows (&buffer_defaults, Qt);
5182 bset_enable_multibyte_characters (&buffer_defaults, Qt);
5183 bset_buffer_file_coding_system (&buffer_defaults, Qnil);
5184 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
5185 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
5186 bset_cache_long_scans (&buffer_defaults, Qt);
5187 bset_file_truename (&buffer_defaults, Qnil);
5188 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
5189 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
5190 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
5191 bset_left_fringe_width (&buffer_defaults, Qnil);
5192 bset_right_fringe_width (&buffer_defaults, Qnil);
5193 bset_fringes_outside_margins (&buffer_defaults, Qnil);
5194 bset_scroll_bar_width (&buffer_defaults, Qnil);
5195 bset_scroll_bar_height (&buffer_defaults, Qnil);
5196 bset_vertical_scroll_bar_type (&buffer_defaults, Qt);
5197 bset_horizontal_scroll_bar_type (&buffer_defaults, Qt);
5198 bset_indicate_empty_lines (&buffer_defaults, Qnil);
5199 bset_indicate_buffer_boundaries (&buffer_defaults, Qnil);
5200 bset_fringe_indicator_alist (&buffer_defaults, Qnil);
5201 bset_fringe_cursor_alist (&buffer_defaults, Qnil);
5202 bset_scroll_up_aggressively (&buffer_defaults, Qnil);
5203 bset_scroll_down_aggressively (&buffer_defaults, Qnil);
5204 bset_display_time (&buffer_defaults, Qnil);
5206 /* Assign the local-flags to the slots that have default values.
5207 The local flag is a bit that is used in the buffer
5208 to say that it has its own local value for the slot.
5209 The local flag bits are in the local_var_flags slot of the buffer. */
5211 /* Nothing can work if this isn't true. */
5212 { verify (sizeof (EMACS_INT) == word_size); }
5214 Vbuffer_alist = Qnil;
5215 current_buffer = 0;
5216 all_buffers = 0;
5218 QSFundamental = build_pure_c_string ("Fundamental");
5220 DEFSYM (Qfundamental_mode, "fundamental-mode");
5221 bset_major_mode (&buffer_defaults, Qfundamental_mode);
5223 DEFSYM (Qmode_class, "mode-class");
5224 DEFSYM (Qprotected_field, "protected-field");
5226 DEFSYM (Qpermanent_local, "permanent-local");
5227 DEFSYM (Qkill_buffer_hook, "kill-buffer-hook");
5228 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5230 /* Super-magic invisible buffer. */
5231 Vprin1_to_string_buffer = Fget_buffer_create (build_pure_c_string (" prin1"));
5232 Vbuffer_alist = Qnil;
5234 Fset_buffer (Fget_buffer_create (build_pure_c_string ("*scratch*")));
5236 inhibit_modification_hooks = 0;
5239 void
5240 init_buffer (int initialized)
5242 char *pwd;
5243 Lisp_Object temp;
5244 ptrdiff_t len;
5246 #ifdef USE_MMAP_FOR_BUFFERS
5247 if (initialized)
5249 struct buffer *b;
5251 #ifndef WINDOWSNT
5252 /* These must be reset in the dumped Emacs, to avoid stale
5253 references to mmap'ed memory from before the dump.
5255 WINDOWSNT doesn't need this because it doesn't track mmap'ed
5256 regions by hand (see w32heap.c, which uses system APIs for
5257 that purpose), and thus doesn't use mmap_regions. */
5258 mmap_regions = NULL;
5259 mmap_fd = -1;
5260 #endif
5262 /* The dumped buffers reference addresses of buffer text
5263 recorded by temacs, that cannot be used by the dumped Emacs.
5264 We map new memory for their text here.
5266 Implementation note: the buffers we carry from temacs are:
5267 " prin1", "*scratch*", " *Minibuf-0*", "*Messages*", and
5268 " *code-conversion-work*". They are created by
5269 init_buffer_once and init_window_once (which are not called
5270 in the dumped Emacs), and by the first call to coding.c routines. */
5271 FOR_EACH_BUFFER (b)
5273 b->text->beg = NULL;
5274 enlarge_buffer_text (b, 0);
5277 else
5279 struct buffer *b;
5281 /* Only buffers with allocated buffer text should be present at
5282 this point in temacs. */
5283 FOR_EACH_BUFFER (b)
5285 eassert (b->text->beg != NULL);
5288 #else /* not USE_MMAP_FOR_BUFFERS */
5289 /* Avoid compiler warnings. */
5290 (void) initialized;
5291 #endif /* USE_MMAP_FOR_BUFFERS */
5293 AUTO_STRING (scratch, "*scratch*");
5294 Fset_buffer (Fget_buffer_create (scratch));
5295 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5296 Fset_buffer_multibyte (Qnil);
5298 pwd = emacs_get_current_dir_name ();
5300 if (!pwd)
5302 fprintf (stderr, "Error getting directory: %s\n",
5303 emacs_strerror (errno));
5304 bset_directory (current_buffer, Qnil);
5306 else
5308 /* Maybe this should really use some standard subroutine
5309 whose definition is filename syntax dependent. */
5310 len = strlen (pwd);
5311 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5313 /* Grow buffer to add directory separator and '\0'. */
5314 pwd = realloc (pwd, len + 2);
5315 if (!pwd)
5316 fatal ("get_current_dir_name: %s\n", strerror (errno));
5317 pwd[len] = DIRECTORY_SEP;
5318 pwd[len + 1] = '\0';
5319 len++;
5322 /* At this moment, we still don't know how to decode the directory
5323 name. So, we keep the bytes in unibyte form so that file I/O
5324 routines correctly get the original bytes. */
5325 bset_directory (current_buffer, make_unibyte_string (pwd, len));
5327 /* Add /: to the front of the name
5328 if it would otherwise be treated as magic. */
5329 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5330 if (! NILP (temp)
5331 /* If the default dir is just /, TEMP is non-nil
5332 because of the ange-ftp completion handler.
5333 However, it is not necessary to turn / into /:/.
5334 So avoid doing that. */
5335 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5337 AUTO_STRING (slash_colon, "/:");
5338 bset_directory (current_buffer,
5339 concat2 (slash_colon,
5340 BVAR (current_buffer, directory)));
5344 temp = get_minibuffer (0);
5345 bset_directory (XBUFFER (temp), BVAR (current_buffer, directory));
5347 free (pwd);
5350 /* Similar to defvar_lisp but define a variable whose value is the
5351 Lisp_Object stored in the current buffer. LNAME is the Lisp-level
5352 variable name. VNAME is the name of the buffer slot. PREDICATE
5353 is nil for a general Lisp variable. If PREDICATE is non-nil, then
5354 only Lisp values that satisfies the PREDICATE are allowed (except
5355 that nil is allowed too). DOC is a dummy where you write the doc
5356 string as a comment. */
5358 #define DEFVAR_PER_BUFFER(lname, vname, predicate, doc) \
5359 do { \
5360 static struct Lisp_Buffer_Objfwd bo_fwd; \
5361 defvar_per_buffer (&bo_fwd, lname, vname, predicate); \
5362 } while (0)
5364 static void
5365 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5366 Lisp_Object *address, Lisp_Object predicate)
5368 struct Lisp_Symbol *sym;
5369 int offset;
5371 sym = XSYMBOL (intern (namestring));
5372 offset = (char *)address - (char *)current_buffer;
5374 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5375 bo_fwd->offset = offset;
5376 bo_fwd->predicate = predicate;
5377 sym->declared_special = 1;
5378 sym->redirect = SYMBOL_FORWARDED;
5379 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *) bo_fwd);
5380 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5382 if (PER_BUFFER_IDX (offset) == 0)
5383 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5384 slot of buffer_local_flags. */
5385 emacs_abort ();
5389 /* Initialize the buffer routines. */
5390 void
5391 syms_of_buffer (void)
5393 staticpro (&last_overlay_modification_hooks);
5394 last_overlay_modification_hooks
5395 = Fmake_vector (make_number (10), Qnil);
5397 staticpro (&QSFundamental);
5398 staticpro (&Vbuffer_alist);
5400 DEFSYM (Qchoice, "choice");
5401 DEFSYM (Qleft, "left");
5402 DEFSYM (Qright, "right");
5403 DEFSYM (Qrange, "range");
5405 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5406 DEFSYM (Qoverlayp, "overlayp");
5407 DEFSYM (Qevaporate, "evaporate");
5408 DEFSYM (Qmodification_hooks, "modification-hooks");
5409 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5410 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5411 DEFSYM (Qget_file_buffer, "get-file-buffer");
5412 DEFSYM (Qpriority, "priority");
5413 DEFSYM (Qbefore_string, "before-string");
5414 DEFSYM (Qafter_string, "after-string");
5415 DEFSYM (Qfirst_change_hook, "first-change-hook");
5416 DEFSYM (Qbefore_change_functions, "before-change-functions");
5417 DEFSYM (Qafter_change_functions, "after-change-functions");
5418 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5420 DEFSYM (Qvertical_scroll_bar, "vertical-scroll-bar");
5421 Fput (Qvertical_scroll_bar, Qchoice, list4 (Qnil, Qt, Qleft, Qright));
5422 DEFSYM (Qhorizontal_scroll_bar, "horizontal-scroll-bar");
5424 DEFSYM (Qfraction, "fraction");
5425 Fput (Qfraction, Qrange, Fcons (make_float (0.0), make_float (1.0)));
5427 DEFSYM (Qoverwrite_mode, "overwrite-mode");
5428 Fput (Qoverwrite_mode, Qchoice,
5429 list3 (Qnil, intern ("overwrite-mode-textual"),
5430 Qoverwrite_mode_binary));
5432 Fput (Qprotected_field, Qerror_conditions,
5433 listn (CONSTYPE_PURE, 2, Qprotected_field, Qerror));
5434 Fput (Qprotected_field, Qerror_message,
5435 build_pure_c_string ("Attempt to modify a protected field"));
5437 DEFVAR_PER_BUFFER ("header-line-format",
5438 &BVAR (current_buffer, header_line_format),
5439 Qnil,
5440 doc: /* Analogous to `mode-line-format', but controls the header line.
5441 The header line appears, optionally, at the top of a window;
5442 the mode line appears at the bottom. */);
5444 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5445 Qnil,
5446 doc: /* Template for displaying mode line for current buffer.
5448 The value may be nil, a string, a symbol or a list.
5450 A value of nil means don't display a mode line.
5452 For any symbol other than t or nil, the symbol's value is processed as
5453 a mode line construct. As a special exception, if that value is a
5454 string, the string is processed verbatim, without handling any
5455 %-constructs (see below). Also, unless the symbol has a non-nil
5456 `risky-local-variable' property, all properties in any strings, as
5457 well as all :eval and :propertize forms in the value, are ignored.
5459 A list whose car is a string or list is processed by processing each
5460 of the list elements recursively, as separate mode line constructs,
5461 and concatenating the results.
5463 A list of the form `(:eval FORM)' is processed by evaluating FORM and
5464 using the result as a mode line construct. Be careful--FORM should
5465 not load any files, because that can cause an infinite recursion.
5467 A list of the form `(:propertize ELT PROPS...)' is processed by
5468 processing ELT as the mode line construct, and adding the text
5469 properties PROPS to the result.
5471 A list whose car is a symbol is processed by examining the symbol's
5472 value, and, if that value is non-nil, processing the cadr of the list
5473 recursively; and if that value is nil, processing the caddr of the
5474 list recursively.
5476 A list whose car is an integer is processed by processing the cadr of
5477 the list, and padding (if the number is positive) or truncating (if
5478 negative) to the width specified by that number.
5480 A string is printed verbatim in the mode line except for %-constructs:
5481 %b -- print buffer name. %f -- print visited file name.
5482 %F -- print frame name.
5483 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5484 %& is like %*, but ignore read-only-ness.
5485 % means buffer is read-only and * means it is modified.
5486 For a modified read-only buffer, %* gives % and %+ gives *.
5487 %s -- print process status. %l -- print the current line number.
5488 %c -- print the current column number (this makes editing slower).
5489 Columns are numbered starting from the left margin, and the
5490 leftmost column is displayed as zero.
5491 To make the column number update correctly in all cases,
5492 `column-number-mode' must be non-nil.
5493 %C -- Like %c, but the leftmost column is displayed as one.
5494 %i -- print the size of the buffer.
5495 %I -- like %i, but use k, M, G, etc., to abbreviate.
5496 %p -- print percent of buffer above top of window, or Top, Bot or All.
5497 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5498 or print Bottom or All.
5499 %n -- print Narrow if appropriate.
5500 %t -- visited file is text or binary (if OS supports this distinction).
5501 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5502 %Z -- like %z, but including the end-of-line format.
5503 %e -- print error message about full memory.
5504 %@ -- print @ or hyphen. @ means that default-directory is on a
5505 remote machine.
5506 %[ -- print one [ for each recursive editing level. %] similar.
5507 %% -- print %. %- -- print infinitely many dashes.
5508 Decimal digits after the % specify field width to which to pad. */);
5510 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5511 Qsymbolp,
5512 doc: /* Symbol for current buffer's major mode.
5513 The default value (normally `fundamental-mode') affects new buffers.
5514 A value of nil means to use the current buffer's major mode, provided
5515 it is not marked as "special". */);
5517 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5518 Qnil,
5519 doc: /* Pretty name of current buffer's major mode.
5520 Usually a string, but can use any of the constructs for `mode-line-format',
5521 which see.
5522 Format with `format-mode-line' to produce a string value. */);
5524 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5525 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5527 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5528 doc: /* Non-nil if Abbrev mode is enabled.
5529 Use the command `abbrev-mode' to change this variable. */);
5531 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5532 Qnil,
5533 doc: /* Non-nil if searches and matches should ignore case. */);
5535 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5536 Qintegerp,
5537 doc: /* Column beyond which automatic line-wrapping should happen.
5538 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5540 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5541 Qintegerp,
5542 doc: /* Column for the default `indent-line-function' to indent to.
5543 Linefeed indents to this column in Fundamental mode. */);
5545 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5546 Qintegerp,
5547 doc: /* Distance between tab stops (for display of tab characters), in columns.
5548 NOTE: This controls the display width of a TAB character, and not
5549 the size of an indentation step.
5550 This should be an integer greater than zero. */);
5552 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5553 doc: /* Non-nil means display control chars with uparrow.
5554 A value of nil means use backslash and octal digits.
5555 This variable does not apply to characters whose display is specified
5556 in the current display table (if there is one). */);
5558 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5559 &BVAR (current_buffer, enable_multibyte_characters),
5560 Qnil,
5561 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5562 Otherwise they are regarded as unibyte. This affects the display,
5563 file I/O and the behavior of various editing commands.
5565 This variable is buffer-local but you cannot set it directly;
5566 use the function `set-buffer-multibyte' to change a buffer's representation.
5567 See also Info node `(elisp)Text Representations'. */);
5568 make_symbol_constant (intern_c_string ("enable-multibyte-characters"));
5570 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5571 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5572 doc: /* Coding system to be used for encoding the buffer contents on saving.
5573 This variable applies to saving the buffer, and also to `write-region'
5574 and other functions that use `write-region'.
5575 It does not apply to sending output to subprocesses, however.
5577 If this is nil, the buffer is saved without any code conversion
5578 unless some coding system is specified in `file-coding-system-alist'
5579 for the buffer file.
5581 If the text to be saved cannot be encoded as specified by this variable,
5582 an alternative encoding is selected by `select-safe-coding-system', which see.
5584 The variable `coding-system-for-write', if non-nil, overrides this variable.
5586 This variable is never applied to a way of decoding a file while reading it. */);
5588 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5589 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5590 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5592 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5593 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5594 doc: /* If non-nil, forces directionality of text paragraphs in the buffer.
5596 If this is nil (the default), the direction of each paragraph is
5597 determined by the first strong directional character of its text.
5598 The values of `right-to-left' and `left-to-right' override that.
5599 Any other value is treated as nil.
5601 This variable has no effect unless the buffer's value of
5602 `bidi-display-reordering' is non-nil. */);
5604 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5605 doc: /* Non-nil means do not display continuation lines.
5606 Instead, give each line of text just one screen line.
5608 Note that this is overridden by the variable
5609 `truncate-partial-width-windows' if that variable is non-nil
5610 and this buffer is not full-frame width.
5612 Minibuffers set this variable to nil. */);
5614 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5615 doc: /* Non-nil means to use word-wrapping for continuation lines.
5616 When word-wrapping is on, continuation lines are wrapped at the space
5617 or tab character nearest to the right window edge.
5618 If nil, continuation lines are wrapped at the right screen edge.
5620 This variable has no effect if long lines are truncated (see
5621 `truncate-lines' and `truncate-partial-width-windows'). If you use
5622 word-wrapping, you might want to reduce the value of
5623 `truncate-partial-width-windows', since wrapping can make text readable
5624 in narrower windows.
5626 Instead of setting this variable directly, most users should use
5627 Visual Line mode . Visual Line mode, when enabled, sets `word-wrap'
5628 to t, and additionally redefines simple editing commands to act on
5629 visual lines rather than logical lines. See the documentation of
5630 `visual-line-mode'. */);
5632 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5633 Qstringp,
5634 doc: /* Name of default directory of current buffer.
5635 It should be a directory name (as opposed to a directory file-name).
5636 On GNU and Unix systems, directory names end in a slash `/'.
5637 To interactively change the default directory, use command `cd'. */);
5639 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5640 Qnil,
5641 doc: /* Function called (if non-nil) to perform auto-fill.
5642 It is called after self-inserting any character specified in
5643 the `auto-fill-chars' table.
5644 NOTE: This variable is not a hook;
5645 its value may not be a list of functions. */);
5647 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5648 Qstringp,
5649 doc: /* Name of file visited in current buffer, or nil if not visiting a file.
5650 This should be an absolute file name. */);
5652 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5653 Qstringp,
5654 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5655 The truename of a file is calculated by `file-truename'
5656 and then abbreviated with `abbreviate-file-name'. */);
5658 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5659 &BVAR (current_buffer, auto_save_file_name),
5660 Qstringp,
5661 doc: /* Name of file for auto-saving current buffer.
5662 If it is nil, that means don't auto-save this buffer. */);
5664 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5665 doc: /* Non-nil if this buffer is read-only. */);
5667 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5668 doc: /* Non-nil if this buffer's file has been backed up.
5669 Backing up is done before the first time the file is saved. */);
5671 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5672 Qintegerp,
5673 doc: /* Length of current buffer when last read in, saved or auto-saved.
5674 0 initially.
5675 -1 means auto-saving turned off until next real save.
5677 If you set this to -2, that means don't turn off auto-saving in this buffer
5678 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5679 you probably should set this to -2 in that buffer. */);
5681 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5682 Qnil,
5683 doc: /* Non-nil enables selective display.
5685 An integer N as value means display only lines
5686 that start with less than N columns of space.
5688 A value of t means that the character ^M makes itself and
5689 all the rest of the line invisible; also, when saving the buffer
5690 in a file, save the ^M as a newline. This usage is obsolete; use
5691 overlays or text properties instead. */);
5693 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5694 &BVAR (current_buffer, selective_display_ellipses),
5695 Qnil,
5696 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5698 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode),
5699 Qoverwrite_mode,
5700 doc: /* Non-nil if self-insertion should replace existing text.
5701 The value should be one of `overwrite-mode-textual',
5702 `overwrite-mode-binary', or nil.
5703 If it is `overwrite-mode-textual', self-insertion still
5704 inserts at the end of a line, and inserts when point is before a tab,
5705 until the tab is filled in.
5706 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5708 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5709 Qnil,
5710 doc: /* Display table that controls display of the contents of current buffer.
5712 If this variable is nil, the value of `standard-display-table' is used.
5713 Each window can have its own, overriding display table, see
5714 `set-window-display-table' and `window-display-table'.
5716 The display table is a char-table created with `make-display-table'.
5717 A char-table is an array indexed by character codes. Normal array
5718 primitives `aref' and `aset' can be used to access elements of a char-table.
5720 Each of the char-table elements control how to display the corresponding
5721 text character: the element at index C in the table says how to display
5722 the character whose code is C. Each element should be a vector of
5723 characters or nil. The value nil means display the character in the
5724 default fashion; otherwise, the characters from the vector are delivered
5725 to the screen instead of the original character.
5727 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5728 to display a capital Y instead of each X character.
5730 In addition, a char-table has six extra slots to control the display of:
5732 the end of a truncated screen line (extra-slot 0, a single character);
5733 the end of a continued line (extra-slot 1, a single character);
5734 the escape character used to display character codes in octal
5735 (extra-slot 2, a single character);
5736 the character used as an arrow for control characters (extra-slot 3,
5737 a single character);
5738 the decoration indicating the presence of invisible lines (extra-slot 4,
5739 a vector of characters);
5740 the character used to draw the border between side-by-side windows
5741 (extra-slot 5, a single character).
5743 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5745 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5746 Qintegerp,
5747 doc: /* Width in columns of left marginal area for display of a buffer.
5748 A value of nil means no marginal area.
5750 Setting this variable does not take effect until a new buffer is displayed
5751 in a window. To make the change take effect, call `set-window-buffer'. */);
5753 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5754 Qintegerp,
5755 doc: /* Width in columns of right marginal area for display of a buffer.
5756 A value of nil means no marginal area.
5758 Setting this variable does not take effect until a new buffer is displayed
5759 in a window. To make the change take effect, call `set-window-buffer'. */);
5761 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5762 Qintegerp,
5763 doc: /* Width of this buffer's left fringe (in pixels).
5764 A value of 0 means no left fringe is shown in this buffer's window.
5765 A value of nil means to use the left fringe width from the window's frame.
5767 Setting this variable does not take effect until a new buffer is displayed
5768 in a window. To make the change take effect, call `set-window-buffer'. */);
5770 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5771 Qintegerp,
5772 doc: /* Width of this buffer's right fringe (in pixels).
5773 A value of 0 means no right fringe is shown in this buffer's window.
5774 A value of nil means to use the right fringe width from the window's frame.
5776 Setting this variable does not take effect until a new buffer is displayed
5777 in a window. To make the change take effect, call `set-window-buffer'. */);
5779 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5780 Qnil,
5781 doc: /* Non-nil means to display fringes outside display margins.
5782 A value of nil means to display fringes between margins and buffer text.
5784 Setting this variable does not take effect until a new buffer is displayed
5785 in a window. To make the change take effect, call `set-window-buffer'. */);
5787 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5788 Qintegerp,
5789 doc: /* Width of this buffer's vertical scroll bars in pixels.
5790 A value of nil means to use the scroll bar width from the window's frame. */);
5792 DEFVAR_PER_BUFFER ("scroll-bar-height", &BVAR (current_buffer, scroll_bar_height),
5793 Qintegerp,
5794 doc: /* Height of this buffer's horizontal scroll bars in pixels.
5795 A value of nil means to use the scroll bar height from the window's frame. */);
5797 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5798 Qvertical_scroll_bar,
5799 doc: /* Position of this buffer's vertical scroll bar.
5800 The value takes effect whenever you tell a window to display this buffer;
5801 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5803 A value of `left' or `right' means put the vertical scroll bar at that side
5804 of the window; a value of nil means don't show any vertical scroll bars.
5805 A value of t (the default) means do whatever the window's frame specifies. */);
5807 DEFVAR_PER_BUFFER ("horizontal-scroll-bar", &BVAR (current_buffer, horizontal_scroll_bar_type),
5808 Qnil,
5809 doc: /* Position of this buffer's horizontal scroll bar.
5810 The value takes effect whenever you tell a window to display this buffer;
5811 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5813 A value of `bottom' means put the horizontal scroll bar at the bottom of
5814 the window; a value of nil means don't show any horizontal scroll bars.
5815 A value of t (the default) means do whatever the window's frame
5816 specifies. */);
5818 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5819 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5820 doc: /* Visually indicate empty lines after the buffer end.
5821 If non-nil, a bitmap is displayed in the left fringe of a window on
5822 window-systems. */);
5824 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5825 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5826 doc: /* Visually indicate buffer boundaries and scrolling.
5827 If non-nil, the first and last line of the buffer are marked in the fringe
5828 of a window on window-systems with angle bitmaps, or if the window can be
5829 scrolled, the top and bottom line of the window are marked with up and down
5830 arrow bitmaps.
5832 If value is a symbol `left' or `right', both angle and arrow bitmaps
5833 are displayed in the left or right fringe, resp. Any other value
5834 that doesn't look like an alist means display the angle bitmaps in
5835 the left fringe but no arrows.
5837 You can exercise more precise control by using an alist as the
5838 value. Each alist element (INDICATOR . POSITION) specifies
5839 where to show one of the indicators. INDICATOR is one of `top',
5840 `bottom', `up', `down', or t, which specifies the default position,
5841 and POSITION is one of `left', `right', or nil, meaning do not show
5842 this indicator.
5844 For example, ((top . left) (t . right)) places the top angle bitmap in
5845 left fringe, the bottom angle bitmap in right fringe, and both arrow
5846 bitmaps in right fringe. To show just the angle bitmaps in the left
5847 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5849 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5850 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5851 doc: /* Mapping from logical to physical fringe indicator bitmaps.
5852 The value is an alist where each element (INDICATOR . BITMAPS)
5853 specifies the fringe bitmaps used to display a specific logical
5854 fringe indicator.
5856 INDICATOR specifies the logical indicator type which is one of the
5857 following symbols: `truncation' , `continuation', `overlay-arrow',
5858 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5860 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5861 the actual bitmap shown in the left or right fringe for the logical
5862 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5863 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5864 are used only for the `bottom' and `top-bottom' indicators when the
5865 last (only) line has no final newline. BITMAPS may also be a single
5866 symbol which is used in both left and right fringes. */);
5868 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5869 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5870 doc: /* Mapping from logical to physical fringe cursor bitmaps.
5871 The value is an alist where each element (CURSOR . BITMAP)
5872 specifies the fringe bitmaps used to display a specific logical
5873 cursor type in the fringe.
5875 CURSOR specifies the logical cursor type which is one of the following
5876 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5877 one is used to show a hollow cursor on narrow lines display lines
5878 where the normal hollow cursor will not fit.
5880 BITMAP is the corresponding fringe bitmap shown for the logical
5881 cursor type. */);
5883 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5884 &BVAR (current_buffer, scroll_up_aggressively), Qfraction,
5885 doc: /* How far to scroll windows upward.
5886 If you move point off the bottom, the window scrolls automatically.
5887 This variable controls how far it scrolls. The value nil, the default,
5888 means scroll to center point. A fraction means scroll to put point
5889 that fraction of the window's height from the bottom of the window.
5890 When the value is 0.0, point goes at the bottom line, which in the
5891 simple case that you moved off with C-f means scrolling just one line.
5892 1.0 means point goes at the top, so that in that simple case, the
5893 window scrolls by a full window height. Meaningful values are
5894 between 0.0 and 1.0, inclusive. */);
5896 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5897 &BVAR (current_buffer, scroll_down_aggressively), Qfraction,
5898 doc: /* How far to scroll windows downward.
5899 If you move point off the top, the window scrolls automatically.
5900 This variable controls how far it scrolls. The value nil, the default,
5901 means scroll to center point. A fraction means scroll to put point
5902 that fraction of the window's height from the top of the window.
5903 When the value is 0.0, point goes at the top line, which in the
5904 simple case that you moved off with C-b means scrolling just one line.
5905 1.0 means point goes at the bottom, so that in that simple case, the
5906 window scrolls by a full window height. Meaningful values are
5907 between 0.0 and 1.0, inclusive. */);
5909 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5910 doc: /* List of functions to call before each text change.
5911 Two arguments are passed to each function: the positions of
5912 the beginning and end of the range of old text to be changed.
5913 \(For an insertion, the beginning and end are at the same place.)
5914 No information is given about the length of the text after the change.
5916 Buffer changes made while executing the `before-change-functions'
5917 don't call any before-change or after-change functions.
5918 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5920 If an unhandled error happens in running these functions,
5921 the variable's value remains nil. That prevents the error
5922 from happening repeatedly and making Emacs nonfunctional. */);
5923 Vbefore_change_functions = Qnil;
5925 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5926 doc: /* List of functions to call after each text change.
5927 Three arguments are passed to each function: the positions of
5928 the beginning and end of the range of changed text,
5929 and the length in chars of the pre-change text replaced by that range.
5930 \(For an insertion, the pre-change length is zero;
5931 for a deletion, that length is the number of chars deleted,
5932 and the post-change beginning and end are at the same place.)
5934 Buffer changes made while executing the `after-change-functions'
5935 don't call any before-change or after-change functions.
5936 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5938 If an unhandled error happens in running these functions,
5939 the variable's value remains nil. That prevents the error
5940 from happening repeatedly and making Emacs nonfunctional. */);
5941 Vafter_change_functions = Qnil;
5943 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5944 doc: /* A list of functions to call before changing a buffer which is unmodified.
5945 The functions are run using the `run-hooks' function. */);
5946 Vfirst_change_hook = Qnil;
5948 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5949 doc: /* List of undo entries in current buffer.
5950 Recent changes come first; older changes follow newer.
5952 An entry (BEG . END) represents an insertion which begins at
5953 position BEG and ends at position END.
5955 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5956 from (abs POSITION). If POSITION is positive, point was at the front
5957 of the text being deleted; if negative, point was at the end.
5959 An entry (t HIGH LOW USEC PSEC) indicates that the buffer was previously
5960 unmodified; (HIGH LOW USEC PSEC) is in the same style as (current-time)
5961 and is the visited file's modification time, as of that time. If the
5962 modification time of the most recent save is different, this entry is
5963 obsolete.
5965 An entry (t . 0) means means the buffer was previously unmodified but
5966 its time stamp was unknown because it was not associated with a file.
5967 An entry (t . -1) is similar, except that it means the buffer's visited
5968 file did not exist.
5970 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5971 was modified between BEG and END. PROPERTY is the property name,
5972 and VALUE is the old value.
5974 An entry (apply FUN-NAME . ARGS) means undo the change with
5975 \(apply FUN-NAME ARGS).
5977 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5978 in the active region. BEG and END is the range affected by this entry
5979 and DELTA is the number of characters added or deleted in that range by
5980 this change.
5982 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5983 was adjusted in position by the offset DISTANCE (an integer).
5985 An entry of the form POSITION indicates that point was at the buffer
5986 location given by the integer. Undoing an entry of this form places
5987 point at POSITION.
5989 Entries with value nil mark undo boundaries. The undo command treats
5990 the changes between two undo boundaries as a single step to be undone.
5992 If the value of the variable is t, undo information is not recorded. */);
5994 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5995 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5997 DEFVAR_PER_BUFFER ("cache-long-scans", &BVAR (current_buffer, cache_long_scans), Qnil,
5998 doc: /* Non-nil means that Emacs should use caches in attempt to speedup buffer scans.
6000 There is no reason to set this to nil except for debugging purposes.
6002 Normally, the line-motion functions work by scanning the buffer for
6003 newlines. Columnar operations (like `move-to-column' and
6004 `compute-motion') also work by scanning the buffer, summing character
6005 widths as they go. This works well for ordinary text, but if the
6006 buffer's lines are very long (say, more than 500 characters), these
6007 motion functions will take longer to execute. Emacs may also take
6008 longer to update the display.
6010 If `cache-long-scans' is non-nil, these motion functions cache the
6011 results of their scans, and consult the cache to avoid rescanning
6012 regions of the buffer until the text is modified. The caches are most
6013 beneficial when they prevent the most searching---that is, when the
6014 buffer contains long lines and large regions of characters with the
6015 same, fixed screen width.
6017 When `cache-long-scans' is non-nil, processing short lines will
6018 become slightly slower (because of the overhead of consulting the
6019 cache), and the caches will use memory roughly proportional to the
6020 number of newlines and characters whose screen width varies.
6022 Bidirectional editing also requires buffer scans to find paragraph
6023 separators. If you have large paragraphs or no paragraph separators
6024 at all, these scans may be slow. If `cache-long-scans' is non-nil,
6025 results of these scans are cached. This doesn't help too much if
6026 paragraphs are of the reasonable (few thousands of characters) size.
6028 The caches require no explicit maintenance; their accuracy is
6029 maintained internally by the Emacs primitives. Enabling or disabling
6030 the cache should not affect the behavior of any of the motion
6031 functions; it should only affect their performance. */);
6033 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
6034 doc: /* Value of point before the last series of scroll operations, or nil. */);
6036 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
6037 doc: /* List of formats to use when saving this buffer.
6038 Formats are defined by `format-alist'. This variable is
6039 set when a file is visited. */);
6041 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6042 &BVAR (current_buffer, auto_save_file_format), Qnil,
6043 doc: /* Format in which to write auto-save files.
6044 Should be a list of symbols naming formats that are defined in `format-alist'.
6045 If it is t, which is the default, auto-save files are written in the
6046 same format as a regular save would use. */);
6048 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6049 &BVAR (current_buffer, invisibility_spec), Qnil,
6050 doc: /* Invisibility spec of this buffer.
6051 The default is t, which means that text is invisible if it has a non-nil
6052 `invisible' property.
6053 This variable can also be a list. The list can have two kinds of elements:
6054 `ATOM' and `(ATOM . ELLIPSIS)'. A text character is invisible if its
6055 `invisible' property is `ATOM', or has an `invisible' property that is a list
6056 that contains `ATOM'.
6057 If the `(ATOM . ELLIPSIS)' form is used, and `ELLIPSIS' is non-nil, an
6058 ellipsis will be displayed after the invisible characters.
6059 Setting this variable is very fast, much faster than scanning all the text in
6060 the buffer looking for properties to change. */);
6062 DEFVAR_PER_BUFFER ("buffer-display-count",
6063 &BVAR (current_buffer, display_count), Qintegerp,
6064 doc: /* A number incremented each time this buffer is displayed in a window.
6065 The function `set-window-buffer' increments it. */);
6067 DEFVAR_PER_BUFFER ("buffer-display-time",
6068 &BVAR (current_buffer, display_time), Qnil,
6069 doc: /* Time stamp updated each time this buffer is displayed in a window.
6070 The function `set-window-buffer' updates this variable
6071 to the value obtained by calling `current-time'.
6072 If the buffer has never been shown in a window, the value is nil. */);
6074 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
6075 doc: /* Non-nil if Transient Mark mode is enabled.
6076 See the command `transient-mark-mode' for a description of this minor mode.
6078 Non-nil also enables highlighting of the region whenever the mark is active.
6079 The region is highlighted with the `region' face.
6080 The variable `highlight-nonselected-windows' controls whether to highlight
6081 all windows or just the selected window.
6083 Lisp programs may give this variable certain special values:
6085 - The symbol `lambda' enables Transient Mark mode temporarily.
6086 The mode is disabled again after any subsequent action that would
6087 normally deactivate the mark (e.g. buffer modification).
6089 - The pair (only . OLDVAL) enables Transient Mark mode
6090 temporarily. After any subsequent point motion command that is
6091 not shift-translated, or any other action that would normally
6092 deactivate the mark (e.g. buffer modification), the value of
6093 `transient-mark-mode' is set to OLDVAL. */);
6094 Vtransient_mark_mode = Qnil;
6096 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
6097 doc: /* Non-nil means disregard read-only status of buffers or characters.
6098 If the value is t, disregard `buffer-read-only' and all `read-only'
6099 text properties. If the value is a list, disregard `buffer-read-only'
6100 and disregard a `read-only' text property if the property value
6101 is a member of the list. */);
6102 Vinhibit_read_only = Qnil;
6104 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
6105 doc: /* Cursor to use when this buffer is in the selected window.
6106 Values are interpreted as follows:
6108 t use the cursor specified for the frame
6109 nil don't display a cursor
6110 box display a filled box cursor
6111 hollow display a hollow box cursor
6112 bar display a vertical bar cursor with default width
6113 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6114 hbar display a horizontal bar cursor with default height
6115 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6116 ANYTHING ELSE display a hollow box cursor
6118 WIDTH and HEIGHT can't exceed the frame's canonical character size.
6120 When the buffer is displayed in a non-selected window, the
6121 cursor's appearance is instead controlled by the variable
6122 `cursor-in-non-selected-windows'. */);
6124 DEFVAR_PER_BUFFER ("line-spacing",
6125 &BVAR (current_buffer, extra_line_spacing), Qnumberp,
6126 doc: /* Additional space to put between lines when displaying a buffer.
6127 The space is measured in pixels, and put below lines on graphic displays,
6128 see `display-graphic-p'.
6129 If value is a floating point number, it specifies the spacing relative
6130 to the default frame line height. A value of nil means add no extra space. */);
6132 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6133 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
6134 doc: /* Non-nil means show a cursor in non-selected windows.
6135 If nil, only shows a cursor in the selected window.
6136 If t, displays a cursor related to the usual cursor type
6137 \(a solid box becomes hollow, a bar becomes a narrower bar).
6138 You can also specify the cursor type as in the `cursor-type' variable.
6139 Use Custom to set this variable and update the display. */);
6141 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
6142 doc: /* List of functions called with no args to query before killing a buffer.
6143 The buffer being killed will be current while the functions are running.
6145 If any of them returns nil, the buffer is not killed. Functions run by
6146 this hook are supposed to not change the current buffer. */);
6147 Vkill_buffer_query_functions = Qnil;
6149 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
6150 doc: /* Normal hook run before changing the major mode of a buffer.
6151 The function `kill-all-local-variables' runs this before doing anything else. */);
6152 Vchange_major_mode_hook = Qnil;
6153 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
6155 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6156 doc: /* Hook run when the buffer list changes.
6157 Functions running this hook are, `get-buffer-create',
6158 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6159 `bury-buffer-internal' and `select-window'. */);
6160 Vbuffer_list_update_hook = Qnil;
6161 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
6163 defsubr (&Sbuffer_live_p);
6164 defsubr (&Sbuffer_list);
6165 defsubr (&Sget_buffer);
6166 defsubr (&Sget_file_buffer);
6167 defsubr (&Sget_buffer_create);
6168 defsubr (&Smake_indirect_buffer);
6169 defsubr (&Sgenerate_new_buffer_name);
6170 defsubr (&Sbuffer_name);
6171 defsubr (&Sbuffer_file_name);
6172 defsubr (&Sbuffer_base_buffer);
6173 defsubr (&Sbuffer_local_value);
6174 defsubr (&Sbuffer_local_variables);
6175 defsubr (&Sbuffer_modified_p);
6176 defsubr (&Sforce_mode_line_update);
6177 defsubr (&Sset_buffer_modified_p);
6178 defsubr (&Sbuffer_modified_tick);
6179 defsubr (&Sbuffer_chars_modified_tick);
6180 defsubr (&Srename_buffer);
6181 defsubr (&Sother_buffer);
6182 defsubr (&Sbuffer_enable_undo);
6183 defsubr (&Skill_buffer);
6184 defsubr (&Sbury_buffer_internal);
6185 defsubr (&Sset_buffer_major_mode);
6186 defsubr (&Scurrent_buffer);
6187 defsubr (&Sset_buffer);
6188 defsubr (&Sbarf_if_buffer_read_only);
6189 defsubr (&Serase_buffer);
6190 defsubr (&Sbuffer_swap_text);
6191 defsubr (&Sset_buffer_multibyte);
6192 defsubr (&Skill_all_local_variables);
6194 defsubr (&Soverlayp);
6195 defsubr (&Smake_overlay);
6196 defsubr (&Sdelete_overlay);
6197 defsubr (&Sdelete_all_overlays);
6198 defsubr (&Smove_overlay);
6199 defsubr (&Soverlay_start);
6200 defsubr (&Soverlay_end);
6201 defsubr (&Soverlay_buffer);
6202 defsubr (&Soverlay_properties);
6203 defsubr (&Soverlays_at);
6204 defsubr (&Soverlays_in);
6205 defsubr (&Snext_overlay_change);
6206 defsubr (&Sprevious_overlay_change);
6207 defsubr (&Soverlay_recenter);
6208 defsubr (&Soverlay_lists);
6209 defsubr (&Soverlay_get);
6210 defsubr (&Soverlay_put);
6211 defsubr (&Srestore_buffer_modified_p);
6213 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);
6216 void
6217 keys_of_buffer (void)
6219 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6220 initial_define_key (control_x_map, 'k', "kill-buffer");