* auth-source.el (auth-source-backend): Fix :initarg for data slot.
[emacs.git] / src / buffer.c
blob328963be78cc70e6e96c77b53630f8678596d7d4
1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/param.h>
25 #include <errno.h>
26 #include <stdio.h>
27 #include <setjmp.h>
28 #include <unistd.h>
30 #include <verify.h>
32 #include "lisp.h"
33 #include "intervals.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "buffer.h"
37 #include "character.h"
38 #include "region-cache.h"
39 #include "indent.h"
40 #include "blockinput.h"
41 #include "keyboard.h"
42 #include "keymap.h"
43 #include "frame.h"
45 struct buffer *current_buffer; /* the current buffer */
47 /* First buffer in chain of all buffers (in reverse order of creation).
48 Threaded through ->header.next.buffer. */
50 struct buffer *all_buffers;
52 /* This structure holds the default values of the buffer-local variables
53 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
54 The default value occupies the same slot in this structure
55 as an individual buffer's value occupies in that buffer.
56 Setting the default value also goes through the alist of buffers
57 and stores into each buffer that does not say it has a local value. */
59 DECL_ALIGN (struct buffer, buffer_defaults);
61 /* A Lisp_Object pointer to the above, used for staticpro */
63 static Lisp_Object Vbuffer_defaults;
65 /* This structure marks which slots in a buffer have corresponding
66 default values in buffer_defaults.
67 Each such slot has a nonzero value in this structure.
68 The value has only one nonzero bit.
70 When a buffer has its own local value for a slot,
71 the entry for that slot (found in the same slot in this structure)
72 is turned on in the buffer's local_flags array.
74 If a slot in this structure is -1, then even though there may
75 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
76 and the corresponding slot in buffer_defaults is not used.
78 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
79 zero, that is a bug */
81 struct buffer buffer_local_flags;
83 /* This structure holds the names of symbols whose values may be
84 buffer-local. It is indexed and accessed in the same way as the above. */
86 DECL_ALIGN (struct buffer, buffer_local_symbols);
88 /* A Lisp_Object pointer to the above, used for staticpro */
89 static Lisp_Object Vbuffer_local_symbols;
91 /* Return the symbol of the per-buffer variable at offset OFFSET in
92 the buffer structure. */
94 #define PER_BUFFER_SYMBOL(OFFSET) \
95 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
97 /* Maximum length of an overlay vector. */
98 #define OVERLAY_COUNT_MAX \
99 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
100 min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)))
102 /* Flags indicating which built-in buffer-local variables
103 are permanent locals. */
104 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
106 /* Number of per-buffer variables used. */
108 int last_per_buffer_idx;
110 static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
111 static Lisp_Object Fdelete_overlay (Lisp_Object);
112 static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
113 int after, Lisp_Object arg1,
114 Lisp_Object arg2, Lisp_Object arg3);
115 static void swap_out_buffer_local_variables (struct buffer *b);
116 static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
118 /* Alist of all buffer names vs the buffers. */
119 /* This used to be a variable, but is no longer,
120 to prevent lossage due to user rplac'ing this alist or its elements. */
121 Lisp_Object Vbuffer_alist;
123 static Lisp_Object Qkill_buffer_query_functions;
125 /* Hook run before changing a major mode. */
126 static Lisp_Object Qchange_major_mode_hook;
128 Lisp_Object Qfirst_change_hook;
129 Lisp_Object Qbefore_change_functions;
130 Lisp_Object Qafter_change_functions;
131 static Lisp_Object Qucs_set_table_for_input;
133 static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
134 static Lisp_Object Qpermanent_local_hook;
136 static Lisp_Object Qprotected_field;
138 static Lisp_Object QSFundamental; /* A string "Fundamental" */
140 static Lisp_Object Qkill_buffer_hook;
141 static Lisp_Object Qbuffer_list_update_hook;
143 static Lisp_Object Qget_file_buffer;
145 static Lisp_Object Qoverlayp;
147 Lisp_Object Qpriority, Qbefore_string, Qafter_string;
149 static Lisp_Object Qclone_number, Qevaporate;
151 Lisp_Object Qmodification_hooks;
152 Lisp_Object Qinsert_in_front_hooks;
153 Lisp_Object Qinsert_behind_hooks;
155 static void alloc_buffer_text (struct buffer *, size_t);
156 static void free_buffer_text (struct buffer *b);
157 static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
158 static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
159 static Lisp_Object buffer_lisp_local_variables (struct buffer *);
161 /* For debugging; temporary. See set_buffer_internal. */
162 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
164 void
165 nsberror (Lisp_Object spec)
167 if (STRINGP (spec))
168 error ("No buffer named %s", SDATA (spec));
169 error ("Invalid buffer argument");
172 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
173 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
174 Value is nil if OBJECT is not a buffer or if it has been killed. */)
175 (Lisp_Object object)
177 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
178 ? Qt : Qnil);
181 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
182 doc: /* Return a list of all existing live buffers.
183 If the optional arg FRAME is a frame, we return the buffer list in the
184 proper order for that frame: the buffers show in FRAME come first,
185 followed by the rest of the buffers. */)
186 (Lisp_Object frame)
188 Lisp_Object general;
189 general = Fmapcar (Qcdr, Vbuffer_alist);
191 if (FRAMEP (frame))
193 Lisp_Object framelist, prevlist, tail;
194 Lisp_Object args[3];
196 CHECK_FRAME (frame);
197 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
198 prevlist = Fnreverse (Fcopy_sequence
199 (XFRAME (frame)->buried_buffer_list));
201 /* Remove from GENERAL any buffer that duplicates one in
202 FRAMELIST or PREVLIST. */
203 tail = framelist;
204 while (CONSP (tail))
206 general = Fdelq (XCAR (tail), general);
207 tail = XCDR (tail);
209 tail = prevlist;
210 while (CONSP (tail))
212 general = Fdelq (XCAR (tail), general);
213 tail = XCDR (tail);
216 args[0] = framelist;
217 args[1] = general;
218 args[2] = prevlist;
219 return Fnconc (3, args);
221 else
222 return general;
225 /* Like Fassoc, but use Fstring_equal to compare
226 (which ignores text properties),
227 and don't ever QUIT. */
229 static Lisp_Object
230 assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
232 register Lisp_Object tail;
233 for (tail = list; CONSP (tail); tail = XCDR (tail))
235 register Lisp_Object elt, tem;
236 elt = XCAR (tail);
237 tem = Fstring_equal (Fcar (elt), key);
238 if (!NILP (tem))
239 return elt;
241 return Qnil;
244 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
245 doc: /* Return the buffer named BUFFER-OR-NAME.
246 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
247 is a string and there is no buffer with that name, return nil. If
248 BUFFER-OR-NAME is a buffer, return it as given. */)
249 (register Lisp_Object buffer_or_name)
251 if (BUFFERP (buffer_or_name))
252 return buffer_or_name;
253 CHECK_STRING (buffer_or_name);
255 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
258 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
259 doc: /* Return the buffer visiting file FILENAME (a string).
260 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
261 If there is no such live buffer, return nil.
262 See also `find-buffer-visiting'. */)
263 (register Lisp_Object filename)
265 register Lisp_Object tail, buf, tem;
266 Lisp_Object handler;
268 CHECK_STRING (filename);
269 filename = Fexpand_file_name (filename, Qnil);
271 /* If the file name has special constructs in it,
272 call the corresponding file handler. */
273 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
274 if (!NILP (handler))
275 return call2 (handler, Qget_file_buffer, filename);
277 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
279 buf = Fcdr (XCAR (tail));
280 if (!BUFFERP (buf)) continue;
281 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
282 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
283 if (!NILP (tem))
284 return buf;
286 return Qnil;
289 Lisp_Object
290 get_truename_buffer (register Lisp_Object filename)
292 register Lisp_Object tail, buf, tem;
294 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
296 buf = Fcdr (XCAR (tail));
297 if (!BUFFERP (buf)) continue;
298 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
299 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
300 if (!NILP (tem))
301 return buf;
303 return Qnil;
306 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
307 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
308 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
309 return that buffer. If no such buffer exists, create a new buffer with
310 that name and return it. If BUFFER-OR-NAME starts with a space, the new
311 buffer does not keep undo information.
313 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
314 even if it is dead. The return value is never nil. */)
315 (register Lisp_Object buffer_or_name)
317 register Lisp_Object buffer, name;
318 register struct buffer *b;
320 buffer = Fget_buffer (buffer_or_name);
321 if (!NILP (buffer))
322 return buffer;
324 if (SCHARS (buffer_or_name) == 0)
325 error ("Empty string for buffer name is not allowed");
327 b = allocate_buffer ();
329 /* An ordinary buffer uses its own struct buffer_text. */
330 b->text = &b->own_text;
331 b->base_buffer = 0;
333 BUF_GAP_SIZE (b) = 20;
334 BLOCK_INPUT;
335 /* We allocate extra 1-byte at the tail and keep it always '\0' for
336 anchoring a search. */
337 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
338 UNBLOCK_INPUT;
339 if (! BUF_BEG_ADDR (b))
340 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
342 b->pt = BEG;
343 b->begv = BEG;
344 b->zv = BEG;
345 b->pt_byte = BEG_BYTE;
346 b->begv_byte = BEG_BYTE;
347 b->zv_byte = BEG_BYTE;
349 BUF_GPT (b) = BEG;
350 BUF_GPT_BYTE (b) = BEG_BYTE;
352 BUF_Z (b) = BEG;
353 BUF_Z_BYTE (b) = BEG_BYTE;
354 BUF_MODIFF (b) = 1;
355 BUF_CHARS_MODIFF (b) = 1;
356 BUF_OVERLAY_MODIFF (b) = 1;
357 BUF_SAVE_MODIFF (b) = 1;
358 BUF_INTERVALS (b) = 0;
359 BUF_UNCHANGED_MODIFIED (b) = 1;
360 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
361 BUF_END_UNCHANGED (b) = 0;
362 BUF_BEG_UNCHANGED (b) = 0;
363 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
365 b->newline_cache = 0;
366 b->width_run_cache = 0;
367 BVAR (b, width_table) = Qnil;
368 b->prevent_redisplay_optimizations_p = 1;
370 /* Put this on the chain of all buffers including killed ones. */
371 b->header.next.buffer = all_buffers;
372 all_buffers = b;
374 /* An ordinary buffer normally doesn't need markers
375 to handle BEGV and ZV. */
376 BVAR (b, pt_marker) = Qnil;
377 BVAR (b, begv_marker) = Qnil;
378 BVAR (b, zv_marker) = Qnil;
380 name = Fcopy_sequence (buffer_or_name);
381 STRING_SET_INTERVALS (name, NULL_INTERVAL);
382 BVAR (b, name) = name;
384 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
386 reset_buffer (b);
387 reset_buffer_local_variables (b, 1);
389 BVAR (b, mark) = Fmake_marker ();
390 BUF_MARKERS (b) = NULL;
391 BVAR (b, name) = name;
393 /* Put this in the alist of all live buffers. */
394 XSETBUFFER (buffer, b);
395 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
396 /* And run buffer-list-update-hook. */
397 if (!NILP (Vrun_hooks))
398 call1 (Vrun_hooks, Qbuffer_list_update_hook);
400 /* An error in calling the function here (should someone redefine it)
401 can lead to infinite regress until you run out of stack. rms
402 says that's not worth protecting against. */
403 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
404 /* buffer is on buffer-alist, so no gcpro. */
405 call1 (Qucs_set_table_for_input, buffer);
407 return buffer;
411 /* Return a list of overlays which is a copy of the overlay list
412 LIST, but for buffer B. */
414 static struct Lisp_Overlay *
415 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
417 Lisp_Object buffer;
418 struct Lisp_Overlay *result = NULL, *tail = NULL;
420 XSETBUFFER (buffer, b);
422 for (; list; list = list->next)
424 Lisp_Object overlay, start, end, old_overlay;
425 EMACS_INT charpos;
427 XSETMISC (old_overlay, list);
428 charpos = marker_position (OVERLAY_START (old_overlay));
429 start = Fmake_marker ();
430 Fset_marker (start, make_number (charpos), buffer);
431 XMARKER (start)->insertion_type
432 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
434 charpos = marker_position (OVERLAY_END (old_overlay));
435 end = Fmake_marker ();
436 Fset_marker (end, make_number (charpos), buffer);
437 XMARKER (end)->insertion_type
438 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
440 overlay = allocate_misc ();
441 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
442 OVERLAY_START (overlay) = start;
443 OVERLAY_END (overlay) = end;
444 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
445 XOVERLAY (overlay)->next = NULL;
447 if (tail)
448 tail = tail->next = XOVERLAY (overlay);
449 else
450 result = tail = XOVERLAY (overlay);
453 return result;
457 /* Clone per-buffer values of buffer FROM.
459 Buffer TO gets the same per-buffer values as FROM, with the
460 following exceptions: (1) TO's name is left untouched, (2) markers
461 are copied and made to refer to TO, and (3) overlay lists are
462 copied. */
464 static void
465 clone_per_buffer_values (struct buffer *from, struct buffer *to)
467 Lisp_Object to_buffer;
468 int offset;
470 XSETBUFFER (to_buffer, to);
472 /* buffer-local Lisp variables start at `undo_list',
473 tho only the ones from `name' on are GC'd normally. */
474 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
475 offset < sizeof *to;
476 offset += sizeof (Lisp_Object))
478 Lisp_Object obj;
480 /* Don't touch the `name' which should be unique for every buffer. */
481 if (offset == PER_BUFFER_VAR_OFFSET (name))
482 continue;
484 obj = PER_BUFFER_VALUE (from, offset);
485 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
487 struct Lisp_Marker *m = XMARKER (obj);
488 obj = Fmake_marker ();
489 XMARKER (obj)->insertion_type = m->insertion_type;
490 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
493 PER_BUFFER_VALUE (to, offset) = obj;
496 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
498 to->overlays_before = copy_overlays (to, from->overlays_before);
499 to->overlays_after = copy_overlays (to, from->overlays_after);
501 /* Get (a copy of) the alist of Lisp-level local variables of FROM
502 and install that in TO. */
503 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
507 /* If buffer B has markers to record PT, BEGV and ZV when it is not
508 current, update these markers. */
510 static void
511 record_buffer_markers (struct buffer *b)
513 if (! NILP (BVAR (b, pt_marker)))
515 Lisp_Object buffer;
517 eassert (!NILP (BVAR (b, begv_marker)));
518 eassert (!NILP (BVAR (b, zv_marker)));
520 XSETBUFFER (buffer, b);
521 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
522 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
523 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
528 /* If buffer B has markers to record PT, BEGV and ZV when it is not
529 current, fetch these values into B->begv etc. */
531 static void
532 fetch_buffer_markers (struct buffer *b)
534 if (! NILP (BVAR (b, pt_marker)))
536 Lisp_Object m;
538 eassert (!NILP (BVAR (b, begv_marker)));
539 eassert (!NILP (BVAR (b, zv_marker)));
541 m = BVAR (b, pt_marker);
542 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
544 m = BVAR (b, begv_marker);
545 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
547 m = BVAR (b, zv_marker);
548 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
553 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
554 2, 3,
555 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
556 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
557 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
558 NAME should be a string which is not the name of an existing buffer.
559 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
560 such as major and minor modes, in the indirect buffer.
561 CLONE nil means the indirect buffer's state is reset to default values. */)
562 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
564 Lisp_Object buf, tem;
565 struct buffer *b;
567 CHECK_STRING (name);
568 buf = Fget_buffer (name);
569 if (!NILP (buf))
570 error ("Buffer name `%s' is in use", SDATA (name));
572 tem = base_buffer;
573 base_buffer = Fget_buffer (base_buffer);
574 if (NILP (base_buffer))
575 error ("No such buffer: `%s'", SDATA (tem));
576 if (NILP (BVAR (XBUFFER (base_buffer), name)))
577 error ("Base buffer has been killed");
579 if (SCHARS (name) == 0)
580 error ("Empty string for buffer name is not allowed");
582 b = allocate_buffer ();
584 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
585 ? XBUFFER (base_buffer)->base_buffer
586 : XBUFFER (base_buffer));
588 /* Use the base buffer's text object. */
589 b->text = b->base_buffer->text;
591 b->pt = b->base_buffer->pt;
592 b->begv = b->base_buffer->begv;
593 b->zv = b->base_buffer->zv;
594 b->pt_byte = b->base_buffer->pt_byte;
595 b->begv_byte = b->base_buffer->begv_byte;
596 b->zv_byte = b->base_buffer->zv_byte;
598 b->newline_cache = 0;
599 b->width_run_cache = 0;
600 BVAR (b, width_table) = Qnil;
602 /* Put this on the chain of all buffers including killed ones. */
603 b->header.next.buffer = all_buffers;
604 all_buffers = b;
606 name = Fcopy_sequence (name);
607 STRING_SET_INTERVALS (name, NULL_INTERVAL);
608 BVAR (b, name) = name;
610 reset_buffer (b);
611 reset_buffer_local_variables (b, 1);
613 /* Put this in the alist of all live buffers. */
614 XSETBUFFER (buf, b);
615 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
617 BVAR (b, mark) = Fmake_marker ();
618 BVAR (b, name) = name;
620 /* The multibyte status belongs to the base buffer. */
621 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
623 /* Make sure the base buffer has markers for its narrowing. */
624 if (NILP (BVAR (b->base_buffer, pt_marker)))
626 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
627 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
629 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
630 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
631 b->base_buffer->pt,
632 b->base_buffer->pt_byte);
634 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
635 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
636 b->base_buffer->begv,
637 b->base_buffer->begv_byte);
639 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
640 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
641 b->base_buffer->zv,
642 b->base_buffer->zv_byte);
643 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
646 if (NILP (clone))
648 /* Give the indirect buffer markers for its narrowing. */
649 BVAR (b, pt_marker) = Fmake_marker ();
650 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
651 BVAR (b, begv_marker) = Fmake_marker ();
652 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
653 BVAR (b, zv_marker) = Fmake_marker ();
654 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
655 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
657 else
659 struct buffer *old_b = current_buffer;
661 clone_per_buffer_values (b->base_buffer, b);
662 BVAR (b, filename) = Qnil;
663 BVAR (b, file_truename) = Qnil;
664 BVAR (b, display_count) = make_number (0);
665 BVAR (b, backed_up) = Qnil;
666 BVAR (b, auto_save_file_name) = Qnil;
667 set_buffer_internal_1 (b);
668 Fset (intern ("buffer-save-without-query"), Qnil);
669 Fset (intern ("buffer-file-number"), Qnil);
670 Fset (intern ("buffer-stale-function"), Qnil);
671 set_buffer_internal_1 (old_b);
674 /* Run buffer-list-update-hook. */
675 if (!NILP (Vrun_hooks))
676 call1 (Vrun_hooks, Qbuffer_list_update_hook);
678 return buf;
681 void
682 delete_all_overlays (struct buffer *b)
684 Lisp_Object overlay;
686 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
687 have to empty the list, otherwise we end up with overlays that
688 think they belong to this buffer while the buffer doesn't know about
689 them any more. */
690 while (b->overlays_before)
692 XSETMISC (overlay, b->overlays_before);
693 Fdelete_overlay (overlay);
695 while (b->overlays_after)
697 XSETMISC (overlay, b->overlays_after);
698 Fdelete_overlay (overlay);
700 eassert (b->overlays_before == NULL);
701 eassert (b->overlays_after == NULL);
704 /* Reinitialize everything about a buffer except its name and contents
705 and local variables.
706 If called on an already-initialized buffer, the list of overlays
707 should be deleted before calling this function, otherwise we end up
708 with overlays that claim to belong to the buffer but the buffer
709 claims it doesn't belong to it. */
711 void
712 reset_buffer (register struct buffer *b)
714 BVAR (b, filename) = Qnil;
715 BVAR (b, file_truename) = Qnil;
716 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
717 b->modtime = 0;
718 b->modtime_size = -1;
719 XSETFASTINT (BVAR (b, save_length), 0);
720 b->last_window_start = 1;
721 /* It is more conservative to start out "changed" than "unchanged". */
722 b->clip_changed = 0;
723 b->prevent_redisplay_optimizations_p = 1;
724 BVAR (b, backed_up) = Qnil;
725 BUF_AUTOSAVE_MODIFF (b) = 0;
726 b->auto_save_failure_time = -1;
727 BVAR (b, auto_save_file_name) = Qnil;
728 BVAR (b, read_only) = Qnil;
729 b->overlays_before = NULL;
730 b->overlays_after = NULL;
731 b->overlay_center = BEG;
732 BVAR (b, mark_active) = Qnil;
733 BVAR (b, point_before_scroll) = Qnil;
734 BVAR (b, file_format) = Qnil;
735 BVAR (b, auto_save_file_format) = Qt;
736 BVAR (b, last_selected_window) = Qnil;
737 XSETINT (BVAR (b, display_count), 0);
738 BVAR (b, display_time) = Qnil;
739 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
740 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
741 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
743 b->display_error_modiff = 0;
746 /* Reset buffer B's local variables info.
747 Don't use this on a buffer that has already been in use;
748 it does not treat permanent locals consistently.
749 Instead, use Fkill_all_local_variables.
751 If PERMANENT_TOO is 1, then we reset permanent
752 buffer-local variables. If PERMANENT_TOO is 0,
753 we preserve those. */
755 static void
756 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
758 register int offset;
759 int i;
761 /* Reset the major mode to Fundamental, together with all the
762 things that depend on the major mode.
763 default-major-mode is handled at a higher level.
764 We ignore it here. */
765 BVAR (b, major_mode) = Qfundamental_mode;
766 BVAR (b, keymap) = Qnil;
767 BVAR (b, mode_name) = QSFundamental;
768 BVAR (b, minor_modes) = Qnil;
770 /* If the standard case table has been altered and invalidated,
771 fix up its insides first. */
772 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
773 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
774 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
775 Fset_standard_case_table (Vascii_downcase_table);
777 BVAR (b, downcase_table) = Vascii_downcase_table;
778 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
779 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
780 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
781 BVAR (b, invisibility_spec) = Qt;
783 /* Reset all (or most) per-buffer variables to their defaults. */
784 if (permanent_too)
785 BVAR (b, local_var_alist) = Qnil;
786 else
788 Lisp_Object tmp, prop, last = Qnil;
789 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
790 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
792 /* If permanent-local, keep it. */
793 last = tmp;
794 if (EQ (prop, Qpermanent_local_hook))
796 /* This is a partially permanent hook variable.
797 Preserve only the elements that want to be preserved. */
798 Lisp_Object list, newlist;
799 list = XCDR (XCAR (tmp));
800 if (!CONSP (list))
801 newlist = list;
802 else
803 for (newlist = Qnil; CONSP (list); list = XCDR (list))
805 Lisp_Object elt = XCAR (list);
806 /* Preserve element ELT if it's t,
807 if it is a function with a `permanent-local-hook' property,
808 or if it's not a symbol. */
809 if (! SYMBOLP (elt)
810 || EQ (elt, Qt)
811 || !NILP (Fget (elt, Qpermanent_local_hook)))
812 newlist = Fcons (elt, newlist);
814 XSETCDR (XCAR (tmp), Fnreverse (newlist));
817 /* Delete this local variable. */
818 else if (NILP (last))
819 BVAR (b, local_var_alist) = XCDR (tmp);
820 else
821 XSETCDR (last, XCDR (tmp));
824 for (i = 0; i < last_per_buffer_idx; ++i)
825 if (permanent_too || buffer_permanent_local_flags[i] == 0)
826 SET_PER_BUFFER_VALUE_P (b, i, 0);
828 /* For each slot that has a default value,
829 copy that into the slot. */
831 /* buffer-local Lisp variables start at `undo_list',
832 tho only the ones from `name' on are GC'd normally. */
833 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
834 offset < sizeof *b;
835 offset += sizeof (Lisp_Object))
837 int idx = PER_BUFFER_IDX (offset);
838 if ((idx > 0
839 && (permanent_too
840 || buffer_permanent_local_flags[idx] == 0)))
841 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
845 /* We split this away from generate-new-buffer, because rename-buffer
846 and set-visited-file-name ought to be able to use this to really
847 rename the buffer properly. */
849 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
850 Sgenerate_new_buffer_name, 1, 2, 0,
851 doc: /* Return a string that is the name of no existing buffer based on NAME.
852 If there is no live buffer named NAME, then return NAME.
853 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
854 \(starting at 2) until an unused name is found, and then return that name.
855 Optional second argument IGNORE specifies a name that is okay to use (if
856 it is in the sequence to be tried) even if a buffer with that name exists. */)
857 (register Lisp_Object name, Lisp_Object ignore)
859 register Lisp_Object gentemp, tem;
860 EMACS_INT count;
861 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
863 CHECK_STRING (name);
865 tem = Fstring_equal (name, ignore);
866 if (!NILP (tem))
867 return name;
868 tem = Fget_buffer (name);
869 if (NILP (tem))
870 return name;
872 count = 1;
873 while (1)
875 sprintf (number, "<%"pI"d>", ++count);
876 gentemp = concat2 (name, build_string (number));
877 tem = Fstring_equal (gentemp, ignore);
878 if (!NILP (tem))
879 return gentemp;
880 tem = Fget_buffer (gentemp);
881 if (NILP (tem))
882 return gentemp;
887 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
888 doc: /* Return the name of BUFFER, as a string.
889 BUFFER defaults to the current buffer.
890 Return nil if BUFFER has been killed. */)
891 (register Lisp_Object buffer)
893 if (NILP (buffer))
894 return BVAR (current_buffer, name);
895 CHECK_BUFFER (buffer);
896 return BVAR (XBUFFER (buffer), name);
899 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
900 doc: /* Return name of file BUFFER is visiting, or nil if none.
901 No argument or nil as argument means use the current buffer. */)
902 (register Lisp_Object buffer)
904 if (NILP (buffer))
905 return BVAR (current_buffer, filename);
906 CHECK_BUFFER (buffer);
907 return BVAR (XBUFFER (buffer), filename);
910 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
911 0, 1, 0,
912 doc: /* Return the base buffer of indirect buffer BUFFER.
913 If BUFFER is not indirect, return nil.
914 BUFFER defaults to the current buffer. */)
915 (register Lisp_Object buffer)
917 struct buffer *base;
918 Lisp_Object base_buffer;
920 if (NILP (buffer))
921 base = current_buffer->base_buffer;
922 else
924 CHECK_BUFFER (buffer);
925 base = XBUFFER (buffer)->base_buffer;
928 if (! base)
929 return Qnil;
930 XSETBUFFER (base_buffer, base);
931 return base_buffer;
934 DEFUN ("buffer-local-value", Fbuffer_local_value,
935 Sbuffer_local_value, 2, 2, 0,
936 doc: /* Return the value of VARIABLE in BUFFER.
937 If VARIABLE does not have a buffer-local binding in BUFFER, the value
938 is the default binding of the variable. */)
939 (register Lisp_Object variable, register Lisp_Object buffer)
941 register struct buffer *buf;
942 register Lisp_Object result;
943 struct Lisp_Symbol *sym;
945 CHECK_SYMBOL (variable);
946 CHECK_BUFFER (buffer);
947 buf = XBUFFER (buffer);
948 sym = XSYMBOL (variable);
950 start:
951 switch (sym->redirect)
953 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
954 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
955 case SYMBOL_LOCALIZED:
956 { /* Look in local_var_alist. */
957 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
958 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
959 result = Fassoc (variable, BVAR (buf, local_var_alist));
960 if (!NILP (result))
962 if (blv->fwd)
963 { /* What binding is loaded right now? */
964 Lisp_Object current_alist_element = blv->valcell;
966 /* The value of the currently loaded binding is not
967 stored in it, but rather in the realvalue slot.
968 Store that value into the binding it belongs to
969 in case that is the one we are about to use. */
971 XSETCDR (current_alist_element,
972 do_symval_forwarding (blv->fwd));
974 /* Now get the (perhaps updated) value out of the binding. */
975 result = XCDR (result);
977 else
978 result = Fdefault_value (variable);
979 break;
981 case SYMBOL_FORWARDED:
983 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
984 if (BUFFER_OBJFWDP (fwd))
985 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
986 else
987 result = Fdefault_value (variable);
988 break;
990 default: abort ();
993 if (!EQ (result, Qunbound))
994 return result;
996 xsignal1 (Qvoid_variable, variable);
999 /* Return an alist of the Lisp-level buffer-local bindings of
1000 buffer BUF. That is, don't include the variables maintained
1001 in special slots in the buffer object. */
1003 static Lisp_Object
1004 buffer_lisp_local_variables (struct buffer *buf)
1006 Lisp_Object result = Qnil;
1007 register Lisp_Object tail;
1008 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1010 Lisp_Object val, elt;
1012 elt = XCAR (tail);
1014 /* Reference each variable in the alist in buf.
1015 If inquiring about the current buffer, this gets the current values,
1016 so store them into the alist so the alist is up to date.
1017 If inquiring about some other buffer, this swaps out any values
1018 for that buffer, making the alist up to date automatically. */
1019 val = find_symbol_value (XCAR (elt));
1020 /* Use the current buffer value only if buf is the current buffer. */
1021 if (buf != current_buffer)
1022 val = XCDR (elt);
1024 result = Fcons (Fcons (XCAR (elt), val), result);
1027 return result;
1030 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1031 Sbuffer_local_variables, 0, 1, 0,
1032 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1033 Most elements look like (SYMBOL . VALUE), describing one variable.
1034 For a symbol that is locally unbound, just the symbol appears in the value.
1035 Note that storing new VALUEs in these elements doesn't change the variables.
1036 No argument or nil as argument means use current buffer as BUFFER. */)
1037 (register Lisp_Object buffer)
1039 register struct buffer *buf;
1040 register Lisp_Object result;
1042 if (NILP (buffer))
1043 buf = current_buffer;
1044 else
1046 CHECK_BUFFER (buffer);
1047 buf = XBUFFER (buffer);
1050 result = buffer_lisp_local_variables (buf);
1052 /* Add on all the variables stored in special slots. */
1054 int offset, idx;
1056 /* buffer-local Lisp variables start at `undo_list',
1057 tho only the ones from `name' on are GC'd normally. */
1058 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
1059 offset < sizeof (struct buffer);
1060 /* sizeof EMACS_INT == sizeof Lisp_Object */
1061 offset += (sizeof (EMACS_INT)))
1063 idx = PER_BUFFER_IDX (offset);
1064 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1065 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1066 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1067 PER_BUFFER_VALUE (buf, offset)),
1068 result);
1072 return result;
1075 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1076 0, 1, 0,
1077 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1078 No argument or nil as argument means use current buffer as BUFFER. */)
1079 (register Lisp_Object buffer)
1081 register struct buffer *buf;
1082 if (NILP (buffer))
1083 buf = current_buffer;
1084 else
1086 CHECK_BUFFER (buffer);
1087 buf = XBUFFER (buffer);
1090 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1093 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1094 1, 1, 0,
1095 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1096 A non-nil FLAG means mark the buffer modified. */)
1097 (register Lisp_Object flag)
1099 register int already;
1100 register Lisp_Object fn;
1101 Lisp_Object buffer, window;
1103 #ifdef CLASH_DETECTION
1104 /* If buffer becoming modified, lock the file.
1105 If buffer becoming unmodified, unlock the file. */
1107 fn = BVAR (current_buffer, file_truename);
1108 /* Test buffer-file-name so that binding it to nil is effective. */
1109 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1111 already = SAVE_MODIFF < MODIFF;
1112 if (!already && !NILP (flag))
1113 lock_file (fn);
1114 else if (already && NILP (flag))
1115 unlock_file (fn);
1117 #endif /* CLASH_DETECTION */
1119 /* Here we have a problem. SAVE_MODIFF is used here to encode
1120 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1121 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1122 modify SAVE_MODIFF to affect one, we may affect the other
1123 as well.
1124 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1125 if SAVE_MODIFF<auto_save_modified that means we risk changing
1126 recent-auto-save-p from t to nil.
1127 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1128 we risk changing recent-auto-save-p from nil to t. */
1129 SAVE_MODIFF = (NILP (flag)
1130 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1131 ? MODIFF
1132 /* Let's try to preserve recent-auto-save-p. */
1133 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1134 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1135 we can either decrease SAVE_MODIFF and auto_save_modified
1136 or increase MODIFF. */
1137 : MODIFF++);
1139 /* Set update_mode_lines only if buffer is displayed in some window.
1140 Packages like jit-lock or lazy-lock preserve a buffer's modified
1141 state by recording/restoring the state around blocks of code.
1142 Setting update_mode_lines makes redisplay consider all windows
1143 (on all frames). Stealth fontification of buffers not displayed
1144 would incur additional redisplay costs if we'd set
1145 update_modes_lines unconditionally.
1147 Ideally, I think there should be another mechanism for fontifying
1148 buffers without "modifying" buffers, or redisplay should be
1149 smarter about updating the `*' in mode lines. --gerd */
1150 XSETBUFFER (buffer, current_buffer);
1151 window = Fget_buffer_window (buffer, Qt);
1152 if (WINDOWP (window))
1154 ++update_mode_lines;
1155 current_buffer->prevent_redisplay_optimizations_p = 1;
1158 return flag;
1161 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1162 Srestore_buffer_modified_p, 1, 1, 0,
1163 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1164 It is not ensured that mode lines will be updated to show the modified
1165 state of the current buffer. Use with care. */)
1166 (Lisp_Object flag)
1168 #ifdef CLASH_DETECTION
1169 Lisp_Object fn;
1171 /* If buffer becoming modified, lock the file.
1172 If buffer becoming unmodified, unlock the file. */
1174 fn = BVAR (current_buffer, file_truename);
1175 /* Test buffer-file-name so that binding it to nil is effective. */
1176 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1178 int already = SAVE_MODIFF < MODIFF;
1179 if (!already && !NILP (flag))
1180 lock_file (fn);
1181 else if (already && NILP (flag))
1182 unlock_file (fn);
1184 #endif /* CLASH_DETECTION */
1186 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1187 return flag;
1190 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1191 0, 1, 0,
1192 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1193 Each buffer has a tick counter which is incremented each time the
1194 text in that buffer is changed. It wraps around occasionally.
1195 No argument or nil as argument means use current buffer as BUFFER. */)
1196 (register Lisp_Object buffer)
1198 register struct buffer *buf;
1199 if (NILP (buffer))
1200 buf = current_buffer;
1201 else
1203 CHECK_BUFFER (buffer);
1204 buf = XBUFFER (buffer);
1207 return make_number (BUF_MODIFF (buf));
1210 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1211 Sbuffer_chars_modified_tick, 0, 1, 0,
1212 doc: /* Return BUFFER's character-change tick counter.
1213 Each buffer has a character-change tick counter, which is set to the
1214 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1215 time text in that buffer is inserted or deleted. By comparing the
1216 values returned by two individual calls of `buffer-chars-modified-tick',
1217 you can tell whether a character change occurred in that buffer in
1218 between these calls. No argument or nil as argument means use current
1219 buffer as BUFFER. */)
1220 (register Lisp_Object buffer)
1222 register struct buffer *buf;
1223 if (NILP (buffer))
1224 buf = current_buffer;
1225 else
1227 CHECK_BUFFER (buffer);
1228 buf = XBUFFER (buffer);
1231 return make_number (BUF_CHARS_MODIFF (buf));
1234 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1235 "(list (read-string \"Rename buffer (to new name): \" \
1236 nil 'buffer-name-history (buffer-name (current-buffer))) \
1237 current-prefix-arg)",
1238 doc: /* Change current buffer's name to NEWNAME (a string).
1239 If second arg UNIQUE is nil or omitted, it is an error if a
1240 buffer named NEWNAME already exists.
1241 If UNIQUE is non-nil, come up with a new name using
1242 `generate-new-buffer-name'.
1243 Interactively, you can set UNIQUE with a prefix argument.
1244 We return the name we actually gave the buffer.
1245 This does not change the name of the visited file (if any). */)
1246 (register Lisp_Object newname, Lisp_Object unique)
1248 register Lisp_Object tem, buf;
1250 CHECK_STRING (newname);
1252 if (SCHARS (newname) == 0)
1253 error ("Empty string is invalid as a buffer name");
1255 tem = Fget_buffer (newname);
1256 if (!NILP (tem))
1258 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1259 rename the buffer automatically so you can create another
1260 with the original name. It makes UNIQUE equivalent to
1261 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1262 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1263 return BVAR (current_buffer, name);
1264 if (!NILP (unique))
1265 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1266 else
1267 error ("Buffer name `%s' is in use", SDATA (newname));
1270 BVAR (current_buffer, name) = newname;
1272 /* Catch redisplay's attention. Unless we do this, the mode lines for
1273 any windows displaying current_buffer will stay unchanged. */
1274 update_mode_lines++;
1276 XSETBUFFER (buf, current_buffer);
1277 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1278 if (NILP (BVAR (current_buffer, filename))
1279 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1280 call0 (intern ("rename-auto-save-file"));
1282 /* Run buffer-list-update-hook. */
1283 if (!NILP (Vrun_hooks))
1284 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1286 /* Refetch since that last call may have done GC. */
1287 return BVAR (current_buffer, name);
1290 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1291 doc: /* Return most recently selected buffer other than BUFFER.
1292 Buffers not visible in windows are preferred to visible buffers, unless
1293 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1294 BUFFER unless it denotes a live buffer. If the optional third argument
1295 FRAME is non-nil, use that frame's buffer list instead of the selected
1296 frame's buffer list.
1298 The buffer is found by scanning the selected or specified frame's buffer
1299 list first, followed by the list of all buffers. If no other buffer
1300 exists, return the buffer `*scratch*' (creating it if necessary). */)
1301 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1303 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1304 Lisp_Object tail, buf, pred;
1305 Lisp_Object notsogood = Qnil;
1307 if (NILP (frame))
1308 frame = selected_frame;
1310 CHECK_FRAME (frame);
1312 pred = frame_buffer_predicate (frame);
1313 /* Consider buffers that have been seen in the frame first. */
1314 tail = XFRAME (frame)->buffer_list;
1315 for (; CONSP (tail); tail = XCDR (tail))
1317 buf = XCAR (tail);
1318 if (BUFFERP (buf) && !EQ (buf, buffer)
1319 && !NILP (BVAR (XBUFFER (buf), name))
1320 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1321 /* If the frame has a buffer_predicate, disregard buffers that
1322 don't fit the predicate. */
1323 && (NILP (pred) || !NILP (call1 (pred, buf))))
1325 if (!NILP (visible_ok)
1326 || NILP (Fget_buffer_window (buf, Qvisible)))
1327 return buf;
1328 else if (NILP (notsogood))
1329 notsogood = buf;
1333 /* Consider alist of all buffers next. */
1334 tail = Vbuffer_alist;
1335 for (; CONSP (tail); tail = XCDR (tail))
1337 buf = Fcdr (XCAR (tail));
1338 if (BUFFERP (buf) && !EQ (buf, buffer)
1339 && !NILP (BVAR (XBUFFER (buf), name))
1340 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1341 /* If the frame has a buffer_predicate, disregard buffers that
1342 don't fit the predicate. */
1343 && (NILP (pred) || !NILP (call1 (pred, buf))))
1345 if (!NILP (visible_ok)
1346 || NILP (Fget_buffer_window (buf, Qvisible)))
1347 return buf;
1348 else if (NILP (notsogood))
1349 notsogood = buf;
1353 if (!NILP (notsogood))
1354 return notsogood;
1355 else
1357 buf = Fget_buffer (build_string ("*scratch*"));
1358 if (NILP (buf))
1360 buf = Fget_buffer_create (build_string ("*scratch*"));
1361 Fset_buffer_major_mode (buf);
1363 return buf;
1367 /* The following function is a safe variant of Fother_buffer: It doesn't
1368 pay attention to any frame-local buffer lists, doesn't care about
1369 visibility of buffers, and doesn't evaluate any frame predicates. */
1371 Lisp_Object
1372 other_buffer_safely (Lisp_Object buffer)
1374 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1375 Lisp_Object tail, buf;
1377 tail = Vbuffer_alist;
1378 for (; CONSP (tail); tail = XCDR (tail))
1380 buf = Fcdr (XCAR (tail));
1381 if (BUFFERP (buf) && !EQ (buf, buffer)
1382 && !NILP (BVAR (XBUFFER (buf), name))
1383 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1384 return buf;
1387 buf = Fget_buffer (build_string ("*scratch*"));
1388 if (NILP (buf))
1390 buf = Fget_buffer_create (build_string ("*scratch*"));
1391 Fset_buffer_major_mode (buf);
1394 return buf;
1397 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1398 0, 1, "",
1399 doc: /* Start keeping undo information for buffer BUFFER.
1400 No argument or nil as argument means do this for the current buffer. */)
1401 (register Lisp_Object buffer)
1403 Lisp_Object real_buffer;
1405 if (NILP (buffer))
1406 XSETBUFFER (real_buffer, current_buffer);
1407 else
1409 real_buffer = Fget_buffer (buffer);
1410 if (NILP (real_buffer))
1411 nsberror (buffer);
1414 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1415 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1417 return Qnil;
1421 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1422 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1423 The buffer being killed will be current while the hook is running.\n\
1424 See `kill-buffer'."
1426 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1427 doc: /* Kill buffer BUFFER-OR-NAME.
1428 The argument may be a buffer or the name of an existing buffer.
1429 Argument nil or omitted means kill the current buffer. Return t if the
1430 buffer is actually killed, nil otherwise.
1432 This function calls `replace-buffer-in-windows' for cleaning up all
1433 windows currently displaying the buffer to be killed. The functions in
1434 `kill-buffer-query-functions' are called with the buffer to be killed as
1435 the current buffer. If any of them returns nil, the buffer is not
1436 killed. The hook `kill-buffer-hook' is run before the buffer is
1437 actually killed. The buffer being killed will be current while the hook
1438 is running.
1440 Any processes that have this buffer as the `process-buffer' are killed
1441 with SIGHUP. */)
1442 (Lisp_Object buffer_or_name)
1444 Lisp_Object buffer;
1445 register struct buffer *b;
1446 register Lisp_Object tem;
1447 register struct Lisp_Marker *m;
1448 struct gcpro gcpro1;
1450 if (NILP (buffer_or_name))
1451 buffer = Fcurrent_buffer ();
1452 else
1453 buffer = Fget_buffer (buffer_or_name);
1454 if (NILP (buffer))
1455 nsberror (buffer_or_name);
1457 b = XBUFFER (buffer);
1459 /* Avoid trouble for buffer already dead. */
1460 if (NILP (BVAR (b, name)))
1461 return Qnil;
1463 /* Query if the buffer is still modified. */
1464 if (INTERACTIVE && !NILP (BVAR (b, filename))
1465 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1467 GCPRO1 (buffer);
1468 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1469 BVAR (b, name), make_number (0)));
1470 UNGCPRO;
1471 if (NILP (tem))
1472 return Qnil;
1475 /* Run hooks with the buffer to be killed the current buffer. */
1477 int count = SPECPDL_INDEX ();
1478 Lisp_Object arglist[1];
1480 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1481 set_buffer_internal (b);
1483 /* First run the query functions; if any query is answered no,
1484 don't kill the buffer. */
1485 arglist[0] = Qkill_buffer_query_functions;
1486 tem = Frun_hook_with_args_until_failure (1, arglist);
1487 if (NILP (tem))
1488 return unbind_to (count, Qnil);
1490 /* Then run the hooks. */
1491 Frun_hooks (1, &Qkill_buffer_hook);
1492 unbind_to (count, Qnil);
1495 /* We have no more questions to ask. Verify that it is valid
1496 to kill the buffer. This must be done after the questions
1497 since anything can happen within do_yes_or_no_p. */
1499 /* Don't kill the minibuffer now current. */
1500 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1501 return Qnil;
1503 if (NILP (BVAR (b, name)))
1504 return Qnil;
1506 /* When we kill a base buffer, kill all its indirect buffers.
1507 We do it at this stage so nothing terrible happens if they
1508 ask questions or their hooks get errors. */
1509 if (! b->base_buffer)
1511 struct buffer *other;
1513 GCPRO1 (buffer);
1515 for (other = all_buffers; other; other = other->header.next.buffer)
1516 /* all_buffers contains dead buffers too;
1517 don't re-kill them. */
1518 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1520 Lisp_Object buf;
1521 XSETBUFFER (buf, other);
1522 Fkill_buffer (buf);
1525 UNGCPRO;
1528 /* Make this buffer not be current.
1529 In the process, notice if this is the sole visible buffer
1530 and give up if so. */
1531 if (b == current_buffer)
1533 tem = Fother_buffer (buffer, Qnil, Qnil);
1534 Fset_buffer (tem);
1535 if (b == current_buffer)
1536 return Qnil;
1539 /* Notice if the buffer to kill is the sole visible buffer
1540 when we're currently in the mini-buffer, and give up if so. */
1541 XSETBUFFER (tem, current_buffer);
1542 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1544 tem = Fother_buffer (buffer, Qnil, Qnil);
1545 if (EQ (buffer, tem))
1546 return Qnil;
1549 /* Now there is no question: we can kill the buffer. */
1551 #ifdef CLASH_DETECTION
1552 /* Unlock this buffer's file, if it is locked. */
1553 unlock_buffer (b);
1554 #endif /* CLASH_DETECTION */
1556 GCPRO1 (buffer);
1557 kill_buffer_processes (buffer);
1558 UNGCPRO;
1560 /* Killing buffer processes may run sentinels which may
1561 have called kill-buffer. */
1563 if (NILP (BVAR (b, name)))
1564 return Qnil;
1566 /* These may run Lisp code and into infinite loops (if someone
1567 insisted on circular lists) so allow quitting here. */
1568 replace_buffer_in_windows (buffer);
1569 frames_discard_buffer (buffer);
1571 clear_charpos_cache (b);
1573 tem = Vinhibit_quit;
1574 Vinhibit_quit = Qt;
1575 /* Remove the buffer from the list of all buffers. */
1576 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1577 /* If replace_buffer_in_windows didn't do its job correctly fix that
1578 now. */
1579 replace_buffer_in_windows_safely (buffer);
1580 Vinhibit_quit = tem;
1582 /* Delete any auto-save file, if we saved it in this session.
1583 But not if the buffer is modified. */
1584 if (STRINGP (BVAR (b, auto_save_file_name))
1585 && BUF_AUTOSAVE_MODIFF (b) != 0
1586 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1587 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1588 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1590 Lisp_Object delete;
1591 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1592 if (! NILP (delete))
1593 internal_delete_file (BVAR (b, auto_save_file_name));
1596 if (b->base_buffer)
1598 /* Unchain all markers that belong to this indirect buffer.
1599 Don't unchain the markers that belong to the base buffer
1600 or its other indirect buffers. */
1601 for (m = BUF_MARKERS (b); m; )
1603 struct Lisp_Marker *next = m->next;
1604 if (m->buffer == b)
1605 unchain_marker (m);
1606 m = next;
1609 else
1611 /* Unchain all markers of this buffer and its indirect buffers.
1612 and leave them pointing nowhere. */
1613 for (m = BUF_MARKERS (b); m; )
1615 struct Lisp_Marker *next = m->next;
1616 m->buffer = 0;
1617 m->next = NULL;
1618 m = next;
1620 BUF_MARKERS (b) = NULL;
1621 BUF_INTERVALS (b) = NULL_INTERVAL;
1623 /* Perhaps we should explicitly free the interval tree here... */
1626 /* Reset the local variables, so that this buffer's local values
1627 won't be protected from GC. They would be protected
1628 if they happened to remain encached in their symbols.
1629 This gets rid of them for certain. */
1630 swap_out_buffer_local_variables (b);
1631 reset_buffer_local_variables (b, 1);
1633 BVAR (b, name) = Qnil;
1635 BLOCK_INPUT;
1636 if (! b->base_buffer)
1637 free_buffer_text (b);
1639 if (b->newline_cache)
1641 free_region_cache (b->newline_cache);
1642 b->newline_cache = 0;
1644 if (b->width_run_cache)
1646 free_region_cache (b->width_run_cache);
1647 b->width_run_cache = 0;
1649 BVAR (b, width_table) = Qnil;
1650 UNBLOCK_INPUT;
1651 BVAR (b, undo_list) = Qnil;
1653 /* Run buffer-list-update-hook. */
1654 if (!NILP (Vrun_hooks))
1655 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1657 return Qt;
1660 /* Move association for BUFFER to the front of buffer (a)lists. Since
1661 we do this each time BUFFER is selected visibly, the more recently
1662 selected buffers are always closer to the front of those lists. This
1663 means that other_buffer is more likely to choose a relevant buffer.
1665 Note that this moves BUFFER to the front of the buffer lists of the
1666 selected frame even if BUFFER is not shown there. If BUFFER is not
1667 shown in the selected frame, consider the present behavior a feature.
1668 `select-window' gets this right since it shows BUFFER in the selected
1669 window when calling us. */
1671 void
1672 record_buffer (Lisp_Object buffer)
1674 Lisp_Object aelt, aelt_cons, tem;
1675 register struct frame *f = XFRAME (selected_frame);
1677 CHECK_BUFFER (buffer);
1679 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1680 Don't allow quitting since this might leave the buffer list in an
1681 inconsistent state. */
1682 tem = Vinhibit_quit;
1683 Vinhibit_quit = Qt;
1684 aelt = Frassq (buffer, Vbuffer_alist);
1685 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1686 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1687 XSETCDR (aelt_cons, Vbuffer_alist);
1688 Vbuffer_alist = aelt_cons;
1689 Vinhibit_quit = tem;
1691 /* Update buffer list of selected frame. */
1692 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1693 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1695 /* Run buffer-list-update-hook. */
1696 if (!NILP (Vrun_hooks))
1697 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1700 DEFUN ("record-buffer", Frecord_buffer, Srecord_buffer, 1, 1, 0,
1701 doc: /* Move BUFFER to the front of the buffer list.
1702 Return BUFFER. */)
1703 (Lisp_Object buffer)
1705 CHECK_BUFFER (buffer);
1707 record_buffer (buffer);
1709 return buffer;
1712 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1713 buffer is killed. For the selected frame's buffer list this moves
1714 BUFFER to its end even if it was never shown in that frame. If
1715 this happens we have a feature, hence `unrecord-buffer' should be
1716 called only when BUFFER was shown in the selected frame. */
1718 DEFUN ("unrecord-buffer", Funrecord_buffer, Sunrecord_buffer, 1, 1, 0,
1719 doc: /* Move BUFFER to the end of the buffer list.
1720 Return BUFFER. */)
1721 (Lisp_Object buffer)
1723 Lisp_Object aelt, aelt_cons, tem;
1724 register struct frame *f = XFRAME (selected_frame);
1726 CHECK_BUFFER (buffer);
1728 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1729 Don't allow quitting since this might leave the buffer list in an
1730 inconsistent state. */
1731 tem = Vinhibit_quit;
1732 Vinhibit_quit = Qt;
1733 aelt = Frassq (buffer, Vbuffer_alist);
1734 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1735 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1736 XSETCDR (aelt_cons, Qnil);
1737 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1738 Vinhibit_quit = tem;
1740 /* Update buffer lists of selected frame. */
1741 f->buffer_list = Fdelq (buffer, f->buffer_list);
1742 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1744 /* Run buffer-list-update-hook. */
1745 if (!NILP (Vrun_hooks))
1746 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1748 return buffer;
1751 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1752 doc: /* Set an appropriate major mode for BUFFER.
1753 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1754 according to `default-major-mode'.
1755 Use this function before selecting the buffer, since it may need to inspect
1756 the current buffer's major mode. */)
1757 (Lisp_Object buffer)
1759 int count;
1760 Lisp_Object function;
1762 CHECK_BUFFER (buffer);
1764 if (STRINGP (BVAR (XBUFFER (buffer), name))
1765 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1766 function = find_symbol_value (intern ("initial-major-mode"));
1767 else
1769 function = BVAR (&buffer_defaults, major_mode);
1770 if (NILP (function)
1771 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1772 function = BVAR (current_buffer, major_mode);
1775 if (NILP (function) || EQ (function, Qfundamental_mode))
1776 return Qnil;
1778 count = SPECPDL_INDEX ();
1780 /* To select a nonfundamental mode,
1781 select the buffer temporarily and then call the mode function. */
1783 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1785 Fset_buffer (buffer);
1786 call0 (function);
1788 return unbind_to (count, Qnil);
1791 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1792 doc: /* Return the current buffer as a Lisp object. */)
1793 (void)
1795 register Lisp_Object buf;
1796 XSETBUFFER (buf, current_buffer);
1797 return buf;
1800 /* Set the current buffer to B.
1802 We previously set windows_or_buffers_changed here to invalidate
1803 global unchanged information in beg_unchanged and end_unchanged.
1804 This is no longer necessary because we now compute unchanged
1805 information on a buffer-basis. Every action affecting other
1806 windows than the selected one requires a select_window at some
1807 time, and that increments windows_or_buffers_changed. */
1809 void
1810 set_buffer_internal (register struct buffer *b)
1812 if (current_buffer != b)
1813 set_buffer_internal_1 (b);
1816 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1817 This is used by redisplay. */
1819 void
1820 set_buffer_internal_1 (register struct buffer *b)
1822 register struct buffer *old_buf;
1823 register Lisp_Object tail;
1825 #ifdef USE_MMAP_FOR_BUFFERS
1826 if (b->text->beg == NULL)
1827 enlarge_buffer_text (b, 0);
1828 #endif /* USE_MMAP_FOR_BUFFERS */
1830 if (current_buffer == b)
1831 return;
1833 old_buf = current_buffer;
1834 current_buffer = b;
1835 last_known_column_point = -1; /* invalidate indentation cache */
1837 if (old_buf)
1839 /* Put the undo list back in the base buffer, so that it appears
1840 that an indirect buffer shares the undo list of its base. */
1841 if (old_buf->base_buffer)
1842 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1844 /* If the old current buffer has markers to record PT, BEGV and ZV
1845 when it is not current, update them now. */
1846 record_buffer_markers (old_buf);
1849 /* Get the undo list from the base buffer, so that it appears
1850 that an indirect buffer shares the undo list of its base. */
1851 if (b->base_buffer)
1852 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1854 /* If the new current buffer has markers to record PT, BEGV and ZV
1855 when it is not current, fetch them now. */
1856 fetch_buffer_markers (b);
1858 /* Look down buffer's list of local Lisp variables
1859 to find and update any that forward into C variables. */
1863 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1865 Lisp_Object var = XCAR (XCAR (tail));
1866 struct Lisp_Symbol *sym = XSYMBOL (var);
1867 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1868 && SYMBOL_BLV (sym)->fwd)
1869 /* Just reference the variable
1870 to cause it to become set for this buffer. */
1871 Fsymbol_value (var);
1874 /* Do the same with any others that were local to the previous buffer */
1875 while (b != old_buf && (b = old_buf, b));
1878 /* Switch to buffer B temporarily for redisplay purposes.
1879 This avoids certain things that don't need to be done within redisplay. */
1881 void
1882 set_buffer_temp (struct buffer *b)
1884 register struct buffer *old_buf;
1886 if (current_buffer == b)
1887 return;
1889 old_buf = current_buffer;
1890 current_buffer = b;
1892 /* If the old current buffer has markers to record PT, BEGV and ZV
1893 when it is not current, update them now. */
1894 record_buffer_markers (old_buf);
1896 /* If the new current buffer has markers to record PT, BEGV and ZV
1897 when it is not current, fetch them now. */
1898 fetch_buffer_markers (b);
1901 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1902 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1903 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1904 also `save-excursion' when you want to make a buffer current
1905 temporarily. This function does not display the buffer, so its effect
1906 ends when the current command terminates. Use `switch-to-buffer' or
1907 `pop-to-buffer' to switch buffers permanently. */)
1908 (register Lisp_Object buffer_or_name)
1910 register Lisp_Object buffer;
1911 buffer = Fget_buffer (buffer_or_name);
1912 if (NILP (buffer))
1913 nsberror (buffer_or_name);
1914 if (NILP (BVAR (XBUFFER (buffer), name)))
1915 error ("Selecting deleted buffer");
1916 set_buffer_internal (XBUFFER (buffer));
1917 return buffer;
1920 /* Set the current buffer to BUFFER provided it is alive. */
1922 Lisp_Object
1923 set_buffer_if_live (Lisp_Object buffer)
1925 if (! NILP (BVAR (XBUFFER (buffer), name)))
1926 Fset_buffer (buffer);
1927 return Qnil;
1930 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1931 Sbarf_if_buffer_read_only, 0, 0, 0,
1932 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1933 (void)
1935 if (!NILP (BVAR (current_buffer, read_only))
1936 && NILP (Vinhibit_read_only))
1937 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1938 return Qnil;
1941 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1942 doc: /* Delete the entire contents of the current buffer.
1943 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1944 so the buffer is truly empty after this. */)
1945 (void)
1947 Fwiden ();
1949 del_range (BEG, Z);
1951 current_buffer->last_window_start = 1;
1952 /* Prevent warnings, or suspension of auto saving, that would happen
1953 if future size is less than past size. Use of erase-buffer
1954 implies that the future text is not really related to the past text. */
1955 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1956 return Qnil;
1959 void
1960 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1962 CHECK_NUMBER_COERCE_MARKER (*b);
1963 CHECK_NUMBER_COERCE_MARKER (*e);
1965 if (XINT (*b) > XINT (*e))
1967 Lisp_Object tem;
1968 tem = *b; *b = *e; *e = tem;
1971 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1972 && XINT (*e) <= ZV))
1973 args_out_of_range (*b, *e);
1976 /* Advance BYTE_POS up to a character boundary
1977 and return the adjusted position. */
1979 static EMACS_INT
1980 advance_to_char_boundary (EMACS_INT byte_pos)
1982 int c;
1984 if (byte_pos == BEG)
1985 /* Beginning of buffer is always a character boundary. */
1986 return BEG;
1988 c = FETCH_BYTE (byte_pos);
1989 if (! CHAR_HEAD_P (c))
1991 /* We should advance BYTE_POS only when C is a constituent of a
1992 multibyte sequence. */
1993 EMACS_INT orig_byte_pos = byte_pos;
1997 byte_pos--;
1998 c = FETCH_BYTE (byte_pos);
2000 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2001 INC_POS (byte_pos);
2002 if (byte_pos < orig_byte_pos)
2003 byte_pos = orig_byte_pos;
2004 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2005 surely advance to the correct character boundary. If C is
2006 not, BYTE_POS was unchanged. */
2009 return byte_pos;
2012 #ifdef REL_ALLOC
2013 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2014 #endif /* REL_ALLOC */
2016 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2017 1, 1, 0,
2018 doc: /* Swap the text between current buffer and BUFFER. */)
2019 (Lisp_Object buffer)
2021 struct buffer *other_buffer;
2022 CHECK_BUFFER (buffer);
2023 other_buffer = XBUFFER (buffer);
2025 if (NILP (BVAR (other_buffer, name)))
2026 error ("Cannot swap a dead buffer's text");
2028 /* Actually, it probably works just fine.
2029 * if (other_buffer == current_buffer)
2030 * error ("Cannot swap a buffer's text with itself"); */
2032 /* Actually, this may be workable as well, tho probably only if they're
2033 *both* indirect. */
2034 if (other_buffer->base_buffer
2035 || current_buffer->base_buffer)
2036 error ("Cannot swap indirect buffers's text");
2038 { /* This is probably harder to make work. */
2039 struct buffer *other;
2040 for (other = all_buffers; other; other = other->header.next.buffer)
2041 if (other->base_buffer == other_buffer
2042 || other->base_buffer == current_buffer)
2043 error ("One of the buffers to swap has indirect buffers");
2046 #define swapfield(field, type) \
2047 do { \
2048 type tmp##field = other_buffer->field; \
2049 other_buffer->field = current_buffer->field; \
2050 current_buffer->field = tmp##field; \
2051 } while (0)
2052 #define swapfield_(field, type) \
2053 do { \
2054 type tmp##field = BVAR (other_buffer, field); \
2055 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2056 BVAR (current_buffer, field) = tmp##field; \
2057 } while (0)
2059 swapfield (own_text, struct buffer_text);
2060 eassert (current_buffer->text == &current_buffer->own_text);
2061 eassert (other_buffer->text == &other_buffer->own_text);
2062 #ifdef REL_ALLOC
2063 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2064 (POINTER_TYPE **) &other_buffer->own_text.beg);
2065 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2066 (POINTER_TYPE **) &current_buffer->own_text.beg);
2067 #endif /* REL_ALLOC */
2069 swapfield (pt, EMACS_INT);
2070 swapfield (pt_byte, EMACS_INT);
2071 swapfield (begv, EMACS_INT);
2072 swapfield (begv_byte, EMACS_INT);
2073 swapfield (zv, EMACS_INT);
2074 swapfield (zv_byte, EMACS_INT);
2075 eassert (!current_buffer->base_buffer);
2076 eassert (!other_buffer->base_buffer);
2077 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2078 swapfield (newline_cache, struct region_cache *);
2079 swapfield (width_run_cache, struct region_cache *);
2080 current_buffer->prevent_redisplay_optimizations_p = 1;
2081 other_buffer->prevent_redisplay_optimizations_p = 1;
2082 swapfield (overlays_before, struct Lisp_Overlay *);
2083 swapfield (overlays_after, struct Lisp_Overlay *);
2084 swapfield (overlay_center, EMACS_INT);
2085 swapfield_ (undo_list, Lisp_Object);
2086 swapfield_ (mark, Lisp_Object);
2087 swapfield_ (enable_multibyte_characters, Lisp_Object);
2088 swapfield_ (bidi_display_reordering, Lisp_Object);
2089 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2090 /* FIXME: Not sure what we should do with these *_marker fields.
2091 Hopefully they're just nil anyway. */
2092 swapfield_ (pt_marker, Lisp_Object);
2093 swapfield_ (begv_marker, Lisp_Object);
2094 swapfield_ (zv_marker, Lisp_Object);
2095 BVAR (current_buffer, point_before_scroll) = Qnil;
2096 BVAR (other_buffer, point_before_scroll) = Qnil;
2098 current_buffer->text->modiff++; other_buffer->text->modiff++;
2099 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2100 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2101 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2102 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2103 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2104 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2106 struct Lisp_Marker *m;
2107 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2108 if (m->buffer == other_buffer)
2109 m->buffer = current_buffer;
2110 else
2111 /* Since there's no indirect buffer in sight, markers on
2112 BUF_MARKERS(buf) should either be for `buf' or dead. */
2113 eassert (!m->buffer);
2114 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2115 if (m->buffer == current_buffer)
2116 m->buffer = other_buffer;
2117 else
2118 /* Since there's no indirect buffer in sight, markers on
2119 BUF_MARKERS(buf) should either be for `buf' or dead. */
2120 eassert (!m->buffer);
2122 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2123 So since we just swapped the markers between the two buffers, we need
2124 to undo the effect of this swap for window markers. */
2125 Lisp_Object w = Fselected_window (), ws = Qnil;
2126 Lisp_Object buf1, buf2;
2127 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2129 while (NILP (Fmemq (w, ws)))
2131 ws = Fcons (w, ws);
2132 if (MARKERP (XWINDOW (w)->pointm)
2133 && (EQ (XWINDOW (w)->buffer, buf1)
2134 || EQ (XWINDOW (w)->buffer, buf2)))
2135 Fset_marker (XWINDOW (w)->pointm,
2136 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2137 XWINDOW (w)->buffer);
2138 w = Fnext_window (w, Qt, Qt);
2142 if (current_buffer->text->intervals)
2143 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2144 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2145 if (other_buffer->text->intervals)
2146 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2147 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2149 return Qnil;
2152 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2153 1, 1, 0,
2154 doc: /* Set the multibyte flag of the current buffer to FLAG.
2155 If FLAG is t, this makes the buffer a multibyte buffer.
2156 If FLAG is nil, this makes the buffer a single-byte buffer.
2157 In these cases, the buffer contents remain unchanged as a sequence of
2158 bytes but the contents viewed as characters do change.
2159 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2160 all eight-bit bytes to eight-bit characters.
2161 If the multibyte flag was really changed, undo information of the
2162 current buffer is cleared. */)
2163 (Lisp_Object flag)
2165 struct Lisp_Marker *tail, *markers;
2166 struct buffer *other;
2167 EMACS_INT begv, zv;
2168 int narrowed = (BEG != BEGV || Z != ZV);
2169 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2170 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2171 struct gcpro gcpro1;
2173 if (current_buffer->base_buffer)
2174 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2176 /* Do nothing if nothing actually changes. */
2177 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2178 return flag;
2180 GCPRO1 (old_undo);
2182 /* Don't record these buffer changes. We will put a special undo entry
2183 instead. */
2184 BVAR (current_buffer, undo_list) = Qt;
2186 /* If the cached position is for this buffer, clear it out. */
2187 clear_charpos_cache (current_buffer);
2189 if (NILP (flag))
2190 begv = BEGV_BYTE, zv = ZV_BYTE;
2191 else
2192 begv = BEGV, zv = ZV;
2194 if (narrowed)
2195 Fwiden ();
2197 if (NILP (flag))
2199 EMACS_INT pos, stop;
2200 unsigned char *p;
2202 /* Do this first, so it can use CHAR_TO_BYTE
2203 to calculate the old correspondences. */
2204 set_intervals_multibyte (0);
2206 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2208 Z = Z_BYTE;
2209 BEGV = BEGV_BYTE;
2210 ZV = ZV_BYTE;
2211 GPT = GPT_BYTE;
2212 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2215 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2216 tail->charpos = tail->bytepos;
2218 /* Convert multibyte form of 8-bit characters to unibyte. */
2219 pos = BEG;
2220 stop = GPT;
2221 p = BEG_ADDR;
2222 while (1)
2224 int c, bytes;
2226 if (pos == stop)
2228 if (pos == Z)
2229 break;
2230 p = GAP_END_ADDR;
2231 stop = Z;
2233 if (ASCII_BYTE_P (*p))
2234 p++, pos++;
2235 else if (CHAR_BYTE8_HEAD_P (*p))
2237 c = STRING_CHAR_AND_LENGTH (p, bytes);
2238 /* Delete all bytes for this 8-bit character but the
2239 last one, and change the last one to the character
2240 code. */
2241 bytes--;
2242 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2243 p = GAP_END_ADDR;
2244 *p++ = c;
2245 pos++;
2246 if (begv > pos)
2247 begv -= bytes;
2248 if (zv > pos)
2249 zv -= bytes;
2250 stop = Z;
2252 else
2254 bytes = BYTES_BY_CHAR_HEAD (*p);
2255 p += bytes, pos += bytes;
2258 if (narrowed)
2259 Fnarrow_to_region (make_number (begv), make_number (zv));
2261 else
2263 EMACS_INT pt = PT;
2264 EMACS_INT pos, stop;
2265 unsigned char *p, *pend;
2267 /* Be sure not to have a multibyte sequence striding over the GAP.
2268 Ex: We change this: "...abc\302 _GAP_ \241def..."
2269 to: "...abc _GAP_ \302\241def..." */
2271 if (EQ (flag, Qt)
2272 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2273 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2275 unsigned char *q = GPT_ADDR - 1;
2277 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2278 if (LEADING_CODE_P (*q))
2280 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
2282 move_gap_both (new_gpt, new_gpt);
2286 /* Make the buffer contents valid as multibyte by converting
2287 8-bit characters to multibyte form. */
2288 pos = BEG;
2289 stop = GPT;
2290 p = BEG_ADDR;
2291 pend = GPT_ADDR;
2292 while (1)
2294 int bytes;
2296 if (pos == stop)
2298 if (pos == Z)
2299 break;
2300 p = GAP_END_ADDR;
2301 pend = Z_ADDR;
2302 stop = Z;
2305 if (ASCII_BYTE_P (*p))
2306 p++, pos++;
2307 else if (EQ (flag, Qt)
2308 && ! CHAR_BYTE8_HEAD_P (*p)
2309 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2310 p += bytes, pos += bytes;
2311 else
2313 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2314 int c;
2316 c = BYTE8_TO_CHAR (*p);
2317 bytes = CHAR_STRING (c, tmp);
2318 *p = tmp[0];
2319 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2320 bytes--;
2321 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2322 /* Now the gap is after the just inserted data. */
2323 pos = GPT;
2324 p = GAP_END_ADDR;
2325 if (pos <= begv)
2326 begv += bytes;
2327 if (pos <= zv)
2328 zv += bytes;
2329 if (pos <= pt)
2330 pt += bytes;
2331 pend = Z_ADDR;
2332 stop = Z;
2336 if (pt != PT)
2337 TEMP_SET_PT (pt);
2339 if (narrowed)
2340 Fnarrow_to_region (make_number (begv), make_number (zv));
2342 /* Do this first, so that chars_in_text asks the right question.
2343 set_intervals_multibyte needs it too. */
2344 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2346 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2347 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2349 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2351 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2352 if (BEGV_BYTE > GPT_BYTE)
2353 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2354 else
2355 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2357 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2358 if (ZV_BYTE > GPT_BYTE)
2359 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2360 else
2361 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2364 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2365 EMACS_INT position;
2367 if (byte > GPT_BYTE)
2368 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2369 else
2370 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2371 TEMP_SET_PT_BOTH (position, byte);
2374 tail = markers = BUF_MARKERS (current_buffer);
2376 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2377 getting confused by the markers that have not yet been updated.
2378 It is also a signal that it should never create a marker. */
2379 BUF_MARKERS (current_buffer) = NULL;
2381 for (; tail; tail = tail->next)
2383 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2384 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2387 /* Make sure no markers were put on the chain
2388 while the chain value was incorrect. */
2389 if (BUF_MARKERS (current_buffer))
2390 abort ();
2392 BUF_MARKERS (current_buffer) = markers;
2394 /* Do this last, so it can calculate the new correspondences
2395 between chars and bytes. */
2396 set_intervals_multibyte (1);
2399 if (!EQ (old_undo, Qt))
2401 /* Represent all the above changes by a special undo entry. */
2402 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2403 intern ("set-buffer-multibyte"),
2404 NILP (flag) ? Qt : Qnil),
2405 old_undo);
2408 UNGCPRO;
2410 /* Changing the multibyteness of a buffer means that all windows
2411 showing that buffer must be updated thoroughly. */
2412 current_buffer->prevent_redisplay_optimizations_p = 1;
2413 ++windows_or_buffers_changed;
2415 /* Copy this buffer's new multibyte status
2416 into all of its indirect buffers. */
2417 for (other = all_buffers; other; other = other->header.next.buffer)
2418 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2420 BVAR (other, enable_multibyte_characters)
2421 = BVAR (current_buffer, enable_multibyte_characters);
2422 other->prevent_redisplay_optimizations_p = 1;
2425 /* Restore the modifiedness of the buffer. */
2426 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2427 Fset_buffer_modified_p (Qnil);
2429 /* Update coding systems of this buffer's process (if any). */
2431 Lisp_Object process;
2433 process = Fget_buffer_process (Fcurrent_buffer ());
2434 if (PROCESSP (process))
2435 setup_process_coding_systems (process);
2438 return flag;
2441 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2442 Skill_all_local_variables, 0, 0, 0,
2443 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2444 Most local variable bindings are eliminated so that the default values
2445 become effective once more. Also, the syntax table is set from
2446 `standard-syntax-table', the local keymap is set to nil,
2447 and the abbrev table from `fundamental-mode-abbrev-table'.
2448 This function also forces redisplay of the mode line.
2450 Every function to select a new major mode starts by
2451 calling this function.
2453 As a special exception, local variables whose names have
2454 a non-nil `permanent-local' property are not eliminated by this function.
2456 The first thing this function does is run
2457 the normal hook `change-major-mode-hook'. */)
2458 (void)
2460 Frun_hooks (1, &Qchange_major_mode_hook);
2462 /* Make sure none of the bindings in local_var_alist
2463 remain swapped in, in their symbols. */
2465 swap_out_buffer_local_variables (current_buffer);
2467 /* Actually eliminate all local bindings of this buffer. */
2469 reset_buffer_local_variables (current_buffer, 0);
2471 /* Force mode-line redisplay. Useful here because all major mode
2472 commands call this function. */
2473 update_mode_lines++;
2475 return Qnil;
2478 /* Make sure no local variables remain set up with buffer B
2479 for their current values. */
2481 static void
2482 swap_out_buffer_local_variables (struct buffer *b)
2484 Lisp_Object oalist, alist, buffer;
2486 XSETBUFFER (buffer, b);
2487 oalist = BVAR (b, local_var_alist);
2489 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2491 Lisp_Object sym = XCAR (XCAR (alist));
2492 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2493 /* Need not do anything if some other buffer's binding is
2494 now encached. */
2495 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2497 /* Symbol is set up for this buffer's old local value:
2498 swap it out! */
2499 swap_in_global_binding (XSYMBOL (sym));
2504 /* Find all the overlays in the current buffer that contain position POS.
2505 Return the number found, and store them in a vector in *VEC_PTR.
2506 Store in *LEN_PTR the size allocated for the vector.
2507 Store in *NEXT_PTR the next position after POS where an overlay starts,
2508 or ZV if there are no more overlays between POS and ZV.
2509 Store in *PREV_PTR the previous position before POS where an overlay ends,
2510 or where an overlay starts which ends at or after POS;
2511 or BEGV if there are no such overlays from BEGV to POS.
2512 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2514 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2515 when this function is called.
2517 If EXTEND is non-zero, we make the vector bigger if necessary.
2518 If EXTEND is zero, we never extend the vector,
2519 and we store only as many overlays as will fit.
2520 But we still return the total number of overlays.
2522 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2523 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2524 default (BEGV or ZV). */
2526 ptrdiff_t
2527 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2528 ptrdiff_t *len_ptr,
2529 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
2531 Lisp_Object overlay, start, end;
2532 struct Lisp_Overlay *tail;
2533 ptrdiff_t idx = 0;
2534 ptrdiff_t len = *len_ptr;
2535 Lisp_Object *vec = *vec_ptr;
2536 EMACS_INT next = ZV;
2537 EMACS_INT prev = BEGV;
2538 int inhibit_storing = 0;
2540 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2542 EMACS_INT startpos, endpos;
2544 XSETMISC (overlay, tail);
2546 start = OVERLAY_START (overlay);
2547 end = OVERLAY_END (overlay);
2548 endpos = OVERLAY_POSITION (end);
2549 if (endpos < pos)
2551 if (prev < endpos)
2552 prev = endpos;
2553 break;
2555 startpos = OVERLAY_POSITION (start);
2556 /* This one ends at or after POS
2557 so its start counts for PREV_PTR if it's before POS. */
2558 if (prev < startpos && startpos < pos)
2559 prev = startpos;
2560 if (endpos == pos)
2561 continue;
2562 if (startpos <= pos)
2564 if (idx == len)
2566 /* The supplied vector is full.
2567 Either make it bigger, or don't store any more in it. */
2568 if (extend)
2570 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2571 memory_full (SIZE_MAX);
2572 /* Make it work with an initial len == 0. */
2573 len = len * 2 + 4;
2574 *len_ptr = len;
2575 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2576 *vec_ptr = vec;
2578 else
2579 inhibit_storing = 1;
2582 if (!inhibit_storing)
2583 vec[idx] = overlay;
2584 /* Keep counting overlays even if we can't return them all. */
2585 idx++;
2587 else if (startpos < next)
2588 next = startpos;
2591 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2593 EMACS_INT startpos, endpos;
2595 XSETMISC (overlay, tail);
2597 start = OVERLAY_START (overlay);
2598 end = OVERLAY_END (overlay);
2599 startpos = OVERLAY_POSITION (start);
2600 if (pos < startpos)
2602 if (startpos < next)
2603 next = startpos;
2604 break;
2606 endpos = OVERLAY_POSITION (end);
2607 if (pos < endpos)
2609 if (idx == len)
2611 if (extend)
2613 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2614 memory_full (SIZE_MAX);
2615 /* Make it work with an initial len == 0. */
2616 len = len * 2 + 4;
2617 *len_ptr = len;
2618 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2619 *vec_ptr = vec;
2621 else
2622 inhibit_storing = 1;
2625 if (!inhibit_storing)
2626 vec[idx] = overlay;
2627 idx++;
2629 if (startpos < pos && startpos > prev)
2630 prev = startpos;
2632 else if (endpos < pos && endpos > prev)
2633 prev = endpos;
2634 else if (endpos == pos && startpos > prev
2635 && (!change_req || startpos < pos))
2636 prev = startpos;
2639 if (next_ptr)
2640 *next_ptr = next;
2641 if (prev_ptr)
2642 *prev_ptr = prev;
2643 return idx;
2646 /* Find all the overlays in the current buffer that overlap the range
2647 BEG-END, or are empty at BEG, or are empty at END provided END
2648 denotes the position at the end of the current buffer.
2650 Return the number found, and store them in a vector in *VEC_PTR.
2651 Store in *LEN_PTR the size allocated for the vector.
2652 Store in *NEXT_PTR the next position after POS where an overlay starts,
2653 or ZV if there are no more overlays.
2654 Store in *PREV_PTR the previous position before POS where an overlay ends,
2655 or BEGV if there are no previous overlays.
2656 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2658 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2659 when this function is called.
2661 If EXTEND is non-zero, we make the vector bigger if necessary.
2662 If EXTEND is zero, we never extend the vector,
2663 and we store only as many overlays as will fit.
2664 But we still return the total number of overlays. */
2666 static ptrdiff_t
2667 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2668 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2669 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
2671 Lisp_Object overlay, ostart, oend;
2672 struct Lisp_Overlay *tail;
2673 ptrdiff_t idx = 0;
2674 ptrdiff_t len = *len_ptr;
2675 Lisp_Object *vec = *vec_ptr;
2676 EMACS_INT next = ZV;
2677 EMACS_INT prev = BEGV;
2678 int inhibit_storing = 0;
2679 int end_is_Z = end == Z;
2681 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2683 EMACS_INT startpos, endpos;
2685 XSETMISC (overlay, tail);
2687 ostart = OVERLAY_START (overlay);
2688 oend = OVERLAY_END (overlay);
2689 endpos = OVERLAY_POSITION (oend);
2690 if (endpos < beg)
2692 if (prev < endpos)
2693 prev = endpos;
2694 break;
2696 startpos = OVERLAY_POSITION (ostart);
2697 /* Count an interval if it overlaps the range, is empty at the
2698 start of the range, or is empty at END provided END denotes the
2699 end of the buffer. */
2700 if ((beg < endpos && startpos < end)
2701 || (startpos == endpos
2702 && (beg == endpos || (end_is_Z && endpos == end))))
2704 if (idx == len)
2706 /* The supplied vector is full.
2707 Either make it bigger, or don't store any more in it. */
2708 if (extend)
2710 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2711 memory_full (SIZE_MAX);
2712 /* Make it work with an initial len == 0. */
2713 len = len * 2 + 4;
2714 *len_ptr = len;
2715 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2716 *vec_ptr = vec;
2718 else
2719 inhibit_storing = 1;
2722 if (!inhibit_storing)
2723 vec[idx] = overlay;
2724 /* Keep counting overlays even if we can't return them all. */
2725 idx++;
2727 else if (startpos < next)
2728 next = startpos;
2731 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2733 EMACS_INT startpos, endpos;
2735 XSETMISC (overlay, tail);
2737 ostart = OVERLAY_START (overlay);
2738 oend = OVERLAY_END (overlay);
2739 startpos = OVERLAY_POSITION (ostart);
2740 if (end < startpos)
2742 if (startpos < next)
2743 next = startpos;
2744 break;
2746 endpos = OVERLAY_POSITION (oend);
2747 /* Count an interval if it overlaps the range, is empty at the
2748 start of the range, or is empty at END provided END denotes the
2749 end of the buffer. */
2750 if ((beg < endpos && startpos < end)
2751 || (startpos == endpos
2752 && (beg == endpos || (end_is_Z && endpos == end))))
2754 if (idx == len)
2756 if (extend)
2758 if ((OVERLAY_COUNT_MAX - 4) / 2 < len)
2759 memory_full (SIZE_MAX);
2760 /* Make it work with an initial len == 0. */
2761 len = len * 2 + 4;
2762 *len_ptr = len;
2763 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2764 *vec_ptr = vec;
2766 else
2767 inhibit_storing = 1;
2770 if (!inhibit_storing)
2771 vec[idx] = overlay;
2772 idx++;
2774 else if (endpos < beg && endpos > prev)
2775 prev = endpos;
2778 if (next_ptr)
2779 *next_ptr = next;
2780 if (prev_ptr)
2781 *prev_ptr = prev;
2782 return idx;
2786 /* Return non-zero if there exists an overlay with a non-nil
2787 `mouse-face' property overlapping OVERLAY. */
2790 mouse_face_overlay_overlaps (Lisp_Object overlay)
2792 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2793 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
2794 ptrdiff_t n, i, size;
2795 Lisp_Object *v, tem;
2797 size = 10;
2798 v = (Lisp_Object *) alloca (size * sizeof *v);
2799 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2800 if (n > size)
2802 v = (Lisp_Object *) alloca (n * sizeof *v);
2803 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2806 for (i = 0; i < n; ++i)
2807 if (!EQ (v[i], overlay)
2808 && (tem = Foverlay_get (overlay, Qmouse_face),
2809 !NILP (tem)))
2810 break;
2812 return i < n;
2817 /* Fast function to just test if we're at an overlay boundary. */
2819 overlay_touches_p (EMACS_INT pos)
2821 Lisp_Object overlay;
2822 struct Lisp_Overlay *tail;
2824 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2826 EMACS_INT endpos;
2828 XSETMISC (overlay ,tail);
2829 if (!OVERLAYP (overlay))
2830 abort ();
2832 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2833 if (endpos < pos)
2834 break;
2835 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2836 return 1;
2839 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2841 EMACS_INT startpos;
2843 XSETMISC (overlay, tail);
2844 if (!OVERLAYP (overlay))
2845 abort ();
2847 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2848 if (pos < startpos)
2849 break;
2850 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2851 return 1;
2853 return 0;
2856 struct sortvec
2858 Lisp_Object overlay;
2859 EMACS_INT beg, end;
2860 EMACS_INT priority;
2863 static int
2864 compare_overlays (const void *v1, const void *v2)
2866 const struct sortvec *s1 = (const struct sortvec *) v1;
2867 const struct sortvec *s2 = (const struct sortvec *) v2;
2868 if (s1->priority != s2->priority)
2869 return s1->priority < s2->priority ? -1 : 1;
2870 if (s1->beg != s2->beg)
2871 return s1->beg < s2->beg ? -1 : 1;
2872 if (s1->end != s2->end)
2873 return s2->end < s1->end ? -1 : 1;
2874 return 0;
2877 /* Sort an array of overlays by priority. The array is modified in place.
2878 The return value is the new size; this may be smaller than the original
2879 size if some of the overlays were invalid or were window-specific. */
2880 ptrdiff_t
2881 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2883 ptrdiff_t i, j;
2884 struct sortvec *sortvec;
2885 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2887 /* Put the valid and relevant overlays into sortvec. */
2889 for (i = 0, j = 0; i < noverlays; i++)
2891 Lisp_Object tem;
2892 Lisp_Object overlay;
2894 overlay = overlay_vec[i];
2895 if (OVERLAY_VALID (overlay)
2896 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2897 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2899 /* If we're interested in a specific window, then ignore
2900 overlays that are limited to some other window. */
2901 if (w)
2903 Lisp_Object window, clone_number;
2905 window = Foverlay_get (overlay, Qwindow);
2906 clone_number = Foverlay_get (overlay, Qclone_number);
2907 if (WINDOWP (window) && XWINDOW (window) != w
2908 && (! NUMBERP (clone_number)
2909 || XFASTINT (clone_number) != XFASTINT (w->clone_number)))
2910 continue;
2913 /* This overlay is good and counts: put it into sortvec. */
2914 sortvec[j].overlay = overlay;
2915 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2916 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2917 tem = Foverlay_get (overlay, Qpriority);
2918 if (INTEGERP (tem))
2919 sortvec[j].priority = XINT (tem);
2920 else
2921 sortvec[j].priority = 0;
2922 j++;
2925 noverlays = j;
2927 /* Sort the overlays into the proper order: increasing priority. */
2929 if (noverlays > 1)
2930 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2932 for (i = 0; i < noverlays; i++)
2933 overlay_vec[i] = sortvec[i].overlay;
2934 return (noverlays);
2937 struct sortstr
2939 Lisp_Object string, string2;
2940 ptrdiff_t size;
2941 EMACS_INT priority;
2944 struct sortstrlist
2946 struct sortstr *buf; /* An array that expands as needed; never freed. */
2947 ptrdiff_t size; /* Allocated length of that array. */
2948 ptrdiff_t used; /* How much of the array is currently in use. */
2949 EMACS_INT bytes; /* Total length of the strings in buf. */
2952 /* Buffers for storing information about the overlays touching a given
2953 position. These could be automatic variables in overlay_strings, but
2954 it's more efficient to hold onto the memory instead of repeatedly
2955 allocating and freeing it. */
2956 static struct sortstrlist overlay_heads, overlay_tails;
2957 static unsigned char *overlay_str_buf;
2959 /* Allocated length of overlay_str_buf. */
2960 static EMACS_INT overlay_str_len;
2962 /* A comparison function suitable for passing to qsort. */
2963 static int
2964 cmp_for_strings (const void *as1, const void *as2)
2966 struct sortstr *s1 = (struct sortstr *)as1;
2967 struct sortstr *s2 = (struct sortstr *)as2;
2968 if (s1->size != s2->size)
2969 return s2->size < s1->size ? -1 : 1;
2970 if (s1->priority != s2->priority)
2971 return s1->priority < s2->priority ? -1 : 1;
2972 return 0;
2975 static void
2976 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2977 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2979 EMACS_INT nbytes;
2981 if (ssl->used == ssl->size)
2983 if (min (PTRDIFF_MAX, SIZE_MAX) / (sizeof (struct sortstr) * 2)
2984 < ssl->size)
2985 memory_full (SIZE_MAX);
2986 else if (0 < ssl->size)
2987 ssl->size *= 2;
2988 else
2989 ssl->size = 5;
2990 ssl->buf = ((struct sortstr *)
2991 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2993 ssl->buf[ssl->used].string = str;
2994 ssl->buf[ssl->used].string2 = str2;
2995 ssl->buf[ssl->used].size = size;
2996 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2997 ssl->used++;
2999 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3000 nbytes = SCHARS (str);
3001 else if (! STRING_MULTIBYTE (str))
3002 nbytes = count_size_as_multibyte (SDATA (str),
3003 SBYTES (str));
3004 else
3005 nbytes = SBYTES (str);
3007 ssl->bytes += nbytes;
3009 if (STRINGP (str2))
3011 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3012 nbytes = SCHARS (str2);
3013 else if (! STRING_MULTIBYTE (str2))
3014 nbytes = count_size_as_multibyte (SDATA (str2),
3015 SBYTES (str2));
3016 else
3017 nbytes = SBYTES (str2);
3019 ssl->bytes += nbytes;
3023 /* Return the concatenation of the strings associated with overlays that
3024 begin or end at POS, ignoring overlays that are specific to a window
3025 other than W. The strings are concatenated in the appropriate order:
3026 shorter overlays nest inside longer ones, and higher priority inside
3027 lower. Normally all of the after-strings come first, but zero-sized
3028 overlays have their after-strings ride along with the before-strings
3029 because it would look strange to print them inside-out.
3031 Returns the string length, and stores the contents indirectly through
3032 PSTR, if that variable is non-null. The string may be overwritten by
3033 subsequent calls. */
3035 EMACS_INT
3036 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3038 Lisp_Object overlay, window, clone_number, str;
3039 struct Lisp_Overlay *ov;
3040 EMACS_INT startpos, endpos;
3041 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3043 overlay_heads.used = overlay_heads.bytes = 0;
3044 overlay_tails.used = overlay_tails.bytes = 0;
3045 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3047 XSETMISC (overlay, ov);
3048 eassert (OVERLAYP (overlay));
3050 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3051 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3052 if (endpos < pos)
3053 break;
3054 if (endpos != pos && startpos != pos)
3055 continue;
3056 window = Foverlay_get (overlay, Qwindow);
3057 clone_number = Foverlay_get (overlay, Qclone_number);
3058 if (WINDOWP (window) && XWINDOW (window) != w
3059 && (! NUMBERP (clone_number)
3060 || XFASTINT (clone_number) != XFASTINT (w->clone_number)))
3061 continue;
3063 if (startpos == pos
3064 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3065 record_overlay_string (&overlay_heads, str,
3066 (startpos == endpos
3067 ? Foverlay_get (overlay, Qafter_string)
3068 : Qnil),
3069 Foverlay_get (overlay, Qpriority),
3070 endpos - startpos);
3071 else if (endpos == pos
3072 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3073 record_overlay_string (&overlay_tails, str, Qnil,
3074 Foverlay_get (overlay, Qpriority),
3075 endpos - startpos);
3077 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3079 XSETMISC (overlay, ov);
3080 eassert (OVERLAYP (overlay));
3082 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3083 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3084 if (startpos > pos)
3085 break;
3086 if (endpos != pos && startpos != pos)
3087 continue;
3088 window = Foverlay_get (overlay, Qwindow);
3089 clone_number = Foverlay_get (overlay, Qclone_number);
3090 if (WINDOWP (window) && XWINDOW (window) != w
3091 && (! NUMBERP (clone_number)
3092 || XFASTINT (clone_number) != XFASTINT (w->clone_number)))
3093 continue;
3094 if (startpos == pos
3095 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3096 record_overlay_string (&overlay_heads, str,
3097 (startpos == endpos
3098 ? Foverlay_get (overlay, Qafter_string)
3099 : Qnil),
3100 Foverlay_get (overlay, Qpriority),
3101 endpos - startpos);
3102 else if (endpos == pos
3103 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3104 record_overlay_string (&overlay_tails, str, Qnil,
3105 Foverlay_get (overlay, Qpriority),
3106 endpos - startpos);
3108 if (overlay_tails.used > 1)
3109 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3110 cmp_for_strings);
3111 if (overlay_heads.used > 1)
3112 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3113 cmp_for_strings);
3114 if (overlay_heads.bytes || overlay_tails.bytes)
3116 Lisp_Object tem;
3117 EMACS_INT i;
3118 unsigned char *p;
3119 EMACS_INT total = overlay_heads.bytes + overlay_tails.bytes;
3121 if (total > overlay_str_len)
3123 overlay_str_len = total;
3124 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3125 total);
3127 p = overlay_str_buf;
3128 for (i = overlay_tails.used; --i >= 0;)
3130 EMACS_INT nbytes;
3131 tem = overlay_tails.buf[i].string;
3132 nbytes = copy_text (SDATA (tem), p,
3133 SBYTES (tem),
3134 STRING_MULTIBYTE (tem), multibyte);
3135 p += nbytes;
3137 for (i = 0; i < overlay_heads.used; ++i)
3139 EMACS_INT nbytes;
3140 tem = overlay_heads.buf[i].string;
3141 nbytes = copy_text (SDATA (tem), p,
3142 SBYTES (tem),
3143 STRING_MULTIBYTE (tem), multibyte);
3144 p += nbytes;
3145 tem = overlay_heads.buf[i].string2;
3146 if (STRINGP (tem))
3148 nbytes = copy_text (SDATA (tem), p,
3149 SBYTES (tem),
3150 STRING_MULTIBYTE (tem), multibyte);
3151 p += nbytes;
3154 if (p != overlay_str_buf + total)
3155 abort ();
3156 if (pstr)
3157 *pstr = overlay_str_buf;
3158 return total;
3160 return 0;
3163 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3165 void
3166 recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
3168 Lisp_Object overlay, beg, end;
3169 struct Lisp_Overlay *prev, *tail, *next;
3171 /* See if anything in overlays_before should move to overlays_after. */
3173 /* We don't strictly need prev in this loop; it should always be nil.
3174 But we use it for symmetry and in case that should cease to be true
3175 with some future change. */
3176 prev = NULL;
3177 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3179 next = tail->next;
3180 XSETMISC (overlay, tail);
3182 /* If the overlay is not valid, get rid of it. */
3183 if (!OVERLAY_VALID (overlay))
3184 #if 1
3185 abort ();
3186 #else
3188 /* Splice the cons cell TAIL out of overlays_before. */
3189 if (!NILP (prev))
3190 XCDR (prev) = next;
3191 else
3192 buf->overlays_before = next;
3193 tail = prev;
3194 continue;
3196 #endif
3198 beg = OVERLAY_START (overlay);
3199 end = OVERLAY_END (overlay);
3201 if (OVERLAY_POSITION (end) > pos)
3203 /* OVERLAY needs to be moved. */
3204 EMACS_INT where = OVERLAY_POSITION (beg);
3205 struct Lisp_Overlay *other, *other_prev;
3207 /* Splice the cons cell TAIL out of overlays_before. */
3208 if (prev)
3209 prev->next = next;
3210 else
3211 buf->overlays_before = next;
3213 /* Search thru overlays_after for where to put it. */
3214 other_prev = NULL;
3215 for (other = buf->overlays_after; other;
3216 other_prev = other, other = other->next)
3218 Lisp_Object otherbeg, otheroverlay;
3220 XSETMISC (otheroverlay, other);
3221 eassert (OVERLAY_VALID (otheroverlay));
3223 otherbeg = OVERLAY_START (otheroverlay);
3224 if (OVERLAY_POSITION (otherbeg) >= where)
3225 break;
3228 /* Add TAIL to overlays_after before OTHER. */
3229 tail->next = other;
3230 if (other_prev)
3231 other_prev->next = tail;
3232 else
3233 buf->overlays_after = tail;
3234 tail = prev;
3236 else
3237 /* We've reached the things that should stay in overlays_before.
3238 All the rest of overlays_before must end even earlier,
3239 so stop now. */
3240 break;
3243 /* See if anything in overlays_after should be in overlays_before. */
3244 prev = NULL;
3245 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3247 next = tail->next;
3248 XSETMISC (overlay, tail);
3250 /* If the overlay is not valid, get rid of it. */
3251 if (!OVERLAY_VALID (overlay))
3252 #if 1
3253 abort ();
3254 #else
3256 /* Splice the cons cell TAIL out of overlays_after. */
3257 if (!NILP (prev))
3258 XCDR (prev) = next;
3259 else
3260 buf->overlays_after = next;
3261 tail = prev;
3262 continue;
3264 #endif
3266 beg = OVERLAY_START (overlay);
3267 end = OVERLAY_END (overlay);
3269 /* Stop looking, when we know that nothing further
3270 can possibly end before POS. */
3271 if (OVERLAY_POSITION (beg) > pos)
3272 break;
3274 if (OVERLAY_POSITION (end) <= pos)
3276 /* OVERLAY needs to be moved. */
3277 EMACS_INT where = OVERLAY_POSITION (end);
3278 struct Lisp_Overlay *other, *other_prev;
3280 /* Splice the cons cell TAIL out of overlays_after. */
3281 if (prev)
3282 prev->next = next;
3283 else
3284 buf->overlays_after = next;
3286 /* Search thru overlays_before for where to put it. */
3287 other_prev = NULL;
3288 for (other = buf->overlays_before; other;
3289 other_prev = other, other = other->next)
3291 Lisp_Object otherend, otheroverlay;
3293 XSETMISC (otheroverlay, other);
3294 eassert (OVERLAY_VALID (otheroverlay));
3296 otherend = OVERLAY_END (otheroverlay);
3297 if (OVERLAY_POSITION (otherend) <= where)
3298 break;
3301 /* Add TAIL to overlays_before before OTHER. */
3302 tail->next = other;
3303 if (other_prev)
3304 other_prev->next = tail;
3305 else
3306 buf->overlays_before = tail;
3307 tail = prev;
3311 buf->overlay_center = pos;
3314 void
3315 adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
3317 /* After an insertion, the lists are still sorted properly,
3318 but we may need to update the value of the overlay center. */
3319 if (current_buffer->overlay_center >= pos)
3320 current_buffer->overlay_center += length;
3323 void
3324 adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
3326 if (current_buffer->overlay_center < pos)
3327 /* The deletion was to our right. No change needed; the before- and
3328 after-lists are still consistent. */
3330 else if (current_buffer->overlay_center > pos + length)
3331 /* The deletion was to our left. We need to adjust the center value
3332 to account for the change in position, but the lists are consistent
3333 given the new value. */
3334 current_buffer->overlay_center -= length;
3335 else
3336 /* We're right in the middle. There might be things on the after-list
3337 that now belong on the before-list. Recentering will move them,
3338 and also update the center point. */
3339 recenter_overlay_lists (current_buffer, pos);
3342 /* Fix up overlays that were garbled as a result of permuting markers
3343 in the range START through END. Any overlay with at least one
3344 endpoint in this range will need to be unlinked from the overlay
3345 list and reinserted in its proper place.
3346 Such an overlay might even have negative size at this point.
3347 If so, we'll make the overlay empty. */
3348 void
3349 fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
3351 Lisp_Object overlay;
3352 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3353 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3354 /* These are either nil, indicating that before_list or after_list
3355 should be assigned, or the cons cell the cdr of which should be
3356 assigned. */
3357 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3358 /* 'Parent', likewise, indicates a cons cell or
3359 current_buffer->overlays_before or overlays_after, depending
3360 which loop we're in. */
3361 struct Lisp_Overlay *tail, *parent;
3362 EMACS_INT startpos, endpos;
3364 /* This algorithm shifts links around instead of consing and GCing.
3365 The loop invariant is that before_list (resp. after_list) is a
3366 well-formed list except that its last element, the CDR of beforep
3367 (resp. afterp) if beforep (afterp) isn't nil or before_list
3368 (after_list) if it is, is still uninitialized. So it's not a bug
3369 that before_list isn't initialized, although it may look
3370 strange. */
3371 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3373 XSETMISC (overlay, tail);
3375 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3376 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3378 /* If the overlay is backwards, make it empty. */
3379 if (endpos < startpos)
3381 startpos = endpos;
3382 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3383 Qnil);
3386 if (endpos < start)
3387 break;
3389 if (endpos < end
3390 || (startpos >= start && startpos < end))
3392 /* Add it to the end of the wrong list. Later on,
3393 recenter_overlay_lists will move it to the right place. */
3394 if (endpos < current_buffer->overlay_center)
3396 if (!afterp)
3397 after_list = tail;
3398 else
3399 afterp->next = tail;
3400 afterp = tail;
3402 else
3404 if (!beforep)
3405 before_list = tail;
3406 else
3407 beforep->next = tail;
3408 beforep = tail;
3410 if (!parent)
3411 current_buffer->overlays_before = tail->next;
3412 else
3413 parent->next = tail->next;
3414 tail = tail->next;
3416 else
3417 parent = tail, tail = parent->next;
3419 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3421 XSETMISC (overlay, tail);
3423 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3424 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3426 /* If the overlay is backwards, make it empty. */
3427 if (endpos < startpos)
3429 startpos = endpos;
3430 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3431 Qnil);
3434 if (startpos >= end)
3435 break;
3437 if (startpos >= start
3438 || (endpos >= start && endpos < end))
3440 if (endpos < current_buffer->overlay_center)
3442 if (!afterp)
3443 after_list = tail;
3444 else
3445 afterp->next = tail;
3446 afterp = tail;
3448 else
3450 if (!beforep)
3451 before_list = tail;
3452 else
3453 beforep->next = tail;
3454 beforep = tail;
3456 if (!parent)
3457 current_buffer->overlays_after = tail->next;
3458 else
3459 parent->next = tail->next;
3460 tail = tail->next;
3462 else
3463 parent = tail, tail = parent->next;
3466 /* Splice the constructed (wrong) lists into the buffer's lists,
3467 and let the recenter function make it sane again. */
3468 if (beforep)
3470 beforep->next = current_buffer->overlays_before;
3471 current_buffer->overlays_before = before_list;
3473 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3475 if (afterp)
3477 afterp->next = current_buffer->overlays_after;
3478 current_buffer->overlays_after = after_list;
3480 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3483 /* We have two types of overlay: the one whose ending marker is
3484 after-insertion-marker (this is the usual case) and the one whose
3485 ending marker is before-insertion-marker. When `overlays_before'
3486 contains overlays of the latter type and the former type in this
3487 order and both overlays end at inserting position, inserting a text
3488 increases only the ending marker of the latter type, which results
3489 in incorrect ordering of `overlays_before'.
3491 This function fixes ordering of overlays in the slot
3492 `overlays_before' of the buffer *BP. Before the insertion, `point'
3493 was at PREV, and now is at POS. */
3495 void
3496 fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3498 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3499 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3500 Lisp_Object tem;
3501 EMACS_INT end IF_LINT (= 0);
3503 /* After the insertion, the several overlays may be in incorrect
3504 order. The possibility is that, in the list `overlays_before',
3505 an overlay which ends at POS appears after an overlay which ends
3506 at PREV. Since POS is greater than PREV, we must fix the
3507 ordering of these overlays, by moving overlays ends at POS before
3508 the overlays ends at PREV. */
3510 /* At first, find a place where disordered overlays should be linked
3511 in. It is where an overlay which end before POS exists. (i.e. an
3512 overlay whose ending marker is after-insertion-marker if disorder
3513 exists). */
3514 while (tail
3515 && (XSETMISC (tem, tail),
3516 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3518 parent = tail;
3519 tail = tail->next;
3522 /* If we don't find such an overlay,
3523 or the found one ends before PREV,
3524 or the found one is the last one in the list,
3525 we don't have to fix anything. */
3526 if (!tail || end < prev || !tail->next)
3527 return;
3529 right_pair = parent;
3530 parent = tail;
3531 tail = tail->next;
3533 /* Now, end position of overlays in the list TAIL should be before
3534 or equal to PREV. In the loop, an overlay which ends at POS is
3535 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3536 we found an overlay which ends before PREV, the remaining
3537 overlays are in correct order. */
3538 while (tail)
3540 XSETMISC (tem, tail);
3541 end = OVERLAY_POSITION (OVERLAY_END (tem));
3543 if (end == pos)
3544 { /* This overlay is disordered. */
3545 struct Lisp_Overlay *found = tail;
3547 /* Unlink the found overlay. */
3548 tail = found->next;
3549 parent->next = tail;
3550 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3551 and link it into the right place. */
3552 if (!right_pair)
3554 found->next = bp->overlays_before;
3555 bp->overlays_before = found;
3557 else
3559 found->next = right_pair->next;
3560 right_pair->next = found;
3563 else if (end == prev)
3565 parent = tail;
3566 tail = tail->next;
3568 else /* No more disordered overlay. */
3569 break;
3573 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3574 doc: /* Return t if OBJECT is an overlay. */)
3575 (Lisp_Object object)
3577 return (OVERLAYP (object) ? Qt : Qnil);
3580 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3581 doc: /* Create a new overlay with range BEG to END in BUFFER.
3582 If omitted, BUFFER defaults to the current buffer.
3583 BEG and END may be integers or markers.
3584 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3585 for the front of the overlay advance when text is inserted there
3586 \(which means the text *is not* included in the overlay).
3587 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3588 for the rear of the overlay advance when text is inserted there
3589 \(which means the text *is* included in the overlay). */)
3590 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3592 Lisp_Object overlay;
3593 struct buffer *b;
3595 if (NILP (buffer))
3596 XSETBUFFER (buffer, current_buffer);
3597 else
3598 CHECK_BUFFER (buffer);
3599 if (MARKERP (beg)
3600 && ! EQ (Fmarker_buffer (beg), buffer))
3601 error ("Marker points into wrong buffer");
3602 if (MARKERP (end)
3603 && ! EQ (Fmarker_buffer (end), buffer))
3604 error ("Marker points into wrong buffer");
3606 CHECK_NUMBER_COERCE_MARKER (beg);
3607 CHECK_NUMBER_COERCE_MARKER (end);
3609 if (XINT (beg) > XINT (end))
3611 Lisp_Object temp;
3612 temp = beg; beg = end; end = temp;
3615 b = XBUFFER (buffer);
3617 beg = Fset_marker (Fmake_marker (), beg, buffer);
3618 end = Fset_marker (Fmake_marker (), end, buffer);
3620 if (!NILP (front_advance))
3621 XMARKER (beg)->insertion_type = 1;
3622 if (!NILP (rear_advance))
3623 XMARKER (end)->insertion_type = 1;
3625 overlay = allocate_misc ();
3626 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3627 XOVERLAY (overlay)->start = beg;
3628 XOVERLAY (overlay)->end = end;
3629 XOVERLAY (overlay)->plist = Qnil;
3630 XOVERLAY (overlay)->next = NULL;
3632 /* Put the new overlay on the wrong list. */
3633 end = OVERLAY_END (overlay);
3634 if (OVERLAY_POSITION (end) < b->overlay_center)
3636 if (b->overlays_after)
3637 XOVERLAY (overlay)->next = b->overlays_after;
3638 b->overlays_after = XOVERLAY (overlay);
3640 else
3642 if (b->overlays_before)
3643 XOVERLAY (overlay)->next = b->overlays_before;
3644 b->overlays_before = XOVERLAY (overlay);
3647 /* This puts it in the right list, and in the right order. */
3648 recenter_overlay_lists (b, b->overlay_center);
3650 /* We don't need to redisplay the region covered by the overlay, because
3651 the overlay has no properties at the moment. */
3653 return overlay;
3656 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3658 static void
3659 modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
3661 if (start > end)
3663 EMACS_INT temp = start;
3664 start = end;
3665 end = temp;
3668 BUF_COMPUTE_UNCHANGED (buf, start, end);
3670 /* If this is a buffer not in the selected window,
3671 we must do other windows. */
3672 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3673 windows_or_buffers_changed = 1;
3674 /* If multiple windows show this buffer, we must do other windows. */
3675 else if (buffer_shared > 1)
3676 windows_or_buffers_changed = 1;
3677 /* If we modify an overlay at the end of the buffer, we cannot
3678 be sure that window end is still valid. */
3679 else if (end >= ZV && start <= ZV)
3680 windows_or_buffers_changed = 1;
3682 ++BUF_OVERLAY_MODIFF (buf);
3686 static struct Lisp_Overlay *
3687 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3689 struct Lisp_Overlay *tmp, *prev;
3690 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3691 if (tmp == overlay)
3693 if (prev)
3694 prev->next = tmp->next;
3695 else
3696 list = tmp->next;
3697 overlay->next = NULL;
3698 break;
3700 return list;
3703 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3704 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3705 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3706 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3707 buffer. */)
3708 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3710 struct buffer *b, *ob;
3711 Lisp_Object obuffer;
3712 int count = SPECPDL_INDEX ();
3714 CHECK_OVERLAY (overlay);
3715 if (NILP (buffer))
3716 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3717 if (NILP (buffer))
3718 XSETBUFFER (buffer, current_buffer);
3719 CHECK_BUFFER (buffer);
3721 if (MARKERP (beg)
3722 && ! EQ (Fmarker_buffer (beg), buffer))
3723 error ("Marker points into wrong buffer");
3724 if (MARKERP (end)
3725 && ! EQ (Fmarker_buffer (end), buffer))
3726 error ("Marker points into wrong buffer");
3728 CHECK_NUMBER_COERCE_MARKER (beg);
3729 CHECK_NUMBER_COERCE_MARKER (end);
3731 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3732 return Fdelete_overlay (overlay);
3734 if (XINT (beg) > XINT (end))
3736 Lisp_Object temp;
3737 temp = beg; beg = end; end = temp;
3740 specbind (Qinhibit_quit, Qt);
3742 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3743 b = XBUFFER (buffer);
3744 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3746 /* If the overlay has changed buffers, do a thorough redisplay. */
3747 if (!EQ (buffer, obuffer))
3749 /* Redisplay where the overlay was. */
3750 if (!NILP (obuffer))
3752 EMACS_INT o_beg;
3753 EMACS_INT o_end;
3755 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3756 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3758 modify_overlay (ob, o_beg, o_end);
3761 /* Redisplay where the overlay is going to be. */
3762 modify_overlay (b, XINT (beg), XINT (end));
3764 else
3765 /* Redisplay the area the overlay has just left, or just enclosed. */
3767 EMACS_INT o_beg, o_end;
3769 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3770 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3772 if (o_beg == XINT (beg))
3773 modify_overlay (b, o_end, XINT (end));
3774 else if (o_end == XINT (end))
3775 modify_overlay (b, o_beg, XINT (beg));
3776 else
3778 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3779 if (XINT (end) > o_end) o_end = XINT (end);
3780 modify_overlay (b, o_beg, o_end);
3784 if (!NILP (obuffer))
3786 ob->overlays_before
3787 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3788 ob->overlays_after
3789 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3790 eassert (XOVERLAY (overlay)->next == NULL);
3793 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3794 Fset_marker (OVERLAY_END (overlay), end, buffer);
3796 /* Put the overlay on the wrong list. */
3797 end = OVERLAY_END (overlay);
3798 if (OVERLAY_POSITION (end) < b->overlay_center)
3800 XOVERLAY (overlay)->next = b->overlays_after;
3801 b->overlays_after = XOVERLAY (overlay);
3803 else
3805 XOVERLAY (overlay)->next = b->overlays_before;
3806 b->overlays_before = XOVERLAY (overlay);
3809 /* This puts it in the right list, and in the right order. */
3810 recenter_overlay_lists (b, b->overlay_center);
3812 return unbind_to (count, overlay);
3815 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3816 doc: /* Delete the overlay OVERLAY from its buffer. */)
3817 (Lisp_Object overlay)
3819 Lisp_Object buffer;
3820 struct buffer *b;
3821 int count = SPECPDL_INDEX ();
3823 CHECK_OVERLAY (overlay);
3825 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3826 if (NILP (buffer))
3827 return Qnil;
3829 b = XBUFFER (buffer);
3830 specbind (Qinhibit_quit, Qt);
3832 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3833 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3834 eassert (XOVERLAY (overlay)->next == NULL);
3835 modify_overlay (b,
3836 marker_position (OVERLAY_START (overlay)),
3837 marker_position (OVERLAY_END (overlay)));
3838 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3839 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3841 /* When deleting an overlay with before or after strings, turn off
3842 display optimizations for the affected buffer, on the basis that
3843 these strings may contain newlines. This is easier to do than to
3844 check for that situation during redisplay. */
3845 if (!windows_or_buffers_changed
3846 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3847 || !NILP (Foverlay_get (overlay, Qafter_string))))
3848 b->prevent_redisplay_optimizations_p = 1;
3850 return unbind_to (count, Qnil);
3853 /* Overlay dissection functions. */
3855 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3856 doc: /* Return the position at which OVERLAY starts. */)
3857 (Lisp_Object overlay)
3859 CHECK_OVERLAY (overlay);
3861 return (Fmarker_position (OVERLAY_START (overlay)));
3864 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3865 doc: /* Return the position at which OVERLAY ends. */)
3866 (Lisp_Object overlay)
3868 CHECK_OVERLAY (overlay);
3870 return (Fmarker_position (OVERLAY_END (overlay)));
3873 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3874 doc: /* Return the buffer OVERLAY belongs to.
3875 Return nil if OVERLAY has been deleted. */)
3876 (Lisp_Object overlay)
3878 CHECK_OVERLAY (overlay);
3880 return Fmarker_buffer (OVERLAY_START (overlay));
3883 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3884 doc: /* Return a list of the properties on OVERLAY.
3885 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3886 OVERLAY. */)
3887 (Lisp_Object overlay)
3889 CHECK_OVERLAY (overlay);
3891 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3895 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3896 doc: /* Return a list of the overlays that contain the character at POS. */)
3897 (Lisp_Object pos)
3899 ptrdiff_t len, noverlays;
3900 Lisp_Object *overlay_vec;
3901 Lisp_Object result;
3903 CHECK_NUMBER_COERCE_MARKER (pos);
3905 len = 10;
3906 /* We can't use alloca here because overlays_at can call xrealloc. */
3907 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3909 /* Put all the overlays we want in a vector in overlay_vec.
3910 Store the length in len. */
3911 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3912 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3914 /* Make a list of them all. */
3915 result = Flist (noverlays, overlay_vec);
3917 xfree (overlay_vec);
3918 return result;
3921 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3922 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3923 Overlap means that at least one character is contained within the overlay
3924 and also contained within the specified region.
3925 Empty overlays are included in the result if they are located at BEG,
3926 between BEG and END, or at END provided END denotes the position at the
3927 end of the buffer. */)
3928 (Lisp_Object beg, Lisp_Object end)
3930 ptrdiff_t len, noverlays;
3931 Lisp_Object *overlay_vec;
3932 Lisp_Object result;
3934 CHECK_NUMBER_COERCE_MARKER (beg);
3935 CHECK_NUMBER_COERCE_MARKER (end);
3937 len = 10;
3938 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3940 /* Put all the overlays we want in a vector in overlay_vec.
3941 Store the length in len. */
3942 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3943 NULL, NULL);
3945 /* Make a list of them all. */
3946 result = Flist (noverlays, overlay_vec);
3948 xfree (overlay_vec);
3949 return result;
3952 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3953 1, 1, 0,
3954 doc: /* Return the next position after POS where an overlay starts or ends.
3955 If there are no overlay boundaries from POS to (point-max),
3956 the value is (point-max). */)
3957 (Lisp_Object pos)
3959 ptrdiff_t i, len, noverlays;
3960 EMACS_INT endpos;
3961 Lisp_Object *overlay_vec;
3963 CHECK_NUMBER_COERCE_MARKER (pos);
3965 len = 10;
3966 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3968 /* Put all the overlays we want in a vector in overlay_vec.
3969 Store the length in len.
3970 endpos gets the position where the next overlay starts. */
3971 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3972 &endpos, (EMACS_INT *) 0, 1);
3974 /* If any of these overlays ends before endpos,
3975 use its ending point instead. */
3976 for (i = 0; i < noverlays; i++)
3978 Lisp_Object oend;
3979 EMACS_INT oendpos;
3981 oend = OVERLAY_END (overlay_vec[i]);
3982 oendpos = OVERLAY_POSITION (oend);
3983 if (oendpos < endpos)
3984 endpos = oendpos;
3987 xfree (overlay_vec);
3988 return make_number (endpos);
3991 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3992 Sprevious_overlay_change, 1, 1, 0,
3993 doc: /* Return the previous position before POS where an overlay starts or ends.
3994 If there are no overlay boundaries from (point-min) to POS,
3995 the value is (point-min). */)
3996 (Lisp_Object pos)
3998 EMACS_INT prevpos;
3999 Lisp_Object *overlay_vec;
4000 ptrdiff_t len;
4002 CHECK_NUMBER_COERCE_MARKER (pos);
4004 /* At beginning of buffer, we know the answer;
4005 avoid bug subtracting 1 below. */
4006 if (XINT (pos) == BEGV)
4007 return pos;
4009 len = 10;
4010 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4012 /* Put all the overlays we want in a vector in overlay_vec.
4013 Store the length in len.
4014 prevpos gets the position of the previous change. */
4015 overlays_at (XINT (pos), 1, &overlay_vec, &len,
4016 (EMACS_INT *) 0, &prevpos, 1);
4018 xfree (overlay_vec);
4019 return make_number (prevpos);
4022 /* These functions are for debugging overlays. */
4024 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4025 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4026 The car has all the overlays before the overlay center;
4027 the cdr has all the overlays after the overlay center.
4028 Recentering overlays moves overlays between these lists.
4029 The lists you get are copies, so that changing them has no effect.
4030 However, the overlays you get are the real objects that the buffer uses. */)
4031 (void)
4033 struct Lisp_Overlay *ol;
4034 Lisp_Object before = Qnil, after = Qnil, tmp;
4035 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4037 XSETMISC (tmp, ol);
4038 before = Fcons (tmp, before);
4040 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4042 XSETMISC (tmp, ol);
4043 after = Fcons (tmp, after);
4045 return Fcons (Fnreverse (before), Fnreverse (after));
4048 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4049 doc: /* Recenter the overlays of the current buffer around position POS.
4050 That makes overlay lookup faster for positions near POS (but perhaps slower
4051 for positions far away from POS). */)
4052 (Lisp_Object pos)
4054 CHECK_NUMBER_COERCE_MARKER (pos);
4056 recenter_overlay_lists (current_buffer, XINT (pos));
4057 return Qnil;
4060 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4061 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4062 (Lisp_Object overlay, Lisp_Object prop)
4064 CHECK_OVERLAY (overlay);
4065 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4068 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4069 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4070 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4072 Lisp_Object tail, buffer;
4073 int changed;
4075 CHECK_OVERLAY (overlay);
4077 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4079 for (tail = XOVERLAY (overlay)->plist;
4080 CONSP (tail) && CONSP (XCDR (tail));
4081 tail = XCDR (XCDR (tail)))
4082 if (EQ (XCAR (tail), prop))
4084 changed = !EQ (XCAR (XCDR (tail)), value);
4085 XSETCAR (XCDR (tail), value);
4086 goto found;
4088 /* It wasn't in the list, so add it to the front. */
4089 changed = !NILP (value);
4090 XOVERLAY (overlay)->plist
4091 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4092 found:
4093 if (! NILP (buffer))
4095 if (changed)
4096 modify_overlay (XBUFFER (buffer),
4097 marker_position (OVERLAY_START (overlay)),
4098 marker_position (OVERLAY_END (overlay)));
4099 if (EQ (prop, Qevaporate) && ! NILP (value)
4100 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4101 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4102 Fdelete_overlay (overlay);
4105 return value;
4108 /* Subroutine of report_overlay_modification. */
4110 /* Lisp vector holding overlay hook functions to call.
4111 Vector elements come in pairs.
4112 Each even-index element is a list of hook functions.
4113 The following odd-index element is the overlay they came from.
4115 Before the buffer change, we fill in this vector
4116 as we call overlay hook functions.
4117 After the buffer change, we get the functions to call from this vector.
4118 This way we always call the same functions before and after the change. */
4119 static Lisp_Object last_overlay_modification_hooks;
4121 /* Number of elements actually used in last_overlay_modification_hooks. */
4122 static int last_overlay_modification_hooks_used;
4124 /* Add one functionlist/overlay pair
4125 to the end of last_overlay_modification_hooks. */
4127 static void
4128 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4130 int oldsize = ASIZE (last_overlay_modification_hooks);
4132 if (last_overlay_modification_hooks_used == oldsize)
4133 last_overlay_modification_hooks = larger_vector
4134 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4135 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4136 functionlist); last_overlay_modification_hooks_used++;
4137 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4138 overlay); last_overlay_modification_hooks_used++;
4141 /* Run the modification-hooks of overlays that include
4142 any part of the text in START to END.
4143 If this change is an insertion, also
4144 run the insert-before-hooks of overlay starting at END,
4145 and the insert-after-hooks of overlay ending at START.
4147 This is called both before and after the modification.
4148 AFTER is nonzero when we call after the modification.
4150 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4151 When AFTER is nonzero, they are the start position,
4152 the position after the inserted new text,
4153 and the length of deleted or replaced old text. */
4155 void
4156 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4157 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4159 Lisp_Object prop, overlay;
4160 struct Lisp_Overlay *tail;
4161 /* 1 if this change is an insertion. */
4162 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4163 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4165 overlay = Qnil;
4166 tail = NULL;
4168 /* We used to run the functions as soon as we found them and only register
4169 them in last_overlay_modification_hooks for the purpose of the `after'
4170 case. But running elisp code as we traverse the list of overlays is
4171 painful because the list can be modified by the elisp code so we had to
4172 copy at several places. We now simply do a read-only traversal that
4173 only collects the functions to run and we run them afterwards. It's
4174 simpler, especially since all the code was already there. -stef */
4176 if (!after)
4178 /* We are being called before a change.
4179 Scan the overlays to find the functions to call. */
4180 last_overlay_modification_hooks_used = 0;
4181 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4183 EMACS_INT startpos, endpos;
4184 Lisp_Object ostart, oend;
4186 XSETMISC (overlay, tail);
4188 ostart = OVERLAY_START (overlay);
4189 oend = OVERLAY_END (overlay);
4190 endpos = OVERLAY_POSITION (oend);
4191 if (XFASTINT (start) > endpos)
4192 break;
4193 startpos = OVERLAY_POSITION (ostart);
4194 if (insertion && (XFASTINT (start) == startpos
4195 || XFASTINT (end) == startpos))
4197 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4198 if (!NILP (prop))
4199 add_overlay_mod_hooklist (prop, overlay);
4201 if (insertion && (XFASTINT (start) == endpos
4202 || XFASTINT (end) == endpos))
4204 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4205 if (!NILP (prop))
4206 add_overlay_mod_hooklist (prop, overlay);
4208 /* Test for intersecting intervals. This does the right thing
4209 for both insertion and deletion. */
4210 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4212 prop = Foverlay_get (overlay, Qmodification_hooks);
4213 if (!NILP (prop))
4214 add_overlay_mod_hooklist (prop, overlay);
4218 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4220 EMACS_INT startpos, endpos;
4221 Lisp_Object ostart, oend;
4223 XSETMISC (overlay, tail);
4225 ostart = OVERLAY_START (overlay);
4226 oend = OVERLAY_END (overlay);
4227 startpos = OVERLAY_POSITION (ostart);
4228 endpos = OVERLAY_POSITION (oend);
4229 if (XFASTINT (end) < startpos)
4230 break;
4231 if (insertion && (XFASTINT (start) == startpos
4232 || XFASTINT (end) == startpos))
4234 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4235 if (!NILP (prop))
4236 add_overlay_mod_hooklist (prop, overlay);
4238 if (insertion && (XFASTINT (start) == endpos
4239 || XFASTINT (end) == endpos))
4241 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4242 if (!NILP (prop))
4243 add_overlay_mod_hooklist (prop, overlay);
4245 /* Test for intersecting intervals. This does the right thing
4246 for both insertion and deletion. */
4247 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4249 prop = Foverlay_get (overlay, Qmodification_hooks);
4250 if (!NILP (prop))
4251 add_overlay_mod_hooklist (prop, overlay);
4256 GCPRO4 (overlay, arg1, arg2, arg3);
4258 /* Call the functions recorded in last_overlay_modification_hooks.
4259 First copy the vector contents, in case some of these hooks
4260 do subsequent modification of the buffer. */
4261 int size = last_overlay_modification_hooks_used;
4262 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4263 int i;
4265 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4266 size * sizeof (Lisp_Object));
4267 gcpro1.var = copy;
4268 gcpro1.nvars = size;
4270 for (i = 0; i < size;)
4272 Lisp_Object prop_i, overlay_i;
4273 prop_i = copy[i++];
4274 overlay_i = copy[i++];
4275 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4278 UNGCPRO;
4281 static void
4282 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4283 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4285 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4287 GCPRO4 (list, arg1, arg2, arg3);
4289 while (CONSP (list))
4291 if (NILP (arg3))
4292 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4293 else
4294 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4295 list = XCDR (list);
4297 UNGCPRO;
4300 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4301 property is set. */
4302 void
4303 evaporate_overlays (EMACS_INT pos)
4305 Lisp_Object overlay, hit_list;
4306 struct Lisp_Overlay *tail;
4308 hit_list = Qnil;
4309 if (pos <= current_buffer->overlay_center)
4310 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4312 EMACS_INT endpos;
4313 XSETMISC (overlay, tail);
4314 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4315 if (endpos < pos)
4316 break;
4317 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4318 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4319 hit_list = Fcons (overlay, hit_list);
4321 else
4322 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4324 EMACS_INT startpos;
4325 XSETMISC (overlay, tail);
4326 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4327 if (startpos > pos)
4328 break;
4329 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4330 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4331 hit_list = Fcons (overlay, hit_list);
4333 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4334 Fdelete_overlay (XCAR (hit_list));
4337 /* Somebody has tried to store a value with an unacceptable type
4338 in the slot with offset OFFSET. */
4340 void
4341 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4343 Lisp_Object predicate;
4345 switch (type)
4347 case_Lisp_Int: predicate = Qintegerp; break;
4348 case Lisp_String: predicate = Qstringp; break;
4349 case Lisp_Symbol: predicate = Qsymbolp; break;
4350 default: abort ();
4353 wrong_type_argument (predicate, newval);
4357 /***********************************************************************
4358 Allocation with mmap
4359 ***********************************************************************/
4361 #ifdef USE_MMAP_FOR_BUFFERS
4363 #include <sys/types.h>
4364 #include <sys/mman.h>
4366 #ifndef MAP_ANON
4367 #ifdef MAP_ANONYMOUS
4368 #define MAP_ANON MAP_ANONYMOUS
4369 #else
4370 #define MAP_ANON 0
4371 #endif
4372 #endif
4374 #ifndef MAP_FAILED
4375 #define MAP_FAILED ((void *) -1)
4376 #endif
4378 #include <stdio.h>
4380 #if MAP_ANON == 0
4381 #include <fcntl.h>
4382 #endif
4384 #include "coding.h"
4387 /* Memory is allocated in regions which are mapped using mmap(2).
4388 The current implementation lets the system select mapped
4389 addresses; we're not using MAP_FIXED in general, except when
4390 trying to enlarge regions.
4392 Each mapped region starts with a mmap_region structure, the user
4393 area starts after that structure, aligned to MEM_ALIGN.
4395 +-----------------------+
4396 | struct mmap_info + |
4397 | padding |
4398 +-----------------------+
4399 | user data |
4402 +-----------------------+ */
4404 struct mmap_region
4406 /* User-specified size. */
4407 size_t nbytes_specified;
4409 /* Number of bytes mapped */
4410 size_t nbytes_mapped;
4412 /* Pointer to the location holding the address of the memory
4413 allocated with the mmap'd block. The variable actually points
4414 after this structure. */
4415 POINTER_TYPE **var;
4417 /* Next and previous in list of all mmap'd regions. */
4418 struct mmap_region *next, *prev;
4421 /* Doubly-linked list of mmap'd regions. */
4423 static struct mmap_region *mmap_regions;
4425 /* File descriptor for mmap. If we don't have anonymous mapping,
4426 /dev/zero will be opened on it. */
4428 static int mmap_fd;
4430 /* Temporary storage for mmap_set_vars, see there. */
4432 static struct mmap_region *mmap_regions_1;
4433 static int mmap_fd_1;
4435 /* Page size on this system. */
4437 static int mmap_page_size;
4439 /* 1 means mmap has been intialized. */
4441 static int mmap_initialized_p;
4443 /* Value is X rounded up to the next multiple of N. */
4445 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4447 /* Size of mmap_region structure plus padding. */
4449 #define MMAP_REGION_STRUCT_SIZE \
4450 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4452 /* Given a pointer P to the start of the user-visible part of a mapped
4453 region, return a pointer to the start of the region. */
4455 #define MMAP_REGION(P) \
4456 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4458 /* Given a pointer P to the start of a mapped region, return a pointer
4459 to the start of the user-visible part of the region. */
4461 #define MMAP_USER_AREA(P) \
4462 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4464 #define MEM_ALIGN sizeof (double)
4466 /* Predicate returning true if part of the address range [START .. END]
4467 is currently mapped. Used to prevent overwriting an existing
4468 memory mapping.
4470 Default is to conservativly assume the address range is occupied by
4471 something else. This can be overridden by system configuration
4472 files if system-specific means to determine this exists. */
4474 #ifndef MMAP_ALLOCATED_P
4475 #define MMAP_ALLOCATED_P(start, end) 1
4476 #endif
4478 /* Function prototypes. */
4480 static int mmap_free_1 (struct mmap_region *);
4481 static int mmap_enlarge (struct mmap_region *, int);
4482 static struct mmap_region *mmap_find (POINTER_TYPE *, POINTER_TYPE *);
4483 static POINTER_TYPE *mmap_alloc (POINTER_TYPE **, size_t);
4484 static POINTER_TYPE *mmap_realloc (POINTER_TYPE **, size_t);
4485 static void mmap_free (POINTER_TYPE **ptr);
4486 static void mmap_init (void);
4489 /* Return a region overlapping address range START...END, or null if
4490 none. END is not including, i.e. the last byte in the range
4491 is at END - 1. */
4493 static struct mmap_region *
4494 mmap_find (start, end)
4495 POINTER_TYPE *start, *end;
4497 struct mmap_region *r;
4498 char *s = (char *) start, *e = (char *) end;
4500 for (r = mmap_regions; r; r = r->next)
4502 char *rstart = (char *) r;
4503 char *rend = rstart + r->nbytes_mapped;
4505 if (/* First byte of range, i.e. START, in this region? */
4506 (s >= rstart && s < rend)
4507 /* Last byte of range, i.e. END - 1, in this region? */
4508 || (e > rstart && e <= rend)
4509 /* First byte of this region in the range? */
4510 || (rstart >= s && rstart < e)
4511 /* Last byte of this region in the range? */
4512 || (rend > s && rend <= e))
4513 break;
4516 return r;
4520 /* Unmap a region. P is a pointer to the start of the user-araa of
4521 the region. Value is non-zero if successful. */
4523 static int
4524 mmap_free_1 (r)
4525 struct mmap_region *r;
4527 if (r->next)
4528 r->next->prev = r->prev;
4529 if (r->prev)
4530 r->prev->next = r->next;
4531 else
4532 mmap_regions = r->next;
4534 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4536 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4537 return 0;
4540 return 1;
4544 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4545 Value is non-zero if successful. */
4547 static int
4548 mmap_enlarge (r, npages)
4549 struct mmap_region *r;
4550 int npages;
4552 char *region_end = (char *) r + r->nbytes_mapped;
4553 size_t nbytes;
4554 int success = 0;
4556 if (npages < 0)
4558 /* Unmap pages at the end of the region. */
4559 nbytes = - npages * mmap_page_size;
4560 if (munmap (region_end - nbytes, nbytes) == -1)
4561 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4562 else
4564 r->nbytes_mapped -= nbytes;
4565 success = 1;
4568 else if (npages > 0)
4570 nbytes = npages * mmap_page_size;
4572 /* Try to map additional pages at the end of the region. We
4573 cannot do this if the address range is already occupied by
4574 something else because mmap deletes any previous mapping.
4575 I'm not sure this is worth doing, let's see. */
4576 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4578 POINTER_TYPE *p;
4580 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4581 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4582 if (p == MAP_FAILED)
4583 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4584 else if (p != (POINTER_TYPE *) region_end)
4586 /* Kernels are free to choose a different address. In
4587 that case, unmap what we've mapped above; we have
4588 no use for it. */
4589 if (munmap (p, nbytes) == -1)
4590 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4592 else
4594 r->nbytes_mapped += nbytes;
4595 success = 1;
4600 return success;
4604 /* Set or reset variables holding references to mapped regions. If
4605 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4606 non-zero, set all variables to the start of the user-areas
4607 of mapped regions.
4609 This function is called from Fdump_emacs to ensure that the dumped
4610 Emacs doesn't contain references to memory that won't be mapped
4611 when Emacs starts. */
4613 void
4614 mmap_set_vars (restore_p)
4615 int restore_p;
4617 struct mmap_region *r;
4619 if (restore_p)
4621 mmap_regions = mmap_regions_1;
4622 mmap_fd = mmap_fd_1;
4623 for (r = mmap_regions; r; r = r->next)
4624 *r->var = MMAP_USER_AREA (r);
4626 else
4628 for (r = mmap_regions; r; r = r->next)
4629 *r->var = NULL;
4630 mmap_regions_1 = mmap_regions;
4631 mmap_regions = NULL;
4632 mmap_fd_1 = mmap_fd;
4633 mmap_fd = -1;
4638 /* Allocate a block of storage large enough to hold NBYTES bytes of
4639 data. A pointer to the data is returned in *VAR. VAR is thus the
4640 address of some variable which will use the data area.
4642 The allocation of 0 bytes is valid.
4644 If we can't allocate the necessary memory, set *VAR to null, and
4645 return null. */
4647 static POINTER_TYPE *
4648 mmap_alloc (var, nbytes)
4649 POINTER_TYPE **var;
4650 size_t nbytes;
4652 void *p;
4653 size_t map;
4655 mmap_init ();
4657 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4658 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4659 mmap_fd, 0);
4661 if (p == MAP_FAILED)
4663 if (errno != ENOMEM)
4664 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4665 p = NULL;
4667 else
4669 struct mmap_region *r = (struct mmap_region *) p;
4671 r->nbytes_specified = nbytes;
4672 r->nbytes_mapped = map;
4673 r->var = var;
4674 r->prev = NULL;
4675 r->next = mmap_regions;
4676 if (r->next)
4677 r->next->prev = r;
4678 mmap_regions = r;
4680 p = MMAP_USER_AREA (p);
4683 return *var = p;
4687 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4688 resize it to size NBYTES. Change *VAR to reflect the new block,
4689 and return this value. If more memory cannot be allocated, then
4690 leave *VAR unchanged, and return null. */
4692 static POINTER_TYPE *
4693 mmap_realloc (var, nbytes)
4694 POINTER_TYPE **var;
4695 size_t nbytes;
4697 POINTER_TYPE *result;
4699 mmap_init ();
4701 if (*var == NULL)
4702 result = mmap_alloc (var, nbytes);
4703 else if (nbytes == 0)
4705 mmap_free (var);
4706 result = mmap_alloc (var, nbytes);
4708 else
4710 struct mmap_region *r = MMAP_REGION (*var);
4711 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4713 if (room < nbytes)
4715 /* Must enlarge. */
4716 POINTER_TYPE *old_ptr = *var;
4718 /* Try to map additional pages at the end of the region.
4719 If that fails, allocate a new region, copy data
4720 from the old region, then free it. */
4721 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4722 / mmap_page_size)))
4724 r->nbytes_specified = nbytes;
4725 *var = result = old_ptr;
4727 else if (mmap_alloc (var, nbytes))
4729 memcpy (*var, old_ptr, r->nbytes_specified);
4730 mmap_free_1 (MMAP_REGION (old_ptr));
4731 result = *var;
4732 r = MMAP_REGION (result);
4733 r->nbytes_specified = nbytes;
4735 else
4737 *var = old_ptr;
4738 result = NULL;
4741 else if (room - nbytes >= mmap_page_size)
4743 /* Shrinking by at least a page. Let's give some
4744 memory back to the system.
4746 The extra parens are to make the division happens first,
4747 on positive values, so we know it will round towards
4748 zero. */
4749 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4750 result = *var;
4751 r->nbytes_specified = nbytes;
4753 else
4755 /* Leave it alone. */
4756 result = *var;
4757 r->nbytes_specified = nbytes;
4761 return result;
4765 /* Free a block of relocatable storage whose data is pointed to by
4766 PTR. Store 0 in *PTR to show there's no block allocated. */
4768 static void
4769 mmap_free (var)
4770 POINTER_TYPE **var;
4772 mmap_init ();
4774 if (*var)
4776 mmap_free_1 (MMAP_REGION (*var));
4777 *var = NULL;
4782 /* Perform necessary intializations for the use of mmap. */
4784 static void
4785 mmap_init ()
4787 #if MAP_ANON == 0
4788 /* The value of mmap_fd is initially 0 in temacs, and -1
4789 in a dumped Emacs. */
4790 if (mmap_fd <= 0)
4792 /* No anonymous mmap -- we need the file descriptor. */
4793 mmap_fd = open ("/dev/zero", O_RDONLY);
4794 if (mmap_fd == -1)
4795 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4797 #endif /* MAP_ANON == 0 */
4799 if (mmap_initialized_p)
4800 return;
4801 mmap_initialized_p = 1;
4803 #if MAP_ANON != 0
4804 mmap_fd = -1;
4805 #endif
4807 mmap_page_size = getpagesize ();
4810 #endif /* USE_MMAP_FOR_BUFFERS */
4814 /***********************************************************************
4815 Buffer-text Allocation
4816 ***********************************************************************/
4818 #ifdef REL_ALLOC
4819 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4820 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4821 extern void r_alloc_free (POINTER_TYPE **ptr);
4822 #endif /* REL_ALLOC */
4825 /* Allocate NBYTES bytes for buffer B's text buffer. */
4827 static void
4828 alloc_buffer_text (struct buffer *b, size_t nbytes)
4830 POINTER_TYPE *p;
4832 BLOCK_INPUT;
4833 #if defined USE_MMAP_FOR_BUFFERS
4834 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4835 #elif defined REL_ALLOC
4836 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4837 #else
4838 p = xmalloc (nbytes);
4839 #endif
4841 if (p == NULL)
4843 UNBLOCK_INPUT;
4844 memory_full (nbytes);
4847 b->text->beg = (unsigned char *) p;
4848 UNBLOCK_INPUT;
4851 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4852 shrink it. */
4854 void
4855 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4857 POINTER_TYPE *p;
4858 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4859 + delta);
4860 BLOCK_INPUT;
4861 #if defined USE_MMAP_FOR_BUFFERS
4862 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4863 #elif defined REL_ALLOC
4864 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4865 #else
4866 p = xrealloc (b->text->beg, nbytes);
4867 #endif
4869 if (p == NULL)
4871 UNBLOCK_INPUT;
4872 memory_full (nbytes);
4875 BUF_BEG_ADDR (b) = (unsigned char *) p;
4876 UNBLOCK_INPUT;
4880 /* Free buffer B's text buffer. */
4882 static void
4883 free_buffer_text (struct buffer *b)
4885 BLOCK_INPUT;
4887 #if defined USE_MMAP_FOR_BUFFERS
4888 mmap_free ((POINTER_TYPE **) &b->text->beg);
4889 #elif defined REL_ALLOC
4890 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4891 #else
4892 xfree (b->text->beg);
4893 #endif
4895 BUF_BEG_ADDR (b) = NULL;
4896 UNBLOCK_INPUT;
4901 /***********************************************************************
4902 Initialization
4903 ***********************************************************************/
4905 void
4906 init_buffer_once (void)
4908 int idx;
4910 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4912 /* Make sure all markable slots in buffer_defaults
4913 are initialized reasonably, so mark_buffer won't choke. */
4914 reset_buffer (&buffer_defaults);
4915 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4916 reset_buffer_local_variables (&buffer_defaults, 1);
4917 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4918 reset_buffer (&buffer_local_symbols);
4919 reset_buffer_local_variables (&buffer_local_symbols, 1);
4920 /* Prevent GC from getting confused. */
4921 buffer_defaults.text = &buffer_defaults.own_text;
4922 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4923 BUF_INTERVALS (&buffer_defaults) = 0;
4924 BUF_INTERVALS (&buffer_local_symbols) = 0;
4925 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4926 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4927 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4928 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4930 /* Set up the default values of various buffer slots. */
4931 /* Must do these before making the first buffer! */
4933 /* real setup is done in bindings.el */
4934 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4935 BVAR (&buffer_defaults, header_line_format) = Qnil;
4936 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4937 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4938 BVAR (&buffer_defaults, case_fold_search) = Qt;
4939 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4940 BVAR (&buffer_defaults, selective_display) = Qnil;
4941 #ifndef old
4942 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4943 #endif
4944 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4945 BVAR (&buffer_defaults, display_table) = Qnil;
4946 BVAR (&buffer_defaults, undo_list) = Qnil;
4947 BVAR (&buffer_defaults, mark_active) = Qnil;
4948 BVAR (&buffer_defaults, file_format) = Qnil;
4949 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4950 buffer_defaults.overlays_before = NULL;
4951 buffer_defaults.overlays_after = NULL;
4952 buffer_defaults.overlay_center = BEG;
4954 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4955 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4956 BVAR (&buffer_defaults, word_wrap) = Qnil;
4957 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4958 BVAR (&buffer_defaults, bidi_display_reordering) = Qnil;
4959 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4960 BVAR (&buffer_defaults, cursor_type) = Qt;
4961 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4962 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4964 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4965 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4966 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4967 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4968 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4969 BVAR (&buffer_defaults, file_truename) = Qnil;
4970 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4971 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4972 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4973 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4974 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4975 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4976 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4977 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4978 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4979 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4980 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4981 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4982 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4983 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4984 BVAR (&buffer_defaults, display_time) = Qnil;
4986 /* Assign the local-flags to the slots that have default values.
4987 The local flag is a bit that is used in the buffer
4988 to say that it has its own local value for the slot.
4989 The local flag bits are in the local_var_flags slot of the buffer. */
4991 /* Nothing can work if this isn't true */
4992 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4994 /* 0 means not a lisp var, -1 means always local, else mask */
4995 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4996 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4997 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4998 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4999 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
5000 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
5001 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
5002 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
5003 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
5004 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
5005 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
5006 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
5007 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
5008 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
5009 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
5010 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
5011 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
5012 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
5013 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
5015 idx = 1;
5016 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
5017 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
5018 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
5019 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
5020 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
5021 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
5022 #ifndef old
5023 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
5024 #endif
5025 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
5026 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
5027 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
5028 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
5029 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5030 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5031 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5032 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
5033 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5034 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
5035 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5036 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5037 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5038 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5039 /* Make this one a permanent local. */
5040 buffer_permanent_local_flags[idx++] = 1;
5041 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5042 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5043 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5044 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5045 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5046 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5047 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5048 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5049 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5050 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5051 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5052 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5053 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5054 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5055 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5056 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5057 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5059 /* Need more room? */
5060 if (idx >= MAX_PER_BUFFER_VARS)
5061 abort ();
5062 last_per_buffer_idx = idx;
5064 Vbuffer_alist = Qnil;
5065 current_buffer = 0;
5066 all_buffers = 0;
5068 QSFundamental = make_pure_c_string ("Fundamental");
5070 Qfundamental_mode = intern_c_string ("fundamental-mode");
5071 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5073 Qmode_class = intern_c_string ("mode-class");
5075 Qprotected_field = intern_c_string ("protected-field");
5077 Qpermanent_local = intern_c_string ("permanent-local");
5079 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5080 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5082 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5084 /* super-magic invisible buffer */
5085 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5086 Vbuffer_alist = Qnil;
5088 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5090 inhibit_modification_hooks = 0;
5093 void
5094 init_buffer (void)
5096 char *pwd;
5097 Lisp_Object temp;
5098 ptrdiff_t len;
5100 #ifdef USE_MMAP_FOR_BUFFERS
5102 /* When using the ralloc implementation based on mmap(2), buffer
5103 text pointers will have been set to null in the dumped Emacs.
5104 Map new memory. */
5105 struct buffer *b;
5107 for (b = all_buffers; b; b = b->header.next.buffer)
5108 if (b->text->beg == NULL)
5109 enlarge_buffer_text (b, 0);
5111 #endif /* USE_MMAP_FOR_BUFFERS */
5113 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5114 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5115 Fset_buffer_multibyte (Qnil);
5117 pwd = get_current_dir_name ();
5119 if (!pwd)
5120 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5122 /* Maybe this should really use some standard subroutine
5123 whose definition is filename syntax dependent. */
5124 len = strlen (pwd);
5125 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5127 /* Grow buffer to add directory separator and '\0'. */
5128 pwd = (char *) realloc (pwd, len + 2);
5129 if (!pwd)
5130 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5131 pwd[len] = DIRECTORY_SEP;
5132 pwd[len + 1] = '\0';
5135 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5136 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5137 /* At this moment, we still don't know how to decode the
5138 directory name. So, we keep the bytes in multibyte form so
5139 that ENCODE_FILE correctly gets the original bytes. */
5140 BVAR (current_buffer, directory)
5141 = string_to_multibyte (BVAR (current_buffer, directory));
5143 /* Add /: to the front of the name
5144 if it would otherwise be treated as magic. */
5145 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5146 if (! NILP (temp)
5147 /* If the default dir is just /, TEMP is non-nil
5148 because of the ange-ftp completion handler.
5149 However, it is not necessary to turn / into /:/.
5150 So avoid doing that. */
5151 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5152 BVAR (current_buffer, directory)
5153 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5155 temp = get_minibuffer (0);
5156 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5158 free (pwd);
5161 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5162 Object stored in the current buffer. address is the address of the slot
5163 in the buffer that is current now. */
5165 /* TYPE is nil for a general Lisp variable.
5166 An integer specifies a type; then only Lisp values
5167 with that type code are allowed (except that nil is allowed too).
5168 LNAME is the Lisp-level variable name.
5169 VNAME is the name of the buffer slot.
5170 DOC is a dummy where you write the doc string as a comment. */
5171 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5172 do { \
5173 static struct Lisp_Buffer_Objfwd bo_fwd; \
5174 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5175 } while (0)
5177 static void
5178 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5179 Lisp_Object *address, Lisp_Object type)
5181 struct Lisp_Symbol *sym;
5182 int offset;
5184 sym = XSYMBOL (intern (namestring));
5185 offset = (char *)address - (char *)current_buffer;
5187 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5188 bo_fwd->offset = offset;
5189 bo_fwd->slottype = type;
5190 sym->declared_special = 1;
5191 sym->redirect = SYMBOL_FORWARDED;
5193 /* I tried to do the job without a cast, but it seems impossible.
5194 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5195 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5197 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5199 if (PER_BUFFER_IDX (offset) == 0)
5200 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5201 slot of buffer_local_flags */
5202 abort ();
5206 /* initialize the buffer routines */
5207 void
5208 syms_of_buffer (void)
5210 staticpro (&last_overlay_modification_hooks);
5211 last_overlay_modification_hooks
5212 = Fmake_vector (make_number (10), Qnil);
5214 staticpro (&Vbuffer_defaults);
5215 staticpro (&Vbuffer_local_symbols);
5216 staticpro (&Qfundamental_mode);
5217 staticpro (&Qmode_class);
5218 staticpro (&QSFundamental);
5219 staticpro (&Vbuffer_alist);
5220 staticpro (&Qprotected_field);
5221 staticpro (&Qpermanent_local);
5222 staticpro (&Qkill_buffer_hook);
5224 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5225 DEFSYM (Qoverlayp, "overlayp");
5226 DEFSYM (Qevaporate, "evaporate");
5227 DEFSYM (Qmodification_hooks, "modification-hooks");
5228 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5229 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5230 DEFSYM (Qget_file_buffer, "get-file-buffer");
5231 DEFSYM (Qpriority, "priority");
5232 DEFSYM (Qclone_number, "clone-number");
5233 DEFSYM (Qbefore_string, "before-string");
5234 DEFSYM (Qafter_string, "after-string");
5235 DEFSYM (Qfirst_change_hook, "first-change-hook");
5236 DEFSYM (Qbefore_change_functions, "before-change-functions");
5237 DEFSYM (Qafter_change_functions, "after-change-functions");
5238 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5240 /* The next one is initialized in init_buffer_once. */
5241 staticpro (&Qucs_set_table_for_input);
5243 Fput (Qprotected_field, Qerror_conditions,
5244 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5245 Fput (Qprotected_field, Qerror_message,
5246 make_pure_c_string ("Attempt to modify a protected field"));
5248 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5249 mode_line_format,
5250 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5251 This is the same as (default-value 'mode-line-format). */);
5253 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5254 header_line_format,
5255 doc: /* Default value of `header-line-format' for buffers that don't override it.
5256 This is the same as (default-value 'header-line-format). */);
5258 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5259 doc: /* Default value of `cursor-type' for buffers that don't override it.
5260 This is the same as (default-value 'cursor-type). */);
5262 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5263 extra_line_spacing,
5264 doc: /* Default value of `line-spacing' for buffers that don't override it.
5265 This is the same as (default-value 'line-spacing). */);
5267 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5268 cursor_in_non_selected_windows,
5269 doc: /* Default value of `cursor-in-non-selected-windows'.
5270 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5272 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5273 abbrev_mode,
5274 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5275 This is the same as (default-value 'abbrev-mode). */);
5277 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5278 ctl_arrow,
5279 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5280 This is the same as (default-value 'ctl-arrow). */);
5282 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5283 enable_multibyte_characters,
5284 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5285 This is the same as (default-value 'enable-multibyte-characters). */);
5287 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5288 buffer_file_coding_system,
5289 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5290 This is the same as (default-value 'buffer-file-coding-system). */);
5292 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5293 truncate_lines,
5294 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5295 This is the same as (default-value 'truncate-lines). */);
5297 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5298 fill_column,
5299 doc: /* Default value of `fill-column' for buffers that do not override it.
5300 This is the same as (default-value 'fill-column). */);
5302 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5303 left_margin,
5304 doc: /* Default value of `left-margin' for buffers that do not override it.
5305 This is the same as (default-value 'left-margin). */);
5307 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5308 tab_width,
5309 doc: /* Default value of `tab-width' for buffers that do not override it.
5310 This is the same as (default-value 'tab-width). */);
5312 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5313 case_fold_search,
5314 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5315 This is the same as (default-value 'case-fold-search). */);
5317 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5318 left_margin_cols,
5319 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5320 This is the same as (default-value 'left-margin-width). */);
5322 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5323 right_margin_cols,
5324 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5325 This is the same as (default-value 'right-margin-width). */);
5327 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5328 left_fringe_width,
5329 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5330 This is the same as (default-value 'left-fringe-width). */);
5332 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5333 right_fringe_width,
5334 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5335 This is the same as (default-value 'right-fringe-width). */);
5337 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5338 fringes_outside_margins,
5339 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5340 This is the same as (default-value 'fringes-outside-margins). */);
5342 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5343 scroll_bar_width,
5344 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5345 This is the same as (default-value 'scroll-bar-width). */);
5347 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5348 vertical_scroll_bar_type,
5349 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5350 This is the same as (default-value 'vertical-scroll-bar). */);
5352 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5353 indicate_empty_lines,
5354 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5355 This is the same as (default-value 'indicate-empty-lines). */);
5357 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5358 indicate_buffer_boundaries,
5359 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5360 This is the same as (default-value 'indicate-buffer-boundaries). */);
5362 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5363 fringe_indicator_alist,
5364 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5365 This is the same as (default-value 'fringe-indicator-alist'). */);
5367 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5368 fringe_cursor_alist,
5369 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5370 This is the same as (default-value 'fringe-cursor-alist'). */);
5372 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5373 scroll_up_aggressively,
5374 doc: /* Default value of `scroll-up-aggressively'.
5375 This value applies in buffers that don't have their own local values.
5376 This is the same as (default-value 'scroll-up-aggressively). */);
5378 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5379 scroll_down_aggressively,
5380 doc: /* Default value of `scroll-down-aggressively'.
5381 This value applies in buffers that don't have their own local values.
5382 This is the same as (default-value 'scroll-down-aggressively). */);
5384 DEFVAR_PER_BUFFER ("header-line-format",
5385 &BVAR (current_buffer, header_line_format),
5386 Qnil,
5387 doc: /* Analogous to `mode-line-format', but controls the header line.
5388 The header line appears, optionally, at the top of a window;
5389 the mode line appears at the bottom. */);
5391 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5392 Qnil,
5393 doc: /* Template for displaying mode line for current buffer.
5394 Each buffer has its own value of this variable.
5395 Value may be nil, a string, a symbol or a list or cons cell.
5396 A value of nil means don't display a mode line.
5397 For a symbol, its value is used (but it is ignored if t or nil).
5398 A string appearing directly as the value of a symbol is processed verbatim
5399 in that the %-constructs below are not recognized.
5400 Note that unless the symbol is marked as a `risky-local-variable', all
5401 properties in any strings, as well as all :eval and :propertize forms
5402 in the value of that symbol will be ignored.
5403 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5404 is used as a mode line element. Be careful--FORM should not load any files,
5405 because that can cause an infinite recursion.
5406 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5407 with the specified properties PROPS applied.
5408 For a list whose car is a symbol, the symbol's value is taken,
5409 and if that is non-nil, the cadr of the list is processed recursively.
5410 Otherwise, the caddr of the list (if there is one) is processed.
5411 For a list whose car is a string or list, each element is processed
5412 recursively and the results are effectively concatenated.
5413 For a list whose car is an integer, the cdr of the list is processed
5414 and padded (if the number is positive) or truncated (if negative)
5415 to the width specified by that number.
5416 A string is printed verbatim in the mode line except for %-constructs:
5417 (%-constructs are allowed when the string is the entire mode-line-format
5418 or when it is found in a cons-cell or a list)
5419 %b -- print buffer name. %f -- print visited file name.
5420 %F -- print frame name.
5421 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5422 %& is like %*, but ignore read-only-ness.
5423 % means buffer is read-only and * means it is modified.
5424 For a modified read-only buffer, %* gives % and %+ gives *.
5425 %s -- print process status. %l -- print the current line number.
5426 %c -- print the current column number (this makes editing slower).
5427 To make the column number update correctly in all cases,
5428 `column-number-mode' must be non-nil.
5429 %i -- print the size of the buffer.
5430 %I -- like %i, but use k, M, G, etc., to abbreviate.
5431 %p -- print percent of buffer above top of window, or Top, Bot or All.
5432 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5433 or print Bottom or All.
5434 %n -- print Narrow if appropriate.
5435 %t -- visited file is text or binary (if OS supports this distinction).
5436 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5437 %Z -- like %z, but including the end-of-line format.
5438 %e -- print error message about full memory.
5439 %@ -- print @ or hyphen. @ means that default-directory is on a
5440 remote machine.
5441 %[ -- print one [ for each recursive editing level. %] similar.
5442 %% -- print %. %- -- print infinitely many dashes.
5443 Decimal digits after the % specify field width to which to pad. */);
5445 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5446 doc: /* *Value of `major-mode' for new buffers. */);
5448 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5449 make_number (Lisp_Symbol),
5450 doc: /* Symbol for current buffer's major mode.
5451 The default value (normally `fundamental-mode') affects new buffers.
5452 A value of nil means to use the current buffer's major mode, provided
5453 it is not marked as "special".
5455 When a mode is used by default, `find-file' switches to it before it
5456 reads the contents into the buffer and before it finishes setting up
5457 the buffer. Thus, the mode and its hooks should not expect certain
5458 variables such as `buffer-read-only' and `buffer-file-coding-system'
5459 to be set up. */);
5461 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5462 Qnil,
5463 doc: /* Pretty name of current buffer's major mode.
5464 Usually a string, but can use any of the constructs for `mode-line-format',
5465 which see.
5466 Format with `format-mode-line' to produce a string value. */);
5468 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5469 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5471 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5472 doc: /* Non-nil if Abbrev mode is enabled.
5473 Use the command `abbrev-mode' to change this variable. */);
5475 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5476 Qnil,
5477 doc: /* *Non-nil if searches and matches should ignore case. */);
5479 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5480 make_number (LISP_INT_TAG),
5481 doc: /* *Column beyond which automatic line-wrapping should happen.
5482 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5484 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5485 make_number (LISP_INT_TAG),
5486 doc: /* *Column for the default `indent-line-function' to indent to.
5487 Linefeed indents to this column in Fundamental mode. */);
5489 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5490 make_number (LISP_INT_TAG),
5491 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5492 This should be an integer greater than zero. */);
5494 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5495 doc: /* *Non-nil means display control chars with uparrow.
5496 A value of nil means use backslash and octal digits.
5497 This variable does not apply to characters whose display is specified
5498 in the current display table (if there is one). */);
5500 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5501 &BVAR (current_buffer, enable_multibyte_characters),
5502 Qnil,
5503 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5504 Otherwise they are regarded as unibyte. This affects the display,
5505 file I/O and the behavior of various editing commands.
5507 This variable is buffer-local but you cannot set it directly;
5508 use the function `set-buffer-multibyte' to change a buffer's representation.
5509 Changing its default value with `setq-default' is supported.
5510 See also variable `default-enable-multibyte-characters' and Info node
5511 `(elisp)Text Representations'. */);
5512 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5514 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5515 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5516 doc: /* Coding system to be used for encoding the buffer contents on saving.
5517 This variable applies to saving the buffer, and also to `write-region'
5518 and other functions that use `write-region'.
5519 It does not apply to sending output to subprocesses, however.
5521 If this is nil, the buffer is saved without any code conversion
5522 unless some coding system is specified in `file-coding-system-alist'
5523 for the buffer file.
5525 If the text to be saved cannot be encoded as specified by this variable,
5526 an alternative encoding is selected by `select-safe-coding-system', which see.
5528 The variable `coding-system-for-write', if non-nil, overrides this variable.
5530 This variable is never applied to a way of decoding a file while reading it. */);
5532 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5533 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5534 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5536 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5537 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5538 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5540 If this is nil (the default), the direction of each paragraph is
5541 determined by the first strong directional character of its text.
5542 The values of `right-to-left' and `left-to-right' override that.
5543 Any other value is treated as nil.
5545 This variable has no effect unless the buffer's value of
5546 \`bidi-display-reordering' is non-nil. */);
5548 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5549 doc: /* *Non-nil means do not display continuation lines.
5550 Instead, give each line of text just one screen line.
5552 Note that this is overridden by the variable
5553 `truncate-partial-width-windows' if that variable is non-nil
5554 and this buffer is not full-frame width. */);
5556 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5557 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5558 When word-wrapping is on, continuation lines are wrapped at the space
5559 or tab character nearest to the right window edge.
5560 If nil, continuation lines are wrapped at the right screen edge.
5562 This variable has no effect if long lines are truncated (see
5563 `truncate-lines' and `truncate-partial-width-windows'). If you use
5564 word-wrapping, you might want to reduce the value of
5565 `truncate-partial-width-windows', since wrapping can make text readable
5566 in narrower windows. */);
5568 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5569 make_number (Lisp_String),
5570 doc: /* Name of default directory of current buffer. Should end with slash.
5571 To interactively change the default directory, use command `cd'. */);
5573 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5574 Qnil,
5575 doc: /* Function called (if non-nil) to perform auto-fill.
5576 It is called after self-inserting any character specified in
5577 the `auto-fill-chars' table.
5578 NOTE: This variable is not a hook;
5579 its value may not be a list of functions. */);
5581 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5582 make_number (Lisp_String),
5583 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5585 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5586 make_number (Lisp_String),
5587 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5588 The truename of a file is calculated by `file-truename'
5589 and then abbreviated with `abbreviate-file-name'. */);
5591 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5592 &BVAR (current_buffer, auto_save_file_name),
5593 make_number (Lisp_String),
5594 doc: /* Name of file for auto-saving current buffer.
5595 If it is nil, that means don't auto-save this buffer. */);
5597 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5598 doc: /* Non-nil if this buffer is read-only. */);
5600 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5601 doc: /* Non-nil if this buffer's file has been backed up.
5602 Backing up is done before the first time the file is saved. */);
5604 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5605 make_number (LISP_INT_TAG),
5606 doc: /* Length of current buffer when last read in, saved or auto-saved.
5607 0 initially.
5608 -1 means auto-saving turned off until next real save.
5610 If you set this to -2, that means don't turn off auto-saving in this buffer
5611 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5612 you probably should set this to -2 in that buffer. */);
5614 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5615 Qnil,
5616 doc: /* Non-nil enables selective display.
5617 An integer N as value means display only lines
5618 that start with less than N columns of space.
5619 A value of t means that the character ^M makes itself and
5620 all the rest of the line invisible; also, when saving the buffer
5621 in a file, save the ^M as a newline. */);
5623 #ifndef old
5624 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5625 &BVAR (current_buffer, selective_display_ellipses),
5626 Qnil,
5627 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5628 #endif
5630 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5631 doc: /* Non-nil if self-insertion should replace existing text.
5632 The value should be one of `overwrite-mode-textual',
5633 `overwrite-mode-binary', or nil.
5634 If it is `overwrite-mode-textual', self-insertion still
5635 inserts at the end of a line, and inserts when point is before a tab,
5636 until the tab is filled in.
5637 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5639 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5640 Qnil,
5641 doc: /* Display table that controls display of the contents of current buffer.
5643 If this variable is nil, the value of `standard-display-table' is used.
5644 Each window can have its own, overriding display table, see
5645 `set-window-display-table' and `window-display-table'.
5647 The display table is a char-table created with `make-display-table'.
5648 A char-table is an array indexed by character codes. Normal array
5649 primitives `aref' and `aset' can be used to access elements of a char-table.
5651 Each of the char-table elements control how to display the corresponding
5652 text character: the element at index C in the table says how to display
5653 the character whose code is C. Each element should be a vector of
5654 characters or nil. The value nil means display the character in the
5655 default fashion; otherwise, the characters from the vector are delivered
5656 to the screen instead of the original character.
5658 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5659 to display a capital Y instead of each X character.
5661 In addition, a char-table has six extra slots to control the display of:
5663 the end of a truncated screen line (extra-slot 0, a single character);
5664 the end of a continued line (extra-slot 1, a single character);
5665 the escape character used to display character codes in octal
5666 (extra-slot 2, a single character);
5667 the character used as an arrow for control characters (extra-slot 3,
5668 a single character);
5669 the decoration indicating the presence of invisible lines (extra-slot 4,
5670 a vector of characters);
5671 the character used to draw the border between side-by-side windows
5672 (extra-slot 5, a single character).
5674 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5676 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5677 Qnil,
5678 doc: /* *Width of left marginal area for display of a buffer.
5679 A value of nil means no marginal area. */);
5681 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5682 Qnil,
5683 doc: /* *Width of right marginal area for display of a buffer.
5684 A value of nil means no marginal area. */);
5686 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5687 Qnil,
5688 doc: /* *Width of this buffer's left fringe (in pixels).
5689 A value of 0 means no left fringe is shown in this buffer's window.
5690 A value of nil means to use the left fringe width from the window's frame. */);
5692 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5693 Qnil,
5694 doc: /* *Width of this buffer's right fringe (in pixels).
5695 A value of 0 means no right fringe is shown in this buffer's window.
5696 A value of nil means to use the right fringe width from the window's frame. */);
5698 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5699 Qnil,
5700 doc: /* *Non-nil means to display fringes outside display margins.
5701 A value of nil means to display fringes between margins and buffer text. */);
5703 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5704 Qnil,
5705 doc: /* *Width of this buffer's scroll bars in pixels.
5706 A value of nil means to use the scroll bar width from the window's frame. */);
5708 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5709 Qnil,
5710 doc: /* *Position of this buffer's vertical scroll bar.
5711 The value takes effect whenever you tell a window to display this buffer;
5712 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5714 A value of `left' or `right' means put the vertical scroll bar at that side
5715 of the window; a value of nil means don't show any vertical scroll bars.
5716 A value of t (the default) means do whatever the window's frame specifies. */);
5718 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5719 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5720 doc: /* *Visually indicate empty lines after the buffer end.
5721 If non-nil, a bitmap is displayed in the left fringe of a window on
5722 window-systems. */);
5724 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5725 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5726 doc: /* *Visually indicate buffer boundaries and scrolling.
5727 If non-nil, the first and last line of the buffer are marked in the fringe
5728 of a window on window-systems with angle bitmaps, or if the window can be
5729 scrolled, the top and bottom line of the window are marked with up and down
5730 arrow bitmaps.
5732 If value is a symbol `left' or `right', both angle and arrow bitmaps
5733 are displayed in the left or right fringe, resp. Any other value
5734 that doesn't look like an alist means display the angle bitmaps in
5735 the left fringe but no arrows.
5737 You can exercise more precise control by using an alist as the
5738 value. Each alist element (INDICATOR . POSITION) specifies
5739 where to show one of the indicators. INDICATOR is one of `top',
5740 `bottom', `up', `down', or t, which specifies the default position,
5741 and POSITION is one of `left', `right', or nil, meaning do not show
5742 this indicator.
5744 For example, ((top . left) (t . right)) places the top angle bitmap in
5745 left fringe, the bottom angle bitmap in right fringe, and both arrow
5746 bitmaps in right fringe. To show just the angle bitmaps in the left
5747 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5749 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5750 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5751 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5752 The value is an alist where each element (INDICATOR . BITMAPS)
5753 specifies the fringe bitmaps used to display a specific logical
5754 fringe indicator.
5756 INDICATOR specifies the logical indicator type which is one of the
5757 following symbols: `truncation' , `continuation', `overlay-arrow',
5758 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5760 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5761 the actual bitmap shown in the left or right fringe for the logical
5762 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5763 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5764 are used only for the `bottom' and `top-bottom' indicators when the
5765 last (only) line has no final newline. BITMAPS may also be a single
5766 symbol which is used in both left and right fringes. */);
5768 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5769 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5770 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5771 The value is an alist where each element (CURSOR . BITMAP)
5772 specifies the fringe bitmaps used to display a specific logical
5773 cursor type in the fringe.
5775 CURSOR specifies the logical cursor type which is one of the following
5776 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5777 one is used to show a hollow cursor on narrow lines display lines
5778 where the normal hollow cursor will not fit.
5780 BITMAP is the corresponding fringe bitmap shown for the logical
5781 cursor type. */);
5783 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5784 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5785 doc: /* How far to scroll windows upward.
5786 If you move point off the bottom, the window scrolls automatically.
5787 This variable controls how far it scrolls. The value nil, the default,
5788 means scroll to center point. A fraction means scroll to put point
5789 that fraction of the window's height from the bottom of the window.
5790 When the value is 0.0, point goes at the bottom line, which in the
5791 simple case that you moved off with C-f means scrolling just one line.
5792 1.0 means point goes at the top, so that in that simple case, the
5793 window scrolls by a full window height. Meaningful values are
5794 between 0.0 and 1.0, inclusive. */);
5796 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5797 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5798 doc: /* How far to scroll windows downward.
5799 If you move point off the top, the window scrolls automatically.
5800 This variable controls how far it scrolls. The value nil, the default,
5801 means scroll to center point. A fraction means scroll to put point
5802 that fraction of the window's height from the top of the window.
5803 When the value is 0.0, point goes at the top line, which in the
5804 simple case that you moved off with C-b means scrolling just one line.
5805 1.0 means point goes at the bottom, so that in that simple case, the
5806 window scrolls by a full window height. Meaningful values are
5807 between 0.0 and 1.0, inclusive. */);
5809 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5810 "Don't ask.");
5813 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5814 doc: /* List of functions to call before each text change.
5815 Two arguments are passed to each function: the positions of
5816 the beginning and end of the range of old text to be changed.
5817 \(For an insertion, the beginning and end are at the same place.)
5818 No information is given about the length of the text after the change.
5820 Buffer changes made while executing the `before-change-functions'
5821 don't call any before-change or after-change functions.
5822 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5824 If an unhandled error happens in running these functions,
5825 the variable's value remains nil. That prevents the error
5826 from happening repeatedly and making Emacs nonfunctional. */);
5827 Vbefore_change_functions = Qnil;
5829 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5830 doc: /* List of functions to call after each text change.
5831 Three arguments are passed to each function: the positions of
5832 the beginning and end of the range of changed text,
5833 and the length in bytes of the pre-change text replaced by that range.
5834 \(For an insertion, the pre-change length is zero;
5835 for a deletion, that length is the number of bytes deleted,
5836 and the post-change beginning and end are at the same place.)
5838 Buffer changes made while executing the `after-change-functions'
5839 don't call any before-change or after-change functions.
5840 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5842 If an unhandled error happens in running these functions,
5843 the variable's value remains nil. That prevents the error
5844 from happening repeatedly and making Emacs nonfunctional. */);
5845 Vafter_change_functions = Qnil;
5847 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5848 doc: /* A list of functions to call before changing a buffer which is unmodified.
5849 The functions are run using the `run-hooks' function. */);
5850 Vfirst_change_hook = Qnil;
5852 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5853 doc: /* List of undo entries in current buffer.
5854 Recent changes come first; older changes follow newer.
5856 An entry (BEG . END) represents an insertion which begins at
5857 position BEG and ends at position END.
5859 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5860 from (abs POSITION). If POSITION is positive, point was at the front
5861 of the text being deleted; if negative, point was at the end.
5863 An entry (t HIGH . LOW) indicates that the buffer previously had
5864 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5865 of the visited file's modification time, as of that time. If the
5866 modification time of the most recent save is different, this entry is
5867 obsolete.
5869 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5870 was modified between BEG and END. PROPERTY is the property name,
5871 and VALUE is the old value.
5873 An entry (apply FUN-NAME . ARGS) means undo the change with
5874 \(apply FUN-NAME ARGS).
5876 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5877 in the active region. BEG and END is the range affected by this entry
5878 and DELTA is the number of bytes added or deleted in that range by
5879 this change.
5881 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5882 was adjusted in position by the offset DISTANCE (an integer).
5884 An entry of the form POSITION indicates that point was at the buffer
5885 location given by the integer. Undoing an entry of this form places
5886 point at POSITION.
5888 Entries with value `nil' mark undo boundaries. The undo command treats
5889 the changes between two undo boundaries as a single step to be undone.
5891 If the value of the variable is t, undo information is not recorded. */);
5893 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5894 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5896 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5897 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5899 Normally, the line-motion functions work by scanning the buffer for
5900 newlines. Columnar operations (like `move-to-column' and
5901 `compute-motion') also work by scanning the buffer, summing character
5902 widths as they go. This works well for ordinary text, but if the
5903 buffer's lines are very long (say, more than 500 characters), these
5904 motion functions will take longer to execute. Emacs may also take
5905 longer to update the display.
5907 If `cache-long-line-scans' is non-nil, these motion functions cache the
5908 results of their scans, and consult the cache to avoid rescanning
5909 regions of the buffer until the text is modified. The caches are most
5910 beneficial when they prevent the most searching---that is, when the
5911 buffer contains long lines and large regions of characters with the
5912 same, fixed screen width.
5914 When `cache-long-line-scans' is non-nil, processing short lines will
5915 become slightly slower (because of the overhead of consulting the
5916 cache), and the caches will use memory roughly proportional to the
5917 number of newlines and characters whose screen width varies.
5919 The caches require no explicit maintenance; their accuracy is
5920 maintained internally by the Emacs primitives. Enabling or disabling
5921 the cache should not affect the behavior of any of the motion
5922 functions; it should only affect their performance. */);
5924 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5925 doc: /* Value of point before the last series of scroll operations, or nil. */);
5927 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5928 doc: /* List of formats to use when saving this buffer.
5929 Formats are defined by `format-alist'. This variable is
5930 set when a file is visited. */);
5932 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5933 &BVAR (current_buffer, auto_save_file_format), Qnil,
5934 doc: /* *Format in which to write auto-save files.
5935 Should be a list of symbols naming formats that are defined in `format-alist'.
5936 If it is t, which is the default, auto-save files are written in the
5937 same format as a regular save would use. */);
5939 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5940 &BVAR (current_buffer, invisibility_spec), Qnil,
5941 doc: /* Invisibility spec of this buffer.
5942 The default is t, which means that text is invisible
5943 if it has a non-nil `invisible' property.
5944 If the value is a list, a text character is invisible if its `invisible'
5945 property is an element in that list (or is a list with members in common).
5946 If an element is a cons cell of the form (PROP . ELLIPSIS),
5947 then characters with property value PROP are invisible,
5948 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5950 DEFVAR_PER_BUFFER ("buffer-display-count",
5951 &BVAR (current_buffer, display_count), Qnil,
5952 doc: /* A number incremented each time this buffer is displayed in a window.
5953 The function `set-window-buffer' increments it. */);
5955 DEFVAR_PER_BUFFER ("buffer-display-time",
5956 &BVAR (current_buffer, display_time), Qnil,
5957 doc: /* Time stamp updated each time this buffer is displayed in a window.
5958 The function `set-window-buffer' updates this variable
5959 to the value obtained by calling `current-time'.
5960 If the buffer has never been shown in a window, the value is nil. */);
5962 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5963 doc: /* Non-nil if Transient Mark mode is enabled.
5964 See the command `transient-mark-mode' for a description of this minor mode.
5966 Non-nil also enables highlighting of the region whenever the mark is active.
5967 The variable `highlight-nonselected-windows' controls whether to highlight
5968 all windows or just the selected window.
5970 Lisp programs may give this variable certain special values:
5972 - A value of `lambda' enables Transient Mark mode temporarily.
5973 It is disabled again after any subsequent action that would
5974 normally deactivate the mark (e.g. buffer modification).
5976 - A value of (only . OLDVAL) enables Transient Mark mode
5977 temporarily. After any subsequent point motion command that is
5978 not shift-translated, or any other action that would normally
5979 deactivate the mark (e.g. buffer modification), the value of
5980 `transient-mark-mode' is set to OLDVAL. */);
5981 Vtransient_mark_mode = Qnil;
5983 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5984 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5985 If the value is t, disregard `buffer-read-only' and all `read-only'
5986 text properties. If the value is a list, disregard `buffer-read-only'
5987 and disregard a `read-only' text property if the property value
5988 is a member of the list. */);
5989 Vinhibit_read_only = Qnil;
5991 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5992 doc: /* Cursor to use when this buffer is in the selected window.
5993 Values are interpreted as follows:
5995 t use the cursor specified for the frame
5996 nil don't display a cursor
5997 box display a filled box cursor
5998 hollow display a hollow box cursor
5999 bar display a vertical bar cursor with default width
6000 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6001 hbar display a horizontal bar cursor with default height
6002 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6003 ANYTHING ELSE display a hollow box cursor
6005 When the buffer is displayed in a non-selected window, the
6006 cursor's appearance is instead controlled by the variable
6007 `cursor-in-non-selected-windows'. */);
6009 DEFVAR_PER_BUFFER ("line-spacing",
6010 &BVAR (current_buffer, extra_line_spacing), Qnil,
6011 doc: /* Additional space to put between lines when displaying a buffer.
6012 The space is measured in pixels, and put below lines on graphic displays,
6013 see `display-graphic-p'.
6014 If value is a floating point number, it specifies the spacing relative
6015 to the default frame line height. A value of nil means add no extra space. */);
6017 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6018 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
6019 doc: /* *Non-nil means show a cursor in non-selected windows.
6020 If nil, only shows a cursor in the selected window.
6021 If t, displays a cursor related to the usual cursor type
6022 \(a solid box becomes hollow, a bar becomes a narrower bar).
6023 You can also specify the cursor type as in the `cursor-type' variable.
6024 Use Custom to set this variable and update the display." */);
6026 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
6027 doc: /* List of functions called with no args to query before killing a buffer.
6028 The buffer being killed will be current while the functions are running.
6029 If any of them returns nil, the buffer is not killed. */);
6030 Vkill_buffer_query_functions = Qnil;
6032 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
6033 doc: /* Normal hook run before changing the major mode of a buffer.
6034 The function `kill-all-local-variables' runs this before doing anything else. */);
6035 Vchange_major_mode_hook = Qnil;
6036 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
6038 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6039 doc: /* Hook run when the buffer list changes.
6040 Functions running this hook are `get-buffer-create',
6041 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6042 `record-buffer' and `unrecord-buffer'. */);
6043 Vbuffer_list_update_hook = Qnil;
6044 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
6046 defsubr (&Sbuffer_live_p);
6047 defsubr (&Sbuffer_list);
6048 defsubr (&Sget_buffer);
6049 defsubr (&Sget_file_buffer);
6050 defsubr (&Sget_buffer_create);
6051 defsubr (&Smake_indirect_buffer);
6052 defsubr (&Sgenerate_new_buffer_name);
6053 defsubr (&Sbuffer_name);
6054 /*defsubr (&Sbuffer_number);*/
6055 defsubr (&Sbuffer_file_name);
6056 defsubr (&Sbuffer_base_buffer);
6057 defsubr (&Sbuffer_local_value);
6058 defsubr (&Sbuffer_local_variables);
6059 defsubr (&Sbuffer_modified_p);
6060 defsubr (&Sset_buffer_modified_p);
6061 defsubr (&Sbuffer_modified_tick);
6062 defsubr (&Sbuffer_chars_modified_tick);
6063 defsubr (&Srename_buffer);
6064 defsubr (&Sother_buffer);
6065 defsubr (&Sbuffer_enable_undo);
6066 defsubr (&Skill_buffer);
6067 defsubr (&Srecord_buffer);
6068 defsubr (&Sunrecord_buffer);
6069 defsubr (&Sset_buffer_major_mode);
6070 defsubr (&Scurrent_buffer);
6071 defsubr (&Sset_buffer);
6072 defsubr (&Sbarf_if_buffer_read_only);
6073 defsubr (&Serase_buffer);
6074 defsubr (&Sbuffer_swap_text);
6075 defsubr (&Sset_buffer_multibyte);
6076 defsubr (&Skill_all_local_variables);
6078 defsubr (&Soverlayp);
6079 defsubr (&Smake_overlay);
6080 defsubr (&Sdelete_overlay);
6081 defsubr (&Smove_overlay);
6082 defsubr (&Soverlay_start);
6083 defsubr (&Soverlay_end);
6084 defsubr (&Soverlay_buffer);
6085 defsubr (&Soverlay_properties);
6086 defsubr (&Soverlays_at);
6087 defsubr (&Soverlays_in);
6088 defsubr (&Snext_overlay_change);
6089 defsubr (&Sprevious_overlay_change);
6090 defsubr (&Soverlay_recenter);
6091 defsubr (&Soverlay_lists);
6092 defsubr (&Soverlay_get);
6093 defsubr (&Soverlay_put);
6094 defsubr (&Srestore_buffer_modified_p);
6097 void
6098 keys_of_buffer (void)
6100 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6101 initial_define_key (control_x_map, 'k', "kill-buffer");
6103 /* This must not be in syms_of_buffer, because Qdisabled is not
6104 initialized when that function gets called. */
6105 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);