Use gnulib's alloca-opt module.
[emacs.git] / src / buffer.c
blobd7adf63c98bcd8bcff8e131a1e0f959f486d0f76
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 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;
2862 if (s1->beg != s2->beg)
2863 return s1->beg - s2->beg;
2864 if (s1->end != s2->end)
2865 return s2->end - s1->end;
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 int size;
2930 int priority;
2933 struct sortstrlist
2935 struct sortstr *buf; /* An array that expands as needed; never freed. */
2936 int size; /* Allocated length of that array. */
2937 int 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;
2959 if (s1->priority != s2->priority)
2960 return s1->priority - s2->priority;
2961 return 0;
2964 static void
2965 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str, Lisp_Object str2, Lisp_Object pri, int size)
2967 EMACS_INT nbytes;
2969 if (ssl->used == ssl->size)
2971 if (ssl->buf)
2972 ssl->size *= 2;
2973 else
2974 ssl->size = 5;
2975 ssl->buf = ((struct sortstr *)
2976 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2978 ssl->buf[ssl->used].string = str;
2979 ssl->buf[ssl->used].string2 = str2;
2980 ssl->buf[ssl->used].size = size;
2981 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2982 ssl->used++;
2984 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2985 nbytes = SCHARS (str);
2986 else if (! STRING_MULTIBYTE (str))
2987 nbytes = count_size_as_multibyte (SDATA (str),
2988 SBYTES (str));
2989 else
2990 nbytes = SBYTES (str);
2992 ssl->bytes += nbytes;
2994 if (STRINGP (str2))
2996 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2997 nbytes = SCHARS (str2);
2998 else if (! STRING_MULTIBYTE (str2))
2999 nbytes = count_size_as_multibyte (SDATA (str2),
3000 SBYTES (str2));
3001 else
3002 nbytes = SBYTES (str2);
3004 ssl->bytes += nbytes;
3008 /* Return the concatenation of the strings associated with overlays that
3009 begin or end at POS, ignoring overlays that are specific to a window
3010 other than W. The strings are concatenated in the appropriate order:
3011 shorter overlays nest inside longer ones, and higher priority inside
3012 lower. Normally all of the after-strings come first, but zero-sized
3013 overlays have their after-strings ride along with the before-strings
3014 because it would look strange to print them inside-out.
3016 Returns the string length, and stores the contents indirectly through
3017 PSTR, if that variable is non-null. The string may be overwritten by
3018 subsequent calls. */
3020 EMACS_INT
3021 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3023 Lisp_Object overlay, window, str;
3024 struct Lisp_Overlay *ov;
3025 EMACS_INT startpos, endpos;
3026 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3028 overlay_heads.used = overlay_heads.bytes = 0;
3029 overlay_tails.used = overlay_tails.bytes = 0;
3030 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3032 XSETMISC (overlay, ov);
3033 eassert (OVERLAYP (overlay));
3035 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3036 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3037 if (endpos < pos)
3038 break;
3039 if (endpos != pos && startpos != pos)
3040 continue;
3041 window = Foverlay_get (overlay, Qwindow);
3042 if (WINDOWP (window) && XWINDOW (window) != w)
3043 continue;
3044 if (startpos == pos
3045 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3046 record_overlay_string (&overlay_heads, str,
3047 (startpos == endpos
3048 ? Foverlay_get (overlay, Qafter_string)
3049 : Qnil),
3050 Foverlay_get (overlay, Qpriority),
3051 endpos - startpos);
3052 else if (endpos == pos
3053 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3054 record_overlay_string (&overlay_tails, str, Qnil,
3055 Foverlay_get (overlay, Qpriority),
3056 endpos - startpos);
3058 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3060 XSETMISC (overlay, ov);
3061 eassert (OVERLAYP (overlay));
3063 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3064 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3065 if (startpos > pos)
3066 break;
3067 if (endpos != pos && startpos != pos)
3068 continue;
3069 window = Foverlay_get (overlay, Qwindow);
3070 if (WINDOWP (window) && XWINDOW (window) != w)
3071 continue;
3072 if (startpos == pos
3073 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3074 record_overlay_string (&overlay_heads, str,
3075 (startpos == endpos
3076 ? Foverlay_get (overlay, Qafter_string)
3077 : Qnil),
3078 Foverlay_get (overlay, Qpriority),
3079 endpos - startpos);
3080 else if (endpos == pos
3081 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3082 record_overlay_string (&overlay_tails, str, Qnil,
3083 Foverlay_get (overlay, Qpriority),
3084 endpos - startpos);
3086 if (overlay_tails.used > 1)
3087 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3088 cmp_for_strings);
3089 if (overlay_heads.used > 1)
3090 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3091 cmp_for_strings);
3092 if (overlay_heads.bytes || overlay_tails.bytes)
3094 Lisp_Object tem;
3095 EMACS_INT i;
3096 unsigned char *p;
3097 EMACS_INT total = overlay_heads.bytes + overlay_tails.bytes;
3099 if (total > overlay_str_len)
3101 overlay_str_len = total;
3102 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3103 total);
3105 p = overlay_str_buf;
3106 for (i = overlay_tails.used; --i >= 0;)
3108 EMACS_INT nbytes;
3109 tem = overlay_tails.buf[i].string;
3110 nbytes = copy_text (SDATA (tem), p,
3111 SBYTES (tem),
3112 STRING_MULTIBYTE (tem), multibyte);
3113 p += nbytes;
3115 for (i = 0; i < overlay_heads.used; ++i)
3117 EMACS_INT nbytes;
3118 tem = overlay_heads.buf[i].string;
3119 nbytes = copy_text (SDATA (tem), p,
3120 SBYTES (tem),
3121 STRING_MULTIBYTE (tem), multibyte);
3122 p += nbytes;
3123 tem = overlay_heads.buf[i].string2;
3124 if (STRINGP (tem))
3126 nbytes = copy_text (SDATA (tem), p,
3127 SBYTES (tem),
3128 STRING_MULTIBYTE (tem), multibyte);
3129 p += nbytes;
3132 if (p != overlay_str_buf + total)
3133 abort ();
3134 if (pstr)
3135 *pstr = overlay_str_buf;
3136 return total;
3138 return 0;
3141 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3143 void
3144 recenter_overlay_lists (struct buffer *buf, EMACS_INT pos)
3146 Lisp_Object overlay, beg, end;
3147 struct Lisp_Overlay *prev, *tail, *next;
3149 /* See if anything in overlays_before should move to overlays_after. */
3151 /* We don't strictly need prev in this loop; it should always be nil.
3152 But we use it for symmetry and in case that should cease to be true
3153 with some future change. */
3154 prev = NULL;
3155 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3157 next = tail->next;
3158 XSETMISC (overlay, tail);
3160 /* If the overlay is not valid, get rid of it. */
3161 if (!OVERLAY_VALID (overlay))
3162 #if 1
3163 abort ();
3164 #else
3166 /* Splice the cons cell TAIL out of overlays_before. */
3167 if (!NILP (prev))
3168 XCDR (prev) = next;
3169 else
3170 buf->overlays_before = next;
3171 tail = prev;
3172 continue;
3174 #endif
3176 beg = OVERLAY_START (overlay);
3177 end = OVERLAY_END (overlay);
3179 if (OVERLAY_POSITION (end) > pos)
3181 /* OVERLAY needs to be moved. */
3182 EMACS_INT where = OVERLAY_POSITION (beg);
3183 struct Lisp_Overlay *other, *other_prev;
3185 /* Splice the cons cell TAIL out of overlays_before. */
3186 if (prev)
3187 prev->next = next;
3188 else
3189 buf->overlays_before = next;
3191 /* Search thru overlays_after for where to put it. */
3192 other_prev = NULL;
3193 for (other = buf->overlays_after; other;
3194 other_prev = other, other = other->next)
3196 Lisp_Object otherbeg, otheroverlay;
3198 XSETMISC (otheroverlay, other);
3199 eassert (OVERLAY_VALID (otheroverlay));
3201 otherbeg = OVERLAY_START (otheroverlay);
3202 if (OVERLAY_POSITION (otherbeg) >= where)
3203 break;
3206 /* Add TAIL to overlays_after before OTHER. */
3207 tail->next = other;
3208 if (other_prev)
3209 other_prev->next = tail;
3210 else
3211 buf->overlays_after = tail;
3212 tail = prev;
3214 else
3215 /* We've reached the things that should stay in overlays_before.
3216 All the rest of overlays_before must end even earlier,
3217 so stop now. */
3218 break;
3221 /* See if anything in overlays_after should be in overlays_before. */
3222 prev = NULL;
3223 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3225 next = tail->next;
3226 XSETMISC (overlay, tail);
3228 /* If the overlay is not valid, get rid of it. */
3229 if (!OVERLAY_VALID (overlay))
3230 #if 1
3231 abort ();
3232 #else
3234 /* Splice the cons cell TAIL out of overlays_after. */
3235 if (!NILP (prev))
3236 XCDR (prev) = next;
3237 else
3238 buf->overlays_after = next;
3239 tail = prev;
3240 continue;
3242 #endif
3244 beg = OVERLAY_START (overlay);
3245 end = OVERLAY_END (overlay);
3247 /* Stop looking, when we know that nothing further
3248 can possibly end before POS. */
3249 if (OVERLAY_POSITION (beg) > pos)
3250 break;
3252 if (OVERLAY_POSITION (end) <= pos)
3254 /* OVERLAY needs to be moved. */
3255 EMACS_INT where = OVERLAY_POSITION (end);
3256 struct Lisp_Overlay *other, *other_prev;
3258 /* Splice the cons cell TAIL out of overlays_after. */
3259 if (prev)
3260 prev->next = next;
3261 else
3262 buf->overlays_after = next;
3264 /* Search thru overlays_before for where to put it. */
3265 other_prev = NULL;
3266 for (other = buf->overlays_before; other;
3267 other_prev = other, other = other->next)
3269 Lisp_Object otherend, otheroverlay;
3271 XSETMISC (otheroverlay, other);
3272 eassert (OVERLAY_VALID (otheroverlay));
3274 otherend = OVERLAY_END (otheroverlay);
3275 if (OVERLAY_POSITION (otherend) <= where)
3276 break;
3279 /* Add TAIL to overlays_before before OTHER. */
3280 tail->next = other;
3281 if (other_prev)
3282 other_prev->next = tail;
3283 else
3284 buf->overlays_before = tail;
3285 tail = prev;
3289 buf->overlay_center = pos;
3292 void
3293 adjust_overlays_for_insert (EMACS_INT pos, EMACS_INT length)
3295 /* After an insertion, the lists are still sorted properly,
3296 but we may need to update the value of the overlay center. */
3297 if (current_buffer->overlay_center >= pos)
3298 current_buffer->overlay_center += length;
3301 void
3302 adjust_overlays_for_delete (EMACS_INT pos, EMACS_INT length)
3304 if (current_buffer->overlay_center < pos)
3305 /* The deletion was to our right. No change needed; the before- and
3306 after-lists are still consistent. */
3308 else if (current_buffer->overlay_center > pos + length)
3309 /* The deletion was to our left. We need to adjust the center value
3310 to account for the change in position, but the lists are consistent
3311 given the new value. */
3312 current_buffer->overlay_center -= length;
3313 else
3314 /* We're right in the middle. There might be things on the after-list
3315 that now belong on the before-list. Recentering will move them,
3316 and also update the center point. */
3317 recenter_overlay_lists (current_buffer, pos);
3320 /* Fix up overlays that were garbled as a result of permuting markers
3321 in the range START through END. Any overlay with at least one
3322 endpoint in this range will need to be unlinked from the overlay
3323 list and reinserted in its proper place.
3324 Such an overlay might even have negative size at this point.
3325 If so, we'll make the overlay empty. */
3326 void
3327 fix_start_end_in_overlays (register EMACS_INT start, register EMACS_INT end)
3329 Lisp_Object overlay;
3330 struct Lisp_Overlay *before_list IF_LINT (= NULL);
3331 struct Lisp_Overlay *after_list IF_LINT (= NULL);
3332 /* These are either nil, indicating that before_list or after_list
3333 should be assigned, or the cons cell the cdr of which should be
3334 assigned. */
3335 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3336 /* 'Parent', likewise, indicates a cons cell or
3337 current_buffer->overlays_before or overlays_after, depending
3338 which loop we're in. */
3339 struct Lisp_Overlay *tail, *parent;
3340 EMACS_INT startpos, endpos;
3342 /* This algorithm shifts links around instead of consing and GCing.
3343 The loop invariant is that before_list (resp. after_list) is a
3344 well-formed list except that its last element, the CDR of beforep
3345 (resp. afterp) if beforep (afterp) isn't nil or before_list
3346 (after_list) if it is, is still uninitialized. So it's not a bug
3347 that before_list isn't initialized, although it may look
3348 strange. */
3349 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3351 XSETMISC (overlay, tail);
3353 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3354 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3356 /* If the overlay is backwards, make it empty. */
3357 if (endpos < startpos)
3359 startpos = endpos;
3360 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3361 Qnil);
3364 if (endpos < start)
3365 break;
3367 if (endpos < end
3368 || (startpos >= start && startpos < end))
3370 /* Add it to the end of the wrong list. Later on,
3371 recenter_overlay_lists will move it to the right place. */
3372 if (endpos < current_buffer->overlay_center)
3374 if (!afterp)
3375 after_list = tail;
3376 else
3377 afterp->next = tail;
3378 afterp = tail;
3380 else
3382 if (!beforep)
3383 before_list = tail;
3384 else
3385 beforep->next = tail;
3386 beforep = tail;
3388 if (!parent)
3389 current_buffer->overlays_before = tail->next;
3390 else
3391 parent->next = tail->next;
3392 tail = tail->next;
3394 else
3395 parent = tail, tail = parent->next;
3397 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3399 XSETMISC (overlay, tail);
3401 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3402 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3404 /* If the overlay is backwards, make it empty. */
3405 if (endpos < startpos)
3407 startpos = endpos;
3408 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3409 Qnil);
3412 if (startpos >= end)
3413 break;
3415 if (startpos >= start
3416 || (endpos >= start && endpos < end))
3418 if (endpos < current_buffer->overlay_center)
3420 if (!afterp)
3421 after_list = tail;
3422 else
3423 afterp->next = tail;
3424 afterp = tail;
3426 else
3428 if (!beforep)
3429 before_list = tail;
3430 else
3431 beforep->next = tail;
3432 beforep = tail;
3434 if (!parent)
3435 current_buffer->overlays_after = tail->next;
3436 else
3437 parent->next = tail->next;
3438 tail = tail->next;
3440 else
3441 parent = tail, tail = parent->next;
3444 /* Splice the constructed (wrong) lists into the buffer's lists,
3445 and let the recenter function make it sane again. */
3446 if (beforep)
3448 beforep->next = current_buffer->overlays_before;
3449 current_buffer->overlays_before = before_list;
3451 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3453 if (afterp)
3455 afterp->next = current_buffer->overlays_after;
3456 current_buffer->overlays_after = after_list;
3458 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3461 /* We have two types of overlay: the one whose ending marker is
3462 after-insertion-marker (this is the usual case) and the one whose
3463 ending marker is before-insertion-marker. When `overlays_before'
3464 contains overlays of the latter type and the former type in this
3465 order and both overlays end at inserting position, inserting a text
3466 increases only the ending marker of the latter type, which results
3467 in incorrect ordering of `overlays_before'.
3469 This function fixes ordering of overlays in the slot
3470 `overlays_before' of the buffer *BP. Before the insertion, `point'
3471 was at PREV, and now is at POS. */
3473 void
3474 fix_overlays_before (struct buffer *bp, EMACS_INT prev, EMACS_INT pos)
3476 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3477 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3478 Lisp_Object tem;
3479 EMACS_INT end IF_LINT (= 0);
3481 /* After the insertion, the several overlays may be in incorrect
3482 order. The possibility is that, in the list `overlays_before',
3483 an overlay which ends at POS appears after an overlay which ends
3484 at PREV. Since POS is greater than PREV, we must fix the
3485 ordering of these overlays, by moving overlays ends at POS before
3486 the overlays ends at PREV. */
3488 /* At first, find a place where disordered overlays should be linked
3489 in. It is where an overlay which end before POS exists. (i.e. an
3490 overlay whose ending marker is after-insertion-marker if disorder
3491 exists). */
3492 while (tail
3493 && (XSETMISC (tem, tail),
3494 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3496 parent = tail;
3497 tail = tail->next;
3500 /* If we don't find such an overlay,
3501 or the found one ends before PREV,
3502 or the found one is the last one in the list,
3503 we don't have to fix anything. */
3504 if (!tail || end < prev || !tail->next)
3505 return;
3507 right_pair = parent;
3508 parent = tail;
3509 tail = tail->next;
3511 /* Now, end position of overlays in the list TAIL should be before
3512 or equal to PREV. In the loop, an overlay which ends at POS is
3513 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3514 we found an overlay which ends before PREV, the remaining
3515 overlays are in correct order. */
3516 while (tail)
3518 XSETMISC (tem, tail);
3519 end = OVERLAY_POSITION (OVERLAY_END (tem));
3521 if (end == pos)
3522 { /* This overlay is disordered. */
3523 struct Lisp_Overlay *found = tail;
3525 /* Unlink the found overlay. */
3526 tail = found->next;
3527 parent->next = tail;
3528 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3529 and link it into the right place. */
3530 if (!right_pair)
3532 found->next = bp->overlays_before;
3533 bp->overlays_before = found;
3535 else
3537 found->next = right_pair->next;
3538 right_pair->next = found;
3541 else if (end == prev)
3543 parent = tail;
3544 tail = tail->next;
3546 else /* No more disordered overlay. */
3547 break;
3551 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3552 doc: /* Return t if OBJECT is an overlay. */)
3553 (Lisp_Object object)
3555 return (OVERLAYP (object) ? Qt : Qnil);
3558 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3559 doc: /* Create a new overlay with range BEG to END in BUFFER.
3560 If omitted, BUFFER defaults to the current buffer.
3561 BEG and END may be integers or markers.
3562 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3563 for the front of the overlay advance when text is inserted there
3564 \(which means the text *is not* included in the overlay).
3565 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3566 for the rear of the overlay advance when text is inserted there
3567 \(which means the text *is* included in the overlay). */)
3568 (Lisp_Object beg, Lisp_Object end, Lisp_Object buffer, Lisp_Object front_advance, Lisp_Object rear_advance)
3570 Lisp_Object overlay;
3571 struct buffer *b;
3573 if (NILP (buffer))
3574 XSETBUFFER (buffer, current_buffer);
3575 else
3576 CHECK_BUFFER (buffer);
3577 if (MARKERP (beg)
3578 && ! EQ (Fmarker_buffer (beg), buffer))
3579 error ("Marker points into wrong buffer");
3580 if (MARKERP (end)
3581 && ! EQ (Fmarker_buffer (end), buffer))
3582 error ("Marker points into wrong buffer");
3584 CHECK_NUMBER_COERCE_MARKER (beg);
3585 CHECK_NUMBER_COERCE_MARKER (end);
3587 if (XINT (beg) > XINT (end))
3589 Lisp_Object temp;
3590 temp = beg; beg = end; end = temp;
3593 b = XBUFFER (buffer);
3595 beg = Fset_marker (Fmake_marker (), beg, buffer);
3596 end = Fset_marker (Fmake_marker (), end, buffer);
3598 if (!NILP (front_advance))
3599 XMARKER (beg)->insertion_type = 1;
3600 if (!NILP (rear_advance))
3601 XMARKER (end)->insertion_type = 1;
3603 overlay = allocate_misc ();
3604 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3605 XOVERLAY (overlay)->start = beg;
3606 XOVERLAY (overlay)->end = end;
3607 XOVERLAY (overlay)->plist = Qnil;
3608 XOVERLAY (overlay)->next = NULL;
3610 /* Put the new overlay on the wrong list. */
3611 end = OVERLAY_END (overlay);
3612 if (OVERLAY_POSITION (end) < b->overlay_center)
3614 if (b->overlays_after)
3615 XOVERLAY (overlay)->next = b->overlays_after;
3616 b->overlays_after = XOVERLAY (overlay);
3618 else
3620 if (b->overlays_before)
3621 XOVERLAY (overlay)->next = b->overlays_before;
3622 b->overlays_before = XOVERLAY (overlay);
3625 /* This puts it in the right list, and in the right order. */
3626 recenter_overlay_lists (b, b->overlay_center);
3628 /* We don't need to redisplay the region covered by the overlay, because
3629 the overlay has no properties at the moment. */
3631 return overlay;
3634 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3636 static void
3637 modify_overlay (struct buffer *buf, EMACS_INT start, EMACS_INT end)
3639 if (start > end)
3641 EMACS_INT temp = start;
3642 start = end;
3643 end = temp;
3646 BUF_COMPUTE_UNCHANGED (buf, start, end);
3648 /* If this is a buffer not in the selected window,
3649 we must do other windows. */
3650 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3651 windows_or_buffers_changed = 1;
3652 /* If multiple windows show this buffer, we must do other windows. */
3653 else if (buffer_shared > 1)
3654 windows_or_buffers_changed = 1;
3655 /* If we modify an overlay at the end of the buffer, we cannot
3656 be sure that window end is still valid. */
3657 else if (end >= ZV && start <= ZV)
3658 windows_or_buffers_changed = 1;
3660 ++BUF_OVERLAY_MODIFF (buf);
3664 static struct Lisp_Overlay *
3665 unchain_overlay (struct Lisp_Overlay *list, struct Lisp_Overlay *overlay)
3667 struct Lisp_Overlay *tmp, *prev;
3668 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3669 if (tmp == overlay)
3671 if (prev)
3672 prev->next = tmp->next;
3673 else
3674 list = tmp->next;
3675 overlay->next = NULL;
3676 break;
3678 return list;
3681 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3682 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3683 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3684 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3685 buffer. */)
3686 (Lisp_Object overlay, Lisp_Object beg, Lisp_Object end, Lisp_Object buffer)
3688 struct buffer *b, *ob;
3689 Lisp_Object obuffer;
3690 int count = SPECPDL_INDEX ();
3692 CHECK_OVERLAY (overlay);
3693 if (NILP (buffer))
3694 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3695 if (NILP (buffer))
3696 XSETBUFFER (buffer, current_buffer);
3697 CHECK_BUFFER (buffer);
3699 if (MARKERP (beg)
3700 && ! EQ (Fmarker_buffer (beg), buffer))
3701 error ("Marker points into wrong buffer");
3702 if (MARKERP (end)
3703 && ! EQ (Fmarker_buffer (end), buffer))
3704 error ("Marker points into wrong buffer");
3706 CHECK_NUMBER_COERCE_MARKER (beg);
3707 CHECK_NUMBER_COERCE_MARKER (end);
3709 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3710 return Fdelete_overlay (overlay);
3712 if (XINT (beg) > XINT (end))
3714 Lisp_Object temp;
3715 temp = beg; beg = end; end = temp;
3718 specbind (Qinhibit_quit, Qt);
3720 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3721 b = XBUFFER (buffer);
3722 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3724 /* If the overlay has changed buffers, do a thorough redisplay. */
3725 if (!EQ (buffer, obuffer))
3727 /* Redisplay where the overlay was. */
3728 if (!NILP (obuffer))
3730 EMACS_INT o_beg;
3731 EMACS_INT o_end;
3733 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3734 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3736 modify_overlay (ob, o_beg, o_end);
3739 /* Redisplay where the overlay is going to be. */
3740 modify_overlay (b, XINT (beg), XINT (end));
3742 else
3743 /* Redisplay the area the overlay has just left, or just enclosed. */
3745 EMACS_INT o_beg, o_end;
3747 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3748 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3750 if (o_beg == XINT (beg))
3751 modify_overlay (b, o_end, XINT (end));
3752 else if (o_end == XINT (end))
3753 modify_overlay (b, o_beg, XINT (beg));
3754 else
3756 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3757 if (XINT (end) > o_end) o_end = XINT (end);
3758 modify_overlay (b, o_beg, o_end);
3762 if (!NILP (obuffer))
3764 ob->overlays_before
3765 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3766 ob->overlays_after
3767 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3768 eassert (XOVERLAY (overlay)->next == NULL);
3771 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3772 Fset_marker (OVERLAY_END (overlay), end, buffer);
3774 /* Put the overlay on the wrong list. */
3775 end = OVERLAY_END (overlay);
3776 if (OVERLAY_POSITION (end) < b->overlay_center)
3778 XOVERLAY (overlay)->next = b->overlays_after;
3779 b->overlays_after = XOVERLAY (overlay);
3781 else
3783 XOVERLAY (overlay)->next = b->overlays_before;
3784 b->overlays_before = XOVERLAY (overlay);
3787 /* This puts it in the right list, and in the right order. */
3788 recenter_overlay_lists (b, b->overlay_center);
3790 return unbind_to (count, overlay);
3793 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3794 doc: /* Delete the overlay OVERLAY from its buffer. */)
3795 (Lisp_Object overlay)
3797 Lisp_Object buffer;
3798 struct buffer *b;
3799 int count = SPECPDL_INDEX ();
3801 CHECK_OVERLAY (overlay);
3803 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3804 if (NILP (buffer))
3805 return Qnil;
3807 b = XBUFFER (buffer);
3808 specbind (Qinhibit_quit, Qt);
3810 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3811 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3812 eassert (XOVERLAY (overlay)->next == NULL);
3813 modify_overlay (b,
3814 marker_position (OVERLAY_START (overlay)),
3815 marker_position (OVERLAY_END (overlay)));
3816 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3817 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3819 /* When deleting an overlay with before or after strings, turn off
3820 display optimizations for the affected buffer, on the basis that
3821 these strings may contain newlines. This is easier to do than to
3822 check for that situation during redisplay. */
3823 if (!windows_or_buffers_changed
3824 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3825 || !NILP (Foverlay_get (overlay, Qafter_string))))
3826 b->prevent_redisplay_optimizations_p = 1;
3828 return unbind_to (count, Qnil);
3831 /* Overlay dissection functions. */
3833 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3834 doc: /* Return the position at which OVERLAY starts. */)
3835 (Lisp_Object overlay)
3837 CHECK_OVERLAY (overlay);
3839 return (Fmarker_position (OVERLAY_START (overlay)));
3842 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3843 doc: /* Return the position at which OVERLAY ends. */)
3844 (Lisp_Object overlay)
3846 CHECK_OVERLAY (overlay);
3848 return (Fmarker_position (OVERLAY_END (overlay)));
3851 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3852 doc: /* Return the buffer OVERLAY belongs to.
3853 Return nil if OVERLAY has been deleted. */)
3854 (Lisp_Object overlay)
3856 CHECK_OVERLAY (overlay);
3858 return Fmarker_buffer (OVERLAY_START (overlay));
3861 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3862 doc: /* Return a list of the properties on OVERLAY.
3863 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3864 OVERLAY. */)
3865 (Lisp_Object overlay)
3867 CHECK_OVERLAY (overlay);
3869 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3873 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3874 doc: /* Return a list of the overlays that contain the character at POS. */)
3875 (Lisp_Object pos)
3877 int noverlays;
3878 Lisp_Object *overlay_vec;
3879 int len;
3880 Lisp_Object result;
3882 CHECK_NUMBER_COERCE_MARKER (pos);
3884 len = 10;
3885 /* We can't use alloca here because overlays_at can call xrealloc. */
3886 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3888 /* Put all the overlays we want in a vector in overlay_vec.
3889 Store the length in len. */
3890 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3891 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3893 /* Make a list of them all. */
3894 result = Flist (noverlays, overlay_vec);
3896 xfree (overlay_vec);
3897 return result;
3900 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3901 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3902 Overlap means that at least one character is contained within the overlay
3903 and also contained within the specified region.
3904 Empty overlays are included in the result if they are located at BEG,
3905 between BEG and END, or at END provided END denotes the position at the
3906 end of the buffer. */)
3907 (Lisp_Object beg, Lisp_Object end)
3909 int noverlays;
3910 Lisp_Object *overlay_vec;
3911 int len;
3912 Lisp_Object result;
3914 CHECK_NUMBER_COERCE_MARKER (beg);
3915 CHECK_NUMBER_COERCE_MARKER (end);
3917 len = 10;
3918 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3920 /* Put all the overlays we want in a vector in overlay_vec.
3921 Store the length in len. */
3922 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3923 NULL, NULL);
3925 /* Make a list of them all. */
3926 result = Flist (noverlays, overlay_vec);
3928 xfree (overlay_vec);
3929 return result;
3932 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3933 1, 1, 0,
3934 doc: /* Return the next position after POS where an overlay starts or ends.
3935 If there are no overlay boundaries from POS to (point-max),
3936 the value is (point-max). */)
3937 (Lisp_Object pos)
3939 int noverlays;
3940 EMACS_INT endpos;
3941 Lisp_Object *overlay_vec;
3942 int len;
3943 int i;
3945 CHECK_NUMBER_COERCE_MARKER (pos);
3947 len = 10;
3948 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3950 /* Put all the overlays we want in a vector in overlay_vec.
3951 Store the length in len.
3952 endpos gets the position where the next overlay starts. */
3953 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3954 &endpos, (EMACS_INT *) 0, 1);
3956 /* If any of these overlays ends before endpos,
3957 use its ending point instead. */
3958 for (i = 0; i < noverlays; i++)
3960 Lisp_Object oend;
3961 EMACS_INT oendpos;
3963 oend = OVERLAY_END (overlay_vec[i]);
3964 oendpos = OVERLAY_POSITION (oend);
3965 if (oendpos < endpos)
3966 endpos = oendpos;
3969 xfree (overlay_vec);
3970 return make_number (endpos);
3973 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3974 Sprevious_overlay_change, 1, 1, 0,
3975 doc: /* Return the previous position before POS where an overlay starts or ends.
3976 If there are no overlay boundaries from (point-min) to POS,
3977 the value is (point-min). */)
3978 (Lisp_Object pos)
3980 EMACS_INT prevpos;
3981 Lisp_Object *overlay_vec;
3982 int len;
3984 CHECK_NUMBER_COERCE_MARKER (pos);
3986 /* At beginning of buffer, we know the answer;
3987 avoid bug subtracting 1 below. */
3988 if (XINT (pos) == BEGV)
3989 return pos;
3991 len = 10;
3992 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3994 /* Put all the overlays we want in a vector in overlay_vec.
3995 Store the length in len.
3996 prevpos gets the position of the previous change. */
3997 overlays_at (XINT (pos), 1, &overlay_vec, &len,
3998 (EMACS_INT *) 0, &prevpos, 1);
4000 xfree (overlay_vec);
4001 return make_number (prevpos);
4004 /* These functions are for debugging overlays. */
4006 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4007 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4008 The car has all the overlays before the overlay center;
4009 the cdr has all the overlays after the overlay center.
4010 Recentering overlays moves overlays between these lists.
4011 The lists you get are copies, so that changing them has no effect.
4012 However, the overlays you get are the real objects that the buffer uses. */)
4013 (void)
4015 struct Lisp_Overlay *ol;
4016 Lisp_Object before = Qnil, after = Qnil, tmp;
4017 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4019 XSETMISC (tmp, ol);
4020 before = Fcons (tmp, before);
4022 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4024 XSETMISC (tmp, ol);
4025 after = Fcons (tmp, after);
4027 return Fcons (Fnreverse (before), Fnreverse (after));
4030 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4031 doc: /* Recenter the overlays of the current buffer around position POS.
4032 That makes overlay lookup faster for positions near POS (but perhaps slower
4033 for positions far away from POS). */)
4034 (Lisp_Object pos)
4036 CHECK_NUMBER_COERCE_MARKER (pos);
4038 recenter_overlay_lists (current_buffer, XINT (pos));
4039 return Qnil;
4042 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4043 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4044 (Lisp_Object overlay, Lisp_Object prop)
4046 CHECK_OVERLAY (overlay);
4047 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4050 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4051 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4052 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4054 Lisp_Object tail, buffer;
4055 int changed;
4057 CHECK_OVERLAY (overlay);
4059 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4061 for (tail = XOVERLAY (overlay)->plist;
4062 CONSP (tail) && CONSP (XCDR (tail));
4063 tail = XCDR (XCDR (tail)))
4064 if (EQ (XCAR (tail), prop))
4066 changed = !EQ (XCAR (XCDR (tail)), value);
4067 XSETCAR (XCDR (tail), value);
4068 goto found;
4070 /* It wasn't in the list, so add it to the front. */
4071 changed = !NILP (value);
4072 XOVERLAY (overlay)->plist
4073 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4074 found:
4075 if (! NILP (buffer))
4077 if (changed)
4078 modify_overlay (XBUFFER (buffer),
4079 marker_position (OVERLAY_START (overlay)),
4080 marker_position (OVERLAY_END (overlay)));
4081 if (EQ (prop, Qevaporate) && ! NILP (value)
4082 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4083 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4084 Fdelete_overlay (overlay);
4087 return value;
4090 /* Subroutine of report_overlay_modification. */
4092 /* Lisp vector holding overlay hook functions to call.
4093 Vector elements come in pairs.
4094 Each even-index element is a list of hook functions.
4095 The following odd-index element is the overlay they came from.
4097 Before the buffer change, we fill in this vector
4098 as we call overlay hook functions.
4099 After the buffer change, we get the functions to call from this vector.
4100 This way we always call the same functions before and after the change. */
4101 static Lisp_Object last_overlay_modification_hooks;
4103 /* Number of elements actually used in last_overlay_modification_hooks. */
4104 static int last_overlay_modification_hooks_used;
4106 /* Add one functionlist/overlay pair
4107 to the end of last_overlay_modification_hooks. */
4109 static void
4110 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4112 int oldsize = ASIZE (last_overlay_modification_hooks);
4114 if (last_overlay_modification_hooks_used == oldsize)
4115 last_overlay_modification_hooks = larger_vector
4116 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4117 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4118 functionlist); last_overlay_modification_hooks_used++;
4119 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4120 overlay); last_overlay_modification_hooks_used++;
4123 /* Run the modification-hooks of overlays that include
4124 any part of the text in START to END.
4125 If this change is an insertion, also
4126 run the insert-before-hooks of overlay starting at END,
4127 and the insert-after-hooks of overlay ending at START.
4129 This is called both before and after the modification.
4130 AFTER is nonzero when we call after the modification.
4132 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4133 When AFTER is nonzero, they are the start position,
4134 the position after the inserted new text,
4135 and the length of deleted or replaced old text. */
4137 void
4138 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4139 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4141 Lisp_Object prop, overlay;
4142 struct Lisp_Overlay *tail;
4143 /* 1 if this change is an insertion. */
4144 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4145 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4147 overlay = Qnil;
4148 tail = NULL;
4150 /* We used to run the functions as soon as we found them and only register
4151 them in last_overlay_modification_hooks for the purpose of the `after'
4152 case. But running elisp code as we traverse the list of overlays is
4153 painful because the list can be modified by the elisp code so we had to
4154 copy at several places. We now simply do a read-only traversal that
4155 only collects the functions to run and we run them afterwards. It's
4156 simpler, especially since all the code was already there. -stef */
4158 if (!after)
4160 /* We are being called before a change.
4161 Scan the overlays to find the functions to call. */
4162 last_overlay_modification_hooks_used = 0;
4163 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4165 EMACS_INT startpos, endpos;
4166 Lisp_Object ostart, oend;
4168 XSETMISC (overlay, tail);
4170 ostart = OVERLAY_START (overlay);
4171 oend = OVERLAY_END (overlay);
4172 endpos = OVERLAY_POSITION (oend);
4173 if (XFASTINT (start) > endpos)
4174 break;
4175 startpos = OVERLAY_POSITION (ostart);
4176 if (insertion && (XFASTINT (start) == startpos
4177 || XFASTINT (end) == startpos))
4179 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4180 if (!NILP (prop))
4181 add_overlay_mod_hooklist (prop, overlay);
4183 if (insertion && (XFASTINT (start) == endpos
4184 || XFASTINT (end) == endpos))
4186 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4187 if (!NILP (prop))
4188 add_overlay_mod_hooklist (prop, overlay);
4190 /* Test for intersecting intervals. This does the right thing
4191 for both insertion and deletion. */
4192 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4194 prop = Foverlay_get (overlay, Qmodification_hooks);
4195 if (!NILP (prop))
4196 add_overlay_mod_hooklist (prop, overlay);
4200 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4202 EMACS_INT startpos, endpos;
4203 Lisp_Object ostart, oend;
4205 XSETMISC (overlay, tail);
4207 ostart = OVERLAY_START (overlay);
4208 oend = OVERLAY_END (overlay);
4209 startpos = OVERLAY_POSITION (ostart);
4210 endpos = OVERLAY_POSITION (oend);
4211 if (XFASTINT (end) < startpos)
4212 break;
4213 if (insertion && (XFASTINT (start) == startpos
4214 || XFASTINT (end) == startpos))
4216 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4217 if (!NILP (prop))
4218 add_overlay_mod_hooklist (prop, overlay);
4220 if (insertion && (XFASTINT (start) == endpos
4221 || XFASTINT (end) == endpos))
4223 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4224 if (!NILP (prop))
4225 add_overlay_mod_hooklist (prop, overlay);
4227 /* Test for intersecting intervals. This does the right thing
4228 for both insertion and deletion. */
4229 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4231 prop = Foverlay_get (overlay, Qmodification_hooks);
4232 if (!NILP (prop))
4233 add_overlay_mod_hooklist (prop, overlay);
4238 GCPRO4 (overlay, arg1, arg2, arg3);
4240 /* Call the functions recorded in last_overlay_modification_hooks.
4241 First copy the vector contents, in case some of these hooks
4242 do subsequent modification of the buffer. */
4243 int size = last_overlay_modification_hooks_used;
4244 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4245 int i;
4247 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4248 size * sizeof (Lisp_Object));
4249 gcpro1.var = copy;
4250 gcpro1.nvars = size;
4252 for (i = 0; i < size;)
4254 Lisp_Object prop_i, overlay_i;
4255 prop_i = copy[i++];
4256 overlay_i = copy[i++];
4257 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4260 UNGCPRO;
4263 static void
4264 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4265 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4267 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4269 GCPRO4 (list, arg1, arg2, arg3);
4271 while (CONSP (list))
4273 if (NILP (arg3))
4274 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4275 else
4276 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4277 list = XCDR (list);
4279 UNGCPRO;
4282 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4283 property is set. */
4284 void
4285 evaporate_overlays (EMACS_INT pos)
4287 Lisp_Object overlay, hit_list;
4288 struct Lisp_Overlay *tail;
4290 hit_list = Qnil;
4291 if (pos <= current_buffer->overlay_center)
4292 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4294 EMACS_INT endpos;
4295 XSETMISC (overlay, tail);
4296 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4297 if (endpos < pos)
4298 break;
4299 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4300 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4301 hit_list = Fcons (overlay, hit_list);
4303 else
4304 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4306 EMACS_INT startpos;
4307 XSETMISC (overlay, tail);
4308 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4309 if (startpos > pos)
4310 break;
4311 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4312 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4313 hit_list = Fcons (overlay, hit_list);
4315 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4316 Fdelete_overlay (XCAR (hit_list));
4319 /* Somebody has tried to store a value with an unacceptable type
4320 in the slot with offset OFFSET. */
4322 void
4323 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4325 Lisp_Object predicate;
4327 switch (type)
4329 case_Lisp_Int: predicate = Qintegerp; break;
4330 case Lisp_String: predicate = Qstringp; break;
4331 case Lisp_Symbol: predicate = Qsymbolp; break;
4332 default: abort ();
4335 wrong_type_argument (predicate, newval);
4339 /***********************************************************************
4340 Allocation with mmap
4341 ***********************************************************************/
4343 #ifdef USE_MMAP_FOR_BUFFERS
4345 #include <sys/types.h>
4346 #include <sys/mman.h>
4348 #ifndef MAP_ANON
4349 #ifdef MAP_ANONYMOUS
4350 #define MAP_ANON MAP_ANONYMOUS
4351 #else
4352 #define MAP_ANON 0
4353 #endif
4354 #endif
4356 #ifndef MAP_FAILED
4357 #define MAP_FAILED ((void *) -1)
4358 #endif
4360 #include <stdio.h>
4362 #if MAP_ANON == 0
4363 #include <fcntl.h>
4364 #endif
4366 #include "coding.h"
4369 /* Memory is allocated in regions which are mapped using mmap(2).
4370 The current implementation lets the system select mapped
4371 addresses; we're not using MAP_FIXED in general, except when
4372 trying to enlarge regions.
4374 Each mapped region starts with a mmap_region structure, the user
4375 area starts after that structure, aligned to MEM_ALIGN.
4377 +-----------------------+
4378 | struct mmap_info + |
4379 | padding |
4380 +-----------------------+
4381 | user data |
4384 +-----------------------+ */
4386 struct mmap_region
4388 /* User-specified size. */
4389 size_t nbytes_specified;
4391 /* Number of bytes mapped */
4392 size_t nbytes_mapped;
4394 /* Pointer to the location holding the address of the memory
4395 allocated with the mmap'd block. The variable actually points
4396 after this structure. */
4397 POINTER_TYPE **var;
4399 /* Next and previous in list of all mmap'd regions. */
4400 struct mmap_region *next, *prev;
4403 /* Doubly-linked list of mmap'd regions. */
4405 static struct mmap_region *mmap_regions;
4407 /* File descriptor for mmap. If we don't have anonymous mapping,
4408 /dev/zero will be opened on it. */
4410 static int mmap_fd;
4412 /* Temporary storage for mmap_set_vars, see there. */
4414 static struct mmap_region *mmap_regions_1;
4415 static int mmap_fd_1;
4417 /* Page size on this system. */
4419 static int mmap_page_size;
4421 /* 1 means mmap has been intialized. */
4423 static int mmap_initialized_p;
4425 /* Value is X rounded up to the next multiple of N. */
4427 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4429 /* Size of mmap_region structure plus padding. */
4431 #define MMAP_REGION_STRUCT_SIZE \
4432 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4434 /* Given a pointer P to the start of the user-visible part of a mapped
4435 region, return a pointer to the start of the region. */
4437 #define MMAP_REGION(P) \
4438 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4440 /* Given a pointer P to the start of a mapped region, return a pointer
4441 to the start of the user-visible part of the region. */
4443 #define MMAP_USER_AREA(P) \
4444 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4446 #define MEM_ALIGN sizeof (double)
4448 /* Predicate returning true if part of the address range [START .. END]
4449 is currently mapped. Used to prevent overwriting an existing
4450 memory mapping.
4452 Default is to conservativly assume the address range is occupied by
4453 something else. This can be overridden by system configuration
4454 files if system-specific means to determine this exists. */
4456 #ifndef MMAP_ALLOCATED_P
4457 #define MMAP_ALLOCATED_P(start, end) 1
4458 #endif
4460 /* Function prototypes. */
4462 static int mmap_free_1 (struct mmap_region *);
4463 static int mmap_enlarge (struct mmap_region *, int);
4464 static struct mmap_region *mmap_find (POINTER_TYPE *, POINTER_TYPE *);
4465 static POINTER_TYPE *mmap_alloc (POINTER_TYPE **, size_t);
4466 static POINTER_TYPE *mmap_realloc (POINTER_TYPE **, size_t);
4467 static void mmap_free (POINTER_TYPE **ptr);
4468 static void mmap_init (void);
4471 /* Return a region overlapping address range START...END, or null if
4472 none. END is not including, i.e. the last byte in the range
4473 is at END - 1. */
4475 static struct mmap_region *
4476 mmap_find (start, end)
4477 POINTER_TYPE *start, *end;
4479 struct mmap_region *r;
4480 char *s = (char *) start, *e = (char *) end;
4482 for (r = mmap_regions; r; r = r->next)
4484 char *rstart = (char *) r;
4485 char *rend = rstart + r->nbytes_mapped;
4487 if (/* First byte of range, i.e. START, in this region? */
4488 (s >= rstart && s < rend)
4489 /* Last byte of range, i.e. END - 1, in this region? */
4490 || (e > rstart && e <= rend)
4491 /* First byte of this region in the range? */
4492 || (rstart >= s && rstart < e)
4493 /* Last byte of this region in the range? */
4494 || (rend > s && rend <= e))
4495 break;
4498 return r;
4502 /* Unmap a region. P is a pointer to the start of the user-araa of
4503 the region. Value is non-zero if successful. */
4505 static int
4506 mmap_free_1 (r)
4507 struct mmap_region *r;
4509 if (r->next)
4510 r->next->prev = r->prev;
4511 if (r->prev)
4512 r->prev->next = r->next;
4513 else
4514 mmap_regions = r->next;
4516 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4518 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4519 return 0;
4522 return 1;
4526 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4527 Value is non-zero if successful. */
4529 static int
4530 mmap_enlarge (r, npages)
4531 struct mmap_region *r;
4532 int npages;
4534 char *region_end = (char *) r + r->nbytes_mapped;
4535 size_t nbytes;
4536 int success = 0;
4538 if (npages < 0)
4540 /* Unmap pages at the end of the region. */
4541 nbytes = - npages * mmap_page_size;
4542 if (munmap (region_end - nbytes, nbytes) == -1)
4543 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4544 else
4546 r->nbytes_mapped -= nbytes;
4547 success = 1;
4550 else if (npages > 0)
4552 nbytes = npages * mmap_page_size;
4554 /* Try to map additional pages at the end of the region. We
4555 cannot do this if the address range is already occupied by
4556 something else because mmap deletes any previous mapping.
4557 I'm not sure this is worth doing, let's see. */
4558 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4560 POINTER_TYPE *p;
4562 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4563 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4564 if (p == MAP_FAILED)
4565 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4566 else if (p != (POINTER_TYPE *) region_end)
4568 /* Kernels are free to choose a different address. In
4569 that case, unmap what we've mapped above; we have
4570 no use for it. */
4571 if (munmap (p, nbytes) == -1)
4572 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4574 else
4576 r->nbytes_mapped += nbytes;
4577 success = 1;
4582 return success;
4586 /* Set or reset variables holding references to mapped regions. If
4587 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4588 non-zero, set all variables to the start of the user-areas
4589 of mapped regions.
4591 This function is called from Fdump_emacs to ensure that the dumped
4592 Emacs doesn't contain references to memory that won't be mapped
4593 when Emacs starts. */
4595 void
4596 mmap_set_vars (restore_p)
4597 int restore_p;
4599 struct mmap_region *r;
4601 if (restore_p)
4603 mmap_regions = mmap_regions_1;
4604 mmap_fd = mmap_fd_1;
4605 for (r = mmap_regions; r; r = r->next)
4606 *r->var = MMAP_USER_AREA (r);
4608 else
4610 for (r = mmap_regions; r; r = r->next)
4611 *r->var = NULL;
4612 mmap_regions_1 = mmap_regions;
4613 mmap_regions = NULL;
4614 mmap_fd_1 = mmap_fd;
4615 mmap_fd = -1;
4620 /* Allocate a block of storage large enough to hold NBYTES bytes of
4621 data. A pointer to the data is returned in *VAR. VAR is thus the
4622 address of some variable which will use the data area.
4624 The allocation of 0 bytes is valid.
4626 If we can't allocate the necessary memory, set *VAR to null, and
4627 return null. */
4629 static POINTER_TYPE *
4630 mmap_alloc (var, nbytes)
4631 POINTER_TYPE **var;
4632 size_t nbytes;
4634 void *p;
4635 size_t map;
4637 mmap_init ();
4639 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4640 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4641 mmap_fd, 0);
4643 if (p == MAP_FAILED)
4645 if (errno != ENOMEM)
4646 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4647 p = NULL;
4649 else
4651 struct mmap_region *r = (struct mmap_region *) p;
4653 r->nbytes_specified = nbytes;
4654 r->nbytes_mapped = map;
4655 r->var = var;
4656 r->prev = NULL;
4657 r->next = mmap_regions;
4658 if (r->next)
4659 r->next->prev = r;
4660 mmap_regions = r;
4662 p = MMAP_USER_AREA (p);
4665 return *var = p;
4669 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4670 resize it to size NBYTES. Change *VAR to reflect the new block,
4671 and return this value. If more memory cannot be allocated, then
4672 leave *VAR unchanged, and return null. */
4674 static POINTER_TYPE *
4675 mmap_realloc (var, nbytes)
4676 POINTER_TYPE **var;
4677 size_t nbytes;
4679 POINTER_TYPE *result;
4681 mmap_init ();
4683 if (*var == NULL)
4684 result = mmap_alloc (var, nbytes);
4685 else if (nbytes == 0)
4687 mmap_free (var);
4688 result = mmap_alloc (var, nbytes);
4690 else
4692 struct mmap_region *r = MMAP_REGION (*var);
4693 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4695 if (room < nbytes)
4697 /* Must enlarge. */
4698 POINTER_TYPE *old_ptr = *var;
4700 /* Try to map additional pages at the end of the region.
4701 If that fails, allocate a new region, copy data
4702 from the old region, then free it. */
4703 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4704 / mmap_page_size)))
4706 r->nbytes_specified = nbytes;
4707 *var = result = old_ptr;
4709 else if (mmap_alloc (var, nbytes))
4711 memcpy (*var, old_ptr, r->nbytes_specified);
4712 mmap_free_1 (MMAP_REGION (old_ptr));
4713 result = *var;
4714 r = MMAP_REGION (result);
4715 r->nbytes_specified = nbytes;
4717 else
4719 *var = old_ptr;
4720 result = NULL;
4723 else if (room - nbytes >= mmap_page_size)
4725 /* Shrinking by at least a page. Let's give some
4726 memory back to the system.
4728 The extra parens are to make the division happens first,
4729 on positive values, so we know it will round towards
4730 zero. */
4731 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4732 result = *var;
4733 r->nbytes_specified = nbytes;
4735 else
4737 /* Leave it alone. */
4738 result = *var;
4739 r->nbytes_specified = nbytes;
4743 return result;
4747 /* Free a block of relocatable storage whose data is pointed to by
4748 PTR. Store 0 in *PTR to show there's no block allocated. */
4750 static void
4751 mmap_free (var)
4752 POINTER_TYPE **var;
4754 mmap_init ();
4756 if (*var)
4758 mmap_free_1 (MMAP_REGION (*var));
4759 *var = NULL;
4764 /* Perform necessary intializations for the use of mmap. */
4766 static void
4767 mmap_init ()
4769 #if MAP_ANON == 0
4770 /* The value of mmap_fd is initially 0 in temacs, and -1
4771 in a dumped Emacs. */
4772 if (mmap_fd <= 0)
4774 /* No anonymous mmap -- we need the file descriptor. */
4775 mmap_fd = open ("/dev/zero", O_RDONLY);
4776 if (mmap_fd == -1)
4777 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4779 #endif /* MAP_ANON == 0 */
4781 if (mmap_initialized_p)
4782 return;
4783 mmap_initialized_p = 1;
4785 #if MAP_ANON != 0
4786 mmap_fd = -1;
4787 #endif
4789 mmap_page_size = getpagesize ();
4792 #endif /* USE_MMAP_FOR_BUFFERS */
4796 /***********************************************************************
4797 Buffer-text Allocation
4798 ***********************************************************************/
4800 #ifdef REL_ALLOC
4801 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4802 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4803 extern void r_alloc_free (POINTER_TYPE **ptr);
4804 #endif /* REL_ALLOC */
4807 /* Allocate NBYTES bytes for buffer B's text buffer. */
4809 static void
4810 alloc_buffer_text (struct buffer *b, size_t nbytes)
4812 POINTER_TYPE *p;
4814 BLOCK_INPUT;
4815 #if defined USE_MMAP_FOR_BUFFERS
4816 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4817 #elif defined REL_ALLOC
4818 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4819 #else
4820 p = xmalloc (nbytes);
4821 #endif
4823 if (p == NULL)
4825 UNBLOCK_INPUT;
4826 memory_full (nbytes);
4829 b->text->beg = (unsigned char *) p;
4830 UNBLOCK_INPUT;
4833 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4834 shrink it. */
4836 void
4837 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4839 POINTER_TYPE *p;
4840 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4841 + delta);
4842 BLOCK_INPUT;
4843 #if defined USE_MMAP_FOR_BUFFERS
4844 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4845 #elif defined REL_ALLOC
4846 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4847 #else
4848 p = xrealloc (b->text->beg, nbytes);
4849 #endif
4851 if (p == NULL)
4853 UNBLOCK_INPUT;
4854 memory_full (nbytes);
4857 BUF_BEG_ADDR (b) = (unsigned char *) p;
4858 UNBLOCK_INPUT;
4862 /* Free buffer B's text buffer. */
4864 static void
4865 free_buffer_text (struct buffer *b)
4867 BLOCK_INPUT;
4869 #if defined USE_MMAP_FOR_BUFFERS
4870 mmap_free ((POINTER_TYPE **) &b->text->beg);
4871 #elif defined REL_ALLOC
4872 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4873 #else
4874 xfree (b->text->beg);
4875 #endif
4877 BUF_BEG_ADDR (b) = NULL;
4878 UNBLOCK_INPUT;
4883 /***********************************************************************
4884 Initialization
4885 ***********************************************************************/
4887 void
4888 init_buffer_once (void)
4890 int idx;
4892 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4894 /* Make sure all markable slots in buffer_defaults
4895 are initialized reasonably, so mark_buffer won't choke. */
4896 reset_buffer (&buffer_defaults);
4897 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4898 reset_buffer_local_variables (&buffer_defaults, 1);
4899 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4900 reset_buffer (&buffer_local_symbols);
4901 reset_buffer_local_variables (&buffer_local_symbols, 1);
4902 /* Prevent GC from getting confused. */
4903 buffer_defaults.text = &buffer_defaults.own_text;
4904 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4905 BUF_INTERVALS (&buffer_defaults) = 0;
4906 BUF_INTERVALS (&buffer_local_symbols) = 0;
4907 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4908 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4909 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4910 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4912 /* Set up the default values of various buffer slots. */
4913 /* Must do these before making the first buffer! */
4915 /* real setup is done in bindings.el */
4916 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4917 BVAR (&buffer_defaults, header_line_format) = Qnil;
4918 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4919 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4920 BVAR (&buffer_defaults, case_fold_search) = Qt;
4921 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4922 BVAR (&buffer_defaults, selective_display) = Qnil;
4923 #ifndef old
4924 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4925 #endif
4926 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4927 BVAR (&buffer_defaults, display_table) = Qnil;
4928 BVAR (&buffer_defaults, undo_list) = Qnil;
4929 BVAR (&buffer_defaults, mark_active) = Qnil;
4930 BVAR (&buffer_defaults, file_format) = Qnil;
4931 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4932 buffer_defaults.overlays_before = NULL;
4933 buffer_defaults.overlays_after = NULL;
4934 buffer_defaults.overlay_center = BEG;
4936 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4937 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4938 BVAR (&buffer_defaults, word_wrap) = Qnil;
4939 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4940 BVAR (&buffer_defaults, bidi_display_reordering) = Qnil;
4941 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4942 BVAR (&buffer_defaults, cursor_type) = Qt;
4943 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4944 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4946 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4947 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4948 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4949 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4950 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4951 BVAR (&buffer_defaults, file_truename) = Qnil;
4952 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4953 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4954 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4955 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4956 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4957 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4958 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4959 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4960 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4961 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4962 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4963 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4964 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4965 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4966 BVAR (&buffer_defaults, display_time) = Qnil;
4968 /* Assign the local-flags to the slots that have default values.
4969 The local flag is a bit that is used in the buffer
4970 to say that it has its own local value for the slot.
4971 The local flag bits are in the local_var_flags slot of the buffer. */
4973 /* Nothing can work if this isn't true */
4974 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4976 /* 0 means not a lisp var, -1 means always local, else mask */
4977 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4978 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4979 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4980 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4981 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4982 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4983 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4984 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4985 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4986 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4987 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4988 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4989 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4990 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4991 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4992 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4993 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4994 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4995 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4997 idx = 1;
4998 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4999 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
5004 #ifndef old
5005 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
5006 #endif
5007 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
5009 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
5010 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
5011 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
5014 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
5015 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
5016 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
5017 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
5018 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
5019 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
5020 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
5021 /* Make this one a permanent local. */
5022 buffer_permanent_local_flags[idx++] = 1;
5023 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5024 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5025 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5026 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5027 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5028 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5029 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5030 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5031 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5032 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5033 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5034 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5035 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5036 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5037 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5038 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5039 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5041 /* Need more room? */
5042 if (idx >= MAX_PER_BUFFER_VARS)
5043 abort ();
5044 last_per_buffer_idx = idx;
5046 Vbuffer_alist = Qnil;
5047 current_buffer = 0;
5048 all_buffers = 0;
5050 QSFundamental = make_pure_c_string ("Fundamental");
5052 Qfundamental_mode = intern_c_string ("fundamental-mode");
5053 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5055 Qmode_class = intern_c_string ("mode-class");
5057 Qprotected_field = intern_c_string ("protected-field");
5059 Qpermanent_local = intern_c_string ("permanent-local");
5061 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5062 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5064 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5066 /* super-magic invisible buffer */
5067 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5068 Vbuffer_alist = Qnil;
5070 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5072 inhibit_modification_hooks = 0;
5075 void
5076 init_buffer (void)
5078 char *pwd;
5079 Lisp_Object temp;
5080 int len;
5082 #ifdef USE_MMAP_FOR_BUFFERS
5084 /* When using the ralloc implementation based on mmap(2), buffer
5085 text pointers will have been set to null in the dumped Emacs.
5086 Map new memory. */
5087 struct buffer *b;
5089 for (b = all_buffers; b; b = b->header.next.buffer)
5090 if (b->text->beg == NULL)
5091 enlarge_buffer_text (b, 0);
5093 #endif /* USE_MMAP_FOR_BUFFERS */
5095 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5096 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5097 Fset_buffer_multibyte (Qnil);
5099 pwd = get_current_dir_name ();
5101 if (!pwd)
5102 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5104 /* Maybe this should really use some standard subroutine
5105 whose definition is filename syntax dependent. */
5106 len = strlen (pwd);
5107 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5109 /* Grow buffer to add directory separator and '\0'. */
5110 pwd = (char *) realloc (pwd, len + 2);
5111 if (!pwd)
5112 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5113 pwd[len] = DIRECTORY_SEP;
5114 pwd[len + 1] = '\0';
5117 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5118 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5119 /* At this moment, we still don't know how to decode the
5120 directory name. So, we keep the bytes in multibyte form so
5121 that ENCODE_FILE correctly gets the original bytes. */
5122 BVAR (current_buffer, directory)
5123 = string_to_multibyte (BVAR (current_buffer, directory));
5125 /* Add /: to the front of the name
5126 if it would otherwise be treated as magic. */
5127 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5128 if (! NILP (temp)
5129 /* If the default dir is just /, TEMP is non-nil
5130 because of the ange-ftp completion handler.
5131 However, it is not necessary to turn / into /:/.
5132 So avoid doing that. */
5133 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5134 BVAR (current_buffer, directory)
5135 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5137 temp = get_minibuffer (0);
5138 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5140 free (pwd);
5143 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5144 Object stored in the current buffer. address is the address of the slot
5145 in the buffer that is current now. */
5147 /* TYPE is nil for a general Lisp variable.
5148 An integer specifies a type; then only Lisp values
5149 with that type code are allowed (except that nil is allowed too).
5150 LNAME is the Lisp-level variable name.
5151 VNAME is the name of the buffer slot.
5152 DOC is a dummy where you write the doc string as a comment. */
5153 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5154 do { \
5155 static struct Lisp_Buffer_Objfwd bo_fwd; \
5156 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5157 } while (0)
5159 static void
5160 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5161 Lisp_Object *address, Lisp_Object type)
5163 struct Lisp_Symbol *sym;
5164 int offset;
5166 sym = XSYMBOL (intern (namestring));
5167 offset = (char *)address - (char *)current_buffer;
5169 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5170 bo_fwd->offset = offset;
5171 bo_fwd->slottype = type;
5172 sym->declared_special = 1;
5173 sym->redirect = SYMBOL_FORWARDED;
5175 /* I tried to do the job without a cast, but it seems impossible.
5176 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5177 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5179 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5181 if (PER_BUFFER_IDX (offset) == 0)
5182 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5183 slot of buffer_local_flags */
5184 abort ();
5188 /* initialize the buffer routines */
5189 void
5190 syms_of_buffer (void)
5192 staticpro (&last_overlay_modification_hooks);
5193 last_overlay_modification_hooks
5194 = Fmake_vector (make_number (10), Qnil);
5196 staticpro (&Vbuffer_defaults);
5197 staticpro (&Vbuffer_local_symbols);
5198 staticpro (&Qfundamental_mode);
5199 staticpro (&Qmode_class);
5200 staticpro (&QSFundamental);
5201 staticpro (&Vbuffer_alist);
5202 staticpro (&Qprotected_field);
5203 staticpro (&Qpermanent_local);
5204 Qpermanent_local_hook = intern_c_string ("permanent-local-hook");
5205 staticpro (&Qpermanent_local_hook);
5206 staticpro (&Qkill_buffer_hook);
5207 Qoverlayp = intern_c_string ("overlayp");
5208 staticpro (&Qoverlayp);
5209 Qevaporate = intern_c_string ("evaporate");
5210 staticpro (&Qevaporate);
5211 Qmodification_hooks = intern_c_string ("modification-hooks");
5212 staticpro (&Qmodification_hooks);
5213 Qinsert_in_front_hooks = intern_c_string ("insert-in-front-hooks");
5214 staticpro (&Qinsert_in_front_hooks);
5215 Qinsert_behind_hooks = intern_c_string ("insert-behind-hooks");
5216 staticpro (&Qinsert_behind_hooks);
5217 Qget_file_buffer = intern_c_string ("get-file-buffer");
5218 staticpro (&Qget_file_buffer);
5219 Qpriority = intern_c_string ("priority");
5220 staticpro (&Qpriority);
5221 Qbefore_string = intern_c_string ("before-string");
5222 staticpro (&Qbefore_string);
5223 Qafter_string = intern_c_string ("after-string");
5224 staticpro (&Qafter_string);
5225 Qfirst_change_hook = intern_c_string ("first-change-hook");
5226 staticpro (&Qfirst_change_hook);
5227 Qbefore_change_functions = intern_c_string ("before-change-functions");
5228 staticpro (&Qbefore_change_functions);
5229 Qafter_change_functions = intern_c_string ("after-change-functions");
5230 staticpro (&Qafter_change_functions);
5231 /* The next one is initialized in init_buffer_once. */
5232 staticpro (&Qucs_set_table_for_input);
5234 Qkill_buffer_query_functions = intern_c_string ("kill-buffer-query-functions");
5235 staticpro (&Qkill_buffer_query_functions);
5237 Fput (Qprotected_field, Qerror_conditions,
5238 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5239 Fput (Qprotected_field, Qerror_message,
5240 make_pure_c_string ("Attempt to modify a protected field"));
5242 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5243 mode_line_format,
5244 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5245 This is the same as (default-value 'mode-line-format). */);
5247 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5248 header_line_format,
5249 doc: /* Default value of `header-line-format' for buffers that don't override it.
5250 This is the same as (default-value 'header-line-format). */);
5252 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5253 doc: /* Default value of `cursor-type' for buffers that don't override it.
5254 This is the same as (default-value 'cursor-type). */);
5256 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5257 extra_line_spacing,
5258 doc: /* Default value of `line-spacing' for buffers that don't override it.
5259 This is the same as (default-value 'line-spacing). */);
5261 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5262 cursor_in_non_selected_windows,
5263 doc: /* Default value of `cursor-in-non-selected-windows'.
5264 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5266 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5267 abbrev_mode,
5268 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5269 This is the same as (default-value 'abbrev-mode). */);
5271 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5272 ctl_arrow,
5273 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5274 This is the same as (default-value 'ctl-arrow). */);
5276 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5277 enable_multibyte_characters,
5278 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5279 This is the same as (default-value 'enable-multibyte-characters). */);
5281 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5282 buffer_file_coding_system,
5283 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5284 This is the same as (default-value 'buffer-file-coding-system). */);
5286 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5287 truncate_lines,
5288 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5289 This is the same as (default-value 'truncate-lines). */);
5291 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5292 fill_column,
5293 doc: /* Default value of `fill-column' for buffers that do not override it.
5294 This is the same as (default-value 'fill-column). */);
5296 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5297 left_margin,
5298 doc: /* Default value of `left-margin' for buffers that do not override it.
5299 This is the same as (default-value 'left-margin). */);
5301 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5302 tab_width,
5303 doc: /* Default value of `tab-width' for buffers that do not override it.
5304 This is the same as (default-value 'tab-width). */);
5306 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5307 case_fold_search,
5308 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5309 This is the same as (default-value 'case-fold-search). */);
5311 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5312 left_margin_cols,
5313 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5314 This is the same as (default-value 'left-margin-width). */);
5316 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5317 right_margin_cols,
5318 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5319 This is the same as (default-value 'right-margin-width). */);
5321 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5322 left_fringe_width,
5323 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5324 This is the same as (default-value 'left-fringe-width). */);
5326 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5327 right_fringe_width,
5328 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5329 This is the same as (default-value 'right-fringe-width). */);
5331 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5332 fringes_outside_margins,
5333 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5334 This is the same as (default-value 'fringes-outside-margins). */);
5336 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5337 scroll_bar_width,
5338 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5339 This is the same as (default-value 'scroll-bar-width). */);
5341 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5342 vertical_scroll_bar_type,
5343 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5344 This is the same as (default-value 'vertical-scroll-bar). */);
5346 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5347 indicate_empty_lines,
5348 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5349 This is the same as (default-value 'indicate-empty-lines). */);
5351 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5352 indicate_buffer_boundaries,
5353 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5354 This is the same as (default-value 'indicate-buffer-boundaries). */);
5356 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5357 fringe_indicator_alist,
5358 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5359 This is the same as (default-value 'fringe-indicator-alist'). */);
5361 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5362 fringe_cursor_alist,
5363 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5364 This is the same as (default-value 'fringe-cursor-alist'). */);
5366 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5367 scroll_up_aggressively,
5368 doc: /* Default value of `scroll-up-aggressively'.
5369 This value applies in buffers that don't have their own local values.
5370 This is the same as (default-value 'scroll-up-aggressively). */);
5372 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5373 scroll_down_aggressively,
5374 doc: /* Default value of `scroll-down-aggressively'.
5375 This value applies in buffers that don't have their own local values.
5376 This is the same as (default-value 'scroll-down-aggressively). */);
5378 DEFVAR_PER_BUFFER ("header-line-format",
5379 &BVAR (current_buffer, header_line_format),
5380 Qnil,
5381 doc: /* Analogous to `mode-line-format', but controls the header line.
5382 The header line appears, optionally, at the top of a window;
5383 the mode line appears at the bottom. */);
5385 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5386 Qnil,
5387 doc: /* Template for displaying mode line for current buffer.
5388 Each buffer has its own value of this variable.
5389 Value may be nil, a string, a symbol or a list or cons cell.
5390 A value of nil means don't display a mode line.
5391 For a symbol, its value is used (but it is ignored if t or nil).
5392 A string appearing directly as the value of a symbol is processed verbatim
5393 in that the %-constructs below are not recognized.
5394 Note that unless the symbol is marked as a `risky-local-variable', all
5395 properties in any strings, as well as all :eval and :propertize forms
5396 in the value of that symbol will be ignored.
5397 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5398 is used as a mode line element. Be careful--FORM should not load any files,
5399 because that can cause an infinite recursion.
5400 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5401 with the specified properties PROPS applied.
5402 For a list whose car is a symbol, the symbol's value is taken,
5403 and if that is non-nil, the cadr of the list is processed recursively.
5404 Otherwise, the caddr of the list (if there is one) is processed.
5405 For a list whose car is a string or list, each element is processed
5406 recursively and the results are effectively concatenated.
5407 For a list whose car is an integer, the cdr of the list is processed
5408 and padded (if the number is positive) or truncated (if negative)
5409 to the width specified by that number.
5410 A string is printed verbatim in the mode line except for %-constructs:
5411 (%-constructs are allowed when the string is the entire mode-line-format
5412 or when it is found in a cons-cell or a list)
5413 %b -- print buffer name. %f -- print visited file name.
5414 %F -- print frame name.
5415 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5416 %& is like %*, but ignore read-only-ness.
5417 % means buffer is read-only and * means it is modified.
5418 For a modified read-only buffer, %* gives % and %+ gives *.
5419 %s -- print process status. %l -- print the current line number.
5420 %c -- print the current column number (this makes editing slower).
5421 To make the column number update correctly in all cases,
5422 `column-number-mode' must be non-nil.
5423 %i -- print the size of the buffer.
5424 %I -- like %i, but use k, M, G, etc., to abbreviate.
5425 %p -- print percent of buffer above top of window, or Top, Bot or All.
5426 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5427 or print Bottom or All.
5428 %n -- print Narrow if appropriate.
5429 %t -- visited file is text or binary (if OS supports this distinction).
5430 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5431 %Z -- like %z, but including the end-of-line format.
5432 %e -- print error message about full memory.
5433 %@ -- print @ or hyphen. @ means that default-directory is on a
5434 remote machine.
5435 %[ -- print one [ for each recursive editing level. %] similar.
5436 %% -- print %. %- -- print infinitely many dashes.
5437 Decimal digits after the % specify field width to which to pad. */);
5439 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5440 doc: /* *Value of `major-mode' for new buffers. */);
5442 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5443 make_number (Lisp_Symbol),
5444 doc: /* Symbol for current buffer's major mode.
5445 The default value (normally `fundamental-mode') affects new buffers.
5446 A value of nil means to use the current buffer's major mode, provided
5447 it is not marked as "special".
5449 When a mode is used by default, `find-file' switches to it before it
5450 reads the contents into the buffer and before it finishes setting up
5451 the buffer. Thus, the mode and its hooks should not expect certain
5452 variables such as `buffer-read-only' and `buffer-file-coding-system'
5453 to be set up. */);
5455 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5456 Qnil,
5457 doc: /* Pretty name of current buffer's major mode.
5458 Usually a string, but can use any of the constructs for `mode-line-format',
5459 which see.
5460 Format with `format-mode-line' to produce a string value. */);
5462 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5463 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5465 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5466 doc: /* Non-nil if Abbrev mode is enabled.
5467 Use the command `abbrev-mode' to change this variable. */);
5469 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5470 Qnil,
5471 doc: /* *Non-nil if searches and matches should ignore case. */);
5473 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5474 make_number (LISP_INT_TAG),
5475 doc: /* *Column beyond which automatic line-wrapping should happen.
5476 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5478 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5479 make_number (LISP_INT_TAG),
5480 doc: /* *Column for the default `indent-line-function' to indent to.
5481 Linefeed indents to this column in Fundamental mode. */);
5483 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5484 make_number (LISP_INT_TAG),
5485 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5486 This should be an integer greater than zero. */);
5488 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5489 doc: /* *Non-nil means display control chars with uparrow.
5490 A value of nil means use backslash and octal digits.
5491 This variable does not apply to characters whose display is specified
5492 in the current display table (if there is one). */);
5494 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5495 &BVAR (current_buffer, enable_multibyte_characters),
5496 Qnil,
5497 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5498 Otherwise they are regarded as unibyte. This affects the display,
5499 file I/O and the behavior of various editing commands.
5501 This variable is buffer-local but you cannot set it directly;
5502 use the function `set-buffer-multibyte' to change a buffer's representation.
5503 Changing its default value with `setq-default' is supported.
5504 See also variable `default-enable-multibyte-characters' and Info node
5505 `(elisp)Text Representations'. */);
5506 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5508 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5509 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5510 doc: /* Coding system to be used for encoding the buffer contents on saving.
5511 This variable applies to saving the buffer, and also to `write-region'
5512 and other functions that use `write-region'.
5513 It does not apply to sending output to subprocesses, however.
5515 If this is nil, the buffer is saved without any code conversion
5516 unless some coding system is specified in `file-coding-system-alist'
5517 for the buffer file.
5519 If the text to be saved cannot be encoded as specified by this variable,
5520 an alternative encoding is selected by `select-safe-coding-system', which see.
5522 The variable `coding-system-for-write', if non-nil, overrides this variable.
5524 This variable is never applied to a way of decoding a file while reading it. */);
5526 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5527 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5528 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5530 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5531 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5532 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5534 If this is nil (the default), the direction of each paragraph is
5535 determined by the first strong directional character of its text.
5536 The values of `right-to-left' and `left-to-right' override that.
5537 Any other value is treated as nil.
5539 This variable has no effect unless the buffer's value of
5540 \`bidi-display-reordering' is non-nil. */);
5542 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5543 doc: /* *Non-nil means do not display continuation lines.
5544 Instead, give each line of text just one screen line.
5546 Note that this is overridden by the variable
5547 `truncate-partial-width-windows' if that variable is non-nil
5548 and this buffer is not full-frame width. */);
5550 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5551 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5552 When word-wrapping is on, continuation lines are wrapped at the space
5553 or tab character nearest to the right window edge.
5554 If nil, continuation lines are wrapped at the right screen edge.
5556 This variable has no effect if long lines are truncated (see
5557 `truncate-lines' and `truncate-partial-width-windows'). If you use
5558 word-wrapping, you might want to reduce the value of
5559 `truncate-partial-width-windows', since wrapping can make text readable
5560 in narrower windows. */);
5562 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5563 make_number (Lisp_String),
5564 doc: /* Name of default directory of current buffer. Should end with slash.
5565 To interactively change the default directory, use command `cd'. */);
5567 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5568 Qnil,
5569 doc: /* Function called (if non-nil) to perform auto-fill.
5570 It is called after self-inserting any character specified in
5571 the `auto-fill-chars' table.
5572 NOTE: This variable is not a hook;
5573 its value may not be a list of functions. */);
5575 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5576 make_number (Lisp_String),
5577 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5579 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5580 make_number (Lisp_String),
5581 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5582 The truename of a file is calculated by `file-truename'
5583 and then abbreviated with `abbreviate-file-name'. */);
5585 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5586 &BVAR (current_buffer, auto_save_file_name),
5587 make_number (Lisp_String),
5588 doc: /* Name of file for auto-saving current buffer.
5589 If it is nil, that means don't auto-save this buffer. */);
5591 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5592 doc: /* Non-nil if this buffer is read-only. */);
5594 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5595 doc: /* Non-nil if this buffer's file has been backed up.
5596 Backing up is done before the first time the file is saved. */);
5598 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5599 make_number (LISP_INT_TAG),
5600 doc: /* Length of current buffer when last read in, saved or auto-saved.
5601 0 initially.
5602 -1 means auto-saving turned off until next real save.
5604 If you set this to -2, that means don't turn off auto-saving in this buffer
5605 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5606 you probably should set this to -2 in that buffer. */);
5608 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5609 Qnil,
5610 doc: /* Non-nil enables selective display.
5611 An integer N as value means display only lines
5612 that start with less than N columns of space.
5613 A value of t means that the character ^M makes itself and
5614 all the rest of the line invisible; also, when saving the buffer
5615 in a file, save the ^M as a newline. */);
5617 #ifndef old
5618 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5619 &BVAR (current_buffer, selective_display_ellipses),
5620 Qnil,
5621 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5622 #endif
5624 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5625 doc: /* Non-nil if self-insertion should replace existing text.
5626 The value should be one of `overwrite-mode-textual',
5627 `overwrite-mode-binary', or nil.
5628 If it is `overwrite-mode-textual', self-insertion still
5629 inserts at the end of a line, and inserts when point is before a tab,
5630 until the tab is filled in.
5631 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5633 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5634 Qnil,
5635 doc: /* Display table that controls display of the contents of current buffer.
5637 If this variable is nil, the value of `standard-display-table' is used.
5638 Each window can have its own, overriding display table, see
5639 `set-window-display-table' and `window-display-table'.
5641 The display table is a char-table created with `make-display-table'.
5642 A char-table is an array indexed by character codes. Normal array
5643 primitives `aref' and `aset' can be used to access elements of a char-table.
5645 Each of the char-table elements control how to display the corresponding
5646 text character: the element at index C in the table says how to display
5647 the character whose code is C. Each element should be a vector of
5648 characters or nil. The value nil means display the character in the
5649 default fashion; otherwise, the characters from the vector are delivered
5650 to the screen instead of the original character.
5652 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5653 to display a capital Y instead of each X character.
5655 In addition, a char-table has six extra slots to control the display of:
5657 the end of a truncated screen line (extra-slot 0, a single character);
5658 the end of a continued line (extra-slot 1, a single character);
5659 the escape character used to display character codes in octal
5660 (extra-slot 2, a single character);
5661 the character used as an arrow for control characters (extra-slot 3,
5662 a single character);
5663 the decoration indicating the presence of invisible lines (extra-slot 4,
5664 a vector of characters);
5665 the character used to draw the border between side-by-side windows
5666 (extra-slot 5, a single character).
5668 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5670 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5671 Qnil,
5672 doc: /* *Width of left marginal area for display of a buffer.
5673 A value of nil means no marginal area. */);
5675 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5676 Qnil,
5677 doc: /* *Width of right marginal area for display of a buffer.
5678 A value of nil means no marginal area. */);
5680 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5681 Qnil,
5682 doc: /* *Width of this buffer's left fringe (in pixels).
5683 A value of 0 means no left fringe is shown in this buffer's window.
5684 A value of nil means to use the left fringe width from the window's frame. */);
5686 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5687 Qnil,
5688 doc: /* *Width of this buffer's right fringe (in pixels).
5689 A value of 0 means no right fringe is shown in this buffer's window.
5690 A value of nil means to use the right fringe width from the window's frame. */);
5692 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5693 Qnil,
5694 doc: /* *Non-nil means to display fringes outside display margins.
5695 A value of nil means to display fringes between margins and buffer text. */);
5697 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5698 Qnil,
5699 doc: /* *Width of this buffer's scroll bars in pixels.
5700 A value of nil means to use the scroll bar width from the window's frame. */);
5702 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5703 Qnil,
5704 doc: /* *Position of this buffer's vertical scroll bar.
5705 The value takes effect whenever you tell a window to display this buffer;
5706 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5708 A value of `left' or `right' means put the vertical scroll bar at that side
5709 of the window; a value of nil means don't show any vertical scroll bars.
5710 A value of t (the default) means do whatever the window's frame specifies. */);
5712 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5713 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5714 doc: /* *Visually indicate empty lines after the buffer end.
5715 If non-nil, a bitmap is displayed in the left fringe of a window on
5716 window-systems. */);
5718 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5719 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5720 doc: /* *Visually indicate buffer boundaries and scrolling.
5721 If non-nil, the first and last line of the buffer are marked in the fringe
5722 of a window on window-systems with angle bitmaps, or if the window can be
5723 scrolled, the top and bottom line of the window are marked with up and down
5724 arrow bitmaps.
5726 If value is a symbol `left' or `right', both angle and arrow bitmaps
5727 are displayed in the left or right fringe, resp. Any other value
5728 that doesn't look like an alist means display the angle bitmaps in
5729 the left fringe but no arrows.
5731 You can exercise more precise control by using an alist as the
5732 value. Each alist element (INDICATOR . POSITION) specifies
5733 where to show one of the indicators. INDICATOR is one of `top',
5734 `bottom', `up', `down', or t, which specifies the default position,
5735 and POSITION is one of `left', `right', or nil, meaning do not show
5736 this indicator.
5738 For example, ((top . left) (t . right)) places the top angle bitmap in
5739 left fringe, the bottom angle bitmap in right fringe, and both arrow
5740 bitmaps in right fringe. To show just the angle bitmaps in the left
5741 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5743 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5744 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5745 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5746 The value is an alist where each element (INDICATOR . BITMAPS)
5747 specifies the fringe bitmaps used to display a specific logical
5748 fringe indicator.
5750 INDICATOR specifies the logical indicator type which is one of the
5751 following symbols: `truncation' , `continuation', `overlay-arrow',
5752 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5754 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5755 the actual bitmap shown in the left or right fringe for the logical
5756 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5757 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5758 are used only for the `bottom' and `top-bottom' indicators when the
5759 last (only) line has no final newline. BITMAPS may also be a single
5760 symbol which is used in both left and right fringes. */);
5762 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5763 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5764 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5765 The value is an alist where each element (CURSOR . BITMAP)
5766 specifies the fringe bitmaps used to display a specific logical
5767 cursor type in the fringe.
5769 CURSOR specifies the logical cursor type which is one of the following
5770 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5771 one is used to show a hollow cursor on narrow lines display lines
5772 where the normal hollow cursor will not fit.
5774 BITMAP is the corresponding fringe bitmap shown for the logical
5775 cursor type. */);
5777 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5778 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5779 doc: /* How far to scroll windows upward.
5780 If you move point off the bottom, the window scrolls automatically.
5781 This variable controls how far it scrolls. The value nil, the default,
5782 means scroll to center point. A fraction means scroll to put point
5783 that fraction of the window's height from the bottom of the window.
5784 When the value is 0.0, point goes at the bottom line, which in the
5785 simple case that you moved off with C-f means scrolling just one line.
5786 1.0 means point goes at the top, so that in that simple case, the
5787 window scrolls by a full window height. Meaningful values are
5788 between 0.0 and 1.0, inclusive. */);
5790 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5791 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5792 doc: /* How far to scroll windows downward.
5793 If you move point off the top, the window scrolls automatically.
5794 This variable controls how far it scrolls. The value nil, the default,
5795 means scroll to center point. A fraction means scroll to put point
5796 that fraction of the window's height from the top of the window.
5797 When the value is 0.0, point goes at the top line, which in the
5798 simple case that you moved off with C-b means scrolling just one line.
5799 1.0 means point goes at the bottom, so that in that simple case, the
5800 window scrolls by a full window height. Meaningful values are
5801 between 0.0 and 1.0, inclusive. */);
5803 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5804 "Don't ask.");
5807 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5808 doc: /* List of functions to call before each text change.
5809 Two arguments are passed to each function: the positions of
5810 the beginning and end of the range of old text to be changed.
5811 \(For an insertion, the beginning and end are at the same place.)
5812 No information is given about the length of the text after the change.
5814 Buffer changes made while executing the `before-change-functions'
5815 don't call any before-change or after-change functions.
5816 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5818 If an unhandled error happens in running these functions,
5819 the variable's value remains nil. That prevents the error
5820 from happening repeatedly and making Emacs nonfunctional. */);
5821 Vbefore_change_functions = Qnil;
5823 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5824 doc: /* List of functions to call after each text change.
5825 Three arguments are passed to each function: the positions of
5826 the beginning and end of the range of changed text,
5827 and the length in bytes of the pre-change text replaced by that range.
5828 \(For an insertion, the pre-change length is zero;
5829 for a deletion, that length is the number of bytes deleted,
5830 and the post-change beginning and end are at the same place.)
5832 Buffer changes made while executing the `after-change-functions'
5833 don't call any before-change or after-change functions.
5834 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5836 If an unhandled error happens in running these functions,
5837 the variable's value remains nil. That prevents the error
5838 from happening repeatedly and making Emacs nonfunctional. */);
5839 Vafter_change_functions = Qnil;
5841 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5842 doc: /* A list of functions to call before changing a buffer which is unmodified.
5843 The functions are run using the `run-hooks' function. */);
5844 Vfirst_change_hook = Qnil;
5846 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5847 doc: /* List of undo entries in current buffer.
5848 Recent changes come first; older changes follow newer.
5850 An entry (BEG . END) represents an insertion which begins at
5851 position BEG and ends at position END.
5853 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5854 from (abs POSITION). If POSITION is positive, point was at the front
5855 of the text being deleted; if negative, point was at the end.
5857 An entry (t HIGH . LOW) indicates that the buffer previously had
5858 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5859 of the visited file's modification time, as of that time. If the
5860 modification time of the most recent save is different, this entry is
5861 obsolete.
5863 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5864 was modified between BEG and END. PROPERTY is the property name,
5865 and VALUE is the old value.
5867 An entry (apply FUN-NAME . ARGS) means undo the change with
5868 \(apply FUN-NAME ARGS).
5870 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5871 in the active region. BEG and END is the range affected by this entry
5872 and DELTA is the number of bytes added or deleted in that range by
5873 this change.
5875 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5876 was adjusted in position by the offset DISTANCE (an integer).
5878 An entry of the form POSITION indicates that point was at the buffer
5879 location given by the integer. Undoing an entry of this form places
5880 point at POSITION.
5882 Entries with value `nil' mark undo boundaries. The undo command treats
5883 the changes between two undo boundaries as a single step to be undone.
5885 If the value of the variable is t, undo information is not recorded. */);
5887 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5888 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5890 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5891 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5893 Normally, the line-motion functions work by scanning the buffer for
5894 newlines. Columnar operations (like `move-to-column' and
5895 `compute-motion') also work by scanning the buffer, summing character
5896 widths as they go. This works well for ordinary text, but if the
5897 buffer's lines are very long (say, more than 500 characters), these
5898 motion functions will take longer to execute. Emacs may also take
5899 longer to update the display.
5901 If `cache-long-line-scans' is non-nil, these motion functions cache the
5902 results of their scans, and consult the cache to avoid rescanning
5903 regions of the buffer until the text is modified. The caches are most
5904 beneficial when they prevent the most searching---that is, when the
5905 buffer contains long lines and large regions of characters with the
5906 same, fixed screen width.
5908 When `cache-long-line-scans' is non-nil, processing short lines will
5909 become slightly slower (because of the overhead of consulting the
5910 cache), and the caches will use memory roughly proportional to the
5911 number of newlines and characters whose screen width varies.
5913 The caches require no explicit maintenance; their accuracy is
5914 maintained internally by the Emacs primitives. Enabling or disabling
5915 the cache should not affect the behavior of any of the motion
5916 functions; it should only affect their performance. */);
5918 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5919 doc: /* Value of point before the last series of scroll operations, or nil. */);
5921 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5922 doc: /* List of formats to use when saving this buffer.
5923 Formats are defined by `format-alist'. This variable is
5924 set when a file is visited. */);
5926 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5927 &BVAR (current_buffer, auto_save_file_format), Qnil,
5928 doc: /* *Format in which to write auto-save files.
5929 Should be a list of symbols naming formats that are defined in `format-alist'.
5930 If it is t, which is the default, auto-save files are written in the
5931 same format as a regular save would use. */);
5933 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5934 &BVAR (current_buffer, invisibility_spec), Qnil,
5935 doc: /* Invisibility spec of this buffer.
5936 The default is t, which means that text is invisible
5937 if it has a non-nil `invisible' property.
5938 If the value is a list, a text character is invisible if its `invisible'
5939 property is an element in that list (or is a list with members in common).
5940 If an element is a cons cell of the form (PROP . ELLIPSIS),
5941 then characters with property value PROP are invisible,
5942 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5944 DEFVAR_PER_BUFFER ("buffer-display-count",
5945 &BVAR (current_buffer, display_count), Qnil,
5946 doc: /* A number incremented each time this buffer is displayed in a window.
5947 The function `set-window-buffer' increments it. */);
5949 DEFVAR_PER_BUFFER ("buffer-display-time",
5950 &BVAR (current_buffer, display_time), Qnil,
5951 doc: /* Time stamp updated each time this buffer is displayed in a window.
5952 The function `set-window-buffer' updates this variable
5953 to the value obtained by calling `current-time'.
5954 If the buffer has never been shown in a window, the value is nil. */);
5956 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5957 doc: /* Non-nil if Transient Mark mode is enabled.
5958 See the command `transient-mark-mode' for a description of this minor mode.
5960 Non-nil also enables highlighting of the region whenever the mark is active.
5961 The variable `highlight-nonselected-windows' controls whether to highlight
5962 all windows or just the selected window.
5964 Lisp programs may give this variable certain special values:
5966 - A value of `lambda' enables Transient Mark mode temporarily.
5967 It is disabled again after any subsequent action that would
5968 normally deactivate the mark (e.g. buffer modification).
5970 - A value of (only . OLDVAL) enables Transient Mark mode
5971 temporarily. After any subsequent point motion command that is
5972 not shift-translated, or any other action that would normally
5973 deactivate the mark (e.g. buffer modification), the value of
5974 `transient-mark-mode' is set to OLDVAL. */);
5975 Vtransient_mark_mode = Qnil;
5977 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5978 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5979 If the value is t, disregard `buffer-read-only' and all `read-only'
5980 text properties. If the value is a list, disregard `buffer-read-only'
5981 and disregard a `read-only' text property if the property value
5982 is a member of the list. */);
5983 Vinhibit_read_only = Qnil;
5985 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5986 doc: /* Cursor to use when this buffer is in the selected window.
5987 Values are interpreted as follows:
5989 t use the cursor specified for the frame
5990 nil don't display a cursor
5991 box display a filled box cursor
5992 hollow display a hollow box cursor
5993 bar display a vertical bar cursor with default width
5994 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5995 hbar display a horizontal bar cursor with default height
5996 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5997 ANYTHING ELSE display a hollow box cursor
5999 When the buffer is displayed in a non-selected window, the
6000 cursor's appearance is instead controlled by the variable
6001 `cursor-in-non-selected-windows'. */);
6003 DEFVAR_PER_BUFFER ("line-spacing",
6004 &BVAR (current_buffer, extra_line_spacing), Qnil,
6005 doc: /* Additional space to put between lines when displaying a buffer.
6006 The space is measured in pixels, and put below lines on graphic displays,
6007 see `display-graphic-p'.
6008 If value is a floating point number, it specifies the spacing relative
6009 to the default frame line height. A value of nil means add no extra space. */);
6011 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6012 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
6013 doc: /* *Non-nil means show a cursor in non-selected windows.
6014 If nil, only shows a cursor in the selected window.
6015 If t, displays a cursor related to the usual cursor type
6016 \(a solid box becomes hollow, a bar becomes a narrower bar).
6017 You can also specify the cursor type as in the `cursor-type' variable.
6018 Use Custom to set this variable and update the display." */);
6020 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
6021 doc: /* List of functions called with no args to query before killing a buffer.
6022 The buffer being killed will be current while the functions are running.
6023 If any of them returns nil, the buffer is not killed. */);
6024 Vkill_buffer_query_functions = Qnil;
6026 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
6027 doc: /* Normal hook run before changing the major mode of a buffer.
6028 The function `kill-all-local-variables' runs this before doing anything else. */);
6029 Vchange_major_mode_hook = Qnil;
6030 Qchange_major_mode_hook = intern_c_string ("change-major-mode-hook");
6031 staticpro (&Qchange_major_mode_hook);
6033 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
6034 doc: /* Hook run when the buffer list changes.
6035 Functions running this hook are `get-buffer-create',
6036 `make-indirect-buffer', `rename-buffer', `kill-buffer',
6037 `record-buffer' and `unrecord-buffer'. */);
6038 Vbuffer_list_update_hook = Qnil;
6039 Qbuffer_list_update_hook = intern_c_string ("buffer-list-update-hook");
6040 staticpro (&Qbuffer_list_update_hook);
6042 defsubr (&Sbuffer_live_p);
6043 defsubr (&Sbuffer_list);
6044 defsubr (&Sget_buffer);
6045 defsubr (&Sget_file_buffer);
6046 defsubr (&Sget_buffer_create);
6047 defsubr (&Smake_indirect_buffer);
6048 defsubr (&Sgenerate_new_buffer_name);
6049 defsubr (&Sbuffer_name);
6050 /*defsubr (&Sbuffer_number);*/
6051 defsubr (&Sbuffer_file_name);
6052 defsubr (&Sbuffer_base_buffer);
6053 defsubr (&Sbuffer_local_value);
6054 defsubr (&Sbuffer_local_variables);
6055 defsubr (&Sbuffer_modified_p);
6056 defsubr (&Sset_buffer_modified_p);
6057 defsubr (&Sbuffer_modified_tick);
6058 defsubr (&Sbuffer_chars_modified_tick);
6059 defsubr (&Srename_buffer);
6060 defsubr (&Sother_buffer);
6061 defsubr (&Sbuffer_enable_undo);
6062 defsubr (&Skill_buffer);
6063 defsubr (&Srecord_buffer);
6064 defsubr (&Sunrecord_buffer);
6065 defsubr (&Sset_buffer_major_mode);
6066 defsubr (&Scurrent_buffer);
6067 defsubr (&Sset_buffer);
6068 defsubr (&Sbarf_if_buffer_read_only);
6069 defsubr (&Serase_buffer);
6070 defsubr (&Sbuffer_swap_text);
6071 defsubr (&Sset_buffer_multibyte);
6072 defsubr (&Skill_all_local_variables);
6074 defsubr (&Soverlayp);
6075 defsubr (&Smake_overlay);
6076 defsubr (&Sdelete_overlay);
6077 defsubr (&Smove_overlay);
6078 defsubr (&Soverlay_start);
6079 defsubr (&Soverlay_end);
6080 defsubr (&Soverlay_buffer);
6081 defsubr (&Soverlay_properties);
6082 defsubr (&Soverlays_at);
6083 defsubr (&Soverlays_in);
6084 defsubr (&Snext_overlay_change);
6085 defsubr (&Sprevious_overlay_change);
6086 defsubr (&Soverlay_recenter);
6087 defsubr (&Soverlay_lists);
6088 defsubr (&Soverlay_get);
6089 defsubr (&Soverlay_put);
6090 defsubr (&Srestore_buffer_modified_p);
6093 void
6094 keys_of_buffer (void)
6096 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6097 initial_define_key (control_x_map, 'k', "kill-buffer");
6099 /* This must not be in syms_of_buffer, because Qdisabled is not
6100 initialized when that function gets called. */
6101 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);