* buffer.c (record_overlay_string): Check for size-calculation overflow.
[emacs.git] / src / buffer.c
blob93f739c0d4b0ecc2a25cb6adb893ec9fb001ea2e
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 "lisp.h"
31 #include "intervals.h"
32 #include "window.h"
33 #include "commands.h"
34 #include "buffer.h"
35 #include "character.h"
36 #include "region-cache.h"
37 #include "indent.h"
38 #include "blockinput.h"
39 #include "keyboard.h"
40 #include "keymap.h"
41 #include "frame.h"
43 struct buffer *current_buffer; /* the current buffer */
45 /* First buffer in chain of all buffers (in reverse order of creation).
46 Threaded through ->header.next.buffer. */
48 struct buffer *all_buffers;
50 /* This structure holds the default values of the buffer-local variables
51 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
52 The default value occupies the same slot in this structure
53 as an individual buffer's value occupies in that buffer.
54 Setting the default value also goes through the alist of buffers
55 and stores into each buffer that does not say it has a local value. */
57 DECL_ALIGN (struct buffer, buffer_defaults);
59 /* A Lisp_Object pointer to the above, used for staticpro */
61 static Lisp_Object Vbuffer_defaults;
63 /* This structure marks which slots in a buffer have corresponding
64 default values in buffer_defaults.
65 Each such slot has a nonzero value in this structure.
66 The value has only one nonzero bit.
68 When a buffer has its own local value for a slot,
69 the entry for that slot (found in the same slot in this structure)
70 is turned on in the buffer's local_flags array.
72 If a slot in this structure is -1, then even though there may
73 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
74 and the corresponding slot in buffer_defaults is not used.
76 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
77 zero, that is a bug */
79 struct buffer buffer_local_flags;
81 /* This structure holds the names of symbols whose values may be
82 buffer-local. It is indexed and accessed in the same way as the above. */
84 DECL_ALIGN (struct buffer, buffer_local_symbols);
86 /* A Lisp_Object pointer to the above, used for staticpro */
87 static Lisp_Object Vbuffer_local_symbols;
89 /* Return the symbol of the per-buffer variable at offset OFFSET in
90 the buffer structure. */
92 #define PER_BUFFER_SYMBOL(OFFSET) \
93 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
95 /* Flags indicating which built-in buffer-local variables
96 are permanent locals. */
97 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
99 /* Number of per-buffer variables used. */
101 int last_per_buffer_idx;
103 static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
104 static Lisp_Object Fdelete_overlay (Lisp_Object);
105 static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
106 int after, Lisp_Object arg1,
107 Lisp_Object arg2, Lisp_Object arg3);
108 static void swap_out_buffer_local_variables (struct buffer *b);
109 static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
111 /* Alist of all buffer names vs the buffers. */
112 /* This used to be a variable, but is no longer,
113 to prevent lossage due to user rplac'ing this alist or its elements. */
114 Lisp_Object Vbuffer_alist;
116 static Lisp_Object Qkill_buffer_query_functions;
118 /* Hook run before changing a major mode. */
119 static Lisp_Object Qchange_major_mode_hook;
121 Lisp_Object Qfirst_change_hook;
122 Lisp_Object Qbefore_change_functions;
123 Lisp_Object Qafter_change_functions;
124 static Lisp_Object Qucs_set_table_for_input;
126 static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
127 static Lisp_Object Qpermanent_local_hook;
129 static Lisp_Object Qprotected_field;
131 static Lisp_Object QSFundamental; /* A string "Fundamental" */
133 static Lisp_Object Qkill_buffer_hook;
134 static Lisp_Object Qbuffer_list_update_hook;
136 static Lisp_Object Qget_file_buffer;
138 static Lisp_Object Qoverlayp;
140 Lisp_Object Qpriority, Qbefore_string, Qafter_string;
142 static Lisp_Object Qevaporate;
144 Lisp_Object Qmodification_hooks;
145 Lisp_Object Qinsert_in_front_hooks;
146 Lisp_Object Qinsert_behind_hooks;
148 static void alloc_buffer_text (struct buffer *, size_t);
149 static void free_buffer_text (struct buffer *b);
150 static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
151 static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
152 static Lisp_Object buffer_lisp_local_variables (struct buffer *);
154 /* For debugging; temporary. See set_buffer_internal. */
155 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
157 void
158 nsberror (Lisp_Object spec)
160 if (STRINGP (spec))
161 error ("No buffer named %s", SDATA (spec));
162 error ("Invalid buffer argument");
165 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
166 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
167 Value is nil if OBJECT is not a buffer or if it has been killed. */)
168 (Lisp_Object object)
170 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
171 ? Qt : Qnil);
174 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
175 doc: /* Return a list of all existing live buffers.
176 If the optional arg FRAME is a frame, we return the buffer list in the
177 proper order for that frame: the buffers show in FRAME come first,
178 followed by the rest of the buffers. */)
179 (Lisp_Object frame)
181 Lisp_Object general;
182 general = Fmapcar (Qcdr, Vbuffer_alist);
184 if (FRAMEP (frame))
186 Lisp_Object framelist, prevlist, tail;
187 Lisp_Object args[3];
189 CHECK_FRAME (frame);
190 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
191 prevlist = Fnreverse (Fcopy_sequence
192 (XFRAME (frame)->buried_buffer_list));
194 /* Remove from GENERAL any buffer that duplicates one in
195 FRAMELIST or PREVLIST. */
196 tail = framelist;
197 while (CONSP (tail))
199 general = Fdelq (XCAR (tail), general);
200 tail = XCDR (tail);
202 tail = prevlist;
203 while (CONSP (tail))
205 general = Fdelq (XCAR (tail), general);
206 tail = XCDR (tail);
209 args[0] = framelist;
210 args[1] = general;
211 args[2] = prevlist;
212 return Fnconc (3, args);
214 else
215 return general;
218 /* Like Fassoc, but use Fstring_equal to compare
219 (which ignores text properties),
220 and don't ever QUIT. */
222 static Lisp_Object
223 assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
225 register Lisp_Object tail;
226 for (tail = list; CONSP (tail); tail = XCDR (tail))
228 register Lisp_Object elt, tem;
229 elt = XCAR (tail);
230 tem = Fstring_equal (Fcar (elt), key);
231 if (!NILP (tem))
232 return elt;
234 return Qnil;
237 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
238 doc: /* Return the buffer named BUFFER-OR-NAME.
239 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
240 is a string and there is no buffer with that name, return nil. If
241 BUFFER-OR-NAME is a buffer, return it as given. */)
242 (register Lisp_Object buffer_or_name)
244 if (BUFFERP (buffer_or_name))
245 return buffer_or_name;
246 CHECK_STRING (buffer_or_name);
248 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
251 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
252 doc: /* Return the buffer visiting file FILENAME (a string).
253 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
254 If there is no such live buffer, return nil.
255 See also `find-buffer-visiting'. */)
256 (register Lisp_Object filename)
258 register Lisp_Object tail, buf, tem;
259 Lisp_Object handler;
261 CHECK_STRING (filename);
262 filename = Fexpand_file_name (filename, Qnil);
264 /* If the file name has special constructs in it,
265 call the corresponding file handler. */
266 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
267 if (!NILP (handler))
268 return call2 (handler, Qget_file_buffer, filename);
270 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
272 buf = Fcdr (XCAR (tail));
273 if (!BUFFERP (buf)) continue;
274 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
275 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
276 if (!NILP (tem))
277 return buf;
279 return Qnil;
282 Lisp_Object
283 get_truename_buffer (register Lisp_Object filename)
285 register Lisp_Object tail, buf, tem;
287 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
289 buf = Fcdr (XCAR (tail));
290 if (!BUFFERP (buf)) continue;
291 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
292 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
293 if (!NILP (tem))
294 return buf;
296 return Qnil;
299 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
300 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
301 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
302 return that buffer. If no such buffer exists, create a new buffer with
303 that name and return it. If BUFFER-OR-NAME starts with a space, the new
304 buffer does not keep undo information.
306 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
307 even if it is dead. The return value is never nil. */)
308 (register Lisp_Object buffer_or_name)
310 register Lisp_Object buffer, name;
311 register struct buffer *b;
313 buffer = Fget_buffer (buffer_or_name);
314 if (!NILP (buffer))
315 return buffer;
317 if (SCHARS (buffer_or_name) == 0)
318 error ("Empty string for buffer name is not allowed");
320 b = allocate_buffer ();
322 /* An ordinary buffer uses its own struct buffer_text. */
323 b->text = &b->own_text;
324 b->base_buffer = 0;
326 BUF_GAP_SIZE (b) = 20;
327 BLOCK_INPUT;
328 /* We allocate extra 1-byte at the tail and keep it always '\0' for
329 anchoring a search. */
330 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
331 UNBLOCK_INPUT;
332 if (! BUF_BEG_ADDR (b))
333 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
335 b->pt = BEG;
336 b->begv = BEG;
337 b->zv = BEG;
338 b->pt_byte = BEG_BYTE;
339 b->begv_byte = BEG_BYTE;
340 b->zv_byte = BEG_BYTE;
342 BUF_GPT (b) = BEG;
343 BUF_GPT_BYTE (b) = BEG_BYTE;
345 BUF_Z (b) = BEG;
346 BUF_Z_BYTE (b) = BEG_BYTE;
347 BUF_MODIFF (b) = 1;
348 BUF_CHARS_MODIFF (b) = 1;
349 BUF_OVERLAY_MODIFF (b) = 1;
350 BUF_SAVE_MODIFF (b) = 1;
351 BUF_INTERVALS (b) = 0;
352 BUF_UNCHANGED_MODIFIED (b) = 1;
353 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
354 BUF_END_UNCHANGED (b) = 0;
355 BUF_BEG_UNCHANGED (b) = 0;
356 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
358 b->newline_cache = 0;
359 b->width_run_cache = 0;
360 BVAR (b, width_table) = Qnil;
361 b->prevent_redisplay_optimizations_p = 1;
363 /* Put this on the chain of all buffers including killed ones. */
364 b->header.next.buffer = all_buffers;
365 all_buffers = b;
367 /* An ordinary buffer normally doesn't need markers
368 to handle BEGV and ZV. */
369 BVAR (b, pt_marker) = Qnil;
370 BVAR (b, begv_marker) = Qnil;
371 BVAR (b, zv_marker) = Qnil;
373 name = Fcopy_sequence (buffer_or_name);
374 STRING_SET_INTERVALS (name, NULL_INTERVAL);
375 BVAR (b, name) = name;
377 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
379 reset_buffer (b);
380 reset_buffer_local_variables (b, 1);
382 BVAR (b, mark) = Fmake_marker ();
383 BUF_MARKERS (b) = NULL;
384 BVAR (b, name) = name;
386 /* Put this in the alist of all live buffers. */
387 XSETBUFFER (buffer, b);
388 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
389 /* And run buffer-list-update-hook. */
390 if (!NILP (Vrun_hooks))
391 call1 (Vrun_hooks, Qbuffer_list_update_hook);
393 /* An error in calling the function here (should someone redefine it)
394 can lead to infinite regress until you run out of stack. rms
395 says that's not worth protecting against. */
396 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
397 /* buffer is on buffer-alist, so no gcpro. */
398 call1 (Qucs_set_table_for_input, buffer);
400 return buffer;
404 /* Return a list of overlays which is a copy of the overlay list
405 LIST, but for buffer B. */
407 static struct Lisp_Overlay *
408 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
410 Lisp_Object buffer;
411 struct Lisp_Overlay *result = NULL, *tail = NULL;
413 XSETBUFFER (buffer, b);
415 for (; list; list = list->next)
417 Lisp_Object overlay, start, end, old_overlay;
418 EMACS_INT charpos;
420 XSETMISC (old_overlay, list);
421 charpos = marker_position (OVERLAY_START (old_overlay));
422 start = Fmake_marker ();
423 Fset_marker (start, make_number (charpos), buffer);
424 XMARKER (start)->insertion_type
425 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
427 charpos = marker_position (OVERLAY_END (old_overlay));
428 end = Fmake_marker ();
429 Fset_marker (end, make_number (charpos), buffer);
430 XMARKER (end)->insertion_type
431 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
433 overlay = allocate_misc ();
434 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
435 OVERLAY_START (overlay) = start;
436 OVERLAY_END (overlay) = end;
437 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
438 XOVERLAY (overlay)->next = NULL;
440 if (tail)
441 tail = tail->next = XOVERLAY (overlay);
442 else
443 result = tail = XOVERLAY (overlay);
446 return result;
450 /* Clone per-buffer values of buffer FROM.
452 Buffer TO gets the same per-buffer values as FROM, with the
453 following exceptions: (1) TO's name is left untouched, (2) markers
454 are copied and made to refer to TO, and (3) overlay lists are
455 copied. */
457 static void
458 clone_per_buffer_values (struct buffer *from, struct buffer *to)
460 Lisp_Object to_buffer;
461 int offset;
463 XSETBUFFER (to_buffer, to);
465 /* buffer-local Lisp variables start at `undo_list',
466 tho only the ones from `name' on are GC'd normally. */
467 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
468 offset < sizeof *to;
469 offset += sizeof (Lisp_Object))
471 Lisp_Object obj;
473 /* Don't touch the `name' which should be unique for every buffer. */
474 if (offset == PER_BUFFER_VAR_OFFSET (name))
475 continue;
477 obj = PER_BUFFER_VALUE (from, offset);
478 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
480 struct Lisp_Marker *m = XMARKER (obj);
481 obj = Fmake_marker ();
482 XMARKER (obj)->insertion_type = m->insertion_type;
483 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
486 PER_BUFFER_VALUE (to, offset) = obj;
489 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
491 to->overlays_before = copy_overlays (to, from->overlays_before);
492 to->overlays_after = copy_overlays (to, from->overlays_after);
494 /* Get (a copy of) the alist of Lisp-level local variables of FROM
495 and install that in TO. */
496 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
500 /* If buffer B has markers to record PT, BEGV and ZV when it is not
501 current, update these markers. */
503 static void
504 record_buffer_markers (struct buffer *b)
506 if (! NILP (BVAR (b, pt_marker)))
508 Lisp_Object buffer;
510 eassert (!NILP (BVAR (b, begv_marker)));
511 eassert (!NILP (BVAR (b, zv_marker)));
513 XSETBUFFER (buffer, b);
514 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
515 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
516 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
521 /* If buffer B has markers to record PT, BEGV and ZV when it is not
522 current, fetch these values into B->begv etc. */
524 static void
525 fetch_buffer_markers (struct buffer *b)
527 if (! NILP (BVAR (b, pt_marker)))
529 Lisp_Object m;
531 eassert (!NILP (BVAR (b, begv_marker)));
532 eassert (!NILP (BVAR (b, zv_marker)));
534 m = BVAR (b, pt_marker);
535 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
537 m = BVAR (b, begv_marker);
538 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
540 m = BVAR (b, zv_marker);
541 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
546 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
547 2, 3,
548 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
549 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
550 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
551 NAME should be a string which is not the name of an existing buffer.
552 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
553 such as major and minor modes, in the indirect buffer.
554 CLONE nil means the indirect buffer's state is reset to default values. */)
555 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
557 Lisp_Object buf, tem;
558 struct buffer *b;
560 CHECK_STRING (name);
561 buf = Fget_buffer (name);
562 if (!NILP (buf))
563 error ("Buffer name `%s' is in use", SDATA (name));
565 tem = base_buffer;
566 base_buffer = Fget_buffer (base_buffer);
567 if (NILP (base_buffer))
568 error ("No such buffer: `%s'", SDATA (tem));
569 if (NILP (BVAR (XBUFFER (base_buffer), name)))
570 error ("Base buffer has been killed");
572 if (SCHARS (name) == 0)
573 error ("Empty string for buffer name is not allowed");
575 b = allocate_buffer ();
577 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
578 ? XBUFFER (base_buffer)->base_buffer
579 : XBUFFER (base_buffer));
581 /* Use the base buffer's text object. */
582 b->text = b->base_buffer->text;
584 b->pt = b->base_buffer->pt;
585 b->begv = b->base_buffer->begv;
586 b->zv = b->base_buffer->zv;
587 b->pt_byte = b->base_buffer->pt_byte;
588 b->begv_byte = b->base_buffer->begv_byte;
589 b->zv_byte = b->base_buffer->zv_byte;
591 b->newline_cache = 0;
592 b->width_run_cache = 0;
593 BVAR (b, width_table) = Qnil;
595 /* Put this on the chain of all buffers including killed ones. */
596 b->header.next.buffer = all_buffers;
597 all_buffers = b;
599 name = Fcopy_sequence (name);
600 STRING_SET_INTERVALS (name, NULL_INTERVAL);
601 BVAR (b, name) = name;
603 reset_buffer (b);
604 reset_buffer_local_variables (b, 1);
606 /* Put this in the alist of all live buffers. */
607 XSETBUFFER (buf, b);
608 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
610 BVAR (b, mark) = Fmake_marker ();
611 BVAR (b, name) = name;
613 /* The multibyte status belongs to the base buffer. */
614 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
616 /* Make sure the base buffer has markers for its narrowing. */
617 if (NILP (BVAR (b->base_buffer, pt_marker)))
619 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
620 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
622 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
623 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
624 b->base_buffer->pt,
625 b->base_buffer->pt_byte);
627 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
628 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
629 b->base_buffer->begv,
630 b->base_buffer->begv_byte);
632 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
633 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
634 b->base_buffer->zv,
635 b->base_buffer->zv_byte);
636 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
639 if (NILP (clone))
641 /* Give the indirect buffer markers for its narrowing. */
642 BVAR (b, pt_marker) = Fmake_marker ();
643 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
644 BVAR (b, begv_marker) = Fmake_marker ();
645 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
646 BVAR (b, zv_marker) = Fmake_marker ();
647 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
648 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
650 else
652 struct buffer *old_b = current_buffer;
654 clone_per_buffer_values (b->base_buffer, b);
655 BVAR (b, filename) = Qnil;
656 BVAR (b, file_truename) = Qnil;
657 BVAR (b, display_count) = make_number (0);
658 BVAR (b, backed_up) = Qnil;
659 BVAR (b, auto_save_file_name) = Qnil;
660 set_buffer_internal_1 (b);
661 Fset (intern ("buffer-save-without-query"), Qnil);
662 Fset (intern ("buffer-file-number"), Qnil);
663 Fset (intern ("buffer-stale-function"), Qnil);
664 set_buffer_internal_1 (old_b);
667 /* Run buffer-list-update-hook. */
668 if (!NILP (Vrun_hooks))
669 call1 (Vrun_hooks, Qbuffer_list_update_hook);
671 return buf;
674 void
675 delete_all_overlays (struct buffer *b)
677 Lisp_Object overlay;
679 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
680 have to empty the list, otherwise we end up with overlays that
681 think they belong to this buffer while the buffer doesn't know about
682 them any more. */
683 while (b->overlays_before)
685 XSETMISC (overlay, b->overlays_before);
686 Fdelete_overlay (overlay);
688 while (b->overlays_after)
690 XSETMISC (overlay, b->overlays_after);
691 Fdelete_overlay (overlay);
693 eassert (b->overlays_before == NULL);
694 eassert (b->overlays_after == NULL);
697 /* Reinitialize everything about a buffer except its name and contents
698 and local variables.
699 If called on an already-initialized buffer, the list of overlays
700 should be deleted before calling this function, otherwise we end up
701 with overlays that claim to belong to the buffer but the buffer
702 claims it doesn't belong to it. */
704 void
705 reset_buffer (register struct buffer *b)
707 BVAR (b, filename) = Qnil;
708 BVAR (b, file_truename) = Qnil;
709 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
710 b->modtime = 0;
711 b->modtime_size = -1;
712 XSETFASTINT (BVAR (b, save_length), 0);
713 b->last_window_start = 1;
714 /* It is more conservative to start out "changed" than "unchanged". */
715 b->clip_changed = 0;
716 b->prevent_redisplay_optimizations_p = 1;
717 BVAR (b, backed_up) = Qnil;
718 BUF_AUTOSAVE_MODIFF (b) = 0;
719 b->auto_save_failure_time = -1;
720 BVAR (b, auto_save_file_name) = Qnil;
721 BVAR (b, read_only) = Qnil;
722 b->overlays_before = NULL;
723 b->overlays_after = NULL;
724 b->overlay_center = BEG;
725 BVAR (b, mark_active) = Qnil;
726 BVAR (b, point_before_scroll) = Qnil;
727 BVAR (b, file_format) = Qnil;
728 BVAR (b, auto_save_file_format) = Qt;
729 BVAR (b, last_selected_window) = Qnil;
730 XSETINT (BVAR (b, display_count), 0);
731 BVAR (b, display_time) = Qnil;
732 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
733 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
734 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
736 b->display_error_modiff = 0;
739 /* Reset buffer B's local variables info.
740 Don't use this on a buffer that has already been in use;
741 it does not treat permanent locals consistently.
742 Instead, use Fkill_all_local_variables.
744 If PERMANENT_TOO is 1, then we reset permanent
745 buffer-local variables. If PERMANENT_TOO is 0,
746 we preserve those. */
748 static void
749 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
751 register int offset;
752 int i;
754 /* Reset the major mode to Fundamental, together with all the
755 things that depend on the major mode.
756 default-major-mode is handled at a higher level.
757 We ignore it here. */
758 BVAR (b, major_mode) = Qfundamental_mode;
759 BVAR (b, keymap) = Qnil;
760 BVAR (b, mode_name) = QSFundamental;
761 BVAR (b, minor_modes) = Qnil;
763 /* If the standard case table has been altered and invalidated,
764 fix up its insides first. */
765 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
766 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
767 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
768 Fset_standard_case_table (Vascii_downcase_table);
770 BVAR (b, downcase_table) = Vascii_downcase_table;
771 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
772 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
773 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
774 BVAR (b, invisibility_spec) = Qt;
776 /* Reset all (or most) per-buffer variables to their defaults. */
777 if (permanent_too)
778 BVAR (b, local_var_alist) = Qnil;
779 else
781 Lisp_Object tmp, prop, last = Qnil;
782 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
783 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
785 /* If permanent-local, keep it. */
786 last = tmp;
787 if (EQ (prop, Qpermanent_local_hook))
789 /* This is a partially permanent hook variable.
790 Preserve only the elements that want to be preserved. */
791 Lisp_Object list, newlist;
792 list = XCDR (XCAR (tmp));
793 if (!CONSP (list))
794 newlist = list;
795 else
796 for (newlist = Qnil; CONSP (list); list = XCDR (list))
798 Lisp_Object elt = XCAR (list);
799 /* Preserve element ELT if it's t,
800 if it is a function with a `permanent-local-hook' property,
801 or if it's not a symbol. */
802 if (! SYMBOLP (elt)
803 || EQ (elt, Qt)
804 || !NILP (Fget (elt, Qpermanent_local_hook)))
805 newlist = Fcons (elt, newlist);
807 XSETCDR (XCAR (tmp), Fnreverse (newlist));
810 /* Delete this local variable. */
811 else if (NILP (last))
812 BVAR (b, local_var_alist) = XCDR (tmp);
813 else
814 XSETCDR (last, XCDR (tmp));
817 for (i = 0; i < last_per_buffer_idx; ++i)
818 if (permanent_too || buffer_permanent_local_flags[i] == 0)
819 SET_PER_BUFFER_VALUE_P (b, i, 0);
821 /* For each slot that has a default value,
822 copy that into the slot. */
824 /* buffer-local Lisp variables start at `undo_list',
825 tho only the ones from `name' on are GC'd normally. */
826 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
827 offset < sizeof *b;
828 offset += sizeof (Lisp_Object))
830 int idx = PER_BUFFER_IDX (offset);
831 if ((idx > 0
832 && (permanent_too
833 || buffer_permanent_local_flags[idx] == 0)))
834 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
838 /* We split this away from generate-new-buffer, because rename-buffer
839 and set-visited-file-name ought to be able to use this to really
840 rename the buffer properly. */
842 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
843 Sgenerate_new_buffer_name, 1, 2, 0,
844 doc: /* Return a string that is the name of no existing buffer based on NAME.
845 If there is no live buffer named NAME, then return NAME.
846 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
847 \(starting at 2) until an unused name is found, and then return that name.
848 Optional second argument IGNORE specifies a name that is okay to use (if
849 it is in the sequence to be tried) even if a buffer with that name exists. */)
850 (register Lisp_Object name, Lisp_Object ignore)
852 register Lisp_Object gentemp, tem;
853 EMACS_INT count;
854 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
856 CHECK_STRING (name);
858 tem = Fstring_equal (name, ignore);
859 if (!NILP (tem))
860 return name;
861 tem = Fget_buffer (name);
862 if (NILP (tem))
863 return name;
865 count = 1;
866 while (1)
868 sprintf (number, "<%"pI"d>", ++count);
869 gentemp = concat2 (name, build_string (number));
870 tem = Fstring_equal (gentemp, ignore);
871 if (!NILP (tem))
872 return gentemp;
873 tem = Fget_buffer (gentemp);
874 if (NILP (tem))
875 return gentemp;
880 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
881 doc: /* Return the name of BUFFER, as a string.
882 BUFFER defaults to the current buffer.
883 Return nil if BUFFER has been killed. */)
884 (register Lisp_Object buffer)
886 if (NILP (buffer))
887 return BVAR (current_buffer, name);
888 CHECK_BUFFER (buffer);
889 return BVAR (XBUFFER (buffer), name);
892 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
893 doc: /* Return name of file BUFFER is visiting, or nil if none.
894 No argument or nil as argument means use the current buffer. */)
895 (register Lisp_Object buffer)
897 if (NILP (buffer))
898 return BVAR (current_buffer, filename);
899 CHECK_BUFFER (buffer);
900 return BVAR (XBUFFER (buffer), filename);
903 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
904 0, 1, 0,
905 doc: /* Return the base buffer of indirect buffer BUFFER.
906 If BUFFER is not indirect, return nil.
907 BUFFER defaults to the current buffer. */)
908 (register Lisp_Object buffer)
910 struct buffer *base;
911 Lisp_Object base_buffer;
913 if (NILP (buffer))
914 base = current_buffer->base_buffer;
915 else
917 CHECK_BUFFER (buffer);
918 base = XBUFFER (buffer)->base_buffer;
921 if (! base)
922 return Qnil;
923 XSETBUFFER (base_buffer, base);
924 return base_buffer;
927 DEFUN ("buffer-local-value", Fbuffer_local_value,
928 Sbuffer_local_value, 2, 2, 0,
929 doc: /* Return the value of VARIABLE in BUFFER.
930 If VARIABLE does not have a buffer-local binding in BUFFER, the value
931 is the default binding of the variable. */)
932 (register Lisp_Object variable, register Lisp_Object buffer)
934 register struct buffer *buf;
935 register Lisp_Object result;
936 struct Lisp_Symbol *sym;
938 CHECK_SYMBOL (variable);
939 CHECK_BUFFER (buffer);
940 buf = XBUFFER (buffer);
941 sym = XSYMBOL (variable);
943 start:
944 switch (sym->redirect)
946 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
947 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
948 case SYMBOL_LOCALIZED:
949 { /* Look in local_var_alist. */
950 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
951 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
952 result = Fassoc (variable, BVAR (buf, local_var_alist));
953 if (!NILP (result))
955 if (blv->fwd)
956 { /* What binding is loaded right now? */
957 Lisp_Object current_alist_element = blv->valcell;
959 /* The value of the currently loaded binding is not
960 stored in it, but rather in the realvalue slot.
961 Store that value into the binding it belongs to
962 in case that is the one we are about to use. */
964 XSETCDR (current_alist_element,
965 do_symval_forwarding (blv->fwd));
967 /* Now get the (perhaps updated) value out of the binding. */
968 result = XCDR (result);
970 else
971 result = Fdefault_value (variable);
972 break;
974 case SYMBOL_FORWARDED:
976 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
977 if (BUFFER_OBJFWDP (fwd))
978 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
979 else
980 result = Fdefault_value (variable);
981 break;
983 default: abort ();
986 if (!EQ (result, Qunbound))
987 return result;
989 xsignal1 (Qvoid_variable, variable);
992 /* Return an alist of the Lisp-level buffer-local bindings of
993 buffer BUF. That is, don't include the variables maintained
994 in special slots in the buffer object. */
996 static Lisp_Object
997 buffer_lisp_local_variables (struct buffer *buf)
999 Lisp_Object result = Qnil;
1000 register Lisp_Object tail;
1001 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1003 Lisp_Object val, elt;
1005 elt = XCAR (tail);
1007 /* Reference each variable in the alist in buf.
1008 If inquiring about the current buffer, this gets the current values,
1009 so store them into the alist so the alist is up to date.
1010 If inquiring about some other buffer, this swaps out any values
1011 for that buffer, making the alist up to date automatically. */
1012 val = find_symbol_value (XCAR (elt));
1013 /* Use the current buffer value only if buf is the current buffer. */
1014 if (buf != current_buffer)
1015 val = XCDR (elt);
1017 result = Fcons (Fcons (XCAR (elt), val), result);
1020 return result;
1023 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1024 Sbuffer_local_variables, 0, 1, 0,
1025 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1026 Most elements look like (SYMBOL . VALUE), describing one variable.
1027 For a symbol that is locally unbound, just the symbol appears in the value.
1028 Note that storing new VALUEs in these elements doesn't change the variables.
1029 No argument or nil as argument means use current buffer as BUFFER. */)
1030 (register Lisp_Object buffer)
1032 register struct buffer *buf;
1033 register Lisp_Object result;
1035 if (NILP (buffer))
1036 buf = current_buffer;
1037 else
1039 CHECK_BUFFER (buffer);
1040 buf = XBUFFER (buffer);
1043 result = buffer_lisp_local_variables (buf);
1045 /* Add on all the variables stored in special slots. */
1047 int offset, idx;
1049 /* buffer-local Lisp variables start at `undo_list',
1050 tho only the ones from `name' on are GC'd normally. */
1051 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
1052 offset < sizeof (struct buffer);
1053 /* sizeof EMACS_INT == sizeof Lisp_Object */
1054 offset += (sizeof (EMACS_INT)))
1056 idx = PER_BUFFER_IDX (offset);
1057 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1058 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1059 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1060 PER_BUFFER_VALUE (buf, offset)),
1061 result);
1065 return result;
1068 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1069 0, 1, 0,
1070 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1071 No argument or nil as argument means use current buffer as BUFFER. */)
1072 (register Lisp_Object buffer)
1074 register struct buffer *buf;
1075 if (NILP (buffer))
1076 buf = current_buffer;
1077 else
1079 CHECK_BUFFER (buffer);
1080 buf = XBUFFER (buffer);
1083 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1086 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1087 1, 1, 0,
1088 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1089 A non-nil FLAG means mark the buffer modified. */)
1090 (register Lisp_Object flag)
1092 register int already;
1093 register Lisp_Object fn;
1094 Lisp_Object buffer, window;
1096 #ifdef CLASH_DETECTION
1097 /* If buffer becoming modified, lock the file.
1098 If buffer becoming unmodified, unlock the file. */
1100 fn = BVAR (current_buffer, file_truename);
1101 /* Test buffer-file-name so that binding it to nil is effective. */
1102 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1104 already = SAVE_MODIFF < MODIFF;
1105 if (!already && !NILP (flag))
1106 lock_file (fn);
1107 else if (already && NILP (flag))
1108 unlock_file (fn);
1110 #endif /* CLASH_DETECTION */
1112 /* Here we have a problem. SAVE_MODIFF is used here to encode
1113 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1114 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1115 modify SAVE_MODIFF to affect one, we may affect the other
1116 as well.
1117 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1118 if SAVE_MODIFF<auto_save_modified that means we risk changing
1119 recent-auto-save-p from t to nil.
1120 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1121 we risk changing recent-auto-save-p from nil to t. */
1122 SAVE_MODIFF = (NILP (flag)
1123 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1124 ? MODIFF
1125 /* Let's try to preserve recent-auto-save-p. */
1126 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1127 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1128 we can either decrease SAVE_MODIFF and auto_save_modified
1129 or increase MODIFF. */
1130 : MODIFF++);
1132 /* Set update_mode_lines only if buffer is displayed in some window.
1133 Packages like jit-lock or lazy-lock preserve a buffer's modified
1134 state by recording/restoring the state around blocks of code.
1135 Setting update_mode_lines makes redisplay consider all windows
1136 (on all frames). Stealth fontification of buffers not displayed
1137 would incur additional redisplay costs if we'd set
1138 update_modes_lines unconditionally.
1140 Ideally, I think there should be another mechanism for fontifying
1141 buffers without "modifying" buffers, or redisplay should be
1142 smarter about updating the `*' in mode lines. --gerd */
1143 XSETBUFFER (buffer, current_buffer);
1144 window = Fget_buffer_window (buffer, Qt);
1145 if (WINDOWP (window))
1147 ++update_mode_lines;
1148 current_buffer->prevent_redisplay_optimizations_p = 1;
1151 return flag;
1154 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1155 Srestore_buffer_modified_p, 1, 1, 0,
1156 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1157 It is not ensured that mode lines will be updated to show the modified
1158 state of the current buffer. Use with care. */)
1159 (Lisp_Object flag)
1161 #ifdef CLASH_DETECTION
1162 Lisp_Object fn;
1164 /* If buffer becoming modified, lock the file.
1165 If buffer becoming unmodified, unlock the file. */
1167 fn = BVAR (current_buffer, file_truename);
1168 /* Test buffer-file-name so that binding it to nil is effective. */
1169 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1171 int already = SAVE_MODIFF < MODIFF;
1172 if (!already && !NILP (flag))
1173 lock_file (fn);
1174 else if (already && NILP (flag))
1175 unlock_file (fn);
1177 #endif /* CLASH_DETECTION */
1179 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1180 return flag;
1183 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1184 0, 1, 0,
1185 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1186 Each buffer has a tick counter which is incremented each time the
1187 text in that buffer is changed. It wraps around occasionally.
1188 No argument or nil as argument means use current buffer as BUFFER. */)
1189 (register Lisp_Object buffer)
1191 register struct buffer *buf;
1192 if (NILP (buffer))
1193 buf = current_buffer;
1194 else
1196 CHECK_BUFFER (buffer);
1197 buf = XBUFFER (buffer);
1200 return make_number (BUF_MODIFF (buf));
1203 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1204 Sbuffer_chars_modified_tick, 0, 1, 0,
1205 doc: /* Return BUFFER's character-change tick counter.
1206 Each buffer has a character-change tick counter, which is set to the
1207 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1208 time text in that buffer is inserted or deleted. By comparing the
1209 values returned by two individual calls of `buffer-chars-modified-tick',
1210 you can tell whether a character change occurred in that buffer in
1211 between these calls. No argument or nil as argument means use current
1212 buffer as BUFFER. */)
1213 (register Lisp_Object buffer)
1215 register struct buffer *buf;
1216 if (NILP (buffer))
1217 buf = current_buffer;
1218 else
1220 CHECK_BUFFER (buffer);
1221 buf = XBUFFER (buffer);
1224 return make_number (BUF_CHARS_MODIFF (buf));
1227 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1228 "(list (read-string \"Rename buffer (to new name): \" \
1229 nil 'buffer-name-history (buffer-name (current-buffer))) \
1230 current-prefix-arg)",
1231 doc: /* Change current buffer's name to NEWNAME (a string).
1232 If second arg UNIQUE is nil or omitted, it is an error if a
1233 buffer named NEWNAME already exists.
1234 If UNIQUE is non-nil, come up with a new name using
1235 `generate-new-buffer-name'.
1236 Interactively, you can set UNIQUE with a prefix argument.
1237 We return the name we actually gave the buffer.
1238 This does not change the name of the visited file (if any). */)
1239 (register Lisp_Object newname, Lisp_Object unique)
1241 register Lisp_Object tem, buf;
1243 CHECK_STRING (newname);
1245 if (SCHARS (newname) == 0)
1246 error ("Empty string is invalid as a buffer name");
1248 tem = Fget_buffer (newname);
1249 if (!NILP (tem))
1251 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1252 rename the buffer automatically so you can create another
1253 with the original name. It makes UNIQUE equivalent to
1254 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1255 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1256 return BVAR (current_buffer, name);
1257 if (!NILP (unique))
1258 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1259 else
1260 error ("Buffer name `%s' is in use", SDATA (newname));
1263 BVAR (current_buffer, name) = newname;
1265 /* Catch redisplay's attention. Unless we do this, the mode lines for
1266 any windows displaying current_buffer will stay unchanged. */
1267 update_mode_lines++;
1269 XSETBUFFER (buf, current_buffer);
1270 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1271 if (NILP (BVAR (current_buffer, filename))
1272 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1273 call0 (intern ("rename-auto-save-file"));
1275 /* Run buffer-list-update-hook. */
1276 if (!NILP (Vrun_hooks))
1277 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1279 /* Refetch since that last call may have done GC. */
1280 return BVAR (current_buffer, name);
1283 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1284 doc: /* Return most recently selected buffer other than BUFFER.
1285 Buffers not visible in windows are preferred to visible buffers, unless
1286 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1287 BUFFER unless it denotes a live buffer. If the optional third argument
1288 FRAME is non-nil, use that frame's buffer list instead of the selected
1289 frame's buffer list.
1291 The buffer is found by scanning the selected or specified frame's buffer
1292 list first, followed by the list of all buffers. If no other buffer
1293 exists, return the buffer `*scratch*' (creating it if necessary). */)
1294 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1296 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1297 Lisp_Object tail, buf, pred;
1298 Lisp_Object notsogood = Qnil;
1300 if (NILP (frame))
1301 frame = selected_frame;
1303 CHECK_FRAME (frame);
1305 pred = frame_buffer_predicate (frame);
1306 /* Consider buffers that have been seen in the frame first. */
1307 tail = XFRAME (frame)->buffer_list;
1308 for (; CONSP (tail); tail = XCDR (tail))
1310 buf = XCAR (tail);
1311 if (BUFFERP (buf) && !EQ (buf, buffer)
1312 && !NILP (BVAR (XBUFFER (buf), name))
1313 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1314 /* If the frame has a buffer_predicate, disregard buffers that
1315 don't fit the predicate. */
1316 && (NILP (pred) || !NILP (call1 (pred, buf))))
1318 if (!NILP (visible_ok)
1319 || NILP (Fget_buffer_window (buf, Qvisible)))
1320 return buf;
1321 else if (NILP (notsogood))
1322 notsogood = buf;
1326 /* Consider alist of all buffers next. */
1327 tail = Vbuffer_alist;
1328 for (; CONSP (tail); tail = XCDR (tail))
1330 buf = Fcdr (XCAR (tail));
1331 if (BUFFERP (buf) && !EQ (buf, buffer)
1332 && !NILP (BVAR (XBUFFER (buf), name))
1333 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1334 /* If the frame has a buffer_predicate, disregard buffers that
1335 don't fit the predicate. */
1336 && (NILP (pred) || !NILP (call1 (pred, buf))))
1338 if (!NILP (visible_ok)
1339 || NILP (Fget_buffer_window (buf, Qvisible)))
1340 return buf;
1341 else if (NILP (notsogood))
1342 notsogood = buf;
1346 if (!NILP (notsogood))
1347 return notsogood;
1348 else
1350 buf = Fget_buffer (build_string ("*scratch*"));
1351 if (NILP (buf))
1353 buf = Fget_buffer_create (build_string ("*scratch*"));
1354 Fset_buffer_major_mode (buf);
1356 return buf;
1360 /* The following function is a safe variant of Fother_buffer: It doesn't
1361 pay attention to any frame-local buffer lists, doesn't care about
1362 visibility of buffers, and doesn't evaluate any frame predicates. */
1364 Lisp_Object
1365 other_buffer_safely (Lisp_Object buffer)
1367 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1368 Lisp_Object tail, buf;
1370 tail = Vbuffer_alist;
1371 for (; CONSP (tail); tail = XCDR (tail))
1373 buf = Fcdr (XCAR (tail));
1374 if (BUFFERP (buf) && !EQ (buf, buffer)
1375 && !NILP (BVAR (XBUFFER (buf), name))
1376 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1377 return buf;
1380 buf = Fget_buffer (build_string ("*scratch*"));
1381 if (NILP (buf))
1383 buf = Fget_buffer_create (build_string ("*scratch*"));
1384 Fset_buffer_major_mode (buf);
1387 return buf;
1390 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1391 0, 1, "",
1392 doc: /* Start keeping undo information for buffer BUFFER.
1393 No argument or nil as argument means do this for the current buffer. */)
1394 (register Lisp_Object buffer)
1396 Lisp_Object real_buffer;
1398 if (NILP (buffer))
1399 XSETBUFFER (real_buffer, current_buffer);
1400 else
1402 real_buffer = Fget_buffer (buffer);
1403 if (NILP (real_buffer))
1404 nsberror (buffer);
1407 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1408 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1410 return Qnil;
1414 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1415 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1416 The buffer being killed will be current while the hook is running.\n\
1417 See `kill-buffer'."
1419 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1420 doc: /* Kill buffer BUFFER-OR-NAME.
1421 The argument may be a buffer or the name of an existing buffer.
1422 Argument nil or omitted means kill the current buffer. Return t if the
1423 buffer is actually killed, nil otherwise.
1425 This function calls `replace-buffer-in-windows' for cleaning up all
1426 windows currently displaying the buffer to be killed. The functions in
1427 `kill-buffer-query-functions' are called with the buffer to be killed as
1428 the current buffer. If any of them returns nil, the buffer is not
1429 killed. The hook `kill-buffer-hook' is run before the buffer is
1430 actually killed. The buffer being killed will be current while the hook
1431 is running.
1433 Any processes that have this buffer as the `process-buffer' are killed
1434 with SIGHUP. */)
1435 (Lisp_Object buffer_or_name)
1437 Lisp_Object buffer;
1438 register struct buffer *b;
1439 register Lisp_Object tem;
1440 register struct Lisp_Marker *m;
1441 struct gcpro gcpro1;
1443 if (NILP (buffer_or_name))
1444 buffer = Fcurrent_buffer ();
1445 else
1446 buffer = Fget_buffer (buffer_or_name);
1447 if (NILP (buffer))
1448 nsberror (buffer_or_name);
1450 b = XBUFFER (buffer);
1452 /* Avoid trouble for buffer already dead. */
1453 if (NILP (BVAR (b, name)))
1454 return Qnil;
1456 /* Query if the buffer is still modified. */
1457 if (INTERACTIVE && !NILP (BVAR (b, filename))
1458 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1460 GCPRO1 (buffer);
1461 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1462 BVAR (b, name), make_number (0)));
1463 UNGCPRO;
1464 if (NILP (tem))
1465 return Qnil;
1468 /* Run hooks with the buffer to be killed the current buffer. */
1470 int count = SPECPDL_INDEX ();
1471 Lisp_Object arglist[1];
1473 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1474 set_buffer_internal (b);
1476 /* First run the query functions; if any query is answered no,
1477 don't kill the buffer. */
1478 arglist[0] = Qkill_buffer_query_functions;
1479 tem = Frun_hook_with_args_until_failure (1, arglist);
1480 if (NILP (tem))
1481 return unbind_to (count, Qnil);
1483 /* Then run the hooks. */
1484 Frun_hooks (1, &Qkill_buffer_hook);
1485 unbind_to (count, Qnil);
1488 /* We have no more questions to ask. Verify that it is valid
1489 to kill the buffer. This must be done after the questions
1490 since anything can happen within do_yes_or_no_p. */
1492 /* Don't kill the minibuffer now current. */
1493 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1494 return Qnil;
1496 if (NILP (BVAR (b, name)))
1497 return Qnil;
1499 /* When we kill a base buffer, kill all its indirect buffers.
1500 We do it at this stage so nothing terrible happens if they
1501 ask questions or their hooks get errors. */
1502 if (! b->base_buffer)
1504 struct buffer *other;
1506 GCPRO1 (buffer);
1508 for (other = all_buffers; other; other = other->header.next.buffer)
1509 /* all_buffers contains dead buffers too;
1510 don't re-kill them. */
1511 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1513 Lisp_Object buf;
1514 XSETBUFFER (buf, other);
1515 Fkill_buffer (buf);
1518 UNGCPRO;
1521 /* Make this buffer not be current.
1522 In the process, notice if this is the sole visible buffer
1523 and give up if so. */
1524 if (b == current_buffer)
1526 tem = Fother_buffer (buffer, Qnil, Qnil);
1527 Fset_buffer (tem);
1528 if (b == current_buffer)
1529 return Qnil;
1532 /* Notice if the buffer to kill is the sole visible buffer
1533 when we're currently in the mini-buffer, and give up if so. */
1534 XSETBUFFER (tem, current_buffer);
1535 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1537 tem = Fother_buffer (buffer, Qnil, Qnil);
1538 if (EQ (buffer, tem))
1539 return Qnil;
1542 /* Now there is no question: we can kill the buffer. */
1544 #ifdef CLASH_DETECTION
1545 /* Unlock this buffer's file, if it is locked. */
1546 unlock_buffer (b);
1547 #endif /* CLASH_DETECTION */
1549 GCPRO1 (buffer);
1550 kill_buffer_processes (buffer);
1551 UNGCPRO;
1553 /* Killing buffer processes may run sentinels which may
1554 have called kill-buffer. */
1556 if (NILP (BVAR (b, name)))
1557 return Qnil;
1559 /* These may run Lisp code and into infinite loops (if someone
1560 insisted on circular lists) so allow quitting here. */
1561 replace_buffer_in_windows (buffer);
1562 frames_discard_buffer (buffer);
1564 clear_charpos_cache (b);
1566 tem = Vinhibit_quit;
1567 Vinhibit_quit = Qt;
1568 /* Remove the buffer from the list of all buffers. */
1569 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1570 /* If replace_buffer_in_windows didn't do its job correctly fix that
1571 now. */
1572 replace_buffer_in_windows_safely (buffer);
1573 Vinhibit_quit = tem;
1575 /* Delete any auto-save file, if we saved it in this session.
1576 But not if the buffer is modified. */
1577 if (STRINGP (BVAR (b, auto_save_file_name))
1578 && BUF_AUTOSAVE_MODIFF (b) != 0
1579 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1580 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1581 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1583 Lisp_Object delete;
1584 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1585 if (! NILP (delete))
1586 internal_delete_file (BVAR (b, auto_save_file_name));
1589 if (b->base_buffer)
1591 /* Unchain all markers that belong to this indirect buffer.
1592 Don't unchain the markers that belong to the base buffer
1593 or its other indirect buffers. */
1594 for (m = BUF_MARKERS (b); m; )
1596 struct Lisp_Marker *next = m->next;
1597 if (m->buffer == b)
1598 unchain_marker (m);
1599 m = next;
1602 else
1604 /* Unchain all markers of this buffer and its indirect buffers.
1605 and leave them pointing nowhere. */
1606 for (m = BUF_MARKERS (b); m; )
1608 struct Lisp_Marker *next = m->next;
1609 m->buffer = 0;
1610 m->next = NULL;
1611 m = next;
1613 BUF_MARKERS (b) = NULL;
1614 BUF_INTERVALS (b) = NULL_INTERVAL;
1616 /* Perhaps we should explicitly free the interval tree here... */
1619 /* Reset the local variables, so that this buffer's local values
1620 won't be protected from GC. They would be protected
1621 if they happened to remain encached in their symbols.
1622 This gets rid of them for certain. */
1623 swap_out_buffer_local_variables (b);
1624 reset_buffer_local_variables (b, 1);
1626 BVAR (b, name) = Qnil;
1628 BLOCK_INPUT;
1629 if (! b->base_buffer)
1630 free_buffer_text (b);
1632 if (b->newline_cache)
1634 free_region_cache (b->newline_cache);
1635 b->newline_cache = 0;
1637 if (b->width_run_cache)
1639 free_region_cache (b->width_run_cache);
1640 b->width_run_cache = 0;
1642 BVAR (b, width_table) = Qnil;
1643 UNBLOCK_INPUT;
1644 BVAR (b, undo_list) = Qnil;
1646 /* Run buffer-list-update-hook. */
1647 if (!NILP (Vrun_hooks))
1648 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1650 return Qt;
1653 /* Move association for BUFFER to the front of buffer (a)lists. Since
1654 we do this each time BUFFER is selected visibly, the more recently
1655 selected buffers are always closer to the front of those lists. This
1656 means that other_buffer is more likely to choose a relevant buffer.
1658 Note that this moves BUFFER to the front of the buffer lists of the
1659 selected frame even if BUFFER is not shown there. If BUFFER is not
1660 shown in the selected frame, consider the present behavior a feature.
1661 `select-window' gets this right since it shows BUFFER in the selected
1662 window when calling us. */
1664 void
1665 record_buffer (Lisp_Object buffer)
1667 Lisp_Object aelt, aelt_cons, tem;
1668 register struct frame *f = XFRAME (selected_frame);
1670 CHECK_BUFFER (buffer);
1672 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1673 Don't allow quitting since this might leave the buffer list in an
1674 inconsistent state. */
1675 tem = Vinhibit_quit;
1676 Vinhibit_quit = Qt;
1677 aelt = Frassq (buffer, Vbuffer_alist);
1678 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1679 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1680 XSETCDR (aelt_cons, Vbuffer_alist);
1681 Vbuffer_alist = aelt_cons;
1682 Vinhibit_quit = tem;
1684 /* Update buffer list of selected frame. */
1685 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1686 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1688 /* Run buffer-list-update-hook. */
1689 if (!NILP (Vrun_hooks))
1690 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1693 DEFUN ("record-buffer", Frecord_buffer, Srecord_buffer, 1, 1, 0,
1694 doc: /* Move BUFFER to the front of the buffer list.
1695 Return BUFFER. */)
1696 (Lisp_Object buffer)
1698 CHECK_BUFFER (buffer);
1700 record_buffer (buffer);
1702 return buffer;
1705 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1706 buffer is killed. For the selected frame's buffer list this moves
1707 BUFFER to its end even if it was never shown in that frame. If
1708 this happens we have a feature, hence `unrecord-buffer' should be
1709 called only when BUFFER was shown in the selected frame. */
1711 DEFUN ("unrecord-buffer", Funrecord_buffer, Sunrecord_buffer, 1, 1, 0,
1712 doc: /* Move BUFFER to the end of the buffer list.
1713 Return BUFFER. */)
1714 (Lisp_Object buffer)
1716 Lisp_Object aelt, aelt_cons, tem;
1717 register struct frame *f = XFRAME (selected_frame);
1719 CHECK_BUFFER (buffer);
1721 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1722 Don't allow quitting since this might leave the buffer list in an
1723 inconsistent state. */
1724 tem = Vinhibit_quit;
1725 Vinhibit_quit = Qt;
1726 aelt = Frassq (buffer, Vbuffer_alist);
1727 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1728 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1729 XSETCDR (aelt_cons, Qnil);
1730 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1731 Vinhibit_quit = tem;
1733 /* Update buffer lists of selected frame. */
1734 f->buffer_list = Fdelq (buffer, f->buffer_list);
1735 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1737 /* Run buffer-list-update-hook. */
1738 if (!NILP (Vrun_hooks))
1739 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1741 return buffer;
1744 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1745 doc: /* Set an appropriate major mode for BUFFER.
1746 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1747 according to `default-major-mode'.
1748 Use this function before selecting the buffer, since it may need to inspect
1749 the current buffer's major mode. */)
1750 (Lisp_Object buffer)
1752 int count;
1753 Lisp_Object function;
1755 CHECK_BUFFER (buffer);
1757 if (STRINGP (BVAR (XBUFFER (buffer), name))
1758 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1759 function = find_symbol_value (intern ("initial-major-mode"));
1760 else
1762 function = BVAR (&buffer_defaults, major_mode);
1763 if (NILP (function)
1764 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1765 function = BVAR (current_buffer, major_mode);
1768 if (NILP (function) || EQ (function, Qfundamental_mode))
1769 return Qnil;
1771 count = SPECPDL_INDEX ();
1773 /* To select a nonfundamental mode,
1774 select the buffer temporarily and then call the mode function. */
1776 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1778 Fset_buffer (buffer);
1779 call0 (function);
1781 return unbind_to (count, Qnil);
1784 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1785 doc: /* Return the current buffer as a Lisp object. */)
1786 (void)
1788 register Lisp_Object buf;
1789 XSETBUFFER (buf, current_buffer);
1790 return buf;
1793 /* Set the current buffer to B.
1795 We previously set windows_or_buffers_changed here to invalidate
1796 global unchanged information in beg_unchanged and end_unchanged.
1797 This is no longer necessary because we now compute unchanged
1798 information on a buffer-basis. Every action affecting other
1799 windows than the selected one requires a select_window at some
1800 time, and that increments windows_or_buffers_changed. */
1802 void
1803 set_buffer_internal (register struct buffer *b)
1805 if (current_buffer != b)
1806 set_buffer_internal_1 (b);
1809 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1810 This is used by redisplay. */
1812 void
1813 set_buffer_internal_1 (register struct buffer *b)
1815 register struct buffer *old_buf;
1816 register Lisp_Object tail;
1818 #ifdef USE_MMAP_FOR_BUFFERS
1819 if (b->text->beg == NULL)
1820 enlarge_buffer_text (b, 0);
1821 #endif /* USE_MMAP_FOR_BUFFERS */
1823 if (current_buffer == b)
1824 return;
1826 old_buf = current_buffer;
1827 current_buffer = b;
1828 last_known_column_point = -1; /* invalidate indentation cache */
1830 if (old_buf)
1832 /* Put the undo list back in the base buffer, so that it appears
1833 that an indirect buffer shares the undo list of its base. */
1834 if (old_buf->base_buffer)
1835 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1837 /* If the old current buffer has markers to record PT, BEGV and ZV
1838 when it is not current, update them now. */
1839 record_buffer_markers (old_buf);
1842 /* Get the undo list from the base buffer, so that it appears
1843 that an indirect buffer shares the undo list of its base. */
1844 if (b->base_buffer)
1845 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1847 /* If the new current buffer has markers to record PT, BEGV and ZV
1848 when it is not current, fetch them now. */
1849 fetch_buffer_markers (b);
1851 /* Look down buffer's list of local Lisp variables
1852 to find and update any that forward into C variables. */
1856 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1858 Lisp_Object var = XCAR (XCAR (tail));
1859 struct Lisp_Symbol *sym = XSYMBOL (var);
1860 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1861 && SYMBOL_BLV (sym)->fwd)
1862 /* Just reference the variable
1863 to cause it to become set for this buffer. */
1864 Fsymbol_value (var);
1867 /* Do the same with any others that were local to the previous buffer */
1868 while (b != old_buf && (b = old_buf, b));
1871 /* Switch to buffer B temporarily for redisplay purposes.
1872 This avoids certain things that don't need to be done within redisplay. */
1874 void
1875 set_buffer_temp (struct buffer *b)
1877 register struct buffer *old_buf;
1879 if (current_buffer == b)
1880 return;
1882 old_buf = current_buffer;
1883 current_buffer = b;
1885 /* If the old current buffer has markers to record PT, BEGV and ZV
1886 when it is not current, update them now. */
1887 record_buffer_markers (old_buf);
1889 /* If the new current buffer has markers to record PT, BEGV and ZV
1890 when it is not current, fetch them now. */
1891 fetch_buffer_markers (b);
1894 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1895 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1896 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1897 also `save-excursion' when you want to make a buffer current
1898 temporarily. This function does not display the buffer, so its effect
1899 ends when the current command terminates. Use `switch-to-buffer' or
1900 `pop-to-buffer' to switch buffers permanently. */)
1901 (register Lisp_Object buffer_or_name)
1903 register Lisp_Object buffer;
1904 buffer = Fget_buffer (buffer_or_name);
1905 if (NILP (buffer))
1906 nsberror (buffer_or_name);
1907 if (NILP (BVAR (XBUFFER (buffer), name)))
1908 error ("Selecting deleted buffer");
1909 set_buffer_internal (XBUFFER (buffer));
1910 return buffer;
1913 /* Set the current buffer to BUFFER provided it is alive. */
1915 Lisp_Object
1916 set_buffer_if_live (Lisp_Object buffer)
1918 if (! NILP (BVAR (XBUFFER (buffer), name)))
1919 Fset_buffer (buffer);
1920 return Qnil;
1923 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1924 Sbarf_if_buffer_read_only, 0, 0, 0,
1925 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1926 (void)
1928 if (!NILP (BVAR (current_buffer, read_only))
1929 && NILP (Vinhibit_read_only))
1930 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1931 return Qnil;
1934 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1935 doc: /* Delete the entire contents of the current buffer.
1936 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1937 so the buffer is truly empty after this. */)
1938 (void)
1940 Fwiden ();
1942 del_range (BEG, Z);
1944 current_buffer->last_window_start = 1;
1945 /* Prevent warnings, or suspension of auto saving, that would happen
1946 if future size is less than past size. Use of erase-buffer
1947 implies that the future text is not really related to the past text. */
1948 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1949 return Qnil;
1952 void
1953 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1955 CHECK_NUMBER_COERCE_MARKER (*b);
1956 CHECK_NUMBER_COERCE_MARKER (*e);
1958 if (XINT (*b) > XINT (*e))
1960 Lisp_Object tem;
1961 tem = *b; *b = *e; *e = tem;
1964 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1965 && XINT (*e) <= ZV))
1966 args_out_of_range (*b, *e);
1969 /* Advance BYTE_POS up to a character boundary
1970 and return the adjusted position. */
1972 static EMACS_INT
1973 advance_to_char_boundary (EMACS_INT byte_pos)
1975 int c;
1977 if (byte_pos == BEG)
1978 /* Beginning of buffer is always a character boundary. */
1979 return BEG;
1981 c = FETCH_BYTE (byte_pos);
1982 if (! CHAR_HEAD_P (c))
1984 /* We should advance BYTE_POS only when C is a constituent of a
1985 multibyte sequence. */
1986 EMACS_INT orig_byte_pos = byte_pos;
1990 byte_pos--;
1991 c = FETCH_BYTE (byte_pos);
1993 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
1994 INC_POS (byte_pos);
1995 if (byte_pos < orig_byte_pos)
1996 byte_pos = orig_byte_pos;
1997 /* If C is a constituent of a multibyte sequence, BYTE_POS was
1998 surely advance to the correct character boundary. If C is
1999 not, BYTE_POS was unchanged. */
2002 return byte_pos;
2005 #ifdef REL_ALLOC
2006 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2007 #endif /* REL_ALLOC */
2009 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2010 1, 1, 0,
2011 doc: /* Swap the text between current buffer and BUFFER. */)
2012 (Lisp_Object buffer)
2014 struct buffer *other_buffer;
2015 CHECK_BUFFER (buffer);
2016 other_buffer = XBUFFER (buffer);
2018 if (NILP (BVAR (other_buffer, name)))
2019 error ("Cannot swap a dead buffer's text");
2021 /* Actually, it probably works just fine.
2022 * if (other_buffer == current_buffer)
2023 * error ("Cannot swap a buffer's text with itself"); */
2025 /* Actually, this may be workable as well, tho probably only if they're
2026 *both* indirect. */
2027 if (other_buffer->base_buffer
2028 || current_buffer->base_buffer)
2029 error ("Cannot swap indirect buffers's text");
2031 { /* This is probably harder to make work. */
2032 struct buffer *other;
2033 for (other = all_buffers; other; other = other->header.next.buffer)
2034 if (other->base_buffer == other_buffer
2035 || other->base_buffer == current_buffer)
2036 error ("One of the buffers to swap has indirect buffers");
2039 #define swapfield(field, type) \
2040 do { \
2041 type tmp##field = other_buffer->field; \
2042 other_buffer->field = current_buffer->field; \
2043 current_buffer->field = tmp##field; \
2044 } while (0)
2045 #define swapfield_(field, type) \
2046 do { \
2047 type tmp##field = BVAR (other_buffer, field); \
2048 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2049 BVAR (current_buffer, field) = tmp##field; \
2050 } while (0)
2052 swapfield (own_text, struct buffer_text);
2053 eassert (current_buffer->text == &current_buffer->own_text);
2054 eassert (other_buffer->text == &other_buffer->own_text);
2055 #ifdef REL_ALLOC
2056 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2057 (POINTER_TYPE **) &other_buffer->own_text.beg);
2058 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2059 (POINTER_TYPE **) &current_buffer->own_text.beg);
2060 #endif /* REL_ALLOC */
2062 swapfield (pt, EMACS_INT);
2063 swapfield (pt_byte, EMACS_INT);
2064 swapfield (begv, EMACS_INT);
2065 swapfield (begv_byte, EMACS_INT);
2066 swapfield (zv, EMACS_INT);
2067 swapfield (zv_byte, EMACS_INT);
2068 eassert (!current_buffer->base_buffer);
2069 eassert (!other_buffer->base_buffer);
2070 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2071 swapfield (newline_cache, struct region_cache *);
2072 swapfield (width_run_cache, struct region_cache *);
2073 current_buffer->prevent_redisplay_optimizations_p = 1;
2074 other_buffer->prevent_redisplay_optimizations_p = 1;
2075 swapfield (overlays_before, struct Lisp_Overlay *);
2076 swapfield (overlays_after, struct Lisp_Overlay *);
2077 swapfield (overlay_center, EMACS_INT);
2078 swapfield_ (undo_list, Lisp_Object);
2079 swapfield_ (mark, Lisp_Object);
2080 swapfield_ (enable_multibyte_characters, Lisp_Object);
2081 swapfield_ (bidi_display_reordering, Lisp_Object);
2082 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2083 /* FIXME: Not sure what we should do with these *_marker fields.
2084 Hopefully they're just nil anyway. */
2085 swapfield_ (pt_marker, Lisp_Object);
2086 swapfield_ (begv_marker, Lisp_Object);
2087 swapfield_ (zv_marker, Lisp_Object);
2088 BVAR (current_buffer, point_before_scroll) = Qnil;
2089 BVAR (other_buffer, point_before_scroll) = Qnil;
2091 current_buffer->text->modiff++; other_buffer->text->modiff++;
2092 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2093 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2094 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2095 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2096 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2097 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2099 struct Lisp_Marker *m;
2100 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2101 if (m->buffer == other_buffer)
2102 m->buffer = current_buffer;
2103 else
2104 /* Since there's no indirect buffer in sight, markers on
2105 BUF_MARKERS(buf) should either be for `buf' or dead. */
2106 eassert (!m->buffer);
2107 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2108 if (m->buffer == current_buffer)
2109 m->buffer = other_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);
2115 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2116 So since we just swapped the markers between the two buffers, we need
2117 to undo the effect of this swap for window markers. */
2118 Lisp_Object w = Fselected_window (), ws = Qnil;
2119 Lisp_Object buf1, buf2;
2120 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2122 while (NILP (Fmemq (w, ws)))
2124 ws = Fcons (w, ws);
2125 if (MARKERP (XWINDOW (w)->pointm)
2126 && (EQ (XWINDOW (w)->buffer, buf1)
2127 || EQ (XWINDOW (w)->buffer, buf2)))
2128 Fset_marker (XWINDOW (w)->pointm,
2129 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2130 XWINDOW (w)->buffer);
2131 w = Fnext_window (w, Qt, Qt);
2135 if (current_buffer->text->intervals)
2136 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2137 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2138 if (other_buffer->text->intervals)
2139 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2140 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2142 return Qnil;
2145 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2146 1, 1, 0,
2147 doc: /* Set the multibyte flag of the current buffer to FLAG.
2148 If FLAG is t, this makes the buffer a multibyte buffer.
2149 If FLAG is nil, this makes the buffer a single-byte buffer.
2150 In these cases, the buffer contents remain unchanged as a sequence of
2151 bytes but the contents viewed as characters do change.
2152 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2153 all eight-bit bytes to eight-bit characters.
2154 If the multibyte flag was really changed, undo information of the
2155 current buffer is cleared. */)
2156 (Lisp_Object flag)
2158 struct Lisp_Marker *tail, *markers;
2159 struct buffer *other;
2160 EMACS_INT begv, zv;
2161 int narrowed = (BEG != BEGV || Z != ZV);
2162 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2163 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2164 struct gcpro gcpro1;
2166 if (current_buffer->base_buffer)
2167 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2169 /* Do nothing if nothing actually changes. */
2170 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2171 return flag;
2173 GCPRO1 (old_undo);
2175 /* Don't record these buffer changes. We will put a special undo entry
2176 instead. */
2177 BVAR (current_buffer, undo_list) = Qt;
2179 /* If the cached position is for this buffer, clear it out. */
2180 clear_charpos_cache (current_buffer);
2182 if (NILP (flag))
2183 begv = BEGV_BYTE, zv = ZV_BYTE;
2184 else
2185 begv = BEGV, zv = ZV;
2187 if (narrowed)
2188 Fwiden ();
2190 if (NILP (flag))
2192 EMACS_INT pos, stop;
2193 unsigned char *p;
2195 /* Do this first, so it can use CHAR_TO_BYTE
2196 to calculate the old correspondences. */
2197 set_intervals_multibyte (0);
2199 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2201 Z = Z_BYTE;
2202 BEGV = BEGV_BYTE;
2203 ZV = ZV_BYTE;
2204 GPT = GPT_BYTE;
2205 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2208 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2209 tail->charpos = tail->bytepos;
2211 /* Convert multibyte form of 8-bit characters to unibyte. */
2212 pos = BEG;
2213 stop = GPT;
2214 p = BEG_ADDR;
2215 while (1)
2217 int c, bytes;
2219 if (pos == stop)
2221 if (pos == Z)
2222 break;
2223 p = GAP_END_ADDR;
2224 stop = Z;
2226 if (ASCII_BYTE_P (*p))
2227 p++, pos++;
2228 else if (CHAR_BYTE8_HEAD_P (*p))
2230 c = STRING_CHAR_AND_LENGTH (p, bytes);
2231 /* Delete all bytes for this 8-bit character but the
2232 last one, and change the last one to the character
2233 code. */
2234 bytes--;
2235 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2236 p = GAP_END_ADDR;
2237 *p++ = c;
2238 pos++;
2239 if (begv > pos)
2240 begv -= bytes;
2241 if (zv > pos)
2242 zv -= bytes;
2243 stop = Z;
2245 else
2247 bytes = BYTES_BY_CHAR_HEAD (*p);
2248 p += bytes, pos += bytes;
2251 if (narrowed)
2252 Fnarrow_to_region (make_number (begv), make_number (zv));
2254 else
2256 EMACS_INT pt = PT;
2257 EMACS_INT pos, stop;
2258 unsigned char *p, *pend;
2260 /* Be sure not to have a multibyte sequence striding over the GAP.
2261 Ex: We change this: "...abc\302 _GAP_ \241def..."
2262 to: "...abc _GAP_ \302\241def..." */
2264 if (EQ (flag, Qt)
2265 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2266 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2268 unsigned char *q = GPT_ADDR - 1;
2270 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2271 if (LEADING_CODE_P (*q))
2273 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
2275 move_gap_both (new_gpt, new_gpt);
2279 /* Make the buffer contents valid as multibyte by converting
2280 8-bit characters to multibyte form. */
2281 pos = BEG;
2282 stop = GPT;
2283 p = BEG_ADDR;
2284 pend = GPT_ADDR;
2285 while (1)
2287 int bytes;
2289 if (pos == stop)
2291 if (pos == Z)
2292 break;
2293 p = GAP_END_ADDR;
2294 pend = Z_ADDR;
2295 stop = Z;
2298 if (ASCII_BYTE_P (*p))
2299 p++, pos++;
2300 else if (EQ (flag, Qt)
2301 && ! CHAR_BYTE8_HEAD_P (*p)
2302 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2303 p += bytes, pos += bytes;
2304 else
2306 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2307 int c;
2309 c = BYTE8_TO_CHAR (*p);
2310 bytes = CHAR_STRING (c, tmp);
2311 *p = tmp[0];
2312 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2313 bytes--;
2314 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2315 /* Now the gap is after the just inserted data. */
2316 pos = GPT;
2317 p = GAP_END_ADDR;
2318 if (pos <= begv)
2319 begv += bytes;
2320 if (pos <= zv)
2321 zv += bytes;
2322 if (pos <= pt)
2323 pt += bytes;
2324 pend = Z_ADDR;
2325 stop = Z;
2329 if (pt != PT)
2330 TEMP_SET_PT (pt);
2332 if (narrowed)
2333 Fnarrow_to_region (make_number (begv), make_number (zv));
2335 /* Do this first, so that chars_in_text asks the right question.
2336 set_intervals_multibyte needs it too. */
2337 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2339 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2340 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2342 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2344 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2345 if (BEGV_BYTE > GPT_BYTE)
2346 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2347 else
2348 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2350 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2351 if (ZV_BYTE > GPT_BYTE)
2352 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2353 else
2354 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2357 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2358 EMACS_INT position;
2360 if (byte > GPT_BYTE)
2361 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2362 else
2363 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2364 TEMP_SET_PT_BOTH (position, byte);
2367 tail = markers = BUF_MARKERS (current_buffer);
2369 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2370 getting confused by the markers that have not yet been updated.
2371 It is also a signal that it should never create a marker. */
2372 BUF_MARKERS (current_buffer) = NULL;
2374 for (; tail; tail = tail->next)
2376 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2377 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2380 /* Make sure no markers were put on the chain
2381 while the chain value was incorrect. */
2382 if (BUF_MARKERS (current_buffer))
2383 abort ();
2385 BUF_MARKERS (current_buffer) = markers;
2387 /* Do this last, so it can calculate the new correspondences
2388 between chars and bytes. */
2389 set_intervals_multibyte (1);
2392 if (!EQ (old_undo, Qt))
2394 /* Represent all the above changes by a special undo entry. */
2395 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2396 intern ("set-buffer-multibyte"),
2397 NILP (flag) ? Qt : Qnil),
2398 old_undo);
2401 UNGCPRO;
2403 /* Changing the multibyteness of a buffer means that all windows
2404 showing that buffer must be updated thoroughly. */
2405 current_buffer->prevent_redisplay_optimizations_p = 1;
2406 ++windows_or_buffers_changed;
2408 /* Copy this buffer's new multibyte status
2409 into all of its indirect buffers. */
2410 for (other = all_buffers; other; other = other->header.next.buffer)
2411 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2413 BVAR (other, enable_multibyte_characters)
2414 = BVAR (current_buffer, enable_multibyte_characters);
2415 other->prevent_redisplay_optimizations_p = 1;
2418 /* Restore the modifiedness of the buffer. */
2419 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2420 Fset_buffer_modified_p (Qnil);
2422 /* Update coding systems of this buffer's process (if any). */
2424 Lisp_Object process;
2426 process = Fget_buffer_process (Fcurrent_buffer ());
2427 if (PROCESSP (process))
2428 setup_process_coding_systems (process);
2431 return flag;
2434 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2435 Skill_all_local_variables, 0, 0, 0,
2436 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2437 Most local variable bindings are eliminated so that the default values
2438 become effective once more. Also, the syntax table is set from
2439 `standard-syntax-table', the local keymap is set to nil,
2440 and the abbrev table from `fundamental-mode-abbrev-table'.
2441 This function also forces redisplay of the mode line.
2443 Every function to select a new major mode starts by
2444 calling this function.
2446 As a special exception, local variables whose names have
2447 a non-nil `permanent-local' property are not eliminated by this function.
2449 The first thing this function does is run
2450 the normal hook `change-major-mode-hook'. */)
2451 (void)
2453 Frun_hooks (1, &Qchange_major_mode_hook);
2455 /* Make sure none of the bindings in local_var_alist
2456 remain swapped in, in their symbols. */
2458 swap_out_buffer_local_variables (current_buffer);
2460 /* Actually eliminate all local bindings of this buffer. */
2462 reset_buffer_local_variables (current_buffer, 0);
2464 /* Force mode-line redisplay. Useful here because all major mode
2465 commands call this function. */
2466 update_mode_lines++;
2468 return Qnil;
2471 /* Make sure no local variables remain set up with buffer B
2472 for their current values. */
2474 static void
2475 swap_out_buffer_local_variables (struct buffer *b)
2477 Lisp_Object oalist, alist, buffer;
2479 XSETBUFFER (buffer, b);
2480 oalist = BVAR (b, local_var_alist);
2482 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2484 Lisp_Object sym = XCAR (XCAR (alist));
2485 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2486 /* Need not do anything if some other buffer's binding is
2487 now encached. */
2488 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2490 /* Symbol is set up for this buffer's old local value:
2491 swap it out! */
2492 swap_in_global_binding (XSYMBOL (sym));
2497 /* Find all the overlays in the current buffer that contain position POS.
2498 Return the number found, and store them in a vector in *VEC_PTR.
2499 Store in *LEN_PTR the size allocated for the vector.
2500 Store in *NEXT_PTR the next position after POS where an overlay starts,
2501 or ZV if there are no more overlays between POS and ZV.
2502 Store in *PREV_PTR the previous position before POS where an overlay ends,
2503 or where an overlay starts which ends at or after POS;
2504 or BEGV if there are no such overlays from BEGV to POS.
2505 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2507 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2508 when this function is called.
2510 If EXTEND is non-zero, we make the vector bigger if necessary.
2511 If EXTEND is zero, we never extend the vector,
2512 and we store only as many overlays as will fit.
2513 But we still return the total number of overlays.
2515 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2516 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2517 default (BEGV or ZV). */
2520 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr, int *len_ptr,
2521 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
2523 Lisp_Object overlay, start, end;
2524 struct Lisp_Overlay *tail;
2525 int idx = 0;
2526 int len = *len_ptr;
2527 Lisp_Object *vec = *vec_ptr;
2528 EMACS_INT next = ZV;
2529 EMACS_INT prev = BEGV;
2530 int inhibit_storing = 0;
2532 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2534 EMACS_INT startpos, endpos;
2536 XSETMISC (overlay, tail);
2538 start = OVERLAY_START (overlay);
2539 end = OVERLAY_END (overlay);
2540 endpos = OVERLAY_POSITION (end);
2541 if (endpos < pos)
2543 if (prev < endpos)
2544 prev = endpos;
2545 break;
2547 startpos = OVERLAY_POSITION (start);
2548 /* This one ends at or after POS
2549 so its start counts for PREV_PTR if it's before POS. */
2550 if (prev < startpos && startpos < pos)
2551 prev = startpos;
2552 if (endpos == pos)
2553 continue;
2554 if (startpos <= pos)
2556 if (idx == len)
2558 /* The supplied vector is full.
2559 Either make it bigger, or don't store any more in it. */
2560 if (extend)
2562 /* Make it work with an initial len == 0. */
2563 len *= 2;
2564 if (len == 0)
2565 len = 4;
2566 *len_ptr = len;
2567 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2568 *vec_ptr = vec;
2570 else
2571 inhibit_storing = 1;
2574 if (!inhibit_storing)
2575 vec[idx] = overlay;
2576 /* Keep counting overlays even if we can't return them all. */
2577 idx++;
2579 else if (startpos < next)
2580 next = startpos;
2583 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2585 EMACS_INT startpos, endpos;
2587 XSETMISC (overlay, tail);
2589 start = OVERLAY_START (overlay);
2590 end = OVERLAY_END (overlay);
2591 startpos = OVERLAY_POSITION (start);
2592 if (pos < startpos)
2594 if (startpos < next)
2595 next = startpos;
2596 break;
2598 endpos = OVERLAY_POSITION (end);
2599 if (pos < endpos)
2601 if (idx == len)
2603 if (extend)
2605 /* Make it work with an initial len == 0. */
2606 len *= 2;
2607 if (len == 0)
2608 len = 4;
2609 *len_ptr = len;
2610 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2611 *vec_ptr = vec;
2613 else
2614 inhibit_storing = 1;
2617 if (!inhibit_storing)
2618 vec[idx] = overlay;
2619 idx++;
2621 if (startpos < pos && startpos > prev)
2622 prev = startpos;
2624 else if (endpos < pos && endpos > prev)
2625 prev = endpos;
2626 else if (endpos == pos && startpos > prev
2627 && (!change_req || startpos < pos))
2628 prev = startpos;
2631 if (next_ptr)
2632 *next_ptr = next;
2633 if (prev_ptr)
2634 *prev_ptr = prev;
2635 return idx;
2638 /* Find all the overlays in the current buffer that overlap the range
2639 BEG-END, or are empty at BEG, or are empty at END provided END
2640 denotes the position at the end of the current buffer.
2642 Return the number found, and store them in a vector in *VEC_PTR.
2643 Store in *LEN_PTR the size allocated for the vector.
2644 Store in *NEXT_PTR the next position after POS where an overlay starts,
2645 or ZV if there are no more overlays.
2646 Store in *PREV_PTR the previous position before POS where an overlay ends,
2647 or BEGV if there are no previous overlays.
2648 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2650 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2651 when this function is called.
2653 If EXTEND is non-zero, we make the vector bigger if necessary.
2654 If EXTEND is zero, we never extend the vector,
2655 and we store only as many overlays as will fit.
2656 But we still return the total number of overlays. */
2658 static int
2659 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2660 Lisp_Object **vec_ptr, int *len_ptr,
2661 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
2663 Lisp_Object overlay, ostart, oend;
2664 struct Lisp_Overlay *tail;
2665 int idx = 0;
2666 int len = *len_ptr;
2667 Lisp_Object *vec = *vec_ptr;
2668 EMACS_INT next = ZV;
2669 EMACS_INT prev = BEGV;
2670 int inhibit_storing = 0;
2671 int end_is_Z = end == Z;
2673 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2675 EMACS_INT startpos, endpos;
2677 XSETMISC (overlay, tail);
2679 ostart = OVERLAY_START (overlay);
2680 oend = OVERLAY_END (overlay);
2681 endpos = OVERLAY_POSITION (oend);
2682 if (endpos < beg)
2684 if (prev < endpos)
2685 prev = endpos;
2686 break;
2688 startpos = OVERLAY_POSITION (ostart);
2689 /* Count an interval if it overlaps the range, is empty at the
2690 start of the range, or is empty at END provided END denotes the
2691 end of the buffer. */
2692 if ((beg < endpos && startpos < end)
2693 || (startpos == endpos
2694 && (beg == endpos || (end_is_Z && endpos == end))))
2696 if (idx == len)
2698 /* The supplied vector is full.
2699 Either make it bigger, or don't store any more in it. */
2700 if (extend)
2702 /* Make it work with an initial len == 0. */
2703 len *= 2;
2704 if (len == 0)
2705 len = 4;
2706 *len_ptr = len;
2707 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2708 *vec_ptr = vec;
2710 else
2711 inhibit_storing = 1;
2714 if (!inhibit_storing)
2715 vec[idx] = overlay;
2716 /* Keep counting overlays even if we can't return them all. */
2717 idx++;
2719 else if (startpos < next)
2720 next = startpos;
2723 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2725 EMACS_INT startpos, endpos;
2727 XSETMISC (overlay, tail);
2729 ostart = OVERLAY_START (overlay);
2730 oend = OVERLAY_END (overlay);
2731 startpos = OVERLAY_POSITION (ostart);
2732 if (end < startpos)
2734 if (startpos < next)
2735 next = startpos;
2736 break;
2738 endpos = OVERLAY_POSITION (oend);
2739 /* Count an interval if it overlaps the range, is empty at the
2740 start of the range, or is empty at END provided END denotes the
2741 end of the buffer. */
2742 if ((beg < endpos && startpos < end)
2743 || (startpos == endpos
2744 && (beg == endpos || (end_is_Z && endpos == end))))
2746 if (idx == len)
2748 if (extend)
2750 /* Make it work with an initial len == 0. */
2751 len *= 2;
2752 if (len == 0)
2753 len = 4;
2754 *len_ptr = len;
2755 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2756 *vec_ptr = vec;
2758 else
2759 inhibit_storing = 1;
2762 if (!inhibit_storing)
2763 vec[idx] = overlay;
2764 idx++;
2766 else if (endpos < beg && endpos > prev)
2767 prev = endpos;
2770 if (next_ptr)
2771 *next_ptr = next;
2772 if (prev_ptr)
2773 *prev_ptr = prev;
2774 return idx;
2778 /* Return non-zero if there exists an overlay with a non-nil
2779 `mouse-face' property overlapping OVERLAY. */
2782 mouse_face_overlay_overlaps (Lisp_Object overlay)
2784 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2785 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
2786 int n, i, size;
2787 Lisp_Object *v, tem;
2789 size = 10;
2790 v = (Lisp_Object *) alloca (size * sizeof *v);
2791 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2792 if (n > size)
2794 v = (Lisp_Object *) alloca (n * sizeof *v);
2795 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2798 for (i = 0; i < n; ++i)
2799 if (!EQ (v[i], overlay)
2800 && (tem = Foverlay_get (overlay, Qmouse_face),
2801 !NILP (tem)))
2802 break;
2804 return i < n;
2809 /* Fast function to just test if we're at an overlay boundary. */
2811 overlay_touches_p (EMACS_INT pos)
2813 Lisp_Object overlay;
2814 struct Lisp_Overlay *tail;
2816 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2818 EMACS_INT endpos;
2820 XSETMISC (overlay ,tail);
2821 if (!OVERLAYP (overlay))
2822 abort ();
2824 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2825 if (endpos < pos)
2826 break;
2827 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2828 return 1;
2831 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2833 EMACS_INT startpos;
2835 XSETMISC (overlay, tail);
2836 if (!OVERLAYP (overlay))
2837 abort ();
2839 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2840 if (pos < startpos)
2841 break;
2842 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2843 return 1;
2845 return 0;
2848 struct sortvec
2850 Lisp_Object overlay;
2851 EMACS_INT beg, end;
2852 EMACS_INT priority;
2855 static int
2856 compare_overlays (const void *v1, const void *v2)
2858 const struct sortvec *s1 = (const struct sortvec *) v1;
2859 const struct sortvec *s2 = (const struct sortvec *) v2;
2860 if (s1->priority != s2->priority)
2861 return s1->priority < s2->priority ? -1 : 1;
2862 if (s1->beg != s2->beg)
2863 return s1->beg < s2->beg ? -1 : 1;
2864 if (s1->end != s2->end)
2865 return s2->end < s1->end ? -1 : 1;
2866 return 0;
2869 /* Sort an array of overlays by priority. The array is modified in place.
2870 The return value is the new size; this may be smaller than the original
2871 size if some of the overlays were invalid or were window-specific. */
2873 sort_overlays (Lisp_Object *overlay_vec, int noverlays, struct window *w)
2875 int i, j;
2876 struct sortvec *sortvec;
2877 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2879 /* Put the valid and relevant overlays into sortvec. */
2881 for (i = 0, j = 0; i < noverlays; i++)
2883 Lisp_Object tem;
2884 Lisp_Object overlay;
2886 overlay = overlay_vec[i];
2887 if (OVERLAY_VALID (overlay)
2888 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2889 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2891 /* If we're interested in a specific window, then ignore
2892 overlays that are limited to some other window. */
2893 if (w)
2895 Lisp_Object window;
2897 window = Foverlay_get (overlay, Qwindow);
2898 if (WINDOWP (window) && XWINDOW (window) != w)
2899 continue;
2902 /* This overlay is good and counts: put it into sortvec. */
2903 sortvec[j].overlay = overlay;
2904 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2905 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2906 tem = Foverlay_get (overlay, Qpriority);
2907 if (INTEGERP (tem))
2908 sortvec[j].priority = XINT (tem);
2909 else
2910 sortvec[j].priority = 0;
2911 j++;
2914 noverlays = j;
2916 /* Sort the overlays into the proper order: increasing priority. */
2918 if (noverlays > 1)
2919 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2921 for (i = 0; i < noverlays; i++)
2922 overlay_vec[i] = sortvec[i].overlay;
2923 return (noverlays);
2926 struct sortstr
2928 Lisp_Object string, string2;
2929 ptrdiff_t size;
2930 EMACS_INT priority;
2933 struct sortstrlist
2935 struct sortstr *buf; /* An array that expands as needed; never freed. */
2936 ptrdiff_t size; /* Allocated length of that array. */
2937 ptrdiff_t used; /* How much of the array is currently in use. */
2938 EMACS_INT bytes; /* Total length of the strings in buf. */
2941 /* Buffers for storing information about the overlays touching a given
2942 position. These could be automatic variables in overlay_strings, but
2943 it's more efficient to hold onto the memory instead of repeatedly
2944 allocating and freeing it. */
2945 static struct sortstrlist overlay_heads, overlay_tails;
2946 static unsigned char *overlay_str_buf;
2948 /* Allocated length of overlay_str_buf. */
2949 static EMACS_INT overlay_str_len;
2951 /* A comparison function suitable for passing to qsort. */
2952 static int
2953 cmp_for_strings (const void *as1, const void *as2)
2955 struct sortstr *s1 = (struct sortstr *)as1;
2956 struct sortstr *s2 = (struct sortstr *)as2;
2957 if (s1->size != s2->size)
2958 return s2->size < s1->size ? -1 : 1;
2959 if (s1->priority != s2->priority)
2960 return s1->priority < s2->priority ? -1 : 1;
2961 return 0;
2964 static void
2965 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2966 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2968 EMACS_INT nbytes;
2970 if (ssl->used == ssl->size)
2972 if (min (PTRDIFF_MAX, SIZE_MAX) / (sizeof (struct sortstr) * 2)
2973 < ssl->size)
2974 memory_full (SIZE_MAX);
2975 else if (0 < ssl->size)
2976 ssl->size *= 2;
2977 else
2978 ssl->size = 5;
2979 ssl->buf = ((struct sortstr *)
2980 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2982 ssl->buf[ssl->used].string = str;
2983 ssl->buf[ssl->used].string2 = str2;
2984 ssl->buf[ssl->used].size = size;
2985 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2986 ssl->used++;
2988 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2989 nbytes = SCHARS (str);
2990 else if (! STRING_MULTIBYTE (str))
2991 nbytes = count_size_as_multibyte (SDATA (str),
2992 SBYTES (str));
2993 else
2994 nbytes = SBYTES (str);
2996 ssl->bytes += nbytes;
2998 if (STRINGP (str2))
3000 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
3001 nbytes = SCHARS (str2);
3002 else if (! STRING_MULTIBYTE (str2))
3003 nbytes = count_size_as_multibyte (SDATA (str2),
3004 SBYTES (str2));
3005 else
3006 nbytes = SBYTES (str2);
3008 ssl->bytes += nbytes;
3012 /* Return the concatenation of the strings associated with overlays that
3013 begin or end at POS, ignoring overlays that are specific to a window
3014 other than W. The strings are concatenated in the appropriate order:
3015 shorter overlays nest inside longer ones, and higher priority inside
3016 lower. Normally all of the after-strings come first, but zero-sized
3017 overlays have their after-strings ride along with the before-strings
3018 because it would look strange to print them inside-out.
3020 Returns the string length, and stores the contents indirectly through
3021 PSTR, if that variable is non-null. The string may be overwritten by
3022 subsequent calls. */
3024 EMACS_INT
3025 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3027 Lisp_Object overlay, window, str;
3028 struct Lisp_Overlay *ov;
3029 EMACS_INT startpos, endpos;
3030 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3032 overlay_heads.used = overlay_heads.bytes = 0;
3033 overlay_tails.used = overlay_tails.bytes = 0;
3034 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3036 XSETMISC (overlay, ov);
3037 eassert (OVERLAYP (overlay));
3039 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3040 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3041 if (endpos < pos)
3042 break;
3043 if (endpos != pos && startpos != pos)
3044 continue;
3045 window = Foverlay_get (overlay, Qwindow);
3046 if (WINDOWP (window) && XWINDOW (window) != w)
3047 continue;
3048 if (startpos == pos
3049 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3050 record_overlay_string (&overlay_heads, str,
3051 (startpos == endpos
3052 ? Foverlay_get (overlay, Qafter_string)
3053 : Qnil),
3054 Foverlay_get (overlay, Qpriority),
3055 endpos - startpos);
3056 else if (endpos == pos
3057 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3058 record_overlay_string (&overlay_tails, str, Qnil,
3059 Foverlay_get (overlay, Qpriority),
3060 endpos - startpos);
3062 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3064 XSETMISC (overlay, ov);
3065 eassert (OVERLAYP (overlay));
3067 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3068 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3069 if (startpos > pos)
3070 break;
3071 if (endpos != pos && startpos != pos)
3072 continue;
3073 window = Foverlay_get (overlay, Qwindow);
3074 if (WINDOWP (window) && XWINDOW (window) != w)
3075 continue;
3076 if (startpos == pos
3077 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3078 record_overlay_string (&overlay_heads, str,
3079 (startpos == endpos
3080 ? Foverlay_get (overlay, Qafter_string)
3081 : Qnil),
3082 Foverlay_get (overlay, Qpriority),
3083 endpos - startpos);
3084 else if (endpos == pos
3085 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3086 record_overlay_string (&overlay_tails, str, Qnil,
3087 Foverlay_get (overlay, Qpriority),
3088 endpos - startpos);
3090 if (overlay_tails.used > 1)
3091 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3092 cmp_for_strings);
3093 if (overlay_heads.used > 1)
3094 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3095 cmp_for_strings);
3096 if (overlay_heads.bytes || overlay_tails.bytes)
3098 Lisp_Object tem;
3099 EMACS_INT i;
3100 unsigned char *p;
3101 EMACS_INT total = overlay_heads.bytes + overlay_tails.bytes;
3103 if (total > overlay_str_len)
3105 overlay_str_len = total;
3106 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3107 total);
3109 p = overlay_str_buf;
3110 for (i = overlay_tails.used; --i >= 0;)
3112 EMACS_INT nbytes;
3113 tem = overlay_tails.buf[i].string;
3114 nbytes = copy_text (SDATA (tem), p,
3115 SBYTES (tem),
3116 STRING_MULTIBYTE (tem), multibyte);
3117 p += nbytes;
3119 for (i = 0; i < overlay_heads.used; ++i)
3121 EMACS_INT nbytes;
3122 tem = overlay_heads.buf[i].string;
3123 nbytes = copy_text (SDATA (tem), p,
3124 SBYTES (tem),
3125 STRING_MULTIBYTE (tem), multibyte);
3126 p += nbytes;
3127 tem = overlay_heads.buf[i].string2;
3128 if (STRINGP (tem))
3130 nbytes = copy_text (SDATA (tem), p,
3131 SBYTES (tem),
3132 STRING_MULTIBYTE (tem), multibyte);
3133 p += nbytes;
3136 if (p != overlay_str_buf + total)
3137 abort ();
3138 if (pstr)
3139 *pstr = overlay_str_buf;
3140 return total;
3142 return 0;
3145 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3147 void
3148 recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
3150 Lisp_Object overlay, beg, end;
3151 struct Lisp_Overlay *prev, *tail, *next;
3153 /* See if anything in overlays_before should move to overlays_after. */
3155 /* We don't strictly need prev in this loop; it should always be nil.
3156 But we use it for symmetry and in case that should cease to be true
3157 with some future change. */
3158 prev = NULL;
3159 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3161 next = tail->next;
3162 XSETMISC (overlay, tail);
3164 /* If the overlay is not valid, get rid of it. */
3165 if (!OVERLAY_VALID (overlay))
3166 #if 1
3167 abort ();
3168 #else
3170 /* Splice the cons cell TAIL out of overlays_before. */
3171 if (!NILP (prev))
3172 XCDR (prev) = next;
3173 else
3174 buf->overlays_before = next;
3175 tail = prev;
3176 continue;
3178 #endif
3180 beg = OVERLAY_START (overlay);
3181 end = OVERLAY_END (overlay);
3183 if (OVERLAY_POSITION (end) > pos)
3185 /* OVERLAY needs to be moved. */
3186 EMACS_INT where = OVERLAY_POSITION (beg);
3187 struct Lisp_Overlay *other, *other_prev;
3189 /* Splice the cons cell TAIL out of overlays_before. */
3190 if (prev)
3191 prev->next = next;
3192 else
3193 buf->overlays_before = next;
3195 /* Search thru overlays_after for where to put it. */
3196 other_prev = NULL;
3197 for (other = buf->overlays_after; other;
3198 other_prev = other, other = other->next)
3200 Lisp_Object otherbeg, otheroverlay;
3202 XSETMISC (otheroverlay, other);
3203 eassert (OVERLAY_VALID (otheroverlay));
3205 otherbeg = OVERLAY_START (otheroverlay);
3206 if (OVERLAY_POSITION (otherbeg) >= where)
3207 break;
3210 /* Add TAIL to overlays_after before OTHER. */
3211 tail->next = other;
3212 if (other_prev)
3213 other_prev->next = tail;
3214 else
3215 buf->overlays_after = tail;
3216 tail = prev;
3218 else
3219 /* We've reached the things that should stay in overlays_before.
3220 All the rest of overlays_before must end even earlier,
3221 so stop now. */
3222 break;
3225 /* See if anything in overlays_after should be in overlays_before. */
3226 prev = NULL;
3227 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3229 next = tail->next;
3230 XSETMISC (overlay, tail);
3232 /* If the overlay is not valid, get rid of it. */
3233 if (!OVERLAY_VALID (overlay))
3234 #if 1
3235 abort ();
3236 #else
3238 /* Splice the cons cell TAIL out of overlays_after. */
3239 if (!NILP (prev))
3240 XCDR (prev) = next;
3241 else
3242 buf->overlays_after = next;
3243 tail = prev;
3244 continue;
3246 #endif
3248 beg = OVERLAY_START (overlay);
3249 end = OVERLAY_END (overlay);
3251 /* Stop looking, when we know that nothing further
3252 can possibly end before POS. */
3253 if (OVERLAY_POSITION (beg) > pos)
3254 break;
3256 if (OVERLAY_POSITION (end) <= pos)
3258 /* OVERLAY needs to be moved. */
3259 EMACS_INT where = OVERLAY_POSITION (end);
3260 struct Lisp_Overlay *other, *other_prev;
3262 /* Splice the cons cell TAIL out of overlays_after. */
3263 if (prev)
3264 prev->next = next;
3265 else
3266 buf->overlays_after = next;
3268 /* Search thru overlays_before for where to put it. */
3269 other_prev = NULL;
3270 for (other = buf->overlays_before; other;
3271 other_prev = other, other = other->next)
3273 Lisp_Object otherend, otheroverlay;
3275 XSETMISC (otheroverlay, other);
3276 eassert (OVERLAY_VALID (otheroverlay));
3278 otherend = OVERLAY_END (otheroverlay);
3279 if (OVERLAY_POSITION (otherend) <= where)
3280 break;
3283 /* Add TAIL to overlays_before before OTHER. */
3284 tail->next = other;
3285 if (other_prev)
3286 other_prev->next = tail;
3287 else
3288 buf->overlays_before = tail;
3289 tail = prev;
3293 buf->overlay_center = pos;
3296 void
3297 adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
3299 /* After an insertion, the lists are still sorted properly,
3300 but we may need to update the value of the overlay center. */
3301 if (current_buffer->overlay_center >= pos)
3302 current_buffer->overlay_center += length;
3305 void
3306 adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
3308 if (current_buffer->overlay_center < pos)
3309 /* The deletion was to our right. No change needed; the before- and
3310 after-lists are still consistent. */
3312 else if (current_buffer->overlay_center > pos + length)
3313 /* The deletion was to our left. We need to adjust the center value
3314 to account for the change in position, but the lists are consistent
3315 given the new value. */
3316 current_buffer->overlay_center -= length;
3317 else
3318 /* We're right in the middle. There might be things on the after-list
3319 that now belong on the before-list. Recentering will move them,
3320 and also update the center point. */
3321 recenter_overlay_lists (current_buffer, pos);
3324 /* Fix up overlays that were garbled as a result of permuting markers
3325 in the range START through END. Any overlay with at least one
3326 endpoint in this range will need to be unlinked from the overlay
3327 list and reinserted in its proper place.
3328 Such an overlay might even have negative size at this point.
3329 If so, we'll make the overlay empty. */
3330 void
3331 fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
3333 Lisp_Object overlay;
3334 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3335 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3336 /* These are either nil, indicating that before_list or after_list
3337 should be assigned, or the cons cell the cdr of which should be
3338 assigned. */
3339 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3340 /* 'Parent', likewise, indicates a cons cell or
3341 current_buffer->overlays_before or overlays_after, depending
3342 which loop we're in. */
3343 struct Lisp_Overlay *tail, *parent;
3344 EMACS_INT startpos, endpos;
3346 /* This algorithm shifts links around instead of consing and GCing.
3347 The loop invariant is that before_list (resp. after_list) is a
3348 well-formed list except that its last element, the CDR of beforep
3349 (resp. afterp) if beforep (afterp) isn't nil or before_list
3350 (after_list) if it is, is still uninitialized. So it's not a bug
3351 that before_list isn't initialized, although it may look
3352 strange. */
3353 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3355 XSETMISC (overlay, tail);
3357 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3358 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3360 /* If the overlay is backwards, make it empty. */
3361 if (endpos < startpos)
3363 startpos = endpos;
3364 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3365 Qnil);
3368 if (endpos < start)
3369 break;
3371 if (endpos < end
3372 || (startpos >= start && startpos < end))
3374 /* Add it to the end of the wrong list. Later on,
3375 recenter_overlay_lists will move it to the right place. */
3376 if (endpos < current_buffer->overlay_center)
3378 if (!afterp)
3379 after_list = tail;
3380 else
3381 afterp->next = tail;
3382 afterp = tail;
3384 else
3386 if (!beforep)
3387 before_list = tail;
3388 else
3389 beforep->next = tail;
3390 beforep = tail;
3392 if (!parent)
3393 current_buffer->overlays_before = tail->next;
3394 else
3395 parent->next = tail->next;
3396 tail = tail->next;
3398 else
3399 parent = tail, tail = parent->next;
3401 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3403 XSETMISC (overlay, tail);
3405 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3406 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3408 /* If the overlay is backwards, make it empty. */
3409 if (endpos < startpos)
3411 startpos = endpos;
3412 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3413 Qnil);
3416 if (startpos >= end)
3417 break;
3419 if (startpos >= start
3420 || (endpos >= start && endpos < end))
3422 if (endpos < current_buffer->overlay_center)
3424 if (!afterp)
3425 after_list = tail;
3426 else
3427 afterp->next = tail;
3428 afterp = tail;
3430 else
3432 if (!beforep)
3433 before_list = tail;
3434 else
3435 beforep->next = tail;
3436 beforep = tail;
3438 if (!parent)
3439 current_buffer->overlays_after = tail->next;
3440 else
3441 parent->next = tail->next;
3442 tail = tail->next;
3444 else
3445 parent = tail, tail = parent->next;
3448 /* Splice the constructed (wrong) lists into the buffer's lists,
3449 and let the recenter function make it sane again. */
3450 if (beforep)
3452 beforep->next = current_buffer->overlays_before;
3453 current_buffer->overlays_before = before_list;
3455 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3457 if (afterp)
3459 afterp->next = current_buffer->overlays_after;
3460 current_buffer->overlays_after = after_list;
3462 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3465 /* We have two types of overlay: the one whose ending marker is
3466 after-insertion-marker (this is the usual case) and the one whose
3467 ending marker is before-insertion-marker. When `overlays_before'
3468 contains overlays of the latter type and the former type in this
3469 order and both overlays end at inserting position, inserting a text
3470 increases only the ending marker of the latter type, which results
3471 in incorrect ordering of `overlays_before'.
3473 This function fixes ordering of overlays in the slot
3474 `overlays_before' of the buffer *BP. Before the insertion, `point'
3475 was at PREV, and now is at POS. */
3477 void
3478 fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3480 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3481 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3482 Lisp_Object tem;
3483 EMACS_INT end IF_LINT (= 0);
3485 /* After the insertion, the several overlays may be in incorrect
3486 order. The possibility is that, in the list `overlays_before',
3487 an overlay which ends at POS appears after an overlay which ends
3488 at PREV. Since POS is greater than PREV, we must fix the
3489 ordering of these overlays, by moving overlays ends at POS before
3490 the overlays ends at PREV. */
3492 /* At first, find a place where disordered overlays should be linked
3493 in. It is where an overlay which end before POS exists. (i.e. an
3494 overlay whose ending marker is after-insertion-marker if disorder
3495 exists). */
3496 while (tail
3497 && (XSETMISC (tem, tail),
3498 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3500 parent = tail;
3501 tail = tail->next;
3504 /* If we don't find such an overlay,
3505 or the found one ends before PREV,
3506 or the found one is the last one in the list,
3507 we don't have to fix anything. */
3508 if (!tail || end < prev || !tail->next)
3509 return;
3511 right_pair = parent;
3512 parent = tail;
3513 tail = tail->next;
3515 /* Now, end position of overlays in the list TAIL should be before
3516 or equal to PREV. In the loop, an overlay which ends at POS is
3517 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3518 we found an overlay which ends before PREV, the remaining
3519 overlays are in correct order. */
3520 while (tail)
3522 XSETMISC (tem, tail);
3523 end = OVERLAY_POSITION (OVERLAY_END (tem));
3525 if (end == pos)
3526 { /* This overlay is disordered. */
3527 struct Lisp_Overlay *found = tail;
3529 /* Unlink the found overlay. */
3530 tail = found->next;
3531 parent->next = tail;
3532 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3533 and link it into the right place. */
3534 if (!right_pair)
3536 found->next = bp->overlays_before;
3537 bp->overlays_before = found;
3539 else
3541 found->next = right_pair->next;
3542 right_pair->next = found;
3545 else if (end == prev)
3547 parent = tail;
3548 tail = tail->next;
3550 else /* No more disordered overlay. */
3551 break;
3555 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3556 doc: /* Return t if OBJECT is an overlay. */)
3557 (Lisp_Object object)
3559 return (OVERLAYP (object) ? Qt : Qnil);
3562 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3563 doc: /* Create a new overlay with range BEG to END in BUFFER.
3564 If omitted, BUFFER defaults to the current buffer.
3565 BEG and END may be integers or markers.
3566 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3567 for the front of the overlay advance when text is inserted there
3568 \(which means the text *is not* included in the overlay).
3569 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3570 for the rear of the overlay advance when text is inserted there
3571 \(which means the text *is* included in the overlay). */)
3572 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3574 Lisp_Object overlay;
3575 struct buffer *b;
3577 if (NILP (buffer))
3578 XSETBUFFER (buffer, current_buffer);
3579 else
3580 CHECK_BUFFER (buffer);
3581 if (MARKERP (beg)
3582 && ! EQ (Fmarker_buffer (beg), buffer))
3583 error ("Marker points into wrong buffer");
3584 if (MARKERP (end)
3585 && ! EQ (Fmarker_buffer (end), buffer))
3586 error ("Marker points into wrong buffer");
3588 CHECK_NUMBER_COERCE_MARKER (beg);
3589 CHECK_NUMBER_COERCE_MARKER (end);
3591 if (XINT (beg) > XINT (end))
3593 Lisp_Object temp;
3594 temp = beg; beg = end; end = temp;
3597 b = XBUFFER (buffer);
3599 beg = Fset_marker (Fmake_marker (), beg, buffer);
3600 end = Fset_marker (Fmake_marker (), end, buffer);
3602 if (!NILP (front_advance))
3603 XMARKER (beg)->insertion_type = 1;
3604 if (!NILP (rear_advance))
3605 XMARKER (end)->insertion_type = 1;
3607 overlay = allocate_misc ();
3608 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3609 XOVERLAY (overlay)->start = beg;
3610 XOVERLAY (overlay)->end = end;
3611 XOVERLAY (overlay)->plist = Qnil;
3612 XOVERLAY (overlay)->next = NULL;
3614 /* Put the new overlay on the wrong list. */
3615 end = OVERLAY_END (overlay);
3616 if (OVERLAY_POSITION (end) < b->overlay_center)
3618 if (b->overlays_after)
3619 XOVERLAY (overlay)->next = b->overlays_after;
3620 b->overlays_after = XOVERLAY (overlay);
3622 else
3624 if (b->overlays_before)
3625 XOVERLAY (overlay)->next = b->overlays_before;
3626 b->overlays_before = XOVERLAY (overlay);
3629 /* This puts it in the right list, and in the right order. */
3630 recenter_overlay_lists (b, b->overlay_center);
3632 /* We don't need to redisplay the region covered by the overlay, because
3633 the overlay has no properties at the moment. */
3635 return overlay;
3638 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3640 static void
3641 modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
3643 if (start > end)
3645 EMACS_INT temp = start;
3646 start = end;
3647 end = temp;
3650 BUF_COMPUTE_UNCHANGED (buf, start, end);
3652 /* If this is a buffer not in the selected window,
3653 we must do other windows. */
3654 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3655 windows_or_buffers_changed = 1;
3656 /* If multiple windows show this buffer, we must do other windows. */
3657 else if (buffer_shared > 1)
3658 windows_or_buffers_changed = 1;
3659 /* If we modify an overlay at the end of the buffer, we cannot
3660 be sure that window end is still valid. */
3661 else if (end >= ZV && start <= ZV)
3662 windows_or_buffers_changed = 1;
3664 ++BUF_OVERLAY_MODIFF (buf);
3668 static struct Lisp_Overlay *
3669 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3671 struct Lisp_Overlay *tmp, *prev;
3672 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3673 if (tmp == overlay)
3675 if (prev)
3676 prev->next = tmp->next;
3677 else
3678 list = tmp->next;
3679 overlay->next = NULL;
3680 break;
3682 return list;
3685 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3686 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3687 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3688 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3689 buffer. */)
3690 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3692 struct buffer *b, *ob;
3693 Lisp_Object obuffer;
3694 int count = SPECPDL_INDEX ();
3696 CHECK_OVERLAY (overlay);
3697 if (NILP (buffer))
3698 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3699 if (NILP (buffer))
3700 XSETBUFFER (buffer, current_buffer);
3701 CHECK_BUFFER (buffer);
3703 if (MARKERP (beg)
3704 && ! EQ (Fmarker_buffer (beg), buffer))
3705 error ("Marker points into wrong buffer");
3706 if (MARKERP (end)
3707 && ! EQ (Fmarker_buffer (end), buffer))
3708 error ("Marker points into wrong buffer");
3710 CHECK_NUMBER_COERCE_MARKER (beg);
3711 CHECK_NUMBER_COERCE_MARKER (end);
3713 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3714 return Fdelete_overlay (overlay);
3716 if (XINT (beg) > XINT (end))
3718 Lisp_Object temp;
3719 temp = beg; beg = end; end = temp;
3722 specbind (Qinhibit_quit, Qt);
3724 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3725 b = XBUFFER (buffer);
3726 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3728 /* If the overlay has changed buffers, do a thorough redisplay. */
3729 if (!EQ (buffer, obuffer))
3731 /* Redisplay where the overlay was. */
3732 if (!NILP (obuffer))
3734 EMACS_INT o_beg;
3735 EMACS_INT o_end;
3737 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3738 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3740 modify_overlay (ob, o_beg, o_end);
3743 /* Redisplay where the overlay is going to be. */
3744 modify_overlay (b, XINT (beg), XINT (end));
3746 else
3747 /* Redisplay the area the overlay has just left, or just enclosed. */
3749 EMACS_INT o_beg, o_end;
3751 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3752 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3754 if (o_beg == XINT (beg))
3755 modify_overlay (b, o_end, XINT (end));
3756 else if (o_end == XINT (end))
3757 modify_overlay (b, o_beg, XINT (beg));
3758 else
3760 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3761 if (XINT (end) > o_end) o_end = XINT (end);
3762 modify_overlay (b, o_beg, o_end);
3766 if (!NILP (obuffer))
3768 ob->overlays_before
3769 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3770 ob->overlays_after
3771 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3772 eassert (XOVERLAY (overlay)->next == NULL);
3775 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3776 Fset_marker (OVERLAY_END (overlay), end, buffer);
3778 /* Put the overlay on the wrong list. */
3779 end = OVERLAY_END (overlay);
3780 if (OVERLAY_POSITION (end) < b->overlay_center)
3782 XOVERLAY (overlay)->next = b->overlays_after;
3783 b->overlays_after = XOVERLAY (overlay);
3785 else
3787 XOVERLAY (overlay)->next = b->overlays_before;
3788 b->overlays_before = XOVERLAY (overlay);
3791 /* This puts it in the right list, and in the right order. */
3792 recenter_overlay_lists (b, b->overlay_center);
3794 return unbind_to (count, overlay);
3797 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3798 doc: /* Delete the overlay OVERLAY from its buffer. */)
3799 (Lisp_Object overlay)
3801 Lisp_Object buffer;
3802 struct buffer *b;
3803 int count = SPECPDL_INDEX ();
3805 CHECK_OVERLAY (overlay);
3807 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3808 if (NILP (buffer))
3809 return Qnil;
3811 b = XBUFFER (buffer);
3812 specbind (Qinhibit_quit, Qt);
3814 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3815 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3816 eassert (XOVERLAY (overlay)->next == NULL);
3817 modify_overlay (b,
3818 marker_position (OVERLAY_START (overlay)),
3819 marker_position (OVERLAY_END (overlay)));
3820 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3821 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3823 /* When deleting an overlay with before or after strings, turn off
3824 display optimizations for the affected buffer, on the basis that
3825 these strings may contain newlines. This is easier to do than to
3826 check for that situation during redisplay. */
3827 if (!windows_or_buffers_changed
3828 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3829 || !NILP (Foverlay_get (overlay, Qafter_string))))
3830 b->prevent_redisplay_optimizations_p = 1;
3832 return unbind_to (count, Qnil);
3835 /* Overlay dissection functions. */
3837 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3838 doc: /* Return the position at which OVERLAY starts. */)
3839 (Lisp_Object overlay)
3841 CHECK_OVERLAY (overlay);
3843 return (Fmarker_position (OVERLAY_START (overlay)));
3846 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3847 doc: /* Return the position at which OVERLAY ends. */)
3848 (Lisp_Object overlay)
3850 CHECK_OVERLAY (overlay);
3852 return (Fmarker_position (OVERLAY_END (overlay)));
3855 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3856 doc: /* Return the buffer OVERLAY belongs to.
3857 Return nil if OVERLAY has been deleted. */)
3858 (Lisp_Object overlay)
3860 CHECK_OVERLAY (overlay);
3862 return Fmarker_buffer (OVERLAY_START (overlay));
3865 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3866 doc: /* Return a list of the properties on OVERLAY.
3867 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3868 OVERLAY. */)
3869 (Lisp_Object overlay)
3871 CHECK_OVERLAY (overlay);
3873 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3877 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3878 doc: /* Return a list of the overlays that contain the character at POS. */)
3879 (Lisp_Object pos)
3881 int noverlays;
3882 Lisp_Object *overlay_vec;
3883 int len;
3884 Lisp_Object result;
3886 CHECK_NUMBER_COERCE_MARKER (pos);
3888 len = 10;
3889 /* We can't use alloca here because overlays_at can call xrealloc. */
3890 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3892 /* Put all the overlays we want in a vector in overlay_vec.
3893 Store the length in len. */
3894 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3895 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3897 /* Make a list of them all. */
3898 result = Flist (noverlays, overlay_vec);
3900 xfree (overlay_vec);
3901 return result;
3904 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3905 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3906 Overlap means that at least one character is contained within the overlay
3907 and also contained within the specified region.
3908 Empty overlays are included in the result if they are located at BEG,
3909 between BEG and END, or at END provided END denotes the position at the
3910 end of the buffer. */)
3911 (Lisp_Object beg, Lisp_Object end)
3913 int noverlays;
3914 Lisp_Object *overlay_vec;
3915 int len;
3916 Lisp_Object result;
3918 CHECK_NUMBER_COERCE_MARKER (beg);
3919 CHECK_NUMBER_COERCE_MARKER (end);
3921 len = 10;
3922 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3924 /* Put all the overlays we want in a vector in overlay_vec.
3925 Store the length in len. */
3926 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3927 NULL, NULL);
3929 /* Make a list of them all. */
3930 result = Flist (noverlays, overlay_vec);
3932 xfree (overlay_vec);
3933 return result;
3936 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3937 1, 1, 0,
3938 doc: /* Return the next position after POS where an overlay starts or ends.
3939 If there are no overlay boundaries from POS to (point-max),
3940 the value is (point-max). */)
3941 (Lisp_Object pos)
3943 int noverlays;
3944 EMACS_INT endpos;
3945 Lisp_Object *overlay_vec;
3946 int len;
3947 int i;
3949 CHECK_NUMBER_COERCE_MARKER (pos);
3951 len = 10;
3952 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3954 /* Put all the overlays we want in a vector in overlay_vec.
3955 Store the length in len.
3956 endpos gets the position where the next overlay starts. */
3957 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3958 &endpos, (EMACS_INT *) 0, 1);
3960 /* If any of these overlays ends before endpos,
3961 use its ending point instead. */
3962 for (i = 0; i < noverlays; i++)
3964 Lisp_Object oend;
3965 EMACS_INT oendpos;
3967 oend = OVERLAY_END (overlay_vec[i]);
3968 oendpos = OVERLAY_POSITION (oend);
3969 if (oendpos < endpos)
3970 endpos = oendpos;
3973 xfree (overlay_vec);
3974 return make_number (endpos);
3977 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3978 Sprevious_overlay_change, 1, 1, 0,
3979 doc: /* Return the previous position before POS where an overlay starts or ends.
3980 If there are no overlay boundaries from (point-min) to POS,
3981 the value is (point-min). */)
3982 (Lisp_Object pos)
3984 EMACS_INT prevpos;
3985 Lisp_Object *overlay_vec;
3986 int len;
3988 CHECK_NUMBER_COERCE_MARKER (pos);
3990 /* At beginning of buffer, we know the answer;
3991 avoid bug subtracting 1 below. */
3992 if (XINT (pos) == BEGV)
3993 return pos;
3995 len = 10;
3996 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3998 /* Put all the overlays we want in a vector in overlay_vec.
3999 Store the length in len.
4000 prevpos gets the position of the previous change. */
4001 overlays_at (XINT (pos), 1, &overlay_vec, &len,
4002 (EMACS_INT *) 0, &prevpos, 1);
4004 xfree (overlay_vec);
4005 return make_number (prevpos);
4008 /* These functions are for debugging overlays. */
4010 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4011 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4012 The car has all the overlays before the overlay center;
4013 the cdr has all the overlays after the overlay center.
4014 Recentering overlays moves overlays between these lists.
4015 The lists you get are copies, so that changing them has no effect.
4016 However, the overlays you get are the real objects that the buffer uses. */)
4017 (void)
4019 struct Lisp_Overlay *ol;
4020 Lisp_Object before = Qnil, after = Qnil, tmp;
4021 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4023 XSETMISC (tmp, ol);
4024 before = Fcons (tmp, before);
4026 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4028 XSETMISC (tmp, ol);
4029 after = Fcons (tmp, after);
4031 return Fcons (Fnreverse (before), Fnreverse (after));
4034 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4035 doc: /* Recenter the overlays of the current buffer around position POS.
4036 That makes overlay lookup faster for positions near POS (but perhaps slower
4037 for positions far away from POS). */)
4038 (Lisp_Object pos)
4040 CHECK_NUMBER_COERCE_MARKER (pos);
4042 recenter_overlay_lists (current_buffer, XINT (pos));
4043 return Qnil;
4046 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4047 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4048 (Lisp_Object overlay, Lisp_Object prop)
4050 CHECK_OVERLAY (overlay);
4051 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4054 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4055 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4056 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4058 Lisp_Object tail, buffer;
4059 int changed;
4061 CHECK_OVERLAY (overlay);
4063 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4065 for (tail = XOVERLAY (overlay)->plist;
4066 CONSP (tail) && CONSP (XCDR (tail));
4067 tail = XCDR (XCDR (tail)))
4068 if (EQ (XCAR (tail), prop))
4070 changed = !EQ (XCAR (XCDR (tail)), value);
4071 XSETCAR (XCDR (tail), value);
4072 goto found;
4074 /* It wasn't in the list, so add it to the front. */
4075 changed = !NILP (value);
4076 XOVERLAY (overlay)->plist
4077 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4078 found:
4079 if (! NILP (buffer))
4081 if (changed)
4082 modify_overlay (XBUFFER (buffer),
4083 marker_position (OVERLAY_START (overlay)),
4084 marker_position (OVERLAY_END (overlay)));
4085 if (EQ (prop, Qevaporate) && ! NILP (value)
4086 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4087 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4088 Fdelete_overlay (overlay);
4091 return value;
4094 /* Subroutine of report_overlay_modification. */
4096 /* Lisp vector holding overlay hook functions to call.
4097 Vector elements come in pairs.
4098 Each even-index element is a list of hook functions.
4099 The following odd-index element is the overlay they came from.
4101 Before the buffer change, we fill in this vector
4102 as we call overlay hook functions.
4103 After the buffer change, we get the functions to call from this vector.
4104 This way we always call the same functions before and after the change. */
4105 static Lisp_Object last_overlay_modification_hooks;
4107 /* Number of elements actually used in last_overlay_modification_hooks. */
4108 static int last_overlay_modification_hooks_used;
4110 /* Add one functionlist/overlay pair
4111 to the end of last_overlay_modification_hooks. */
4113 static void
4114 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4116 int oldsize = ASIZE (last_overlay_modification_hooks);
4118 if (last_overlay_modification_hooks_used == oldsize)
4119 last_overlay_modification_hooks = larger_vector
4120 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4121 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4122 functionlist); last_overlay_modification_hooks_used++;
4123 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4124 overlay); last_overlay_modification_hooks_used++;
4127 /* Run the modification-hooks of overlays that include
4128 any part of the text in START to END.
4129 If this change is an insertion, also
4130 run the insert-before-hooks of overlay starting at END,
4131 and the insert-after-hooks of overlay ending at START.
4133 This is called both before and after the modification.
4134 AFTER is nonzero when we call after the modification.
4136 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4137 When AFTER is nonzero, they are the start position,
4138 the position after the inserted new text,
4139 and the length of deleted or replaced old text. */
4141 void
4142 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4143 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4145 Lisp_Object prop, overlay;
4146 struct Lisp_Overlay *tail;
4147 /* 1 if this change is an insertion. */
4148 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4149 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4151 overlay = Qnil;
4152 tail = NULL;
4154 /* We used to run the functions as soon as we found them and only register
4155 them in last_overlay_modification_hooks for the purpose of the `after'
4156 case. But running elisp code as we traverse the list of overlays is
4157 painful because the list can be modified by the elisp code so we had to
4158 copy at several places. We now simply do a read-only traversal that
4159 only collects the functions to run and we run them afterwards. It's
4160 simpler, especially since all the code was already there. -stef */
4162 if (!after)
4164 /* We are being called before a change.
4165 Scan the overlays to find the functions to call. */
4166 last_overlay_modification_hooks_used = 0;
4167 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4169 EMACS_INT startpos, endpos;
4170 Lisp_Object ostart, oend;
4172 XSETMISC (overlay, tail);
4174 ostart = OVERLAY_START (overlay);
4175 oend = OVERLAY_END (overlay);
4176 endpos = OVERLAY_POSITION (oend);
4177 if (XFASTINT (start) > endpos)
4178 break;
4179 startpos = OVERLAY_POSITION (ostart);
4180 if (insertion && (XFASTINT (start) == startpos
4181 || XFASTINT (end) == startpos))
4183 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4184 if (!NILP (prop))
4185 add_overlay_mod_hooklist (prop, overlay);
4187 if (insertion && (XFASTINT (start) == endpos
4188 || XFASTINT (end) == endpos))
4190 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4191 if (!NILP (prop))
4192 add_overlay_mod_hooklist (prop, overlay);
4194 /* Test for intersecting intervals. This does the right thing
4195 for both insertion and deletion. */
4196 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4198 prop = Foverlay_get (overlay, Qmodification_hooks);
4199 if (!NILP (prop))
4200 add_overlay_mod_hooklist (prop, overlay);
4204 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4206 EMACS_INT startpos, endpos;
4207 Lisp_Object ostart, oend;
4209 XSETMISC (overlay, tail);
4211 ostart = OVERLAY_START (overlay);
4212 oend = OVERLAY_END (overlay);
4213 startpos = OVERLAY_POSITION (ostart);
4214 endpos = OVERLAY_POSITION (oend);
4215 if (XFASTINT (end) < startpos)
4216 break;
4217 if (insertion && (XFASTINT (start) == startpos
4218 || XFASTINT (end) == startpos))
4220 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4221 if (!NILP (prop))
4222 add_overlay_mod_hooklist (prop, overlay);
4224 if (insertion && (XFASTINT (start) == endpos
4225 || XFASTINT (end) == endpos))
4227 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4228 if (!NILP (prop))
4229 add_overlay_mod_hooklist (prop, overlay);
4231 /* Test for intersecting intervals. This does the right thing
4232 for both insertion and deletion. */
4233 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4235 prop = Foverlay_get (overlay, Qmodification_hooks);
4236 if (!NILP (prop))
4237 add_overlay_mod_hooklist (prop, overlay);
4242 GCPRO4 (overlay, arg1, arg2, arg3);
4244 /* Call the functions recorded in last_overlay_modification_hooks.
4245 First copy the vector contents, in case some of these hooks
4246 do subsequent modification of the buffer. */
4247 int size = last_overlay_modification_hooks_used;
4248 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4249 int i;
4251 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4252 size * sizeof (Lisp_Object));
4253 gcpro1.var = copy;
4254 gcpro1.nvars = size;
4256 for (i = 0; i < size;)
4258 Lisp_Object prop_i, overlay_i;
4259 prop_i = copy[i++];
4260 overlay_i = copy[i++];
4261 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4264 UNGCPRO;
4267 static void
4268 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4269 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4271 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4273 GCPRO4 (list, arg1, arg2, arg3);
4275 while (CONSP (list))
4277 if (NILP (arg3))
4278 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4279 else
4280 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4281 list = XCDR (list);
4283 UNGCPRO;
4286 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4287 property is set. */
4288 void
4289 evaporate_overlays (EMACS_INT pos)
4291 Lisp_Object overlay, hit_list;
4292 struct Lisp_Overlay *tail;
4294 hit_list = Qnil;
4295 if (pos <= current_buffer->overlay_center)
4296 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4298 EMACS_INT endpos;
4299 XSETMISC (overlay, tail);
4300 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4301 if (endpos < pos)
4302 break;
4303 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4304 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4305 hit_list = Fcons (overlay, hit_list);
4307 else
4308 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4310 EMACS_INT startpos;
4311 XSETMISC (overlay, tail);
4312 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4313 if (startpos > pos)
4314 break;
4315 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4316 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4317 hit_list = Fcons (overlay, hit_list);
4319 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4320 Fdelete_overlay (XCAR (hit_list));
4323 /* Somebody has tried to store a value with an unacceptable type
4324 in the slot with offset OFFSET. */
4326 void
4327 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4329 Lisp_Object predicate;
4331 switch (type)
4333 case_Lisp_Int: predicate = Qintegerp; break;
4334 case Lisp_String: predicate = Qstringp; break;
4335 case Lisp_Symbol: predicate = Qsymbolp; break;
4336 default: abort ();
4339 wrong_type_argument (predicate, newval);
4343 /***********************************************************************
4344 Allocation with mmap
4345 ***********************************************************************/
4347 #ifdef USE_MMAP_FOR_BUFFERS
4349 #include <sys/types.h>
4350 #include <sys/mman.h>
4352 #ifndef MAP_ANON
4353 #ifdef MAP_ANONYMOUS
4354 #define MAP_ANON MAP_ANONYMOUS
4355 #else
4356 #define MAP_ANON 0
4357 #endif
4358 #endif
4360 #ifndef MAP_FAILED
4361 #define MAP_FAILED ((void *) -1)
4362 #endif
4364 #include <stdio.h>
4366 #if MAP_ANON == 0
4367 #include <fcntl.h>
4368 #endif
4370 #include "coding.h"
4373 /* Memory is allocated in regions which are mapped using mmap(2).
4374 The current implementation lets the system select mapped
4375 addresses; we're not using MAP_FIXED in general, except when
4376 trying to enlarge regions.
4378 Each mapped region starts with a mmap_region structure, the user
4379 area starts after that structure, aligned to MEM_ALIGN.
4381 +-----------------------+
4382 | struct mmap_info + |
4383 | padding |
4384 +-----------------------+
4385 | user data |
4388 +-----------------------+ */
4390 struct mmap_region
4392 /* User-specified size. */
4393 size_t nbytes_specified;
4395 /* Number of bytes mapped */
4396 size_t nbytes_mapped;
4398 /* Pointer to the location holding the address of the memory
4399 allocated with the mmap'd block. The variable actually points
4400 after this structure. */
4401 POINTER_TYPE **var;
4403 /* Next and previous in list of all mmap'd regions. */
4404 struct mmap_region *next, *prev;
4407 /* Doubly-linked list of mmap'd regions. */
4409 static struct mmap_region *mmap_regions;
4411 /* File descriptor for mmap. If we don't have anonymous mapping,
4412 /dev/zero will be opened on it. */
4414 static int mmap_fd;
4416 /* Temporary storage for mmap_set_vars, see there. */
4418 static struct mmap_region *mmap_regions_1;
4419 static int mmap_fd_1;
4421 /* Page size on this system. */
4423 static int mmap_page_size;
4425 /* 1 means mmap has been intialized. */
4427 static int mmap_initialized_p;
4429 /* Value is X rounded up to the next multiple of N. */
4431 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4433 /* Size of mmap_region structure plus padding. */
4435 #define MMAP_REGION_STRUCT_SIZE \
4436 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4438 /* Given a pointer P to the start of the user-visible part of a mapped
4439 region, return a pointer to the start of the region. */
4441 #define MMAP_REGION(P) \
4442 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4444 /* Given a pointer P to the start of a mapped region, return a pointer
4445 to the start of the user-visible part of the region. */
4447 #define MMAP_USER_AREA(P) \
4448 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4450 #define MEM_ALIGN sizeof (double)
4452 /* Predicate returning true if part of the address range [START .. END]
4453 is currently mapped. Used to prevent overwriting an existing
4454 memory mapping.
4456 Default is to conservativly assume the address range is occupied by
4457 something else. This can be overridden by system configuration
4458 files if system-specific means to determine this exists. */
4460 #ifndef MMAP_ALLOCATED_P
4461 #define MMAP_ALLOCATED_P(start, end) 1
4462 #endif
4464 /* Function prototypes. */
4466 static int mmap_free_1 (struct mmap_region *);
4467 static int mmap_enlarge (struct mmap_region *, int);
4468 static struct mmap_region *mmap_find (POINTER_TYPE *, POINTER_TYPE *);
4469 static POINTER_TYPE *mmap_alloc (POINTER_TYPE **, size_t);
4470 static POINTER_TYPE *mmap_realloc (POINTER_TYPE **, size_t);
4471 static void mmap_free (POINTER_TYPE **ptr);
4472 static void mmap_init (void);
4475 /* Return a region overlapping address range START...END, or null if
4476 none. END is not including, i.e. the last byte in the range
4477 is at END - 1. */
4479 static struct mmap_region *
4480 mmap_find (start, end)
4481 POINTER_TYPE *start, *end;
4483 struct mmap_region *r;
4484 char *s = (char *) start, *e = (char *) end;
4486 for (r = mmap_regions; r; r = r->next)
4488 char *rstart = (char *) r;
4489 char *rend = rstart + r->nbytes_mapped;
4491 if (/* First byte of range, i.e. START, in this region? */
4492 (s >= rstart && s < rend)
4493 /* Last byte of range, i.e. END - 1, in this region? */
4494 || (e > rstart && e <= rend)
4495 /* First byte of this region in the range? */
4496 || (rstart >= s && rstart < e)
4497 /* Last byte of this region in the range? */
4498 || (rend > s && rend <= e))
4499 break;
4502 return r;
4506 /* Unmap a region. P is a pointer to the start of the user-araa of
4507 the region. Value is non-zero if successful. */
4509 static int
4510 mmap_free_1 (r)
4511 struct mmap_region *r;
4513 if (r->next)
4514 r->next->prev = r->prev;
4515 if (r->prev)
4516 r->prev->next = r->next;
4517 else
4518 mmap_regions = r->next;
4520 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4522 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4523 return 0;
4526 return 1;
4530 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4531 Value is non-zero if successful. */
4533 static int
4534 mmap_enlarge (r, npages)
4535 struct mmap_region *r;
4536 int npages;
4538 char *region_end = (char *) r + r->nbytes_mapped;
4539 size_t nbytes;
4540 int success = 0;
4542 if (npages < 0)
4544 /* Unmap pages at the end of the region. */
4545 nbytes = - npages * mmap_page_size;
4546 if (munmap (region_end - nbytes, nbytes) == -1)
4547 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4548 else
4550 r->nbytes_mapped -= nbytes;
4551 success = 1;
4554 else if (npages > 0)
4556 nbytes = npages * mmap_page_size;
4558 /* Try to map additional pages at the end of the region. We
4559 cannot do this if the address range is already occupied by
4560 something else because mmap deletes any previous mapping.
4561 I'm not sure this is worth doing, let's see. */
4562 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4564 POINTER_TYPE *p;
4566 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4567 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4568 if (p == MAP_FAILED)
4569 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4570 else if (p != (POINTER_TYPE *) region_end)
4572 /* Kernels are free to choose a different address. In
4573 that case, unmap what we've mapped above; we have
4574 no use for it. */
4575 if (munmap (p, nbytes) == -1)
4576 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4578 else
4580 r->nbytes_mapped += nbytes;
4581 success = 1;
4586 return success;
4590 /* Set or reset variables holding references to mapped regions. If
4591 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4592 non-zero, set all variables to the start of the user-areas
4593 of mapped regions.
4595 This function is called from Fdump_emacs to ensure that the dumped
4596 Emacs doesn't contain references to memory that won't be mapped
4597 when Emacs starts. */
4599 void
4600 mmap_set_vars (restore_p)
4601 int restore_p;
4603 struct mmap_region *r;
4605 if (restore_p)
4607 mmap_regions = mmap_regions_1;
4608 mmap_fd = mmap_fd_1;
4609 for (r = mmap_regions; r; r = r->next)
4610 *r->var = MMAP_USER_AREA (r);
4612 else
4614 for (r = mmap_regions; r; r = r->next)
4615 *r->var = NULL;
4616 mmap_regions_1 = mmap_regions;
4617 mmap_regions = NULL;
4618 mmap_fd_1 = mmap_fd;
4619 mmap_fd = -1;
4624 /* Allocate a block of storage large enough to hold NBYTES bytes of
4625 data. A pointer to the data is returned in *VAR. VAR is thus the
4626 address of some variable which will use the data area.
4628 The allocation of 0 bytes is valid.
4630 If we can't allocate the necessary memory, set *VAR to null, and
4631 return null. */
4633 static POINTER_TYPE *
4634 mmap_alloc (var, nbytes)
4635 POINTER_TYPE **var;
4636 size_t nbytes;
4638 void *p;
4639 size_t map;
4641 mmap_init ();
4643 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4644 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4645 mmap_fd, 0);
4647 if (p == MAP_FAILED)
4649 if (errno != ENOMEM)
4650 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4651 p = NULL;
4653 else
4655 struct mmap_region *r = (struct mmap_region *) p;
4657 r->nbytes_specified = nbytes;
4658 r->nbytes_mapped = map;
4659 r->var = var;
4660 r->prev = NULL;
4661 r->next = mmap_regions;
4662 if (r->next)
4663 r->next->prev = r;
4664 mmap_regions = r;
4666 p = MMAP_USER_AREA (p);
4669 return *var = p;
4673 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4674 resize it to size NBYTES. Change *VAR to reflect the new block,
4675 and return this value. If more memory cannot be allocated, then
4676 leave *VAR unchanged, and return null. */
4678 static POINTER_TYPE *
4679 mmap_realloc (var, nbytes)
4680 POINTER_TYPE **var;
4681 size_t nbytes;
4683 POINTER_TYPE *result;
4685 mmap_init ();
4687 if (*var == NULL)
4688 result = mmap_alloc (var, nbytes);
4689 else if (nbytes == 0)
4691 mmap_free (var);
4692 result = mmap_alloc (var, nbytes);
4694 else
4696 struct mmap_region *r = MMAP_REGION (*var);
4697 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4699 if (room < nbytes)
4701 /* Must enlarge. */
4702 POINTER_TYPE *old_ptr = *var;
4704 /* Try to map additional pages at the end of the region.
4705 If that fails, allocate a new region, copy data
4706 from the old region, then free it. */
4707 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4708 / mmap_page_size)))
4710 r->nbytes_specified = nbytes;
4711 *var = result = old_ptr;
4713 else if (mmap_alloc (var, nbytes))
4715 memcpy (*var, old_ptr, r->nbytes_specified);
4716 mmap_free_1 (MMAP_REGION (old_ptr));
4717 result = *var;
4718 r = MMAP_REGION (result);
4719 r->nbytes_specified = nbytes;
4721 else
4723 *var = old_ptr;
4724 result = NULL;
4727 else if (room - nbytes >= mmap_page_size)
4729 /* Shrinking by at least a page. Let's give some
4730 memory back to the system.
4732 The extra parens are to make the division happens first,
4733 on positive values, so we know it will round towards
4734 zero. */
4735 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4736 result = *var;
4737 r->nbytes_specified = nbytes;
4739 else
4741 /* Leave it alone. */
4742 result = *var;
4743 r->nbytes_specified = nbytes;
4747 return result;
4751 /* Free a block of relocatable storage whose data is pointed to by
4752 PTR. Store 0 in *PTR to show there's no block allocated. */
4754 static void
4755 mmap_free (var)
4756 POINTER_TYPE **var;
4758 mmap_init ();
4760 if (*var)
4762 mmap_free_1 (MMAP_REGION (*var));
4763 *var = NULL;
4768 /* Perform necessary intializations for the use of mmap. */
4770 static void
4771 mmap_init ()
4773 #if MAP_ANON == 0
4774 /* The value of mmap_fd is initially 0 in temacs, and -1
4775 in a dumped Emacs. */
4776 if (mmap_fd <= 0)
4778 /* No anonymous mmap -- we need the file descriptor. */
4779 mmap_fd = open ("/dev/zero", O_RDONLY);
4780 if (mmap_fd == -1)
4781 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4783 #endif /* MAP_ANON == 0 */
4785 if (mmap_initialized_p)
4786 return;
4787 mmap_initialized_p = 1;
4789 #if MAP_ANON != 0
4790 mmap_fd = -1;
4791 #endif
4793 mmap_page_size = getpagesize ();
4796 #endif /* USE_MMAP_FOR_BUFFERS */
4800 /***********************************************************************
4801 Buffer-text Allocation
4802 ***********************************************************************/
4804 #ifdef REL_ALLOC
4805 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4806 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4807 extern void r_alloc_free (POINTER_TYPE **ptr);
4808 #endif /* REL_ALLOC */
4811 /* Allocate NBYTES bytes for buffer B's text buffer. */
4813 static void
4814 alloc_buffer_text (struct buffer *b, size_t nbytes)
4816 POINTER_TYPE *p;
4818 BLOCK_INPUT;
4819 #if defined USE_MMAP_FOR_BUFFERS
4820 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4821 #elif defined REL_ALLOC
4822 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4823 #else
4824 p = xmalloc (nbytes);
4825 #endif
4827 if (p == NULL)
4829 UNBLOCK_INPUT;
4830 memory_full (nbytes);
4833 b->text->beg = (unsigned char *) p;
4834 UNBLOCK_INPUT;
4837 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4838 shrink it. */
4840 void
4841 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4843 POINTER_TYPE *p;
4844 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4845 + delta);
4846 BLOCK_INPUT;
4847 #if defined USE_MMAP_FOR_BUFFERS
4848 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4849 #elif defined REL_ALLOC
4850 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4851 #else
4852 p = xrealloc (b->text->beg, nbytes);
4853 #endif
4855 if (p == NULL)
4857 UNBLOCK_INPUT;
4858 memory_full (nbytes);
4861 BUF_BEG_ADDR (b) = (unsigned char *) p;
4862 UNBLOCK_INPUT;
4866 /* Free buffer B's text buffer. */
4868 static void
4869 free_buffer_text (struct buffer *b)
4871 BLOCK_INPUT;
4873 #if defined USE_MMAP_FOR_BUFFERS
4874 mmap_free ((POINTER_TYPE **) &b->text->beg);
4875 #elif defined REL_ALLOC
4876 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4877 #else
4878 xfree (b->text->beg);
4879 #endif
4881 BUF_BEG_ADDR (b) = NULL;
4882 UNBLOCK_INPUT;
4887 /***********************************************************************
4888 Initialization
4889 ***********************************************************************/
4891 void
4892 init_buffer_once (void)
4894 int idx;
4896 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4898 /* Make sure all markable slots in buffer_defaults
4899 are initialized reasonably, so mark_buffer won't choke. */
4900 reset_buffer (&buffer_defaults);
4901 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4902 reset_buffer_local_variables (&buffer_defaults, 1);
4903 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4904 reset_buffer (&buffer_local_symbols);
4905 reset_buffer_local_variables (&buffer_local_symbols, 1);
4906 /* Prevent GC from getting confused. */
4907 buffer_defaults.text = &buffer_defaults.own_text;
4908 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4909 BUF_INTERVALS (&buffer_defaults) = 0;
4910 BUF_INTERVALS (&buffer_local_symbols) = 0;
4911 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4912 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4913 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4914 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4916 /* Set up the default values of various buffer slots. */
4917 /* Must do these before making the first buffer! */
4919 /* real setup is done in bindings.el */
4920 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4921 BVAR (&buffer_defaults, header_line_format) = Qnil;
4922 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4923 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4924 BVAR (&buffer_defaults, case_fold_search) = Qt;
4925 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4926 BVAR (&buffer_defaults, selective_display) = Qnil;
4927 #ifndef old
4928 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4929 #endif
4930 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4931 BVAR (&buffer_defaults, display_table) = Qnil;
4932 BVAR (&buffer_defaults, undo_list) = Qnil;
4933 BVAR (&buffer_defaults, mark_active) = Qnil;
4934 BVAR (&buffer_defaults, file_format) = Qnil;
4935 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4936 buffer_defaults.overlays_before = NULL;
4937 buffer_defaults.overlays_after = NULL;
4938 buffer_defaults.overlay_center = BEG;
4940 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4941 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4942 BVAR (&buffer_defaults, word_wrap) = Qnil;
4943 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4944 BVAR (&buffer_defaults, bidi_display_reordering) = Qnil;
4945 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4946 BVAR (&buffer_defaults, cursor_type) = Qt;
4947 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4948 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4950 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4951 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4952 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4953 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4954 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4955 BVAR (&buffer_defaults, file_truename) = Qnil;
4956 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4957 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4958 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4959 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4960 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4961 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4962 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4963 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4964 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4965 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4966 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4967 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4968 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4969 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4970 BVAR (&buffer_defaults, display_time) = Qnil;
4972 /* Assign the local-flags to the slots that have default values.
4973 The local flag is a bit that is used in the buffer
4974 to say that it has its own local value for the slot.
4975 The local flag bits are in the local_var_flags slot of the buffer. */
4977 /* Nothing can work if this isn't true */
4978 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4980 /* 0 means not a lisp var, -1 means always local, else mask */
4981 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4982 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4983 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4984 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4985 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4986 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4987 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4988 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4989 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4990 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4991 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4992 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4993 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4994 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4995 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4996 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4997 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4998 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4999 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
5001 idx = 1;
5002 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
5008 #ifndef old
5009 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
5010 #endif
5011 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
5014 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
5015 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5016 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5017 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5018 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
5019 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5020 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
5021 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5022 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5023 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5024 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5025 /* Make this one a permanent local. */
5026 buffer_permanent_local_flags[idx++] = 1;
5027 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5028 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5029 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5030 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5031 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5032 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5033 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5034 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5035 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5036 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5037 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5038 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5039 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5040 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5041 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5042 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5043 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5045 /* Need more room? */
5046 if (idx >= MAX_PER_BUFFER_VARS)
5047 abort ();
5048 last_per_buffer_idx = idx;
5050 Vbuffer_alist = Qnil;
5051 current_buffer = 0;
5052 all_buffers = 0;
5054 QSFundamental = make_pure_c_string ("Fundamental");
5056 Qfundamental_mode = intern_c_string ("fundamental-mode");
5057 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5059 Qmode_class = intern_c_string ("mode-class");
5061 Qprotected_field = intern_c_string ("protected-field");
5063 Qpermanent_local = intern_c_string ("permanent-local");
5065 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5066 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5068 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5070 /* super-magic invisible buffer */
5071 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5072 Vbuffer_alist = Qnil;
5074 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5076 inhibit_modification_hooks = 0;
5079 void
5080 init_buffer (void)
5082 char *pwd;
5083 Lisp_Object temp;
5084 int len;
5086 #ifdef USE_MMAP_FOR_BUFFERS
5088 /* When using the ralloc implementation based on mmap(2), buffer
5089 text pointers will have been set to null in the dumped Emacs.
5090 Map new memory. */
5091 struct buffer *b;
5093 for (b = all_buffers; b; b = b->header.next.buffer)
5094 if (b->text->beg == NULL)
5095 enlarge_buffer_text (b, 0);
5097 #endif /* USE_MMAP_FOR_BUFFERS */
5099 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5100 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5101 Fset_buffer_multibyte (Qnil);
5103 pwd = get_current_dir_name ();
5105 if (!pwd)
5106 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5108 /* Maybe this should really use some standard subroutine
5109 whose definition is filename syntax dependent. */
5110 len = strlen (pwd);
5111 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5113 /* Grow buffer to add directory separator and '\0'. */
5114 pwd = (char *) realloc (pwd, len + 2);
5115 if (!pwd)
5116 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5117 pwd[len] = DIRECTORY_SEP;
5118 pwd[len + 1] = '\0';
5121 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5122 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5123 /* At this moment, we still don't know how to decode the
5124 directory name. So, we keep the bytes in multibyte form so
5125 that ENCODE_FILE correctly gets the original bytes. */
5126 BVAR (current_buffer, directory)
5127 = string_to_multibyte (BVAR (current_buffer, directory));
5129 /* Add /: to the front of the name
5130 if it would otherwise be treated as magic. */
5131 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5132 if (! NILP (temp)
5133 /* If the default dir is just /, TEMP is non-nil
5134 because of the ange-ftp completion handler.
5135 However, it is not necessary to turn / into /:/.
5136 So avoid doing that. */
5137 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5138 BVAR (current_buffer, directory)
5139 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5141 temp = get_minibuffer (0);
5142 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5144 free (pwd);
5147 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5148 Object stored in the current buffer. address is the address of the slot
5149 in the buffer that is current now. */
5151 /* TYPE is nil for a general Lisp variable.
5152 An integer specifies a type; then only Lisp values
5153 with that type code are allowed (except that nil is allowed too).
5154 LNAME is the Lisp-level variable name.
5155 VNAME is the name of the buffer slot.
5156 DOC is a dummy where you write the doc string as a comment. */
5157 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5158 do { \
5159 static struct Lisp_Buffer_Objfwd bo_fwd; \
5160 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5161 } while (0)
5163 static void
5164 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5165 Lisp_Object *address, Lisp_Object type)
5167 struct Lisp_Symbol *sym;
5168 int offset;
5170 sym = XSYMBOL (intern (namestring));
5171 offset = (char *)address - (char *)current_buffer;
5173 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5174 bo_fwd->offset = offset;
5175 bo_fwd->slottype = type;
5176 sym->declared_special = 1;
5177 sym->redirect = SYMBOL_FORWARDED;
5179 /* I tried to do the job without a cast, but it seems impossible.
5180 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5181 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5183 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5185 if (PER_BUFFER_IDX (offset) == 0)
5186 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5187 slot of buffer_local_flags */
5188 abort ();
5192 /* initialize the buffer routines */
5193 void
5194 syms_of_buffer (void)
5196 staticpro (&last_overlay_modification_hooks);
5197 last_overlay_modification_hooks
5198 = Fmake_vector (make_number (10), Qnil);
5200 staticpro (&Vbuffer_defaults);
5201 staticpro (&Vbuffer_local_symbols);
5202 staticpro (&Qfundamental_mode);
5203 staticpro (&Qmode_class);
5204 staticpro (&QSFundamental);
5205 staticpro (&Vbuffer_alist);
5206 staticpro (&Qprotected_field);
5207 staticpro (&Qpermanent_local);
5208 Qpermanent_local_hook = intern_c_string ("permanent-local-hook");
5209 staticpro (&Qpermanent_local_hook);
5210 staticpro (&Qkill_buffer_hook);
5211 Qoverlayp = intern_c_string ("overlayp");
5212 staticpro (&Qoverlayp);
5213 Qevaporate = intern_c_string ("evaporate");
5214 staticpro (&Qevaporate);
5215 Qmodification_hooks = intern_c_string ("modification-hooks");
5216 staticpro (&Qmodification_hooks);
5217 Qinsert_in_front_hooks = intern_c_string ("insert-in-front-hooks");
5218 staticpro (&Qinsert_in_front_hooks);
5219 Qinsert_behind_hooks = intern_c_string ("insert-behind-hooks");
5220 staticpro (&Qinsert_behind_hooks);
5221 Qget_file_buffer = intern_c_string ("get-file-buffer");
5222 staticpro (&Qget_file_buffer);
5223 Qpriority = intern_c_string ("priority");
5224 staticpro (&Qpriority);
5225 Qbefore_string = intern_c_string ("before-string");
5226 staticpro (&Qbefore_string);
5227 Qafter_string = intern_c_string ("after-string");
5228 staticpro (&Qafter_string);
5229 Qfirst_change_hook = intern_c_string ("first-change-hook");
5230 staticpro (&Qfirst_change_hook);
5231 Qbefore_change_functions = intern_c_string ("before-change-functions");
5232 staticpro (&Qbefore_change_functions);
5233 Qafter_change_functions = intern_c_string ("after-change-functions");
5234 staticpro (&Qafter_change_functions);
5235 /* The next one is initialized in init_buffer_once. */
5236 staticpro (&Qucs_set_table_for_input);
5238 Qkill_buffer_query_functions = intern_c_string ("kill-buffer-query-functions");
5239 staticpro (&Qkill_buffer_query_functions);
5241 Fput (Qprotected_field, Qerror_conditions,
5242 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5243 Fput (Qprotected_field, Qerror_message,
5244 make_pure_c_string ("Attempt to modify a protected field"));
5246 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5247 mode_line_format,
5248 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5249 This is the same as (default-value 'mode-line-format). */);
5251 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5252 header_line_format,
5253 doc: /* Default value of `header-line-format' for buffers that don't override it.
5254 This is the same as (default-value 'header-line-format). */);
5256 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5257 doc: /* Default value of `cursor-type' for buffers that don't override it.
5258 This is the same as (default-value 'cursor-type). */);
5260 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5261 extra_line_spacing,
5262 doc: /* Default value of `line-spacing' for buffers that don't override it.
5263 This is the same as (default-value 'line-spacing). */);
5265 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5266 cursor_in_non_selected_windows,
5267 doc: /* Default value of `cursor-in-non-selected-windows'.
5268 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5270 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5271 abbrev_mode,
5272 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5273 This is the same as (default-value 'abbrev-mode). */);
5275 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5276 ctl_arrow,
5277 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5278 This is the same as (default-value 'ctl-arrow). */);
5280 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5281 enable_multibyte_characters,
5282 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5283 This is the same as (default-value 'enable-multibyte-characters). */);
5285 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5286 buffer_file_coding_system,
5287 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5288 This is the same as (default-value 'buffer-file-coding-system). */);
5290 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5291 truncate_lines,
5292 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5293 This is the same as (default-value 'truncate-lines). */);
5295 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5296 fill_column,
5297 doc: /* Default value of `fill-column' for buffers that do not override it.
5298 This is the same as (default-value 'fill-column). */);
5300 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5301 left_margin,
5302 doc: /* Default value of `left-margin' for buffers that do not override it.
5303 This is the same as (default-value 'left-margin). */);
5305 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5306 tab_width,
5307 doc: /* Default value of `tab-width' for buffers that do not override it.
5308 This is the same as (default-value 'tab-width). */);
5310 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5311 case_fold_search,
5312 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5313 This is the same as (default-value 'case-fold-search). */);
5315 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5316 left_margin_cols,
5317 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5318 This is the same as (default-value 'left-margin-width). */);
5320 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5321 right_margin_cols,
5322 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5323 This is the same as (default-value 'right-margin-width). */);
5325 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5326 left_fringe_width,
5327 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5328 This is the same as (default-value 'left-fringe-width). */);
5330 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5331 right_fringe_width,
5332 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5333 This is the same as (default-value 'right-fringe-width). */);
5335 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5336 fringes_outside_margins,
5337 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5338 This is the same as (default-value 'fringes-outside-margins). */);
5340 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5341 scroll_bar_width,
5342 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5343 This is the same as (default-value 'scroll-bar-width). */);
5345 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5346 vertical_scroll_bar_type,
5347 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5348 This is the same as (default-value 'vertical-scroll-bar). */);
5350 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5351 indicate_empty_lines,
5352 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5353 This is the same as (default-value 'indicate-empty-lines). */);
5355 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5356 indicate_buffer_boundaries,
5357 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5358 This is the same as (default-value 'indicate-buffer-boundaries). */);
5360 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5361 fringe_indicator_alist,
5362 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5363 This is the same as (default-value 'fringe-indicator-alist'). */);
5365 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5366 fringe_cursor_alist,
5367 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5368 This is the same as (default-value 'fringe-cursor-alist'). */);
5370 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5371 scroll_up_aggressively,
5372 doc: /* Default value of `scroll-up-aggressively'.
5373 This value applies in buffers that don't have their own local values.
5374 This is the same as (default-value 'scroll-up-aggressively). */);
5376 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5377 scroll_down_aggressively,
5378 doc: /* Default value of `scroll-down-aggressively'.
5379 This value applies in buffers that don't have their own local values.
5380 This is the same as (default-value 'scroll-down-aggressively). */);
5382 DEFVAR_PER_BUFFER ("header-line-format",
5383 &BVAR (current_buffer, header_line_format),
5384 Qnil,
5385 doc: /* Analogous to `mode-line-format', but controls the header line.
5386 The header line appears, optionally, at the top of a window;
5387 the mode line appears at the bottom. */);
5389 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5390 Qnil,
5391 doc: /* Template for displaying mode line for current buffer.
5392 Each buffer has its own value of this variable.
5393 Value may be nil, a string, a symbol or a list or cons cell.
5394 A value of nil means don't display a mode line.
5395 For a symbol, its value is used (but it is ignored if t or nil).
5396 A string appearing directly as the value of a symbol is processed verbatim
5397 in that the %-constructs below are not recognized.
5398 Note that unless the symbol is marked as a `risky-local-variable', all
5399 properties in any strings, as well as all :eval and :propertize forms
5400 in the value of that symbol will be ignored.
5401 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5402 is used as a mode line element. Be careful--FORM should not load any files,
5403 because that can cause an infinite recursion.
5404 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5405 with the specified properties PROPS applied.
5406 For a list whose car is a symbol, the symbol's value is taken,
5407 and if that is non-nil, the cadr of the list is processed recursively.
5408 Otherwise, the caddr of the list (if there is one) is processed.
5409 For a list whose car is a string or list, each element is processed
5410 recursively and the results are effectively concatenated.
5411 For a list whose car is an integer, the cdr of the list is processed
5412 and padded (if the number is positive) or truncated (if negative)
5413 to the width specified by that number.
5414 A string is printed verbatim in the mode line except for %-constructs:
5415 (%-constructs are allowed when the string is the entire mode-line-format
5416 or when it is found in a cons-cell or a list)
5417 %b -- print buffer name. %f -- print visited file name.
5418 %F -- print frame name.
5419 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5420 %& is like %*, but ignore read-only-ness.
5421 % means buffer is read-only and * means it is modified.
5422 For a modified read-only buffer, %* gives % and %+ gives *.
5423 %s -- print process status. %l -- print the current line number.
5424 %c -- print the current column number (this makes editing slower).
5425 To make the column number update correctly in all cases,
5426 `column-number-mode' must be non-nil.
5427 %i -- print the size of the buffer.
5428 %I -- like %i, but use k, M, G, etc., to abbreviate.
5429 %p -- print percent of buffer above top of window, or Top, Bot or All.
5430 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5431 or print Bottom or All.
5432 %n -- print Narrow if appropriate.
5433 %t -- visited file is text or binary (if OS supports this distinction).
5434 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5435 %Z -- like %z, but including the end-of-line format.
5436 %e -- print error message about full memory.
5437 %@ -- print @ or hyphen. @ means that default-directory is on a
5438 remote machine.
5439 %[ -- print one [ for each recursive editing level. %] similar.
5440 %% -- print %. %- -- print infinitely many dashes.
5441 Decimal digits after the % specify field width to which to pad. */);
5443 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5444 doc: /* *Value of `major-mode' for new buffers. */);
5446 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5447 make_number (Lisp_Symbol),
5448 doc: /* Symbol for current buffer's major mode.
5449 The default value (normally `fundamental-mode') affects new buffers.
5450 A value of nil means to use the current buffer's major mode, provided
5451 it is not marked as "special".
5453 When a mode is used by default, `find-file' switches to it before it
5454 reads the contents into the buffer and before it finishes setting up
5455 the buffer. Thus, the mode and its hooks should not expect certain
5456 variables such as `buffer-read-only' and `buffer-file-coding-system'
5457 to be set up. */);
5459 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5460 Qnil,
5461 doc: /* Pretty name of current buffer's major mode.
5462 Usually a string, but can use any of the constructs for `mode-line-format',
5463 which see.
5464 Format with `format-mode-line' to produce a string value. */);
5466 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5467 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5469 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5470 doc: /* Non-nil if Abbrev mode is enabled.
5471 Use the command `abbrev-mode' to change this variable. */);
5473 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5474 Qnil,
5475 doc: /* *Non-nil if searches and matches should ignore case. */);
5477 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5478 make_number (LISP_INT_TAG),
5479 doc: /* *Column beyond which automatic line-wrapping should happen.
5480 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5482 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5483 make_number (LISP_INT_TAG),
5484 doc: /* *Column for the default `indent-line-function' to indent to.
5485 Linefeed indents to this column in Fundamental mode. */);
5487 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5488 make_number (LISP_INT_TAG),
5489 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5490 This should be an integer greater than zero. */);
5492 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5493 doc: /* *Non-nil means display control chars with uparrow.
5494 A value of nil means use backslash and octal digits.
5495 This variable does not apply to characters whose display is specified
5496 in the current display table (if there is one). */);
5498 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5499 &BVAR (current_buffer, enable_multibyte_characters),
5500 Qnil,
5501 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5502 Otherwise they are regarded as unibyte. This affects the display,
5503 file I/O and the behavior of various editing commands.
5505 This variable is buffer-local but you cannot set it directly;
5506 use the function `set-buffer-multibyte' to change a buffer's representation.
5507 Changing its default value with `setq-default' is supported.
5508 See also variable `default-enable-multibyte-characters' and Info node
5509 `(elisp)Text Representations'. */);
5510 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5512 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5513 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5514 doc: /* Coding system to be used for encoding the buffer contents on saving.
5515 This variable applies to saving the buffer, and also to `write-region'
5516 and other functions that use `write-region'.
5517 It does not apply to sending output to subprocesses, however.
5519 If this is nil, the buffer is saved without any code conversion
5520 unless some coding system is specified in `file-coding-system-alist'
5521 for the buffer file.
5523 If the text to be saved cannot be encoded as specified by this variable,
5524 an alternative encoding is selected by `select-safe-coding-system', which see.
5526 The variable `coding-system-for-write', if non-nil, overrides this variable.
5528 This variable is never applied to a way of decoding a file while reading it. */);
5530 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5531 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5532 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5534 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5535 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5536 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5538 If this is nil (the default), the direction of each paragraph is
5539 determined by the first strong directional character of its text.
5540 The values of `right-to-left' and `left-to-right' override that.
5541 Any other value is treated as nil.
5543 This variable has no effect unless the buffer's value of
5544 \`bidi-display-reordering' is non-nil. */);
5546 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5547 doc: /* *Non-nil means do not display continuation lines.
5548 Instead, give each line of text just one screen line.
5550 Note that this is overridden by the variable
5551 `truncate-partial-width-windows' if that variable is non-nil
5552 and this buffer is not full-frame width. */);
5554 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5555 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5556 When word-wrapping is on, continuation lines are wrapped at the space
5557 or tab character nearest to the right window edge.
5558 If nil, continuation lines are wrapped at the right screen edge.
5560 This variable has no effect if long lines are truncated (see
5561 `truncate-lines' and `truncate-partial-width-windows'). If you use
5562 word-wrapping, you might want to reduce the value of
5563 `truncate-partial-width-windows', since wrapping can make text readable
5564 in narrower windows. */);
5566 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5567 make_number (Lisp_String),
5568 doc: /* Name of default directory of current buffer. Should end with slash.
5569 To interactively change the default directory, use command `cd'. */);
5571 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5572 Qnil,
5573 doc: /* Function called (if non-nil) to perform auto-fill.
5574 It is called after self-inserting any character specified in
5575 the `auto-fill-chars' table.
5576 NOTE: This variable is not a hook;
5577 its value may not be a list of functions. */);
5579 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5580 make_number (Lisp_String),
5581 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5583 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5584 make_number (Lisp_String),
5585 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5586 The truename of a file is calculated by `file-truename'
5587 and then abbreviated with `abbreviate-file-name'. */);
5589 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5590 &BVAR (current_buffer, auto_save_file_name),
5591 make_number (Lisp_String),
5592 doc: /* Name of file for auto-saving current buffer.
5593 If it is nil, that means don't auto-save this buffer. */);
5595 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5596 doc: /* Non-nil if this buffer is read-only. */);
5598 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5599 doc: /* Non-nil if this buffer's file has been backed up.
5600 Backing up is done before the first time the file is saved. */);
5602 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5603 make_number (LISP_INT_TAG),
5604 doc: /* Length of current buffer when last read in, saved or auto-saved.
5605 0 initially.
5606 -1 means auto-saving turned off until next real save.
5608 If you set this to -2, that means don't turn off auto-saving in this buffer
5609 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5610 you probably should set this to -2 in that buffer. */);
5612 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5613 Qnil,
5614 doc: /* Non-nil enables selective display.
5615 An integer N as value means display only lines
5616 that start with less than N columns of space.
5617 A value of t means that the character ^M makes itself and
5618 all the rest of the line invisible; also, when saving the buffer
5619 in a file, save the ^M as a newline. */);
5621 #ifndef old
5622 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5623 &BVAR (current_buffer, selective_display_ellipses),
5624 Qnil,
5625 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5626 #endif
5628 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5629 doc: /* Non-nil if self-insertion should replace existing text.
5630 The value should be one of `overwrite-mode-textual',
5631 `overwrite-mode-binary', or nil.
5632 If it is `overwrite-mode-textual', self-insertion still
5633 inserts at the end of a line, and inserts when point is before a tab,
5634 until the tab is filled in.
5635 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5637 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5638 Qnil,
5639 doc: /* Display table that controls display of the contents of current buffer.
5641 If this variable is nil, the value of `standard-display-table' is used.
5642 Each window can have its own, overriding display table, see
5643 `set-window-display-table' and `window-display-table'.
5645 The display table is a char-table created with `make-display-table'.
5646 A char-table is an array indexed by character codes. Normal array
5647 primitives `aref' and `aset' can be used to access elements of a char-table.
5649 Each of the char-table elements control how to display the corresponding
5650 text character: the element at index C in the table says how to display
5651 the character whose code is C. Each element should be a vector of
5652 characters or nil. The value nil means display the character in the
5653 default fashion; otherwise, the characters from the vector are delivered
5654 to the screen instead of the original character.
5656 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5657 to display a capital Y instead of each X character.
5659 In addition, a char-table has six extra slots to control the display of:
5661 the end of a truncated screen line (extra-slot 0, a single character);
5662 the end of a continued line (extra-slot 1, a single character);
5663 the escape character used to display character codes in octal
5664 (extra-slot 2, a single character);
5665 the character used as an arrow for control characters (extra-slot 3,
5666 a single character);
5667 the decoration indicating the presence of invisible lines (extra-slot 4,
5668 a vector of characters);
5669 the character used to draw the border between side-by-side windows
5670 (extra-slot 5, a single character).
5672 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5674 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5675 Qnil,
5676 doc: /* *Width of left marginal area for display of a buffer.
5677 A value of nil means no marginal area. */);
5679 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5680 Qnil,
5681 doc: /* *Width of right marginal area for display of a buffer.
5682 A value of nil means no marginal area. */);
5684 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5685 Qnil,
5686 doc: /* *Width of this buffer's left fringe (in pixels).
5687 A value of 0 means no left fringe is shown in this buffer's window.
5688 A value of nil means to use the left fringe width from the window's frame. */);
5690 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5691 Qnil,
5692 doc: /* *Width of this buffer's right fringe (in pixels).
5693 A value of 0 means no right fringe is shown in this buffer's window.
5694 A value of nil means to use the right fringe width from the window's frame. */);
5696 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5697 Qnil,
5698 doc: /* *Non-nil means to display fringes outside display margins.
5699 A value of nil means to display fringes between margins and buffer text. */);
5701 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5702 Qnil,
5703 doc: /* *Width of this buffer's scroll bars in pixels.
5704 A value of nil means to use the scroll bar width from the window's frame. */);
5706 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5707 Qnil,
5708 doc: /* *Position of this buffer's vertical scroll bar.
5709 The value takes effect whenever you tell a window to display this buffer;
5710 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5712 A value of `left' or `right' means put the vertical scroll bar at that side
5713 of the window; a value of nil means don't show any vertical scroll bars.
5714 A value of t (the default) means do whatever the window's frame specifies. */);
5716 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5717 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5718 doc: /* *Visually indicate empty lines after the buffer end.
5719 If non-nil, a bitmap is displayed in the left fringe of a window on
5720 window-systems. */);
5722 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5723 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5724 doc: /* *Visually indicate buffer boundaries and scrolling.
5725 If non-nil, the first and last line of the buffer are marked in the fringe
5726 of a window on window-systems with angle bitmaps, or if the window can be
5727 scrolled, the top and bottom line of the window are marked with up and down
5728 arrow bitmaps.
5730 If value is a symbol `left' or `right', both angle and arrow bitmaps
5731 are displayed in the left or right fringe, resp. Any other value
5732 that doesn't look like an alist means display the angle bitmaps in
5733 the left fringe but no arrows.
5735 You can exercise more precise control by using an alist as the
5736 value. Each alist element (INDICATOR . POSITION) specifies
5737 where to show one of the indicators. INDICATOR is one of `top',
5738 `bottom', `up', `down', or t, which specifies the default position,
5739 and POSITION is one of `left', `right', or nil, meaning do not show
5740 this indicator.
5742 For example, ((top . left) (t . right)) places the top angle bitmap in
5743 left fringe, the bottom angle bitmap in right fringe, and both arrow
5744 bitmaps in right fringe. To show just the angle bitmaps in the left
5745 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5747 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5748 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5749 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5750 The value is an alist where each element (INDICATOR . BITMAPS)
5751 specifies the fringe bitmaps used to display a specific logical
5752 fringe indicator.
5754 INDICATOR specifies the logical indicator type which is one of the
5755 following symbols: `truncation' , `continuation', `overlay-arrow',
5756 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5758 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5759 the actual bitmap shown in the left or right fringe for the logical
5760 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5761 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5762 are used only for the `bottom' and `top-bottom' indicators when the
5763 last (only) line has no final newline. BITMAPS may also be a single
5764 symbol which is used in both left and right fringes. */);
5766 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5767 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5768 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5769 The value is an alist where each element (CURSOR . BITMAP)
5770 specifies the fringe bitmaps used to display a specific logical
5771 cursor type in the fringe.
5773 CURSOR specifies the logical cursor type which is one of the following
5774 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5775 one is used to show a hollow cursor on narrow lines display lines
5776 where the normal hollow cursor will not fit.
5778 BITMAP is the corresponding fringe bitmap shown for the logical
5779 cursor type. */);
5781 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5782 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5783 doc: /* How far to scroll windows upward.
5784 If you move point off the bottom, the window scrolls automatically.
5785 This variable controls how far it scrolls. The value nil, the default,
5786 means scroll to center point. A fraction means scroll to put point
5787 that fraction of the window's height from the bottom of the window.
5788 When the value is 0.0, point goes at the bottom line, which in the
5789 simple case that you moved off with C-f means scrolling just one line.
5790 1.0 means point goes at the top, so that in that simple case, the
5791 window scrolls by a full window height. Meaningful values are
5792 between 0.0 and 1.0, inclusive. */);
5794 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5795 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5796 doc: /* How far to scroll windows downward.
5797 If you move point off the top, the window scrolls automatically.
5798 This variable controls how far it scrolls. The value nil, the default,
5799 means scroll to center point. A fraction means scroll to put point
5800 that fraction of the window's height from the top of the window.
5801 When the value is 0.0, point goes at the top line, which in the
5802 simple case that you moved off with C-b means scrolling just one line.
5803 1.0 means point goes at the bottom, so that in that simple case, the
5804 window scrolls by a full window height. Meaningful values are
5805 between 0.0 and 1.0, inclusive. */);
5807 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5808 "Don't ask.");
5811 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5812 doc: /* List of functions to call before each text change.
5813 Two arguments are passed to each function: the positions of
5814 the beginning and end of the range of old text to be changed.
5815 \(For an insertion, the beginning and end are at the same place.)
5816 No information is given about the length of the text after the change.
5818 Buffer changes made while executing the `before-change-functions'
5819 don't call any before-change or after-change functions.
5820 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5822 If an unhandled error happens in running these functions,
5823 the variable's value remains nil. That prevents the error
5824 from happening repeatedly and making Emacs nonfunctional. */);
5825 Vbefore_change_functions = Qnil;
5827 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5828 doc: /* List of functions to call after each text change.
5829 Three arguments are passed to each function: the positions of
5830 the beginning and end of the range of changed text,
5831 and the length in bytes of the pre-change text replaced by that range.
5832 \(For an insertion, the pre-change length is zero;
5833 for a deletion, that length is the number of bytes deleted,
5834 and the post-change beginning and end are at the same place.)
5836 Buffer changes made while executing the `after-change-functions'
5837 don't call any before-change or after-change functions.
5838 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5840 If an unhandled error happens in running these functions,
5841 the variable's value remains nil. That prevents the error
5842 from happening repeatedly and making Emacs nonfunctional. */);
5843 Vafter_change_functions = Qnil;
5845 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5846 doc: /* A list of functions to call before changing a buffer which is unmodified.
5847 The functions are run using the `run-hooks' function. */);
5848 Vfirst_change_hook = Qnil;
5850 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5851 doc: /* List of undo entries in current buffer.
5852 Recent changes come first; older changes follow newer.
5854 An entry (BEG . END) represents an insertion which begins at
5855 position BEG and ends at position END.
5857 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5858 from (abs POSITION). If POSITION is positive, point was at the front
5859 of the text being deleted; if negative, point was at the end.
5861 An entry (t HIGH . LOW) indicates that the buffer previously had
5862 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5863 of the visited file's modification time, as of that time. If the
5864 modification time of the most recent save is different, this entry is
5865 obsolete.
5867 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5868 was modified between BEG and END. PROPERTY is the property name,
5869 and VALUE is the old value.
5871 An entry (apply FUN-NAME . ARGS) means undo the change with
5872 \(apply FUN-NAME ARGS).
5874 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5875 in the active region. BEG and END is the range affected by this entry
5876 and DELTA is the number of bytes added or deleted in that range by
5877 this change.
5879 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5880 was adjusted in position by the offset DISTANCE (an integer).
5882 An entry of the form POSITION indicates that point was at the buffer
5883 location given by the integer. Undoing an entry of this form places
5884 point at POSITION.
5886 Entries with value `nil' mark undo boundaries. The undo command treats
5887 the changes between two undo boundaries as a single step to be undone.
5889 If the value of the variable is t, undo information is not recorded. */);
5891 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5892 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5894 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5895 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5897 Normally, the line-motion functions work by scanning the buffer for
5898 newlines. Columnar operations (like `move-to-column' and
5899 `compute-motion') also work by scanning the buffer, summing character
5900 widths as they go. This works well for ordinary text, but if the
5901 buffer's lines are very long (say, more than 500 characters), these
5902 motion functions will take longer to execute. Emacs may also take
5903 longer to update the display.
5905 If `cache-long-line-scans' is non-nil, these motion functions cache the
5906 results of their scans, and consult the cache to avoid rescanning
5907 regions of the buffer until the text is modified. The caches are most
5908 beneficial when they prevent the most searching---that is, when the
5909 buffer contains long lines and large regions of characters with the
5910 same, fixed screen width.
5912 When `cache-long-line-scans' is non-nil, processing short lines will
5913 become slightly slower (because of the overhead of consulting the
5914 cache), and the caches will use memory roughly proportional to the
5915 number of newlines and characters whose screen width varies.
5917 The caches require no explicit maintenance; their accuracy is
5918 maintained internally by the Emacs primitives. Enabling or disabling
5919 the cache should not affect the behavior of any of the motion
5920 functions; it should only affect their performance. */);
5922 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5923 doc: /* Value of point before the last series of scroll operations, or nil. */);
5925 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5926 doc: /* List of formats to use when saving this buffer.
5927 Formats are defined by `format-alist'. This variable is
5928 set when a file is visited. */);
5930 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5931 &BVAR (current_buffer, auto_save_file_format), Qnil,
5932 doc: /* *Format in which to write auto-save files.
5933 Should be a list of symbols naming formats that are defined in `format-alist'.
5934 If it is t, which is the default, auto-save files are written in the
5935 same format as a regular save would use. */);
5937 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5938 &BVAR (current_buffer, invisibility_spec), Qnil,
5939 doc: /* Invisibility spec of this buffer.
5940 The default is t, which means that text is invisible
5941 if it has a non-nil `invisible' property.
5942 If the value is a list, a text character is invisible if its `invisible'
5943 property is an element in that list (or is a list with members in common).
5944 If an element is a cons cell of the form (PROP . ELLIPSIS),
5945 then characters with property value PROP are invisible,
5946 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5948 DEFVAR_PER_BUFFER ("buffer-display-count",
5949 &BVAR (current_buffer, display_count), Qnil,
5950 doc: /* A number incremented each time this buffer is displayed in a window.
5951 The function `set-window-buffer' increments it. */);
5953 DEFVAR_PER_BUFFER ("buffer-display-time",
5954 &BVAR (current_buffer, display_time), Qnil,
5955 doc: /* Time stamp updated each time this buffer is displayed in a window.
5956 The function `set-window-buffer' updates this variable
5957 to the value obtained by calling `current-time'.
5958 If the buffer has never been shown in a window, the value is nil. */);
5960 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5961 doc: /* Non-nil if Transient Mark mode is enabled.
5962 See the command `transient-mark-mode' for a description of this minor mode.
5964 Non-nil also enables highlighting of the region whenever the mark is active.
5965 The variable `highlight-nonselected-windows' controls whether to highlight
5966 all windows or just the selected window.
5968 Lisp programs may give this variable certain special values:
5970 - A value of `lambda' enables Transient Mark mode temporarily.
5971 It is disabled again after any subsequent action that would
5972 normally deactivate the mark (e.g. buffer modification).
5974 - A value of (only . OLDVAL) enables Transient Mark mode
5975 temporarily. After any subsequent point motion command that is
5976 not shift-translated, or any other action that would normally
5977 deactivate the mark (e.g. buffer modification), the value of
5978 `transient-mark-mode' is set to OLDVAL. */);
5979 Vtransient_mark_mode = Qnil;
5981 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5982 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5983 If the value is t, disregard `buffer-read-only' and all `read-only'
5984 text properties. If the value is a list, disregard `buffer-read-only'
5985 and disregard a `read-only' text property if the property value
5986 is a member of the list. */);
5987 Vinhibit_read_only = Qnil;
5989 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5990 doc: /* Cursor to use when this buffer is in the selected window.
5991 Values are interpreted as follows:
5993 t use the cursor specified for the frame
5994 nil don't display a cursor
5995 box display a filled box cursor
5996 hollow display a hollow box cursor
5997 bar display a vertical bar cursor with default width
5998 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5999 hbar display a horizontal bar cursor with default height
6000 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6001 ANYTHING ELSE display a hollow box cursor
6003 When the buffer is displayed in a non-selected window, the
6004 cursor's appearance is instead controlled by the variable
6005 `cursor-in-non-selected-windows'. */);
6007 DEFVAR_PER_BUFFER ("line-spacing",
6008 &BVAR (current_buffer, extra_line_spacing), Qnil,
6009 doc: /* Additional space to put between lines when displaying a buffer.
6010 The space is measured in pixels, and put below lines on graphic displays,
6011 see `display-graphic-p'.
6012 If value is a floating point number, it specifies the spacing relative
6013 to the default frame line height. A value of nil means add no extra space. */);
6015 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6016 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
6017 doc: /* *Non-nil means show a cursor in non-selected windows.
6018 If nil, only shows a cursor in the selected window.
6019 If t, displays a cursor related to the usual cursor type
6020 \(a solid box becomes hollow, a bar becomes a narrower bar).
6021 You can also specify the cursor type as in the `cursor-type' variable.
6022 Use Custom to set this variable and update the display." */);
6024 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
6025 doc: /* List of functions called with no args to query before killing a buffer.
6026 The buffer being killed will be current while the functions are running.
6027 If any of them returns nil, the buffer is not killed. */);
6028 Vkill_buffer_query_functions = Qnil;
6030 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
6031 doc: /* Normal hook run before changing the major mode of a buffer.
6032 The function `kill-all-local-variables' runs this before doing anything else. */);
6033 Vchange_major_mode_hook = Qnil;
6034 Qchange_major_mode_hook = intern_c_string ("change-major-mode-hook");
6035 staticpro (&Qchange_major_mode_hook);
6037 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6038 doc: /* Hook run when the buffer list changes.
6039 Functions running this hook are `get-buffer-create',
6040 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6041 `record-buffer' and `unrecord-buffer'. */);
6042 Vbuffer_list_update_hook = Qnil;
6043 Qbuffer_list_update_hook = intern_c_string ("buffer-list-update-hook");
6044 staticpro (&Qbuffer_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);