* src/buffer.c (buffer-list-update-hook): Doc fix.
[emacs.git] / src / buffer.c
blob1577254d92aedb097ddc4dcfbdcb926c8e6e55a2
1 /* Buffer manipulation primitives for GNU Emacs.
3 Copyright (C) 1985-1989, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/param.h>
25 #include <errno.h>
26 #include <stdio.h>
27 #include <setjmp.h>
28 #include <unistd.h>
30 #include <verify.h>
32 #include "lisp.h"
33 #include "intervals.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "buffer.h"
37 #include "character.h"
38 #include "region-cache.h"
39 #include "indent.h"
40 #include "blockinput.h"
41 #include "keyboard.h"
42 #include "keymap.h"
43 #include "frame.h"
45 struct buffer *current_buffer; /* the current buffer */
47 /* First buffer in chain of all buffers (in reverse order of creation).
48 Threaded through ->header.next.buffer. */
50 struct buffer *all_buffers;
52 /* This structure holds the default values of the buffer-local variables
53 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
54 The default value occupies the same slot in this structure
55 as an individual buffer's value occupies in that buffer.
56 Setting the default value also goes through the alist of buffers
57 and stores into each buffer that does not say it has a local value. */
59 DECL_ALIGN (struct buffer, buffer_defaults);
61 /* A Lisp_Object pointer to the above, used for staticpro */
63 static Lisp_Object Vbuffer_defaults;
65 /* This structure marks which slots in a buffer have corresponding
66 default values in buffer_defaults.
67 Each such slot has a nonzero value in this structure.
68 The value has only one nonzero bit.
70 When a buffer has its own local value for a slot,
71 the entry for that slot (found in the same slot in this structure)
72 is turned on in the buffer's local_flags array.
74 If a slot in this structure is -1, then even though there may
75 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
76 and the corresponding slot in buffer_defaults is not used.
78 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
79 zero, that is a bug */
81 struct buffer buffer_local_flags;
83 /* This structure holds the names of symbols whose values may be
84 buffer-local. It is indexed and accessed in the same way as the above. */
86 DECL_ALIGN (struct buffer, buffer_local_symbols);
88 /* A Lisp_Object pointer to the above, used for staticpro */
89 static Lisp_Object Vbuffer_local_symbols;
91 /* Return the symbol of the per-buffer variable at offset OFFSET in
92 the buffer structure. */
94 #define PER_BUFFER_SYMBOL(OFFSET) \
95 (*(Lisp_Object *)((OFFSET) + (char *) &buffer_local_symbols))
97 /* Maximum length of an overlay vector. */
98 #define OVERLAY_COUNT_MAX \
99 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, \
100 min (PTRDIFF_MAX, SIZE_MAX) / sizeof (Lisp_Object)))
102 /* Flags indicating which built-in buffer-local variables
103 are permanent locals. */
104 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
106 /* Number of per-buffer variables used. */
108 int last_per_buffer_idx;
110 static Lisp_Object Fset_buffer_major_mode (Lisp_Object);
111 static Lisp_Object Fdelete_overlay (Lisp_Object);
112 static void call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay,
113 int after, Lisp_Object arg1,
114 Lisp_Object arg2, Lisp_Object arg3);
115 static void swap_out_buffer_local_variables (struct buffer *b);
116 static void reset_buffer_local_variables (struct buffer *b, int permanent_too);
118 /* Alist of all buffer names vs the buffers. */
119 /* This used to be a variable, but is no longer,
120 to prevent lossage due to user rplac'ing this alist or its elements. */
121 Lisp_Object Vbuffer_alist;
123 static Lisp_Object Qkill_buffer_query_functions;
125 /* Hook run before changing a major mode. */
126 static Lisp_Object Qchange_major_mode_hook;
128 Lisp_Object Qfirst_change_hook;
129 Lisp_Object Qbefore_change_functions;
130 Lisp_Object Qafter_change_functions;
131 static Lisp_Object Qucs_set_table_for_input;
133 static Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
134 static Lisp_Object Qpermanent_local_hook;
136 static Lisp_Object Qprotected_field;
138 static Lisp_Object QSFundamental; /* A string "Fundamental" */
140 static Lisp_Object Qkill_buffer_hook;
141 static Lisp_Object Qbuffer_list_update_hook;
143 static Lisp_Object Qget_file_buffer;
145 static Lisp_Object Qoverlayp;
147 Lisp_Object Qpriority, Qbefore_string, Qafter_string;
149 static Lisp_Object Qevaporate;
151 Lisp_Object Qmodification_hooks;
152 Lisp_Object Qinsert_in_front_hooks;
153 Lisp_Object Qinsert_behind_hooks;
155 static void alloc_buffer_text (struct buffer *, ptrdiff_t);
156 static void free_buffer_text (struct buffer *b);
157 static struct Lisp_Overlay * copy_overlays (struct buffer *, struct Lisp_Overlay *);
158 static void modify_overlay (struct buffer *, EMACS_INT, EMACS_INT);
159 static Lisp_Object buffer_lisp_local_variables (struct buffer *);
161 /* For debugging; temporary. See set_buffer_internal. */
162 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
164 void
165 nsberror (Lisp_Object spec)
167 if (STRINGP (spec))
168 error ("No buffer named %s", SDATA (spec));
169 error ("Invalid buffer argument");
172 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
173 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
174 Value is nil if OBJECT is not a buffer or if it has been killed. */)
175 (Lisp_Object object)
177 return ((BUFFERP (object) && ! NILP (BVAR (XBUFFER (object), name)))
178 ? Qt : Qnil);
181 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
182 doc: /* Return a list of all existing live buffers.
183 If the optional arg FRAME is a frame, we return the buffer list in the
184 proper order for that frame: the buffers show in FRAME come first,
185 followed by the rest of the buffers. */)
186 (Lisp_Object frame)
188 Lisp_Object general;
189 general = Fmapcar (Qcdr, Vbuffer_alist);
191 if (FRAMEP (frame))
193 Lisp_Object framelist, prevlist, tail;
194 Lisp_Object args[3];
196 CHECK_FRAME (frame);
197 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
198 prevlist = Fnreverse (Fcopy_sequence
199 (XFRAME (frame)->buried_buffer_list));
201 /* Remove from GENERAL any buffer that duplicates one in
202 FRAMELIST or PREVLIST. */
203 tail = framelist;
204 while (CONSP (tail))
206 general = Fdelq (XCAR (tail), general);
207 tail = XCDR (tail);
209 tail = prevlist;
210 while (CONSP (tail))
212 general = Fdelq (XCAR (tail), general);
213 tail = XCDR (tail);
216 args[0] = framelist;
217 args[1] = general;
218 args[2] = prevlist;
219 return Fnconc (3, args);
221 else
222 return general;
225 /* Like Fassoc, but use Fstring_equal to compare
226 (which ignores text properties),
227 and don't ever QUIT. */
229 static Lisp_Object
230 assoc_ignore_text_properties (register Lisp_Object key, Lisp_Object list)
232 register Lisp_Object tail;
233 for (tail = list; CONSP (tail); tail = XCDR (tail))
235 register Lisp_Object elt, tem;
236 elt = XCAR (tail);
237 tem = Fstring_equal (Fcar (elt), key);
238 if (!NILP (tem))
239 return elt;
241 return Qnil;
244 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
245 doc: /* Return the buffer named BUFFER-OR-NAME.
246 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
247 is a string and there is no buffer with that name, return nil. If
248 BUFFER-OR-NAME is a buffer, return it as given. */)
249 (register Lisp_Object buffer_or_name)
251 if (BUFFERP (buffer_or_name))
252 return buffer_or_name;
253 CHECK_STRING (buffer_or_name);
255 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
258 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
259 doc: /* Return the buffer visiting file FILENAME (a string).
260 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
261 If there is no such live buffer, return nil.
262 See also `find-buffer-visiting'. */)
263 (register Lisp_Object filename)
265 register Lisp_Object tail, buf, tem;
266 Lisp_Object handler;
268 CHECK_STRING (filename);
269 filename = Fexpand_file_name (filename, Qnil);
271 /* If the file name has special constructs in it,
272 call the corresponding file handler. */
273 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
274 if (!NILP (handler))
276 Lisp_Object handled_buf = call2 (handler, Qget_file_buffer,
277 filename);
278 return BUFFERP (handled_buf) ? handled_buf : Qnil;
281 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
283 buf = Fcdr (XCAR (tail));
284 if (!BUFFERP (buf)) continue;
285 if (!STRINGP (BVAR (XBUFFER (buf), filename))) continue;
286 tem = Fstring_equal (BVAR (XBUFFER (buf), filename), filename);
287 if (!NILP (tem))
288 return buf;
290 return Qnil;
293 Lisp_Object
294 get_truename_buffer (register Lisp_Object filename)
296 register Lisp_Object tail, buf, tem;
298 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
300 buf = Fcdr (XCAR (tail));
301 if (!BUFFERP (buf)) continue;
302 if (!STRINGP (BVAR (XBUFFER (buf), file_truename))) continue;
303 tem = Fstring_equal (BVAR (XBUFFER (buf), file_truename), filename);
304 if (!NILP (tem))
305 return buf;
307 return Qnil;
310 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
311 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
312 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
313 return that buffer. If no such buffer exists, create a new buffer with
314 that name and return it. If BUFFER-OR-NAME starts with a space, the new
315 buffer does not keep undo information.
317 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
318 even if it is dead. The return value is never nil. */)
319 (register Lisp_Object buffer_or_name)
321 register Lisp_Object buffer, name;
322 register struct buffer *b;
324 buffer = Fget_buffer (buffer_or_name);
325 if (!NILP (buffer))
326 return buffer;
328 if (SCHARS (buffer_or_name) == 0)
329 error ("Empty string for buffer name is not allowed");
331 b = allocate_buffer ();
333 /* An ordinary buffer uses its own struct buffer_text. */
334 b->text = &b->own_text;
335 b->base_buffer = 0;
337 BUF_GAP_SIZE (b) = 20;
338 BLOCK_INPUT;
339 /* We allocate extra 1-byte at the tail and keep it always '\0' for
340 anchoring a search. */
341 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
342 UNBLOCK_INPUT;
343 if (! BUF_BEG_ADDR (b))
344 buffer_memory_full (BUF_GAP_SIZE (b) + 1);
346 b->pt = BEG;
347 b->begv = BEG;
348 b->zv = BEG;
349 b->pt_byte = BEG_BYTE;
350 b->begv_byte = BEG_BYTE;
351 b->zv_byte = BEG_BYTE;
353 BUF_GPT (b) = BEG;
354 BUF_GPT_BYTE (b) = BEG_BYTE;
356 BUF_Z (b) = BEG;
357 BUF_Z_BYTE (b) = BEG_BYTE;
358 BUF_MODIFF (b) = 1;
359 BUF_CHARS_MODIFF (b) = 1;
360 BUF_OVERLAY_MODIFF (b) = 1;
361 BUF_SAVE_MODIFF (b) = 1;
362 BUF_INTERVALS (b) = 0;
363 BUF_UNCHANGED_MODIFIED (b) = 1;
364 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
365 BUF_END_UNCHANGED (b) = 0;
366 BUF_BEG_UNCHANGED (b) = 0;
367 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
368 b->text->inhibit_shrinking = 0;
370 b->newline_cache = 0;
371 b->width_run_cache = 0;
372 BVAR (b, width_table) = Qnil;
373 b->prevent_redisplay_optimizations_p = 1;
375 /* Put this on the chain of all buffers including killed ones. */
376 b->header.next.buffer = all_buffers;
377 all_buffers = b;
379 /* An ordinary buffer normally doesn't need markers
380 to handle BEGV and ZV. */
381 BVAR (b, pt_marker) = Qnil;
382 BVAR (b, begv_marker) = Qnil;
383 BVAR (b, zv_marker) = Qnil;
385 name = Fcopy_sequence (buffer_or_name);
386 STRING_SET_INTERVALS (name, NULL_INTERVAL);
387 BVAR (b, name) = name;
389 BVAR (b, undo_list) = (SREF (name, 0) != ' ') ? Qnil : Qt;
391 reset_buffer (b);
392 reset_buffer_local_variables (b, 1);
394 BVAR (b, mark) = Fmake_marker ();
395 BUF_MARKERS (b) = NULL;
396 BVAR (b, name) = name;
398 /* Put this in the alist of all live buffers. */
399 XSETBUFFER (buffer, b);
400 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
401 /* And run buffer-list-update-hook. */
402 if (!NILP (Vrun_hooks))
403 call1 (Vrun_hooks, Qbuffer_list_update_hook);
405 /* An error in calling the function here (should someone redefine it)
406 can lead to infinite regress until you run out of stack. rms
407 says that's not worth protecting against. */
408 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
409 /* buffer is on buffer-alist, so no gcpro. */
410 call1 (Qucs_set_table_for_input, buffer);
412 return buffer;
416 /* Return a list of overlays which is a copy of the overlay list
417 LIST, but for buffer B. */
419 static struct Lisp_Overlay *
420 copy_overlays (struct buffer *b, struct Lisp_Overlay *list)
422 Lisp_Object buffer;
423 struct Lisp_Overlay *result = NULL, *tail = NULL;
425 XSETBUFFER (buffer, b);
427 for (; list; list = list->next)
429 Lisp_Object overlay, start, end, old_overlay;
430 EMACS_INT charpos;
432 XSETMISC (old_overlay, list);
433 charpos = marker_position (OVERLAY_START (old_overlay));
434 start = Fmake_marker ();
435 Fset_marker (start, make_number (charpos), buffer);
436 XMARKER (start)->insertion_type
437 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
439 charpos = marker_position (OVERLAY_END (old_overlay));
440 end = Fmake_marker ();
441 Fset_marker (end, make_number (charpos), buffer);
442 XMARKER (end)->insertion_type
443 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
445 overlay = allocate_misc ();
446 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
447 OVERLAY_START (overlay) = start;
448 OVERLAY_END (overlay) = end;
449 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
450 XOVERLAY (overlay)->next = NULL;
452 if (tail)
453 tail = tail->next = XOVERLAY (overlay);
454 else
455 result = tail = XOVERLAY (overlay);
458 return result;
462 /* Clone per-buffer values of buffer FROM.
464 Buffer TO gets the same per-buffer values as FROM, with the
465 following exceptions: (1) TO's name is left untouched, (2) markers
466 are copied and made to refer to TO, and (3) overlay lists are
467 copied. */
469 static void
470 clone_per_buffer_values (struct buffer *from, struct buffer *to)
472 Lisp_Object to_buffer;
473 int offset;
475 XSETBUFFER (to_buffer, to);
477 /* buffer-local Lisp variables start at `undo_list',
478 tho only the ones from `name' on are GC'd normally. */
479 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
480 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
481 offset += sizeof (Lisp_Object))
483 Lisp_Object obj;
485 /* Don't touch the `name' which should be unique for every buffer. */
486 if (offset == PER_BUFFER_VAR_OFFSET (name))
487 continue;
489 obj = PER_BUFFER_VALUE (from, offset);
490 if (MARKERP (obj) && XMARKER (obj)->buffer == from)
492 struct Lisp_Marker *m = XMARKER (obj);
493 obj = Fmake_marker ();
494 XMARKER (obj)->insertion_type = m->insertion_type;
495 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
498 PER_BUFFER_VALUE (to, offset) = obj;
501 memcpy (to->local_flags, from->local_flags, sizeof to->local_flags);
503 to->overlays_before = copy_overlays (to, from->overlays_before);
504 to->overlays_after = copy_overlays (to, from->overlays_after);
506 /* Get (a copy of) the alist of Lisp-level local variables of FROM
507 and install that in TO. */
508 BVAR (to, local_var_alist) = buffer_lisp_local_variables (from);
512 /* If buffer B has markers to record PT, BEGV and ZV when it is not
513 current, update these markers. */
515 static void
516 record_buffer_markers (struct buffer *b)
518 if (! NILP (BVAR (b, pt_marker)))
520 Lisp_Object buffer;
522 eassert (!NILP (BVAR (b, begv_marker)));
523 eassert (!NILP (BVAR (b, zv_marker)));
525 XSETBUFFER (buffer, b);
526 set_marker_both (BVAR (b, pt_marker), buffer, b->pt, b->pt_byte);
527 set_marker_both (BVAR (b, begv_marker), buffer, b->begv, b->begv_byte);
528 set_marker_both (BVAR (b, zv_marker), buffer, b->zv, b->zv_byte);
533 /* If buffer B has markers to record PT, BEGV and ZV when it is not
534 current, fetch these values into B->begv etc. */
536 static void
537 fetch_buffer_markers (struct buffer *b)
539 if (! NILP (BVAR (b, pt_marker)))
541 Lisp_Object m;
543 eassert (!NILP (BVAR (b, begv_marker)));
544 eassert (!NILP (BVAR (b, zv_marker)));
546 m = BVAR (b, pt_marker);
547 SET_BUF_PT_BOTH (b, marker_position (m), marker_byte_position (m));
549 m = BVAR (b, begv_marker);
550 SET_BUF_BEGV_BOTH (b, marker_position (m), marker_byte_position (m));
552 m = BVAR (b, zv_marker);
553 SET_BUF_ZV_BOTH (b, marker_position (m), marker_byte_position (m));
558 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
559 2, 3,
560 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
561 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
562 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
563 NAME should be a string which is not the name of an existing buffer.
564 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
565 such as major and minor modes, in the indirect buffer.
566 CLONE nil means the indirect buffer's state is reset to default values. */)
567 (Lisp_Object base_buffer, Lisp_Object name, Lisp_Object clone)
569 Lisp_Object buf, tem;
570 struct buffer *b;
572 CHECK_STRING (name);
573 buf = Fget_buffer (name);
574 if (!NILP (buf))
575 error ("Buffer name `%s' is in use", SDATA (name));
577 tem = base_buffer;
578 base_buffer = Fget_buffer (base_buffer);
579 if (NILP (base_buffer))
580 error ("No such buffer: `%s'", SDATA (tem));
581 if (NILP (BVAR (XBUFFER (base_buffer), name)))
582 error ("Base buffer has been killed");
584 if (SCHARS (name) == 0)
585 error ("Empty string for buffer name is not allowed");
587 b = allocate_buffer ();
589 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
590 ? XBUFFER (base_buffer)->base_buffer
591 : XBUFFER (base_buffer));
593 /* Use the base buffer's text object. */
594 b->text = b->base_buffer->text;
596 b->pt = b->base_buffer->pt;
597 b->begv = b->base_buffer->begv;
598 b->zv = b->base_buffer->zv;
599 b->pt_byte = b->base_buffer->pt_byte;
600 b->begv_byte = b->base_buffer->begv_byte;
601 b->zv_byte = b->base_buffer->zv_byte;
603 b->newline_cache = 0;
604 b->width_run_cache = 0;
605 BVAR (b, width_table) = Qnil;
607 /* Put this on the chain of all buffers including killed ones. */
608 b->header.next.buffer = all_buffers;
609 all_buffers = b;
611 name = Fcopy_sequence (name);
612 STRING_SET_INTERVALS (name, NULL_INTERVAL);
613 BVAR (b, name) = name;
615 reset_buffer (b);
616 reset_buffer_local_variables (b, 1);
618 /* Put this in the alist of all live buffers. */
619 XSETBUFFER (buf, b);
620 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
622 BVAR (b, mark) = Fmake_marker ();
623 BVAR (b, name) = name;
625 /* The multibyte status belongs to the base buffer. */
626 BVAR (b, enable_multibyte_characters) = BVAR (b->base_buffer, enable_multibyte_characters);
628 /* Make sure the base buffer has markers for its narrowing. */
629 if (NILP (BVAR (b->base_buffer, pt_marker)))
631 eassert (NILP (BVAR (b->base_buffer, begv_marker)));
632 eassert (NILP (BVAR (b->base_buffer, zv_marker)));
634 BVAR (b->base_buffer, pt_marker) = Fmake_marker ();
635 set_marker_both (BVAR (b->base_buffer, pt_marker), base_buffer,
636 b->base_buffer->pt,
637 b->base_buffer->pt_byte);
639 BVAR (b->base_buffer, begv_marker) = Fmake_marker ();
640 set_marker_both (BVAR (b->base_buffer, begv_marker), base_buffer,
641 b->base_buffer->begv,
642 b->base_buffer->begv_byte);
644 BVAR (b->base_buffer, zv_marker) = Fmake_marker ();
645 set_marker_both (BVAR (b->base_buffer, zv_marker), base_buffer,
646 b->base_buffer->zv,
647 b->base_buffer->zv_byte);
648 XMARKER (BVAR (b->base_buffer, zv_marker))->insertion_type = 1;
651 if (NILP (clone))
653 /* Give the indirect buffer markers for its narrowing. */
654 BVAR (b, pt_marker) = Fmake_marker ();
655 set_marker_both (BVAR (b, pt_marker), buf, b->pt, b->pt_byte);
656 BVAR (b, begv_marker) = Fmake_marker ();
657 set_marker_both (BVAR (b, begv_marker), buf, b->begv, b->begv_byte);
658 BVAR (b, zv_marker) = Fmake_marker ();
659 set_marker_both (BVAR (b, zv_marker), buf, b->zv, b->zv_byte);
660 XMARKER (BVAR (b, zv_marker))->insertion_type = 1;
662 else
664 struct buffer *old_b = current_buffer;
666 clone_per_buffer_values (b->base_buffer, b);
667 BVAR (b, filename) = Qnil;
668 BVAR (b, file_truename) = Qnil;
669 BVAR (b, display_count) = make_number (0);
670 BVAR (b, backed_up) = Qnil;
671 BVAR (b, auto_save_file_name) = Qnil;
672 set_buffer_internal_1 (b);
673 Fset (intern ("buffer-save-without-query"), Qnil);
674 Fset (intern ("buffer-file-number"), Qnil);
675 Fset (intern ("buffer-stale-function"), Qnil);
676 set_buffer_internal_1 (old_b);
679 /* Run buffer-list-update-hook. */
680 if (!NILP (Vrun_hooks))
681 call1 (Vrun_hooks, Qbuffer_list_update_hook);
683 return buf;
686 void
687 delete_all_overlays (struct buffer *b)
689 Lisp_Object overlay;
691 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
692 have to empty the list, otherwise we end up with overlays that
693 think they belong to this buffer while the buffer doesn't know about
694 them any more. */
695 while (b->overlays_before)
697 XSETMISC (overlay, b->overlays_before);
698 Fdelete_overlay (overlay);
700 while (b->overlays_after)
702 XSETMISC (overlay, b->overlays_after);
703 Fdelete_overlay (overlay);
705 eassert (b->overlays_before == NULL);
706 eassert (b->overlays_after == NULL);
709 /* Reinitialize everything about a buffer except its name and contents
710 and local variables.
711 If called on an already-initialized buffer, the list of overlays
712 should be deleted before calling this function, otherwise we end up
713 with overlays that claim to belong to the buffer but the buffer
714 claims it doesn't belong to it. */
716 void
717 reset_buffer (register struct buffer *b)
719 BVAR (b, filename) = Qnil;
720 BVAR (b, file_truename) = Qnil;
721 BVAR (b, directory) = (current_buffer) ? BVAR (current_buffer, directory) : Qnil;
722 b->modtime = 0;
723 b->modtime_size = -1;
724 XSETFASTINT (BVAR (b, save_length), 0);
725 b->last_window_start = 1;
726 /* It is more conservative to start out "changed" than "unchanged". */
727 b->clip_changed = 0;
728 b->prevent_redisplay_optimizations_p = 1;
729 BVAR (b, backed_up) = Qnil;
730 BUF_AUTOSAVE_MODIFF (b) = 0;
731 b->auto_save_failure_time = 0;
732 BVAR (b, auto_save_file_name) = Qnil;
733 BVAR (b, read_only) = Qnil;
734 b->overlays_before = NULL;
735 b->overlays_after = NULL;
736 b->overlay_center = BEG;
737 BVAR (b, mark_active) = Qnil;
738 BVAR (b, point_before_scroll) = Qnil;
739 BVAR (b, file_format) = Qnil;
740 BVAR (b, auto_save_file_format) = Qt;
741 BVAR (b, last_selected_window) = Qnil;
742 XSETINT (BVAR (b, display_count), 0);
743 BVAR (b, display_time) = Qnil;
744 BVAR (b, enable_multibyte_characters) = BVAR (&buffer_defaults, enable_multibyte_characters);
745 BVAR (b, cursor_type) = BVAR (&buffer_defaults, cursor_type);
746 BVAR (b, extra_line_spacing) = BVAR (&buffer_defaults, extra_line_spacing);
748 b->display_error_modiff = 0;
751 /* Reset buffer B's local variables info.
752 Don't use this on a buffer that has already been in use;
753 it does not treat permanent locals consistently.
754 Instead, use Fkill_all_local_variables.
756 If PERMANENT_TOO is 1, then we reset permanent
757 buffer-local variables. If PERMANENT_TOO is 0,
758 we preserve those. */
760 static void
761 reset_buffer_local_variables (register struct buffer *b, int permanent_too)
763 register int offset;
764 int i;
766 /* Reset the major mode to Fundamental, together with all the
767 things that depend on the major mode.
768 default-major-mode is handled at a higher level.
769 We ignore it here. */
770 BVAR (b, major_mode) = Qfundamental_mode;
771 BVAR (b, keymap) = Qnil;
772 BVAR (b, mode_name) = QSFundamental;
773 BVAR (b, minor_modes) = Qnil;
775 /* If the standard case table has been altered and invalidated,
776 fix up its insides first. */
777 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
778 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
779 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
780 Fset_standard_case_table (Vascii_downcase_table);
782 BVAR (b, downcase_table) = Vascii_downcase_table;
783 BVAR (b, upcase_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
784 BVAR (b, case_canon_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
785 BVAR (b, case_eqv_table) = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
786 BVAR (b, invisibility_spec) = Qt;
788 /* Reset all (or most) per-buffer variables to their defaults. */
789 if (permanent_too)
790 BVAR (b, local_var_alist) = Qnil;
791 else
793 Lisp_Object tmp, prop, last = Qnil;
794 for (tmp = BVAR (b, local_var_alist); CONSP (tmp); tmp = XCDR (tmp))
795 if (!NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
797 /* If permanent-local, keep it. */
798 last = tmp;
799 if (EQ (prop, Qpermanent_local_hook))
801 /* This is a partially permanent hook variable.
802 Preserve only the elements that want to be preserved. */
803 Lisp_Object list, newlist;
804 list = XCDR (XCAR (tmp));
805 if (!CONSP (list))
806 newlist = list;
807 else
808 for (newlist = Qnil; CONSP (list); list = XCDR (list))
810 Lisp_Object elt = XCAR (list);
811 /* Preserve element ELT if it's t,
812 if it is a function with a `permanent-local-hook' property,
813 or if it's not a symbol. */
814 if (! SYMBOLP (elt)
815 || EQ (elt, Qt)
816 || !NILP (Fget (elt, Qpermanent_local_hook)))
817 newlist = Fcons (elt, newlist);
819 XSETCDR (XCAR (tmp), Fnreverse (newlist));
822 /* Delete this local variable. */
823 else if (NILP (last))
824 BVAR (b, local_var_alist) = XCDR (tmp);
825 else
826 XSETCDR (last, XCDR (tmp));
829 for (i = 0; i < last_per_buffer_idx; ++i)
830 if (permanent_too || buffer_permanent_local_flags[i] == 0)
831 SET_PER_BUFFER_VALUE_P (b, i, 0);
833 /* For each slot that has a default value,
834 copy that into the slot. */
836 /* buffer-local Lisp variables start at `undo_list',
837 tho only the ones from `name' on are GC'd normally. */
838 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
839 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
840 offset += sizeof (Lisp_Object))
842 int idx = PER_BUFFER_IDX (offset);
843 if ((idx > 0
844 && (permanent_too
845 || buffer_permanent_local_flags[idx] == 0)))
846 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
850 /* We split this away from generate-new-buffer, because rename-buffer
851 and set-visited-file-name ought to be able to use this to really
852 rename the buffer properly. */
854 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name,
855 Sgenerate_new_buffer_name, 1, 2, 0,
856 doc: /* Return a string that is the name of no existing buffer based on NAME.
857 If there is no live buffer named NAME, then return NAME.
858 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
859 \(starting at 2) until an unused name is found, and then return that name.
860 Optional second argument IGNORE specifies a name that is okay to use (if
861 it is in the sequence to be tried) even if a buffer with that name exists. */)
862 (register Lisp_Object name, Lisp_Object ignore)
864 register Lisp_Object gentemp, tem;
865 EMACS_INT count;
866 char number[INT_BUFSIZE_BOUND (EMACS_INT) + sizeof "<>"];
868 CHECK_STRING (name);
870 tem = Fstring_equal (name, ignore);
871 if (!NILP (tem))
872 return name;
873 tem = Fget_buffer (name);
874 if (NILP (tem))
875 return name;
877 count = 1;
878 while (1)
880 sprintf (number, "<%"pI"d>", ++count);
881 gentemp = concat2 (name, build_string (number));
882 tem = Fstring_equal (gentemp, ignore);
883 if (!NILP (tem))
884 return gentemp;
885 tem = Fget_buffer (gentemp);
886 if (NILP (tem))
887 return gentemp;
892 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
893 doc: /* Return the name of BUFFER, as a string.
894 BUFFER defaults to the current buffer.
895 Return nil if BUFFER has been killed. */)
896 (register Lisp_Object buffer)
898 if (NILP (buffer))
899 return BVAR (current_buffer, name);
900 CHECK_BUFFER (buffer);
901 return BVAR (XBUFFER (buffer), name);
904 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
905 doc: /* Return name of file BUFFER is visiting, or nil if none.
906 No argument or nil as argument means use the current buffer. */)
907 (register Lisp_Object buffer)
909 if (NILP (buffer))
910 return BVAR (current_buffer, filename);
911 CHECK_BUFFER (buffer);
912 return BVAR (XBUFFER (buffer), filename);
915 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
916 0, 1, 0,
917 doc: /* Return the base buffer of indirect buffer BUFFER.
918 If BUFFER is not indirect, return nil.
919 BUFFER defaults to the current buffer. */)
920 (register Lisp_Object buffer)
922 struct buffer *base;
923 Lisp_Object base_buffer;
925 if (NILP (buffer))
926 base = current_buffer->base_buffer;
927 else
929 CHECK_BUFFER (buffer);
930 base = XBUFFER (buffer)->base_buffer;
933 if (! base)
934 return Qnil;
935 XSETBUFFER (base_buffer, base);
936 return base_buffer;
939 DEFUN ("buffer-local-value", Fbuffer_local_value,
940 Sbuffer_local_value, 2, 2, 0,
941 doc: /* Return the value of VARIABLE in BUFFER.
942 If VARIABLE does not have a buffer-local binding in BUFFER, the value
943 is the default binding of the variable. */)
944 (register Lisp_Object variable, register Lisp_Object buffer)
946 register struct buffer *buf;
947 register Lisp_Object result;
948 struct Lisp_Symbol *sym;
950 CHECK_SYMBOL (variable);
951 CHECK_BUFFER (buffer);
952 buf = XBUFFER (buffer);
953 sym = XSYMBOL (variable);
955 start:
956 switch (sym->redirect)
958 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
959 case SYMBOL_PLAINVAL: result = SYMBOL_VAL (sym); break;
960 case SYMBOL_LOCALIZED:
961 { /* Look in local_var_alist. */
962 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
963 XSETSYMBOL (variable, sym); /* Update In case of aliasing. */
964 result = Fassoc (variable, BVAR (buf, local_var_alist));
965 if (!NILP (result))
967 if (blv->fwd)
968 { /* What binding is loaded right now? */
969 Lisp_Object current_alist_element = blv->valcell;
971 /* The value of the currently loaded binding is not
972 stored in it, but rather in the realvalue slot.
973 Store that value into the binding it belongs to
974 in case that is the one we are about to use. */
976 XSETCDR (current_alist_element,
977 do_symval_forwarding (blv->fwd));
979 /* Now get the (perhaps updated) value out of the binding. */
980 result = XCDR (result);
982 else
983 result = Fdefault_value (variable);
984 break;
986 case SYMBOL_FORWARDED:
988 union Lisp_Fwd *fwd = SYMBOL_FWD (sym);
989 if (BUFFER_OBJFWDP (fwd))
990 result = PER_BUFFER_VALUE (buf, XBUFFER_OBJFWD (fwd)->offset);
991 else
992 result = Fdefault_value (variable);
993 break;
995 default: abort ();
998 if (!EQ (result, Qunbound))
999 return result;
1001 xsignal1 (Qvoid_variable, variable);
1004 /* Return an alist of the Lisp-level buffer-local bindings of
1005 buffer BUF. That is, don't include the variables maintained
1006 in special slots in the buffer object. */
1008 static Lisp_Object
1009 buffer_lisp_local_variables (struct buffer *buf)
1011 Lisp_Object result = Qnil;
1012 register Lisp_Object tail;
1013 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1015 Lisp_Object val, elt;
1017 elt = XCAR (tail);
1019 /* Reference each variable in the alist in buf.
1020 If inquiring about the current buffer, this gets the current values,
1021 so store them into the alist so the alist is up to date.
1022 If inquiring about some other buffer, this swaps out any values
1023 for that buffer, making the alist up to date automatically. */
1024 val = find_symbol_value (XCAR (elt));
1025 /* Use the current buffer value only if buf is the current buffer. */
1026 if (buf != current_buffer)
1027 val = XCDR (elt);
1029 result = Fcons (EQ (val, Qunbound)
1030 ? XCAR (elt)
1031 : Fcons (XCAR (elt), val),
1032 result);
1035 return result;
1038 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1039 Sbuffer_local_variables, 0, 1, 0,
1040 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1041 Most elements look like (SYMBOL . VALUE), describing one variable.
1042 For a symbol that is locally unbound, just the symbol appears in the value.
1043 Note that storing new VALUEs in these elements doesn't change the variables.
1044 No argument or nil as argument means use current buffer as BUFFER. */)
1045 (register Lisp_Object buffer)
1047 register struct buffer *buf;
1048 register Lisp_Object result;
1050 if (NILP (buffer))
1051 buf = current_buffer;
1052 else
1054 CHECK_BUFFER (buffer);
1055 buf = XBUFFER (buffer);
1058 result = buffer_lisp_local_variables (buf);
1060 /* Add on all the variables stored in special slots. */
1062 int offset, idx;
1064 /* buffer-local Lisp variables start at `undo_list',
1065 tho only the ones from `name' on are GC'd normally. */
1066 for (offset = PER_BUFFER_VAR_OFFSET (FIRST_FIELD_PER_BUFFER);
1067 offset <= PER_BUFFER_VAR_OFFSET (LAST_FIELD_PER_BUFFER);
1068 /* sizeof EMACS_INT == sizeof Lisp_Object */
1069 offset += (sizeof (EMACS_INT)))
1071 idx = PER_BUFFER_IDX (offset);
1072 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1073 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1075 Lisp_Object sym = PER_BUFFER_SYMBOL (offset);
1076 Lisp_Object val = PER_BUFFER_VALUE (buf, offset);
1077 result = Fcons (EQ (val, Qunbound) ? sym : Fcons (sym, val),
1078 result);
1083 return result;
1086 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1087 0, 1, 0,
1088 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1089 No argument or nil as argument means use current buffer as BUFFER. */)
1090 (register Lisp_Object buffer)
1092 register struct buffer *buf;
1093 if (NILP (buffer))
1094 buf = current_buffer;
1095 else
1097 CHECK_BUFFER (buffer);
1098 buf = XBUFFER (buffer);
1101 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1104 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1105 1, 1, 0,
1106 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1107 A non-nil FLAG means mark the buffer modified. */)
1108 (register Lisp_Object flag)
1110 register int already;
1111 register Lisp_Object fn;
1112 Lisp_Object buffer, window;
1114 #ifdef CLASH_DETECTION
1115 /* If buffer becoming modified, lock the file.
1116 If buffer becoming unmodified, unlock the file. */
1118 fn = BVAR (current_buffer, file_truename);
1119 /* Test buffer-file-name so that binding it to nil is effective. */
1120 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1122 already = SAVE_MODIFF < MODIFF;
1123 if (!already && !NILP (flag))
1124 lock_file (fn);
1125 else if (already && NILP (flag))
1126 unlock_file (fn);
1128 #endif /* CLASH_DETECTION */
1130 /* Here we have a problem. SAVE_MODIFF is used here to encode
1131 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1132 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1133 modify SAVE_MODIFF to affect one, we may affect the other
1134 as well.
1135 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1136 if SAVE_MODIFF<auto_save_modified that means we risk changing
1137 recent-auto-save-p from t to nil.
1138 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1139 we risk changing recent-auto-save-p from nil to t. */
1140 SAVE_MODIFF = (NILP (flag)
1141 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1142 ? MODIFF
1143 /* Let's try to preserve recent-auto-save-p. */
1144 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1145 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1146 we can either decrease SAVE_MODIFF and auto_save_modified
1147 or increase MODIFF. */
1148 : MODIFF++);
1150 /* Set update_mode_lines only if buffer is displayed in some window.
1151 Packages like jit-lock or lazy-lock preserve a buffer's modified
1152 state by recording/restoring the state around blocks of code.
1153 Setting update_mode_lines makes redisplay consider all windows
1154 (on all frames). Stealth fontification of buffers not displayed
1155 would incur additional redisplay costs if we'd set
1156 update_modes_lines unconditionally.
1158 Ideally, I think there should be another mechanism for fontifying
1159 buffers without "modifying" buffers, or redisplay should be
1160 smarter about updating the `*' in mode lines. --gerd */
1161 XSETBUFFER (buffer, current_buffer);
1162 window = Fget_buffer_window (buffer, Qt);
1163 if (WINDOWP (window))
1165 ++update_mode_lines;
1166 current_buffer->prevent_redisplay_optimizations_p = 1;
1169 return flag;
1172 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1173 Srestore_buffer_modified_p, 1, 1, 0,
1174 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1175 It is not ensured that mode lines will be updated to show the modified
1176 state of the current buffer. Use with care. */)
1177 (Lisp_Object flag)
1179 #ifdef CLASH_DETECTION
1180 Lisp_Object fn;
1182 /* If buffer becoming modified, lock the file.
1183 If buffer becoming unmodified, unlock the file. */
1185 fn = BVAR (current_buffer, file_truename);
1186 /* Test buffer-file-name so that binding it to nil is effective. */
1187 if (!NILP (fn) && ! NILP (BVAR (current_buffer, filename)))
1189 int already = SAVE_MODIFF < MODIFF;
1190 if (!already && !NILP (flag))
1191 lock_file (fn);
1192 else if (already && NILP (flag))
1193 unlock_file (fn);
1195 #endif /* CLASH_DETECTION */
1197 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1198 return flag;
1201 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1202 0, 1, 0,
1203 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1204 Each buffer has a tick counter which is incremented each time the
1205 text in that buffer is changed. It wraps around occasionally.
1206 No argument or nil as argument means use current buffer as BUFFER. */)
1207 (register Lisp_Object buffer)
1209 register struct buffer *buf;
1210 if (NILP (buffer))
1211 buf = current_buffer;
1212 else
1214 CHECK_BUFFER (buffer);
1215 buf = XBUFFER (buffer);
1218 return make_number (BUF_MODIFF (buf));
1221 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1222 Sbuffer_chars_modified_tick, 0, 1, 0,
1223 doc: /* Return BUFFER's character-change tick counter.
1224 Each buffer has a character-change tick counter, which is set to the
1225 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1226 time text in that buffer is inserted or deleted. By comparing the
1227 values returned by two individual calls of `buffer-chars-modified-tick',
1228 you can tell whether a character change occurred in that buffer in
1229 between these calls. No argument or nil as argument means use current
1230 buffer as BUFFER. */)
1231 (register Lisp_Object buffer)
1233 register struct buffer *buf;
1234 if (NILP (buffer))
1235 buf = current_buffer;
1236 else
1238 CHECK_BUFFER (buffer);
1239 buf = XBUFFER (buffer);
1242 return make_number (BUF_CHARS_MODIFF (buf));
1245 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1246 "(list (read-string \"Rename buffer (to new name): \" \
1247 nil 'buffer-name-history (buffer-name (current-buffer))) \
1248 current-prefix-arg)",
1249 doc: /* Change current buffer's name to NEWNAME (a string).
1250 If second arg UNIQUE is nil or omitted, it is an error if a
1251 buffer named NEWNAME already exists.
1252 If UNIQUE is non-nil, come up with a new name using
1253 `generate-new-buffer-name'.
1254 Interactively, you can set UNIQUE with a prefix argument.
1255 We return the name we actually gave the buffer.
1256 This does not change the name of the visited file (if any). */)
1257 (register Lisp_Object newname, Lisp_Object unique)
1259 register Lisp_Object tem, buf;
1261 CHECK_STRING (newname);
1263 if (SCHARS (newname) == 0)
1264 error ("Empty string is invalid as a buffer name");
1266 tem = Fget_buffer (newname);
1267 if (!NILP (tem))
1269 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1270 rename the buffer automatically so you can create another
1271 with the original name. It makes UNIQUE equivalent to
1272 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1273 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1274 return BVAR (current_buffer, name);
1275 if (!NILP (unique))
1276 newname = Fgenerate_new_buffer_name (newname, BVAR (current_buffer, name));
1277 else
1278 error ("Buffer name `%s' is in use", SDATA (newname));
1281 BVAR (current_buffer, name) = newname;
1283 /* Catch redisplay's attention. Unless we do this, the mode lines for
1284 any windows displaying current_buffer will stay unchanged. */
1285 update_mode_lines++;
1287 XSETBUFFER (buf, current_buffer);
1288 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1289 if (NILP (BVAR (current_buffer, filename))
1290 && !NILP (BVAR (current_buffer, auto_save_file_name)))
1291 call0 (intern ("rename-auto-save-file"));
1293 /* Run buffer-list-update-hook. */
1294 if (!NILP (Vrun_hooks))
1295 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1297 /* Refetch since that last call may have done GC. */
1298 return BVAR (current_buffer, name);
1301 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1302 doc: /* Return most recently selected buffer other than BUFFER.
1303 Buffers not visible in windows are preferred to visible buffers, unless
1304 optional second argument VISIBLE-OK is non-nil. Ignore the argument
1305 BUFFER unless it denotes a live buffer. If the optional third argument
1306 FRAME is non-nil, use that frame's buffer list instead of the selected
1307 frame's buffer list.
1309 The buffer is found by scanning the selected or specified frame's buffer
1310 list first, followed by the list of all buffers. If no other buffer
1311 exists, return the buffer `*scratch*' (creating it if necessary). */)
1312 (register Lisp_Object buffer, Lisp_Object visible_ok, Lisp_Object frame)
1314 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1315 Lisp_Object tail, buf, pred;
1316 Lisp_Object notsogood = Qnil;
1318 if (NILP (frame))
1319 frame = selected_frame;
1321 CHECK_FRAME (frame);
1323 pred = frame_buffer_predicate (frame);
1324 /* Consider buffers that have been seen in the frame first. */
1325 tail = XFRAME (frame)->buffer_list;
1326 for (; CONSP (tail); tail = XCDR (tail))
1328 buf = XCAR (tail);
1329 if (BUFFERP (buf) && !EQ (buf, buffer)
1330 && !NILP (BVAR (XBUFFER (buf), name))
1331 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1332 /* If the frame has a buffer_predicate, disregard buffers that
1333 don't fit the predicate. */
1334 && (NILP (pred) || !NILP (call1 (pred, buf))))
1336 if (!NILP (visible_ok)
1337 || NILP (Fget_buffer_window (buf, Qvisible)))
1338 return buf;
1339 else if (NILP (notsogood))
1340 notsogood = buf;
1344 /* Consider alist of all buffers next. */
1345 tail = Vbuffer_alist;
1346 for (; CONSP (tail); tail = XCDR (tail))
1348 buf = Fcdr (XCAR (tail));
1349 if (BUFFERP (buf) && !EQ (buf, buffer)
1350 && !NILP (BVAR (XBUFFER (buf), name))
1351 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' ')
1352 /* If the frame has a buffer_predicate, disregard buffers that
1353 don't fit the predicate. */
1354 && (NILP (pred) || !NILP (call1 (pred, buf))))
1356 if (!NILP (visible_ok)
1357 || NILP (Fget_buffer_window (buf, Qvisible)))
1358 return buf;
1359 else if (NILP (notsogood))
1360 notsogood = buf;
1364 if (!NILP (notsogood))
1365 return notsogood;
1366 else
1368 buf = Fget_buffer (build_string ("*scratch*"));
1369 if (NILP (buf))
1371 buf = Fget_buffer_create (build_string ("*scratch*"));
1372 Fset_buffer_major_mode (buf);
1374 return buf;
1378 /* The following function is a safe variant of Fother_buffer: It doesn't
1379 pay attention to any frame-local buffer lists, doesn't care about
1380 visibility of buffers, and doesn't evaluate any frame predicates. */
1382 Lisp_Object
1383 other_buffer_safely (Lisp_Object buffer)
1385 Lisp_Object Fset_buffer_major_mode (Lisp_Object buffer);
1386 Lisp_Object tail, buf;
1388 tail = Vbuffer_alist;
1389 for (; CONSP (tail); tail = XCDR (tail))
1391 buf = Fcdr (XCAR (tail));
1392 if (BUFFERP (buf) && !EQ (buf, buffer)
1393 && !NILP (BVAR (XBUFFER (buf), name))
1394 && (SREF (BVAR (XBUFFER (buf), name), 0) != ' '))
1395 return buf;
1398 buf = Fget_buffer (build_string ("*scratch*"));
1399 if (NILP (buf))
1401 buf = Fget_buffer_create (build_string ("*scratch*"));
1402 Fset_buffer_major_mode (buf);
1405 return buf;
1408 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1409 0, 1, "",
1410 doc: /* Start keeping undo information for buffer BUFFER.
1411 No argument or nil as argument means do this for the current buffer. */)
1412 (register Lisp_Object buffer)
1414 Lisp_Object real_buffer;
1416 if (NILP (buffer))
1417 XSETBUFFER (real_buffer, current_buffer);
1418 else
1420 real_buffer = Fget_buffer (buffer);
1421 if (NILP (real_buffer))
1422 nsberror (buffer);
1425 if (EQ (BVAR (XBUFFER (real_buffer), undo_list), Qt))
1426 BVAR (XBUFFER (real_buffer), undo_list) = Qnil;
1428 return Qnil;
1432 DEFVAR_LISP ("kill-buffer-hook", ..., "\
1433 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1434 The buffer being killed will be current while the hook is running.\n\
1435 See `kill-buffer'."
1437 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1438 doc: /* Kill buffer BUFFER-OR-NAME.
1439 The argument may be a buffer or the name of an existing buffer.
1440 Argument nil or omitted means kill the current buffer. Return t if the
1441 buffer is actually killed, nil otherwise.
1443 This function calls `replace-buffer-in-windows' for cleaning up all
1444 windows currently displaying the buffer to be killed. The functions in
1445 `kill-buffer-query-functions' are called with the buffer to be killed as
1446 the current buffer. If any of them returns nil, the buffer is not
1447 killed. The hook `kill-buffer-hook' is run before the buffer is
1448 actually killed. The buffer being killed will be current while the hook
1449 is running.
1451 Any processes that have this buffer as the `process-buffer' are killed
1452 with SIGHUP. */)
1453 (Lisp_Object buffer_or_name)
1455 Lisp_Object buffer;
1456 register struct buffer *b;
1457 register Lisp_Object tem;
1458 register struct Lisp_Marker *m;
1459 struct gcpro gcpro1;
1461 if (NILP (buffer_or_name))
1462 buffer = Fcurrent_buffer ();
1463 else
1464 buffer = Fget_buffer (buffer_or_name);
1465 if (NILP (buffer))
1466 nsberror (buffer_or_name);
1468 b = XBUFFER (buffer);
1470 /* Avoid trouble for buffer already dead. */
1471 if (NILP (BVAR (b, name)))
1472 return Qnil;
1474 /* Query if the buffer is still modified. */
1475 if (INTERACTIVE && !NILP (BVAR (b, filename))
1476 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1478 GCPRO1 (buffer);
1479 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1480 BVAR (b, name), make_number (0)));
1481 UNGCPRO;
1482 if (NILP (tem))
1483 return Qnil;
1486 /* Run hooks with the buffer to be killed the current buffer. */
1488 int count = SPECPDL_INDEX ();
1489 Lisp_Object arglist[1];
1491 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1492 set_buffer_internal (b);
1494 /* First run the query functions; if any query is answered no,
1495 don't kill the buffer. */
1496 arglist[0] = Qkill_buffer_query_functions;
1497 tem = Frun_hook_with_args_until_failure (1, arglist);
1498 if (NILP (tem))
1499 return unbind_to (count, Qnil);
1501 /* Then run the hooks. */
1502 Frun_hooks (1, &Qkill_buffer_hook);
1503 unbind_to (count, Qnil);
1506 /* We have no more questions to ask. Verify that it is valid
1507 to kill the buffer. This must be done after the questions
1508 since anything can happen within do_yes_or_no_p. */
1510 /* Don't kill the minibuffer now current. */
1511 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1512 return Qnil;
1514 if (NILP (BVAR (b, name)))
1515 return Qnil;
1517 /* When we kill a base buffer, kill all its indirect buffers.
1518 We do it at this stage so nothing terrible happens if they
1519 ask questions or their hooks get errors. */
1520 if (! b->base_buffer)
1522 struct buffer *other;
1524 GCPRO1 (buffer);
1526 for (other = all_buffers; other; other = other->header.next.buffer)
1527 /* all_buffers contains dead buffers too;
1528 don't re-kill them. */
1529 if (other->base_buffer == b && !NILP (BVAR (other, name)))
1531 Lisp_Object buf;
1532 XSETBUFFER (buf, other);
1533 Fkill_buffer (buf);
1536 UNGCPRO;
1539 /* Run replace_buffer_in_windows before making another buffer current
1540 since set-window-buffer-start-and-point will refuse to make another
1541 buffer current if the selected window does not show the current
1542 buffer. (Bug#10114) */
1543 replace_buffer_in_windows (buffer);
1545 /* Make this buffer not be current.
1546 In the process, notice if this is the sole visible buffer
1547 and give up if so. */
1548 if (b == current_buffer)
1550 tem = Fother_buffer (buffer, Qnil, Qnil);
1551 Fset_buffer (tem);
1552 if (b == current_buffer)
1553 return Qnil;
1556 /* Notice if the buffer to kill is the sole visible buffer
1557 when we're currently in the mini-buffer, and give up if so. */
1558 XSETBUFFER (tem, current_buffer);
1559 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1561 tem = Fother_buffer (buffer, Qnil, Qnil);
1562 if (EQ (buffer, tem))
1563 return Qnil;
1566 /* Now there is no question: we can kill the buffer. */
1568 #ifdef CLASH_DETECTION
1569 /* Unlock this buffer's file, if it is locked. */
1570 unlock_buffer (b);
1571 #endif /* CLASH_DETECTION */
1573 GCPRO1 (buffer);
1574 kill_buffer_processes (buffer);
1575 UNGCPRO;
1577 /* Killing buffer processes may run sentinels which may
1578 have called kill-buffer. */
1580 if (NILP (BVAR (b, name)))
1581 return Qnil;
1583 /* These may run Lisp code and into infinite loops (if someone
1584 insisted on circular lists) so allow quitting here. */
1585 frames_discard_buffer (buffer);
1587 clear_charpos_cache (b);
1589 tem = Vinhibit_quit;
1590 Vinhibit_quit = Qt;
1591 /* Remove the buffer from the list of all buffers. */
1592 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1593 /* If replace_buffer_in_windows didn't do its job correctly fix that
1594 now. */
1595 replace_buffer_in_windows_safely (buffer);
1596 Vinhibit_quit = tem;
1598 /* Delete any auto-save file, if we saved it in this session.
1599 But not if the buffer is modified. */
1600 if (STRINGP (BVAR (b, auto_save_file_name))
1601 && BUF_AUTOSAVE_MODIFF (b) != 0
1602 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1603 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1604 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1606 Lisp_Object delete;
1607 delete = Fsymbol_value (intern ("delete-auto-save-files"));
1608 if (! NILP (delete))
1609 internal_delete_file (BVAR (b, auto_save_file_name));
1612 if (b->base_buffer)
1614 /* Unchain all markers that belong to this indirect buffer.
1615 Don't unchain the markers that belong to the base buffer
1616 or its other indirect buffers. */
1617 for (m = BUF_MARKERS (b); m; )
1619 struct Lisp_Marker *next = m->next;
1620 if (m->buffer == b)
1621 unchain_marker (m);
1622 m = next;
1625 else
1627 /* Unchain all markers of this buffer and its indirect buffers.
1628 and leave them pointing nowhere. */
1629 for (m = BUF_MARKERS (b); m; )
1631 struct Lisp_Marker *next = m->next;
1632 m->buffer = 0;
1633 m->next = NULL;
1634 m = next;
1636 BUF_MARKERS (b) = NULL;
1637 BUF_INTERVALS (b) = NULL_INTERVAL;
1639 /* Perhaps we should explicitly free the interval tree here... */
1642 /* Reset the local variables, so that this buffer's local values
1643 won't be protected from GC. They would be protected
1644 if they happened to remain cached in their symbols.
1645 This gets rid of them for certain. */
1646 swap_out_buffer_local_variables (b);
1647 reset_buffer_local_variables (b, 1);
1649 BVAR (b, name) = Qnil;
1651 BLOCK_INPUT;
1652 if (! b->base_buffer)
1653 free_buffer_text (b);
1655 if (b->newline_cache)
1657 free_region_cache (b->newline_cache);
1658 b->newline_cache = 0;
1660 if (b->width_run_cache)
1662 free_region_cache (b->width_run_cache);
1663 b->width_run_cache = 0;
1665 BVAR (b, width_table) = Qnil;
1666 UNBLOCK_INPUT;
1667 BVAR (b, undo_list) = Qnil;
1669 /* Run buffer-list-update-hook. */
1670 if (!NILP (Vrun_hooks))
1671 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1673 return Qt;
1676 /* Move association for BUFFER to the front of buffer (a)lists. Since
1677 we do this each time BUFFER is selected visibly, the more recently
1678 selected buffers are always closer to the front of those lists. This
1679 means that other_buffer is more likely to choose a relevant buffer.
1681 Note that this moves BUFFER to the front of the buffer lists of the
1682 selected frame even if BUFFER is not shown there. If BUFFER is not
1683 shown in the selected frame, consider the present behavior a feature.
1684 `select-window' gets this right since it shows BUFFER in the selected
1685 window when calling us. */
1687 void
1688 record_buffer (Lisp_Object buffer)
1690 Lisp_Object aelt, aelt_cons, tem;
1691 register struct frame *f = XFRAME (selected_frame);
1693 CHECK_BUFFER (buffer);
1695 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1696 Don't allow quitting since this might leave the buffer list in an
1697 inconsistent state. */
1698 tem = Vinhibit_quit;
1699 Vinhibit_quit = Qt;
1700 aelt = Frassq (buffer, Vbuffer_alist);
1701 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1702 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1703 XSETCDR (aelt_cons, Vbuffer_alist);
1704 Vbuffer_alist = aelt_cons;
1705 Vinhibit_quit = tem;
1707 /* Update buffer list of selected frame. */
1708 f->buffer_list = Fcons (buffer, Fdelq (buffer, f->buffer_list));
1709 f->buried_buffer_list = Fdelq (buffer, f->buried_buffer_list);
1711 /* Run buffer-list-update-hook. */
1712 if (!NILP (Vrun_hooks))
1713 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1717 /* Move BUFFER to the end of the buffer (a)lists. Do nothing if the
1718 buffer is killed. For the selected frame's buffer list this moves
1719 BUFFER to its end even if it was never shown in that frame. If
1720 this happens we have a feature, hence `bury-buffer-internal' should be
1721 called only when BUFFER was shown in the selected frame. */
1723 DEFUN ("bury-buffer-internal", Fbury_buffer_internal, Sbury_buffer_internal,
1724 1, 1, 0,
1725 doc: /* Move BUFFER to the end of the buffer list. */)
1726 (Lisp_Object buffer)
1728 Lisp_Object aelt, aelt_cons, tem;
1729 register struct frame *f = XFRAME (selected_frame);
1731 CHECK_BUFFER (buffer);
1733 /* Update Vbuffer_alist (we know that it has an entry for BUFFER).
1734 Don't allow quitting since this might leave the buffer list in an
1735 inconsistent state. */
1736 tem = Vinhibit_quit;
1737 Vinhibit_quit = Qt;
1738 aelt = Frassq (buffer, Vbuffer_alist);
1739 aelt_cons = Fmemq (aelt, Vbuffer_alist);
1740 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1741 XSETCDR (aelt_cons, Qnil);
1742 Vbuffer_alist = nconc2 (Vbuffer_alist, aelt_cons);
1743 Vinhibit_quit = tem;
1745 /* Update buffer lists of selected frame. */
1746 f->buffer_list = Fdelq (buffer, f->buffer_list);
1747 f->buried_buffer_list = Fcons (buffer, Fdelq (buffer, f->buried_buffer_list));
1749 /* Run buffer-list-update-hook. */
1750 if (!NILP (Vrun_hooks))
1751 call1 (Vrun_hooks, Qbuffer_list_update_hook);
1753 return Qnil;
1756 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1757 doc: /* Set an appropriate major mode for BUFFER.
1758 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1759 according to `default-major-mode'.
1760 Use this function before selecting the buffer, since it may need to inspect
1761 the current buffer's major mode. */)
1762 (Lisp_Object buffer)
1764 int count;
1765 Lisp_Object function;
1767 CHECK_BUFFER (buffer);
1769 if (STRINGP (BVAR (XBUFFER (buffer), name))
1770 && strcmp (SSDATA (BVAR (XBUFFER (buffer), name)), "*scratch*") == 0)
1771 function = find_symbol_value (intern ("initial-major-mode"));
1772 else
1774 function = BVAR (&buffer_defaults, major_mode);
1775 if (NILP (function)
1776 && NILP (Fget (BVAR (current_buffer, major_mode), Qmode_class)))
1777 function = BVAR (current_buffer, major_mode);
1780 if (NILP (function) || EQ (function, Qfundamental_mode))
1781 return Qnil;
1783 count = SPECPDL_INDEX ();
1785 /* To select a nonfundamental mode,
1786 select the buffer temporarily and then call the mode function. */
1788 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1790 Fset_buffer (buffer);
1791 call0 (function);
1793 return unbind_to (count, Qnil);
1796 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1797 doc: /* Return the current buffer as a Lisp object. */)
1798 (void)
1800 register Lisp_Object buf;
1801 XSETBUFFER (buf, current_buffer);
1802 return buf;
1805 /* Set the current buffer to B.
1807 We previously set windows_or_buffers_changed here to invalidate
1808 global unchanged information in beg_unchanged and end_unchanged.
1809 This is no longer necessary because we now compute unchanged
1810 information on a buffer-basis. Every action affecting other
1811 windows than the selected one requires a select_window at some
1812 time, and that increments windows_or_buffers_changed. */
1814 void
1815 set_buffer_internal (register struct buffer *b)
1817 if (current_buffer != b)
1818 set_buffer_internal_1 (b);
1821 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1822 This is used by redisplay. */
1824 void
1825 set_buffer_internal_1 (register struct buffer *b)
1827 register struct buffer *old_buf;
1828 register Lisp_Object tail;
1830 #ifdef USE_MMAP_FOR_BUFFERS
1831 if (b->text->beg == NULL)
1832 enlarge_buffer_text (b, 0);
1833 #endif /* USE_MMAP_FOR_BUFFERS */
1835 if (current_buffer == b)
1836 return;
1838 old_buf = current_buffer;
1839 current_buffer = b;
1840 last_known_column_point = -1; /* invalidate indentation cache */
1842 if (old_buf)
1844 /* Put the undo list back in the base buffer, so that it appears
1845 that an indirect buffer shares the undo list of its base. */
1846 if (old_buf->base_buffer)
1847 BVAR (old_buf->base_buffer, undo_list) = BVAR (old_buf, undo_list);
1849 /* If the old current buffer has markers to record PT, BEGV and ZV
1850 when it is not current, update them now. */
1851 record_buffer_markers (old_buf);
1854 /* Get the undo list from the base buffer, so that it appears
1855 that an indirect buffer shares the undo list of its base. */
1856 if (b->base_buffer)
1857 BVAR (b, undo_list) = BVAR (b->base_buffer, undo_list);
1859 /* If the new current buffer has markers to record PT, BEGV and ZV
1860 when it is not current, fetch them now. */
1861 fetch_buffer_markers (b);
1863 /* Look down buffer's list of local Lisp variables
1864 to find and update any that forward into C variables. */
1868 for (tail = BVAR (b, local_var_alist); CONSP (tail); tail = XCDR (tail))
1870 Lisp_Object var = XCAR (XCAR (tail));
1871 struct Lisp_Symbol *sym = XSYMBOL (var);
1872 if (sym->redirect == SYMBOL_LOCALIZED /* Just to be sure. */
1873 && SYMBOL_BLV (sym)->fwd)
1874 /* Just reference the variable
1875 to cause it to become set for this buffer. */
1876 Fsymbol_value (var);
1879 /* Do the same with any others that were local to the previous buffer */
1880 while (b != old_buf && (b = old_buf, b));
1883 /* Switch to buffer B temporarily for redisplay purposes.
1884 This avoids certain things that don't need to be done within redisplay. */
1886 void
1887 set_buffer_temp (struct buffer *b)
1889 register struct buffer *old_buf;
1891 if (current_buffer == b)
1892 return;
1894 old_buf = current_buffer;
1895 current_buffer = b;
1897 /* If the old current buffer has markers to record PT, BEGV and ZV
1898 when it is not current, update them now. */
1899 record_buffer_markers (old_buf);
1901 /* If the new current buffer has markers to record PT, BEGV and ZV
1902 when it is not current, fetch them now. */
1903 fetch_buffer_markers (b);
1906 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1907 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
1908 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
1909 also `save-excursion' when you want to make a buffer current
1910 temporarily. This function does not display the buffer, so its effect
1911 ends when the current command terminates. Use `switch-to-buffer' or
1912 `pop-to-buffer' to switch buffers permanently. */)
1913 (register Lisp_Object buffer_or_name)
1915 register Lisp_Object buffer;
1916 buffer = Fget_buffer (buffer_or_name);
1917 if (NILP (buffer))
1918 nsberror (buffer_or_name);
1919 if (NILP (BVAR (XBUFFER (buffer), name)))
1920 error ("Selecting deleted buffer");
1921 set_buffer_internal (XBUFFER (buffer));
1922 return buffer;
1925 /* Set the current buffer to BUFFER provided it is alive. */
1927 Lisp_Object
1928 set_buffer_if_live (Lisp_Object buffer)
1930 if (! NILP (BVAR (XBUFFER (buffer), name)))
1931 Fset_buffer (buffer);
1932 return Qnil;
1935 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1936 Sbarf_if_buffer_read_only, 0, 0, 0,
1937 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1938 (void)
1940 if (!NILP (BVAR (current_buffer, read_only))
1941 && NILP (Vinhibit_read_only))
1942 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
1943 return Qnil;
1946 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1947 doc: /* Delete the entire contents of the current buffer.
1948 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1949 so the buffer is truly empty after this. */)
1950 (void)
1952 Fwiden ();
1954 del_range (BEG, Z);
1956 current_buffer->last_window_start = 1;
1957 /* Prevent warnings, or suspension of auto saving, that would happen
1958 if future size is less than past size. Use of erase-buffer
1959 implies that the future text is not really related to the past text. */
1960 XSETFASTINT (BVAR (current_buffer, save_length), 0);
1961 return Qnil;
1964 void
1965 validate_region (register Lisp_Object *b, register Lisp_Object *e)
1967 CHECK_NUMBER_COERCE_MARKER (*b);
1968 CHECK_NUMBER_COERCE_MARKER (*e);
1970 if (XINT (*b) > XINT (*e))
1972 Lisp_Object tem;
1973 tem = *b; *b = *e; *e = tem;
1976 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1977 && XINT (*e) <= ZV))
1978 args_out_of_range (*b, *e);
1981 /* Advance BYTE_POS up to a character boundary
1982 and return the adjusted position. */
1984 static EMACS_INT
1985 advance_to_char_boundary (EMACS_INT byte_pos)
1987 int c;
1989 if (byte_pos == BEG)
1990 /* Beginning of buffer is always a character boundary. */
1991 return BEG;
1993 c = FETCH_BYTE (byte_pos);
1994 if (! CHAR_HEAD_P (c))
1996 /* We should advance BYTE_POS only when C is a constituent of a
1997 multibyte sequence. */
1998 EMACS_INT orig_byte_pos = byte_pos;
2002 byte_pos--;
2003 c = FETCH_BYTE (byte_pos);
2005 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2006 INC_POS (byte_pos);
2007 if (byte_pos < orig_byte_pos)
2008 byte_pos = orig_byte_pos;
2009 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2010 surely advance to the correct character boundary. If C is
2011 not, BYTE_POS was unchanged. */
2014 return byte_pos;
2017 #ifdef REL_ALLOC
2018 extern void r_alloc_reset_variable (POINTER_TYPE *, POINTER_TYPE *);
2019 #endif /* REL_ALLOC */
2021 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2022 1, 1, 0,
2023 doc: /* Swap the text between current buffer and BUFFER. */)
2024 (Lisp_Object buffer)
2026 struct buffer *other_buffer;
2027 CHECK_BUFFER (buffer);
2028 other_buffer = XBUFFER (buffer);
2030 if (NILP (BVAR (other_buffer, name)))
2031 error ("Cannot swap a dead buffer's text");
2033 /* Actually, it probably works just fine.
2034 * if (other_buffer == current_buffer)
2035 * error ("Cannot swap a buffer's text with itself"); */
2037 /* Actually, this may be workable as well, tho probably only if they're
2038 *both* indirect. */
2039 if (other_buffer->base_buffer
2040 || current_buffer->base_buffer)
2041 error ("Cannot swap indirect buffers's text");
2043 { /* This is probably harder to make work. */
2044 struct buffer *other;
2045 for (other = all_buffers; other; other = other->header.next.buffer)
2046 if (other->base_buffer == other_buffer
2047 || other->base_buffer == current_buffer)
2048 error ("One of the buffers to swap has indirect buffers");
2051 #define swapfield(field, type) \
2052 do { \
2053 type tmp##field = other_buffer->field; \
2054 other_buffer->field = current_buffer->field; \
2055 current_buffer->field = tmp##field; \
2056 } while (0)
2057 #define swapfield_(field, type) \
2058 do { \
2059 type tmp##field = BVAR (other_buffer, field); \
2060 BVAR (other_buffer, field) = BVAR (current_buffer, field); \
2061 BVAR (current_buffer, field) = tmp##field; \
2062 } while (0)
2064 swapfield (own_text, struct buffer_text);
2065 eassert (current_buffer->text == &current_buffer->own_text);
2066 eassert (other_buffer->text == &other_buffer->own_text);
2067 #ifdef REL_ALLOC
2068 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2069 (POINTER_TYPE **) &other_buffer->own_text.beg);
2070 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2071 (POINTER_TYPE **) &current_buffer->own_text.beg);
2072 #endif /* REL_ALLOC */
2074 swapfield (pt, EMACS_INT);
2075 swapfield (pt_byte, EMACS_INT);
2076 swapfield (begv, EMACS_INT);
2077 swapfield (begv_byte, EMACS_INT);
2078 swapfield (zv, EMACS_INT);
2079 swapfield (zv_byte, EMACS_INT);
2080 eassert (!current_buffer->base_buffer);
2081 eassert (!other_buffer->base_buffer);
2082 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2083 swapfield (newline_cache, struct region_cache *);
2084 swapfield (width_run_cache, struct region_cache *);
2085 current_buffer->prevent_redisplay_optimizations_p = 1;
2086 other_buffer->prevent_redisplay_optimizations_p = 1;
2087 swapfield (overlays_before, struct Lisp_Overlay *);
2088 swapfield (overlays_after, struct Lisp_Overlay *);
2089 swapfield (overlay_center, EMACS_INT);
2090 swapfield_ (undo_list, Lisp_Object);
2091 swapfield_ (mark, Lisp_Object);
2092 swapfield_ (enable_multibyte_characters, Lisp_Object);
2093 swapfield_ (bidi_display_reordering, Lisp_Object);
2094 swapfield_ (bidi_paragraph_direction, Lisp_Object);
2095 /* FIXME: Not sure what we should do with these *_marker fields.
2096 Hopefully they're just nil anyway. */
2097 swapfield_ (pt_marker, Lisp_Object);
2098 swapfield_ (begv_marker, Lisp_Object);
2099 swapfield_ (zv_marker, Lisp_Object);
2100 BVAR (current_buffer, point_before_scroll) = Qnil;
2101 BVAR (other_buffer, point_before_scroll) = Qnil;
2103 current_buffer->text->modiff++; other_buffer->text->modiff++;
2104 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2105 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2106 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2107 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2108 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2109 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2111 struct Lisp_Marker *m;
2112 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2113 if (m->buffer == other_buffer)
2114 m->buffer = current_buffer;
2115 else
2116 /* Since there's no indirect buffer in sight, markers on
2117 BUF_MARKERS(buf) should either be for `buf' or dead. */
2118 eassert (!m->buffer);
2119 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2120 if (m->buffer == current_buffer)
2121 m->buffer = other_buffer;
2122 else
2123 /* Since there's no indirect buffer in sight, markers on
2124 BUF_MARKERS(buf) should either be for `buf' or dead. */
2125 eassert (!m->buffer);
2127 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2128 So since we just swapped the markers between the two buffers, we need
2129 to undo the effect of this swap for window markers. */
2130 Lisp_Object w = Fselected_window (), ws = Qnil;
2131 Lisp_Object buf1, buf2;
2132 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2134 while (NILP (Fmemq (w, ws)))
2136 ws = Fcons (w, ws);
2137 if (MARKERP (XWINDOW (w)->pointm)
2138 && (EQ (XWINDOW (w)->buffer, buf1)
2139 || EQ (XWINDOW (w)->buffer, buf2)))
2140 Fset_marker (XWINDOW (w)->pointm,
2141 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2142 XWINDOW (w)->buffer);
2143 w = Fnext_window (w, Qt, Qt);
2147 if (current_buffer->text->intervals)
2148 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2149 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2150 if (other_buffer->text->intervals)
2151 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2152 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2154 return Qnil;
2157 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2158 1, 1, 0,
2159 doc: /* Set the multibyte flag of the current buffer to FLAG.
2160 If FLAG is t, this makes the buffer a multibyte buffer.
2161 If FLAG is nil, this makes the buffer a single-byte buffer.
2162 In these cases, the buffer contents remain unchanged as a sequence of
2163 bytes but the contents viewed as characters do change.
2164 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2165 all eight-bit bytes to eight-bit characters.
2166 If the multibyte flag was really changed, undo information of the
2167 current buffer is cleared. */)
2168 (Lisp_Object flag)
2170 struct Lisp_Marker *tail, *markers;
2171 struct buffer *other;
2172 EMACS_INT begv, zv;
2173 int narrowed = (BEG != BEGV || Z != ZV);
2174 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2175 Lisp_Object old_undo = BVAR (current_buffer, undo_list);
2176 struct gcpro gcpro1;
2178 if (current_buffer->base_buffer)
2179 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2181 /* Do nothing if nothing actually changes. */
2182 if (NILP (flag) == NILP (BVAR (current_buffer, enable_multibyte_characters)))
2183 return flag;
2185 GCPRO1 (old_undo);
2187 /* Don't record these buffer changes. We will put a special undo entry
2188 instead. */
2189 BVAR (current_buffer, undo_list) = Qt;
2191 /* If the cached position is for this buffer, clear it out. */
2192 clear_charpos_cache (current_buffer);
2194 if (NILP (flag))
2195 begv = BEGV_BYTE, zv = ZV_BYTE;
2196 else
2197 begv = BEGV, zv = ZV;
2199 if (narrowed)
2200 Fwiden ();
2202 if (NILP (flag))
2204 EMACS_INT pos, stop;
2205 unsigned char *p;
2207 /* Do this first, so it can use CHAR_TO_BYTE
2208 to calculate the old correspondences. */
2209 set_intervals_multibyte (0);
2211 BVAR (current_buffer, enable_multibyte_characters) = Qnil;
2213 Z = Z_BYTE;
2214 BEGV = BEGV_BYTE;
2215 ZV = ZV_BYTE;
2216 GPT = GPT_BYTE;
2217 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2220 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2221 tail->charpos = tail->bytepos;
2223 /* Convert multibyte form of 8-bit characters to unibyte. */
2224 pos = BEG;
2225 stop = GPT;
2226 p = BEG_ADDR;
2227 while (1)
2229 int c, bytes;
2231 if (pos == stop)
2233 if (pos == Z)
2234 break;
2235 p = GAP_END_ADDR;
2236 stop = Z;
2238 if (ASCII_BYTE_P (*p))
2239 p++, pos++;
2240 else if (CHAR_BYTE8_HEAD_P (*p))
2242 c = STRING_CHAR_AND_LENGTH (p, bytes);
2243 /* Delete all bytes for this 8-bit character but the
2244 last one, and change the last one to the character
2245 code. */
2246 bytes--;
2247 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2248 p = GAP_END_ADDR;
2249 *p++ = c;
2250 pos++;
2251 if (begv > pos)
2252 begv -= bytes;
2253 if (zv > pos)
2254 zv -= bytes;
2255 stop = Z;
2257 else
2259 bytes = BYTES_BY_CHAR_HEAD (*p);
2260 p += bytes, pos += bytes;
2263 if (narrowed)
2264 Fnarrow_to_region (make_number (begv), make_number (zv));
2266 else
2268 EMACS_INT pt = PT;
2269 EMACS_INT pos, stop;
2270 unsigned char *p, *pend;
2272 /* Be sure not to have a multibyte sequence striding over the GAP.
2273 Ex: We change this: "...abc\302 _GAP_ \241def..."
2274 to: "...abc _GAP_ \302\241def..." */
2276 if (EQ (flag, Qt)
2277 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2278 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2280 unsigned char *q = GPT_ADDR - 1;
2282 while (! CHAR_HEAD_P (*q) && q > BEG_ADDR) q--;
2283 if (LEADING_CODE_P (*q))
2285 EMACS_INT new_gpt = GPT_BYTE - (GPT_ADDR - q);
2287 move_gap_both (new_gpt, new_gpt);
2291 /* Make the buffer contents valid as multibyte by converting
2292 8-bit characters to multibyte form. */
2293 pos = BEG;
2294 stop = GPT;
2295 p = BEG_ADDR;
2296 pend = GPT_ADDR;
2297 while (1)
2299 int bytes;
2301 if (pos == stop)
2303 if (pos == Z)
2304 break;
2305 p = GAP_END_ADDR;
2306 pend = Z_ADDR;
2307 stop = Z;
2310 if (ASCII_BYTE_P (*p))
2311 p++, pos++;
2312 else if (EQ (flag, Qt)
2313 && ! CHAR_BYTE8_HEAD_P (*p)
2314 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2315 p += bytes, pos += bytes;
2316 else
2318 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2319 int c;
2321 c = BYTE8_TO_CHAR (*p);
2322 bytes = CHAR_STRING (c, tmp);
2323 *p = tmp[0];
2324 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2325 bytes--;
2326 insert_1_both ((char *) tmp + 1, bytes, bytes, 1, 0, 0);
2327 /* Now the gap is after the just inserted data. */
2328 pos = GPT;
2329 p = GAP_END_ADDR;
2330 if (pos <= begv)
2331 begv += bytes;
2332 if (pos <= zv)
2333 zv += bytes;
2334 if (pos <= pt)
2335 pt += bytes;
2336 pend = Z_ADDR;
2337 stop = Z;
2341 if (pt != PT)
2342 TEMP_SET_PT (pt);
2344 if (narrowed)
2345 Fnarrow_to_region (make_number (begv), make_number (zv));
2347 /* Do this first, so that chars_in_text asks the right question.
2348 set_intervals_multibyte needs it too. */
2349 BVAR (current_buffer, enable_multibyte_characters) = Qt;
2351 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2352 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2354 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2356 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2357 if (BEGV_BYTE > GPT_BYTE)
2358 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2359 else
2360 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2362 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2363 if (ZV_BYTE > GPT_BYTE)
2364 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2365 else
2366 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2369 EMACS_INT byte = advance_to_char_boundary (PT_BYTE);
2370 EMACS_INT position;
2372 if (byte > GPT_BYTE)
2373 position = chars_in_text (GAP_END_ADDR, byte - GPT_BYTE) + GPT;
2374 else
2375 position = chars_in_text (BEG_ADDR, byte - BEG_BYTE) + BEG;
2376 TEMP_SET_PT_BOTH (position, byte);
2379 tail = markers = BUF_MARKERS (current_buffer);
2381 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2382 getting confused by the markers that have not yet been updated.
2383 It is also a signal that it should never create a marker. */
2384 BUF_MARKERS (current_buffer) = NULL;
2386 for (; tail; tail = tail->next)
2388 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2389 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2392 /* Make sure no markers were put on the chain
2393 while the chain value was incorrect. */
2394 if (BUF_MARKERS (current_buffer))
2395 abort ();
2397 BUF_MARKERS (current_buffer) = markers;
2399 /* Do this last, so it can calculate the new correspondences
2400 between chars and bytes. */
2401 set_intervals_multibyte (1);
2404 if (!EQ (old_undo, Qt))
2406 /* Represent all the above changes by a special undo entry. */
2407 BVAR (current_buffer, undo_list) = Fcons (list3 (Qapply,
2408 intern ("set-buffer-multibyte"),
2409 NILP (flag) ? Qt : Qnil),
2410 old_undo);
2413 UNGCPRO;
2415 /* Changing the multibyteness of a buffer means that all windows
2416 showing that buffer must be updated thoroughly. */
2417 current_buffer->prevent_redisplay_optimizations_p = 1;
2418 ++windows_or_buffers_changed;
2420 /* Copy this buffer's new multibyte status
2421 into all of its indirect buffers. */
2422 for (other = all_buffers; other; other = other->header.next.buffer)
2423 if (other->base_buffer == current_buffer && !NILP (BVAR (other, name)))
2425 BVAR (other, enable_multibyte_characters)
2426 = BVAR (current_buffer, enable_multibyte_characters);
2427 other->prevent_redisplay_optimizations_p = 1;
2430 /* Restore the modifiedness of the buffer. */
2431 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2432 Fset_buffer_modified_p (Qnil);
2434 /* Update coding systems of this buffer's process (if any). */
2436 Lisp_Object process;
2438 process = Fget_buffer_process (Fcurrent_buffer ());
2439 if (PROCESSP (process))
2440 setup_process_coding_systems (process);
2443 return flag;
2446 DEFUN ("kill-all-local-variables", Fkill_all_local_variables,
2447 Skill_all_local_variables, 0, 0, 0,
2448 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2449 Most local variable bindings are eliminated so that the default values
2450 become effective once more. Also, the syntax table is set from
2451 `standard-syntax-table', the local keymap is set to nil,
2452 and the abbrev table from `fundamental-mode-abbrev-table'.
2453 This function also forces redisplay of the mode line.
2455 Every function to select a new major mode starts by
2456 calling this function.
2458 As a special exception, local variables whose names have
2459 a non-nil `permanent-local' property are not eliminated by this function.
2461 The first thing this function does is run
2462 the normal hook `change-major-mode-hook'. */)
2463 (void)
2465 Frun_hooks (1, &Qchange_major_mode_hook);
2467 /* Make sure none of the bindings in local_var_alist
2468 remain swapped in, in their symbols. */
2470 swap_out_buffer_local_variables (current_buffer);
2472 /* Actually eliminate all local bindings of this buffer. */
2474 reset_buffer_local_variables (current_buffer, 0);
2476 /* Force mode-line redisplay. Useful here because all major mode
2477 commands call this function. */
2478 update_mode_lines++;
2480 return Qnil;
2483 /* Make sure no local variables remain set up with buffer B
2484 for their current values. */
2486 static void
2487 swap_out_buffer_local_variables (struct buffer *b)
2489 Lisp_Object oalist, alist, buffer;
2491 XSETBUFFER (buffer, b);
2492 oalist = BVAR (b, local_var_alist);
2494 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2496 Lisp_Object sym = XCAR (XCAR (alist));
2497 eassert (XSYMBOL (sym)->redirect == SYMBOL_LOCALIZED);
2498 /* Need not do anything if some other buffer's binding is
2499 now cached. */
2500 if (EQ (SYMBOL_BLV (XSYMBOL (sym))->where, buffer))
2502 /* Symbol is set up for this buffer's old local value:
2503 swap it out! */
2504 swap_in_global_binding (XSYMBOL (sym));
2509 /* Find all the overlays in the current buffer that contain position POS.
2510 Return the number found, and store them in a vector in *VEC_PTR.
2511 Store in *LEN_PTR the size allocated for the vector.
2512 Store in *NEXT_PTR the next position after POS where an overlay starts,
2513 or ZV if there are no more overlays between POS and ZV.
2514 Store in *PREV_PTR the previous position before POS where an overlay ends,
2515 or where an overlay starts which ends at or after POS;
2516 or BEGV if there are no such overlays from BEGV to POS.
2517 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2519 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2520 when this function is called.
2522 If EXTEND is non-zero, we make the vector bigger if necessary.
2523 If EXTEND is zero, we never extend the vector,
2524 and we store only as many overlays as will fit.
2525 But we still return the total number of overlays.
2527 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2528 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2529 default (BEGV or ZV). */
2531 ptrdiff_t
2532 overlays_at (EMACS_INT pos, int extend, Lisp_Object **vec_ptr,
2533 ptrdiff_t *len_ptr,
2534 EMACS_INT *next_ptr, EMACS_INT *prev_ptr, int change_req)
2536 Lisp_Object overlay, start, end;
2537 struct Lisp_Overlay *tail;
2538 ptrdiff_t idx = 0;
2539 ptrdiff_t len = *len_ptr;
2540 Lisp_Object *vec = *vec_ptr;
2541 EMACS_INT next = ZV;
2542 EMACS_INT prev = BEGV;
2543 int inhibit_storing = 0;
2545 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2547 EMACS_INT startpos, endpos;
2549 XSETMISC (overlay, tail);
2551 start = OVERLAY_START (overlay);
2552 end = OVERLAY_END (overlay);
2553 endpos = OVERLAY_POSITION (end);
2554 if (endpos < pos)
2556 if (prev < endpos)
2557 prev = endpos;
2558 break;
2560 startpos = OVERLAY_POSITION (start);
2561 /* This one ends at or after POS
2562 so its start counts for PREV_PTR if it's before POS. */
2563 if (prev < startpos && startpos < pos)
2564 prev = startpos;
2565 if (endpos == pos)
2566 continue;
2567 if (startpos <= pos)
2569 if (idx == len)
2571 /* The supplied vector is full.
2572 Either make it bigger, or don't store any more in it. */
2573 if (extend)
2575 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2576 sizeof *vec);
2577 *vec_ptr = vec;
2578 len = *len_ptr;
2580 else
2581 inhibit_storing = 1;
2584 if (!inhibit_storing)
2585 vec[idx] = overlay;
2586 /* Keep counting overlays even if we can't return them all. */
2587 idx++;
2589 else if (startpos < next)
2590 next = startpos;
2593 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2595 EMACS_INT startpos, endpos;
2597 XSETMISC (overlay, tail);
2599 start = OVERLAY_START (overlay);
2600 end = OVERLAY_END (overlay);
2601 startpos = OVERLAY_POSITION (start);
2602 if (pos < startpos)
2604 if (startpos < next)
2605 next = startpos;
2606 break;
2608 endpos = OVERLAY_POSITION (end);
2609 if (pos < endpos)
2611 if (idx == len)
2613 if (extend)
2615 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2616 sizeof *vec);
2617 *vec_ptr = vec;
2618 len = *len_ptr;
2620 else
2621 inhibit_storing = 1;
2624 if (!inhibit_storing)
2625 vec[idx] = overlay;
2626 idx++;
2628 if (startpos < pos && startpos > prev)
2629 prev = startpos;
2631 else if (endpos < pos && endpos > prev)
2632 prev = endpos;
2633 else if (endpos == pos && startpos > prev
2634 && (!change_req || startpos < pos))
2635 prev = startpos;
2638 if (next_ptr)
2639 *next_ptr = next;
2640 if (prev_ptr)
2641 *prev_ptr = prev;
2642 return idx;
2645 /* Find all the overlays in the current buffer that overlap the range
2646 BEG-END, or are empty at BEG, or are empty at END provided END
2647 denotes the position at the end of the current buffer.
2649 Return the number found, and store them in a vector in *VEC_PTR.
2650 Store in *LEN_PTR the size allocated for the vector.
2651 Store in *NEXT_PTR the next position after POS where an overlay starts,
2652 or ZV if there are no more overlays.
2653 Store in *PREV_PTR the previous position before POS where an overlay ends,
2654 or BEGV if there are no previous overlays.
2655 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2657 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2658 when this function is called.
2660 If EXTEND is non-zero, we make the vector bigger if necessary.
2661 If EXTEND is zero, we never extend the vector,
2662 and we store only as many overlays as will fit.
2663 But we still return the total number of overlays. */
2665 static ptrdiff_t
2666 overlays_in (EMACS_INT beg, EMACS_INT end, int extend,
2667 Lisp_Object **vec_ptr, ptrdiff_t *len_ptr,
2668 EMACS_INT *next_ptr, EMACS_INT *prev_ptr)
2670 Lisp_Object overlay, ostart, oend;
2671 struct Lisp_Overlay *tail;
2672 ptrdiff_t idx = 0;
2673 ptrdiff_t len = *len_ptr;
2674 Lisp_Object *vec = *vec_ptr;
2675 EMACS_INT next = ZV;
2676 EMACS_INT prev = BEGV;
2677 int inhibit_storing = 0;
2678 int end_is_Z = end == Z;
2680 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2682 EMACS_INT startpos, endpos;
2684 XSETMISC (overlay, tail);
2686 ostart = OVERLAY_START (overlay);
2687 oend = OVERLAY_END (overlay);
2688 endpos = OVERLAY_POSITION (oend);
2689 if (endpos < beg)
2691 if (prev < endpos)
2692 prev = endpos;
2693 break;
2695 startpos = OVERLAY_POSITION (ostart);
2696 /* Count an interval if it overlaps the range, is empty at the
2697 start of the range, or is empty at END provided END denotes the
2698 end of the buffer. */
2699 if ((beg < endpos && startpos < end)
2700 || (startpos == endpos
2701 && (beg == endpos || (end_is_Z && endpos == end))))
2703 if (idx == len)
2705 /* The supplied vector is full.
2706 Either make it bigger, or don't store any more in it. */
2707 if (extend)
2709 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2710 sizeof *vec);
2711 *vec_ptr = vec;
2712 len = *len_ptr;
2714 else
2715 inhibit_storing = 1;
2718 if (!inhibit_storing)
2719 vec[idx] = overlay;
2720 /* Keep counting overlays even if we can't return them all. */
2721 idx++;
2723 else if (startpos < next)
2724 next = startpos;
2727 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2729 EMACS_INT startpos, endpos;
2731 XSETMISC (overlay, tail);
2733 ostart = OVERLAY_START (overlay);
2734 oend = OVERLAY_END (overlay);
2735 startpos = OVERLAY_POSITION (ostart);
2736 if (end < startpos)
2738 if (startpos < next)
2739 next = startpos;
2740 break;
2742 endpos = OVERLAY_POSITION (oend);
2743 /* Count an interval if it overlaps the range, is empty at the
2744 start of the range, or is empty at END provided END denotes the
2745 end of the buffer. */
2746 if ((beg < endpos && startpos < end)
2747 || (startpos == endpos
2748 && (beg == endpos || (end_is_Z && endpos == end))))
2750 if (idx == len)
2752 if (extend)
2754 vec = xpalloc (vec, len_ptr, 1, OVERLAY_COUNT_MAX,
2755 sizeof *vec);
2756 *vec_ptr = vec;
2757 len = *len_ptr;
2759 else
2760 inhibit_storing = 1;
2763 if (!inhibit_storing)
2764 vec[idx] = overlay;
2765 idx++;
2767 else if (endpos < beg && endpos > prev)
2768 prev = endpos;
2771 if (next_ptr)
2772 *next_ptr = next;
2773 if (prev_ptr)
2774 *prev_ptr = prev;
2775 return idx;
2779 /* Return non-zero if there exists an overlay with a non-nil
2780 `mouse-face' property overlapping OVERLAY. */
2783 mouse_face_overlay_overlaps (Lisp_Object overlay)
2785 EMACS_INT start = OVERLAY_POSITION (OVERLAY_START (overlay));
2786 EMACS_INT end = OVERLAY_POSITION (OVERLAY_END (overlay));
2787 ptrdiff_t n, i, size;
2788 Lisp_Object *v, tem;
2790 size = 10;
2791 v = (Lisp_Object *) alloca (size * sizeof *v);
2792 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2793 if (n > size)
2795 v = (Lisp_Object *) alloca (n * sizeof *v);
2796 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2799 for (i = 0; i < n; ++i)
2800 if (!EQ (v[i], overlay)
2801 && (tem = Foverlay_get (overlay, Qmouse_face),
2802 !NILP (tem)))
2803 break;
2805 return i < n;
2810 /* Fast function to just test if we're at an overlay boundary. */
2812 overlay_touches_p (EMACS_INT pos)
2814 Lisp_Object overlay;
2815 struct Lisp_Overlay *tail;
2817 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2819 EMACS_INT endpos;
2821 XSETMISC (overlay ,tail);
2822 if (!OVERLAYP (overlay))
2823 abort ();
2825 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2826 if (endpos < pos)
2827 break;
2828 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2829 return 1;
2832 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2834 EMACS_INT startpos;
2836 XSETMISC (overlay, tail);
2837 if (!OVERLAYP (overlay))
2838 abort ();
2840 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2841 if (pos < startpos)
2842 break;
2843 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2844 return 1;
2846 return 0;
2849 struct sortvec
2851 Lisp_Object overlay;
2852 EMACS_INT beg, end;
2853 EMACS_INT priority;
2856 static int
2857 compare_overlays (const void *v1, const void *v2)
2859 const struct sortvec *s1 = (const struct sortvec *) v1;
2860 const struct sortvec *s2 = (const struct sortvec *) v2;
2861 if (s1->priority != s2->priority)
2862 return s1->priority < s2->priority ? -1 : 1;
2863 if (s1->beg != s2->beg)
2864 return s1->beg < s2->beg ? -1 : 1;
2865 if (s1->end != s2->end)
2866 return s2->end < s1->end ? -1 : 1;
2867 return 0;
2870 /* Sort an array of overlays by priority. The array is modified in place.
2871 The return value is the new size; this may be smaller than the original
2872 size if some of the overlays were invalid or were window-specific. */
2873 ptrdiff_t
2874 sort_overlays (Lisp_Object *overlay_vec, ptrdiff_t noverlays, struct window *w)
2876 ptrdiff_t i, j;
2877 struct sortvec *sortvec;
2878 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2880 /* Put the valid and relevant overlays into sortvec. */
2882 for (i = 0, j = 0; i < noverlays; i++)
2884 Lisp_Object tem;
2885 Lisp_Object overlay;
2887 overlay = overlay_vec[i];
2888 if (OVERLAY_VALID (overlay)
2889 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2890 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2892 /* If we're interested in a specific window, then ignore
2893 overlays that are limited to some other window. */
2894 if (w)
2896 Lisp_Object window;
2898 window = Foverlay_get (overlay, Qwindow);
2899 if (WINDOWP (window) && XWINDOW (window) != w)
2900 continue;
2903 /* This overlay is good and counts: put it into sortvec. */
2904 sortvec[j].overlay = overlay;
2905 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2906 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2907 tem = Foverlay_get (overlay, Qpriority);
2908 if (INTEGERP (tem))
2909 sortvec[j].priority = XINT (tem);
2910 else
2911 sortvec[j].priority = 0;
2912 j++;
2915 noverlays = j;
2917 /* Sort the overlays into the proper order: increasing priority. */
2919 if (noverlays > 1)
2920 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2922 for (i = 0; i < noverlays; i++)
2923 overlay_vec[i] = sortvec[i].overlay;
2924 return (noverlays);
2927 struct sortstr
2929 Lisp_Object string, string2;
2930 ptrdiff_t size;
2931 EMACS_INT priority;
2934 struct sortstrlist
2936 struct sortstr *buf; /* An array that expands as needed; never freed. */
2937 ptrdiff_t size; /* Allocated length of that array. */
2938 ptrdiff_t used; /* How much of the array is currently in use. */
2939 ptrdiff_t bytes; /* Total length of the strings in buf. */
2942 /* Buffers for storing information about the overlays touching a given
2943 position. These could be automatic variables in overlay_strings, but
2944 it's more efficient to hold onto the memory instead of repeatedly
2945 allocating and freeing it. */
2946 static struct sortstrlist overlay_heads, overlay_tails;
2947 static unsigned char *overlay_str_buf;
2949 /* Allocated length of overlay_str_buf. */
2950 static ptrdiff_t overlay_str_len;
2952 /* A comparison function suitable for passing to qsort. */
2953 static int
2954 cmp_for_strings (const void *as1, const void *as2)
2956 struct sortstr *s1 = (struct sortstr *)as1;
2957 struct sortstr *s2 = (struct sortstr *)as2;
2958 if (s1->size != s2->size)
2959 return s2->size < s1->size ? -1 : 1;
2960 if (s1->priority != s2->priority)
2961 return s1->priority < s2->priority ? -1 : 1;
2962 return 0;
2965 static void
2966 record_overlay_string (struct sortstrlist *ssl, Lisp_Object str,
2967 Lisp_Object str2, Lisp_Object pri, ptrdiff_t size)
2969 EMACS_INT nbytes;
2971 if (ssl->used == ssl->size)
2972 ssl->buf = xpalloc (ssl->buf, &ssl->size, 5, -1, sizeof *ssl->buf);
2973 ssl->buf[ssl->used].string = str;
2974 ssl->buf[ssl->used].string2 = str2;
2975 ssl->buf[ssl->used].size = size;
2976 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2977 ssl->used++;
2979 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2980 nbytes = SCHARS (str);
2981 else if (! STRING_MULTIBYTE (str))
2982 nbytes = count_size_as_multibyte (SDATA (str),
2983 SBYTES (str));
2984 else
2985 nbytes = SBYTES (str);
2987 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
2988 memory_full (SIZE_MAX);
2989 ssl->bytes += nbytes;
2991 if (STRINGP (str2))
2993 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
2994 nbytes = SCHARS (str2);
2995 else if (! STRING_MULTIBYTE (str2))
2996 nbytes = count_size_as_multibyte (SDATA (str2),
2997 SBYTES (str2));
2998 else
2999 nbytes = SBYTES (str2);
3001 if (INT_ADD_OVERFLOW (ssl->bytes, nbytes))
3002 memory_full (SIZE_MAX);
3003 ssl->bytes += nbytes;
3007 /* Return the concatenation of the strings associated with overlays that
3008 begin or end at POS, ignoring overlays that are specific to a window
3009 other than W. The strings are concatenated in the appropriate order:
3010 shorter overlays nest inside longer ones, and higher priority inside
3011 lower. Normally all of the after-strings come first, but zero-sized
3012 overlays have their after-strings ride along with the before-strings
3013 because it would look strange to print them inside-out.
3015 Returns the string length, and stores the contents indirectly through
3016 PSTR, if that variable is non-null. The string may be overwritten by
3017 subsequent calls. */
3019 EMACS_INT
3020 overlay_strings (EMACS_INT pos, struct window *w, unsigned char **pstr)
3022 Lisp_Object overlay, window, str;
3023 struct Lisp_Overlay *ov;
3024 EMACS_INT startpos, endpos;
3025 int multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
3027 overlay_heads.used = overlay_heads.bytes = 0;
3028 overlay_tails.used = overlay_tails.bytes = 0;
3029 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3031 XSETMISC (overlay, ov);
3032 eassert (OVERLAYP (overlay));
3034 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3035 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3036 if (endpos < pos)
3037 break;
3038 if (endpos != pos && startpos != pos)
3039 continue;
3040 window = Foverlay_get (overlay, Qwindow);
3041 if (WINDOWP (window) && XWINDOW (window) != w)
3042 continue;
3043 if (startpos == pos
3044 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3045 record_overlay_string (&overlay_heads, str,
3046 (startpos == endpos
3047 ? Foverlay_get (overlay, Qafter_string)
3048 : Qnil),
3049 Foverlay_get (overlay, Qpriority),
3050 endpos - startpos);
3051 else if (endpos == pos
3052 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3053 record_overlay_string (&overlay_tails, str, Qnil,
3054 Foverlay_get (overlay, Qpriority),
3055 endpos - startpos);
3057 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3059 XSETMISC (overlay, ov);
3060 eassert (OVERLAYP (overlay));
3062 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3063 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3064 if (startpos > pos)
3065 break;
3066 if (endpos != pos && startpos != pos)
3067 continue;
3068 window = Foverlay_get (overlay, Qwindow);
3069 if (WINDOWP (window) && XWINDOW (window) != w)
3070 continue;
3071 if (startpos == pos
3072 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3073 record_overlay_string (&overlay_heads, str,
3074 (startpos == endpos
3075 ? Foverlay_get (overlay, Qafter_string)
3076 : Qnil),
3077 Foverlay_get (overlay, Qpriority),
3078 endpos - startpos);
3079 else if (endpos == pos
3080 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3081 record_overlay_string (&overlay_tails, str, Qnil,
3082 Foverlay_get (overlay, Qpriority),
3083 endpos - startpos);
3085 if (overlay_tails.used > 1)
3086 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3087 cmp_for_strings);
3088 if (overlay_heads.used > 1)
3089 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3090 cmp_for_strings);
3091 if (overlay_heads.bytes || overlay_tails.bytes)
3093 Lisp_Object tem;
3094 EMACS_INT i;
3095 unsigned char *p;
3096 ptrdiff_t total;
3098 if (INT_ADD_OVERFLOW (overlay_heads.bytes, overlay_tails.bytes))
3099 memory_full (SIZE_MAX);
3100 total = overlay_heads.bytes + overlay_tails.bytes;
3101 if (total > overlay_str_len)
3102 overlay_str_buf = xpalloc (overlay_str_buf, &overlay_str_len,
3103 total - overlay_str_len, -1, 1);
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 ptrdiff_t len, noverlays;
3878 Lisp_Object *overlay_vec;
3879 Lisp_Object result;
3881 CHECK_NUMBER_COERCE_MARKER (pos);
3883 len = 10;
3884 /* We can't use alloca here because overlays_at can call xrealloc. */
3885 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3887 /* Put all the overlays we want in a vector in overlay_vec.
3888 Store the length in len. */
3889 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3890 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
3892 /* Make a list of them all. */
3893 result = Flist (noverlays, overlay_vec);
3895 xfree (overlay_vec);
3896 return result;
3899 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3900 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3901 Overlap means that at least one character is contained within the overlay
3902 and also contained within the specified region.
3903 Empty overlays are included in the result if they are located at BEG,
3904 between BEG and END, or at END provided END denotes the position at the
3905 end of the buffer. */)
3906 (Lisp_Object beg, Lisp_Object end)
3908 ptrdiff_t len, noverlays;
3909 Lisp_Object *overlay_vec;
3910 Lisp_Object result;
3912 CHECK_NUMBER_COERCE_MARKER (beg);
3913 CHECK_NUMBER_COERCE_MARKER (end);
3915 len = 10;
3916 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3918 /* Put all the overlays we want in a vector in overlay_vec.
3919 Store the length in len. */
3920 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3921 NULL, NULL);
3923 /* Make a list of them all. */
3924 result = Flist (noverlays, overlay_vec);
3926 xfree (overlay_vec);
3927 return result;
3930 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3931 1, 1, 0,
3932 doc: /* Return the next position after POS where an overlay starts or ends.
3933 If there are no overlay boundaries from POS to (point-max),
3934 the value is (point-max). */)
3935 (Lisp_Object pos)
3937 ptrdiff_t i, len, noverlays;
3938 EMACS_INT endpos;
3939 Lisp_Object *overlay_vec;
3941 CHECK_NUMBER_COERCE_MARKER (pos);
3943 len = 10;
3944 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3946 /* Put all the overlays we want in a vector in overlay_vec.
3947 Store the length in len.
3948 endpos gets the position where the next overlay starts. */
3949 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3950 &endpos, (EMACS_INT *) 0, 1);
3952 /* If any of these overlays ends before endpos,
3953 use its ending point instead. */
3954 for (i = 0; i < noverlays; i++)
3956 Lisp_Object oend;
3957 EMACS_INT oendpos;
3959 oend = OVERLAY_END (overlay_vec[i]);
3960 oendpos = OVERLAY_POSITION (oend);
3961 if (oendpos < endpos)
3962 endpos = oendpos;
3965 xfree (overlay_vec);
3966 return make_number (endpos);
3969 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3970 Sprevious_overlay_change, 1, 1, 0,
3971 doc: /* Return the previous position before POS where an overlay starts or ends.
3972 If there are no overlay boundaries from (point-min) to POS,
3973 the value is (point-min). */)
3974 (Lisp_Object pos)
3976 EMACS_INT prevpos;
3977 Lisp_Object *overlay_vec;
3978 ptrdiff_t len;
3980 CHECK_NUMBER_COERCE_MARKER (pos);
3982 /* At beginning of buffer, we know the answer;
3983 avoid bug subtracting 1 below. */
3984 if (XINT (pos) == BEGV)
3985 return pos;
3987 len = 10;
3988 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3990 /* Put all the overlays we want in a vector in overlay_vec.
3991 Store the length in len.
3992 prevpos gets the position of the previous change. */
3993 overlays_at (XINT (pos), 1, &overlay_vec, &len,
3994 (EMACS_INT *) 0, &prevpos, 1);
3996 xfree (overlay_vec);
3997 return make_number (prevpos);
4000 /* These functions are for debugging overlays. */
4002 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4003 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4004 The car has all the overlays before the overlay center;
4005 the cdr has all the overlays after the overlay center.
4006 Recentering overlays moves overlays between these lists.
4007 The lists you get are copies, so that changing them has no effect.
4008 However, the overlays you get are the real objects that the buffer uses. */)
4009 (void)
4011 struct Lisp_Overlay *ol;
4012 Lisp_Object before = Qnil, after = Qnil, tmp;
4013 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4015 XSETMISC (tmp, ol);
4016 before = Fcons (tmp, before);
4018 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4020 XSETMISC (tmp, ol);
4021 after = Fcons (tmp, after);
4023 return Fcons (Fnreverse (before), Fnreverse (after));
4026 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4027 doc: /* Recenter the overlays of the current buffer around position POS.
4028 That makes overlay lookup faster for positions near POS (but perhaps slower
4029 for positions far away from POS). */)
4030 (Lisp_Object pos)
4032 CHECK_NUMBER_COERCE_MARKER (pos);
4034 recenter_overlay_lists (current_buffer, XINT (pos));
4035 return Qnil;
4038 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4039 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4040 (Lisp_Object overlay, Lisp_Object prop)
4042 CHECK_OVERLAY (overlay);
4043 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4046 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4047 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE.
4048 VALUE will be returned.*/)
4049 (Lisp_Object overlay, Lisp_Object prop, Lisp_Object value)
4051 Lisp_Object tail, buffer;
4052 int changed;
4054 CHECK_OVERLAY (overlay);
4056 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4058 for (tail = XOVERLAY (overlay)->plist;
4059 CONSP (tail) && CONSP (XCDR (tail));
4060 tail = XCDR (XCDR (tail)))
4061 if (EQ (XCAR (tail), prop))
4063 changed = !EQ (XCAR (XCDR (tail)), value);
4064 XSETCAR (XCDR (tail), value);
4065 goto found;
4067 /* It wasn't in the list, so add it to the front. */
4068 changed = !NILP (value);
4069 XOVERLAY (overlay)->plist
4070 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4071 found:
4072 if (! NILP (buffer))
4074 if (changed)
4075 modify_overlay (XBUFFER (buffer),
4076 marker_position (OVERLAY_START (overlay)),
4077 marker_position (OVERLAY_END (overlay)));
4078 if (EQ (prop, Qevaporate) && ! NILP (value)
4079 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4080 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4081 Fdelete_overlay (overlay);
4084 return value;
4087 /* Subroutine of report_overlay_modification. */
4089 /* Lisp vector holding overlay hook functions to call.
4090 Vector elements come in pairs.
4091 Each even-index element is a list of hook functions.
4092 The following odd-index element is the overlay they came from.
4094 Before the buffer change, we fill in this vector
4095 as we call overlay hook functions.
4096 After the buffer change, we get the functions to call from this vector.
4097 This way we always call the same functions before and after the change. */
4098 static Lisp_Object last_overlay_modification_hooks;
4100 /* Number of elements actually used in last_overlay_modification_hooks. */
4101 static int last_overlay_modification_hooks_used;
4103 /* Add one functionlist/overlay pair
4104 to the end of last_overlay_modification_hooks. */
4106 static void
4107 add_overlay_mod_hooklist (Lisp_Object functionlist, Lisp_Object overlay)
4109 int oldsize = ASIZE (last_overlay_modification_hooks);
4111 if (last_overlay_modification_hooks_used == oldsize)
4112 last_overlay_modification_hooks = larger_vector
4113 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4114 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4115 functionlist); last_overlay_modification_hooks_used++;
4116 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4117 overlay); last_overlay_modification_hooks_used++;
4120 /* Run the modification-hooks of overlays that include
4121 any part of the text in START to END.
4122 If this change is an insertion, also
4123 run the insert-before-hooks of overlay starting at END,
4124 and the insert-after-hooks of overlay ending at START.
4126 This is called both before and after the modification.
4127 AFTER is nonzero when we call after the modification.
4129 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4130 When AFTER is nonzero, they are the start position,
4131 the position after the inserted new text,
4132 and the length of deleted or replaced old text. */
4134 void
4135 report_overlay_modification (Lisp_Object start, Lisp_Object end, int after,
4136 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4138 Lisp_Object prop, overlay;
4139 struct Lisp_Overlay *tail;
4140 /* 1 if this change is an insertion. */
4141 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4142 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4144 overlay = Qnil;
4145 tail = NULL;
4147 /* We used to run the functions as soon as we found them and only register
4148 them in last_overlay_modification_hooks for the purpose of the `after'
4149 case. But running elisp code as we traverse the list of overlays is
4150 painful because the list can be modified by the elisp code so we had to
4151 copy at several places. We now simply do a read-only traversal that
4152 only collects the functions to run and we run them afterwards. It's
4153 simpler, especially since all the code was already there. -stef */
4155 if (!after)
4157 /* We are being called before a change.
4158 Scan the overlays to find the functions to call. */
4159 last_overlay_modification_hooks_used = 0;
4160 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4162 EMACS_INT startpos, endpos;
4163 Lisp_Object ostart, oend;
4165 XSETMISC (overlay, tail);
4167 ostart = OVERLAY_START (overlay);
4168 oend = OVERLAY_END (overlay);
4169 endpos = OVERLAY_POSITION (oend);
4170 if (XFASTINT (start) > endpos)
4171 break;
4172 startpos = OVERLAY_POSITION (ostart);
4173 if (insertion && (XFASTINT (start) == startpos
4174 || XFASTINT (end) == startpos))
4176 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4177 if (!NILP (prop))
4178 add_overlay_mod_hooklist (prop, overlay);
4180 if (insertion && (XFASTINT (start) == endpos
4181 || XFASTINT (end) == endpos))
4183 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4184 if (!NILP (prop))
4185 add_overlay_mod_hooklist (prop, overlay);
4187 /* Test for intersecting intervals. This does the right thing
4188 for both insertion and deletion. */
4189 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4191 prop = Foverlay_get (overlay, Qmodification_hooks);
4192 if (!NILP (prop))
4193 add_overlay_mod_hooklist (prop, overlay);
4197 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4199 EMACS_INT startpos, endpos;
4200 Lisp_Object ostart, oend;
4202 XSETMISC (overlay, tail);
4204 ostart = OVERLAY_START (overlay);
4205 oend = OVERLAY_END (overlay);
4206 startpos = OVERLAY_POSITION (ostart);
4207 endpos = OVERLAY_POSITION (oend);
4208 if (XFASTINT (end) < startpos)
4209 break;
4210 if (insertion && (XFASTINT (start) == startpos
4211 || XFASTINT (end) == startpos))
4213 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4214 if (!NILP (prop))
4215 add_overlay_mod_hooklist (prop, overlay);
4217 if (insertion && (XFASTINT (start) == endpos
4218 || XFASTINT (end) == endpos))
4220 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4221 if (!NILP (prop))
4222 add_overlay_mod_hooklist (prop, overlay);
4224 /* Test for intersecting intervals. This does the right thing
4225 for both insertion and deletion. */
4226 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4228 prop = Foverlay_get (overlay, Qmodification_hooks);
4229 if (!NILP (prop))
4230 add_overlay_mod_hooklist (prop, overlay);
4235 GCPRO4 (overlay, arg1, arg2, arg3);
4237 /* Call the functions recorded in last_overlay_modification_hooks.
4238 First copy the vector contents, in case some of these hooks
4239 do subsequent modification of the buffer. */
4240 int size = last_overlay_modification_hooks_used;
4241 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4242 int i;
4244 memcpy (copy, XVECTOR (last_overlay_modification_hooks)->contents,
4245 size * sizeof (Lisp_Object));
4246 gcpro1.var = copy;
4247 gcpro1.nvars = size;
4249 for (i = 0; i < size;)
4251 Lisp_Object prop_i, overlay_i;
4252 prop_i = copy[i++];
4253 overlay_i = copy[i++];
4254 call_overlay_mod_hooks (prop_i, overlay_i, after, arg1, arg2, arg3);
4257 UNGCPRO;
4260 static void
4261 call_overlay_mod_hooks (Lisp_Object list, Lisp_Object overlay, int after,
4262 Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
4264 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4266 GCPRO4 (list, arg1, arg2, arg3);
4268 while (CONSP (list))
4270 if (NILP (arg3))
4271 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4272 else
4273 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4274 list = XCDR (list);
4276 UNGCPRO;
4279 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4280 property is set. */
4281 void
4282 evaporate_overlays (EMACS_INT pos)
4284 Lisp_Object overlay, hit_list;
4285 struct Lisp_Overlay *tail;
4287 hit_list = Qnil;
4288 if (pos <= current_buffer->overlay_center)
4289 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4291 EMACS_INT endpos;
4292 XSETMISC (overlay, tail);
4293 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4294 if (endpos < pos)
4295 break;
4296 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4297 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4298 hit_list = Fcons (overlay, hit_list);
4300 else
4301 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4303 EMACS_INT startpos;
4304 XSETMISC (overlay, tail);
4305 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4306 if (startpos > pos)
4307 break;
4308 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4309 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4310 hit_list = Fcons (overlay, hit_list);
4312 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4313 Fdelete_overlay (XCAR (hit_list));
4316 /* Somebody has tried to store a value with an unacceptable type
4317 in the slot with offset OFFSET. */
4319 void
4320 buffer_slot_type_mismatch (Lisp_Object newval, int type)
4322 Lisp_Object predicate;
4324 switch (type)
4326 case_Lisp_Int: predicate = Qintegerp; break;
4327 case Lisp_String: predicate = Qstringp; break;
4328 case Lisp_Symbol: predicate = Qsymbolp; break;
4329 default: abort ();
4332 wrong_type_argument (predicate, newval);
4336 /***********************************************************************
4337 Allocation with mmap
4338 ***********************************************************************/
4340 #ifdef USE_MMAP_FOR_BUFFERS
4342 #include <sys/types.h>
4343 #include <sys/mman.h>
4345 #ifndef MAP_ANON
4346 #ifdef MAP_ANONYMOUS
4347 #define MAP_ANON MAP_ANONYMOUS
4348 #else
4349 #define MAP_ANON 0
4350 #endif
4351 #endif
4353 #ifndef MAP_FAILED
4354 #define MAP_FAILED ((void *) -1)
4355 #endif
4357 #include <stdio.h>
4359 #if MAP_ANON == 0
4360 #include <fcntl.h>
4361 #endif
4363 #include "coding.h"
4366 /* Memory is allocated in regions which are mapped using mmap(2).
4367 The current implementation lets the system select mapped
4368 addresses; we're not using MAP_FIXED in general, except when
4369 trying to enlarge regions.
4371 Each mapped region starts with a mmap_region structure, the user
4372 area starts after that structure, aligned to MEM_ALIGN.
4374 +-----------------------+
4375 | struct mmap_info + |
4376 | padding |
4377 +-----------------------+
4378 | user data |
4381 +-----------------------+ */
4383 struct mmap_region
4385 /* User-specified size. */
4386 size_t nbytes_specified;
4388 /* Number of bytes mapped */
4389 size_t nbytes_mapped;
4391 /* Pointer to the location holding the address of the memory
4392 allocated with the mmap'd block. The variable actually points
4393 after this structure. */
4394 POINTER_TYPE **var;
4396 /* Next and previous in list of all mmap'd regions. */
4397 struct mmap_region *next, *prev;
4400 /* Doubly-linked list of mmap'd regions. */
4402 static struct mmap_region *mmap_regions;
4404 /* File descriptor for mmap. If we don't have anonymous mapping,
4405 /dev/zero will be opened on it. */
4407 static int mmap_fd;
4409 /* Temporary storage for mmap_set_vars, see there. */
4411 static struct mmap_region *mmap_regions_1;
4412 static int mmap_fd_1;
4414 /* Page size on this system. */
4416 static int mmap_page_size;
4418 /* 1 means mmap has been initialized. */
4420 static int mmap_initialized_p;
4422 /* Value is X rounded up to the next multiple of N. */
4424 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4426 /* Size of mmap_region structure plus padding. */
4428 #define MMAP_REGION_STRUCT_SIZE \
4429 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4431 /* Given a pointer P to the start of the user-visible part of a mapped
4432 region, return a pointer to the start of the region. */
4434 #define MMAP_REGION(P) \
4435 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4437 /* Given a pointer P to the start of a mapped region, return a pointer
4438 to the start of the user-visible part of the region. */
4440 #define MMAP_USER_AREA(P) \
4441 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4443 #define MEM_ALIGN sizeof (double)
4445 /* Predicate returning true if part of the address range [START .. END]
4446 is currently mapped. Used to prevent overwriting an existing
4447 memory mapping.
4449 Default is to conservatively assume the address range is occupied by
4450 something else. This can be overridden by system configuration
4451 files if system-specific means to determine this exists. */
4453 #ifndef MMAP_ALLOCATED_P
4454 #define MMAP_ALLOCATED_P(start, end) 1
4455 #endif
4457 /* Perform necessary initializations for the use of mmap. */
4459 static void
4460 mmap_init (void)
4462 #if MAP_ANON == 0
4463 /* The value of mmap_fd is initially 0 in temacs, and -1
4464 in a dumped Emacs. */
4465 if (mmap_fd <= 0)
4467 /* No anonymous mmap -- we need the file descriptor. */
4468 mmap_fd = open ("/dev/zero", O_RDONLY);
4469 if (mmap_fd == -1)
4470 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4472 #endif /* MAP_ANON == 0 */
4474 if (mmap_initialized_p)
4475 return;
4476 mmap_initialized_p = 1;
4478 #if MAP_ANON != 0
4479 mmap_fd = -1;
4480 #endif
4482 mmap_page_size = getpagesize ();
4485 /* Return a region overlapping address range START...END, or null if
4486 none. END is not including, i.e. the last byte in the range
4487 is at END - 1. */
4489 static struct mmap_region *
4490 mmap_find (POINTER_TYPE *start, POINTER_TYPE *end)
4492 struct mmap_region *r;
4493 char *s = (char *) start, *e = (char *) end;
4495 for (r = mmap_regions; r; r = r->next)
4497 char *rstart = (char *) r;
4498 char *rend = rstart + r->nbytes_mapped;
4500 if (/* First byte of range, i.e. START, in this region? */
4501 (s >= rstart && s < rend)
4502 /* Last byte of range, i.e. END - 1, in this region? */
4503 || (e > rstart && e <= rend)
4504 /* First byte of this region in the range? */
4505 || (rstart >= s && rstart < e)
4506 /* Last byte of this region in the range? */
4507 || (rend > s && rend <= e))
4508 break;
4511 return r;
4515 /* Unmap a region. P is a pointer to the start of the user-araa of
4516 the region. Value is non-zero if successful. */
4518 static int
4519 mmap_free_1 (struct mmap_region *r)
4521 if (r->next)
4522 r->next->prev = r->prev;
4523 if (r->prev)
4524 r->prev->next = r->next;
4525 else
4526 mmap_regions = r->next;
4528 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4530 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4531 return 0;
4534 return 1;
4538 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4539 Value is non-zero if successful. */
4541 static int
4542 mmap_enlarge (struct mmap_region *r, int npages)
4544 char *region_end = (char *) r + r->nbytes_mapped;
4545 size_t nbytes;
4546 int success = 0;
4548 if (npages < 0)
4550 /* Unmap pages at the end of the region. */
4551 nbytes = - npages * mmap_page_size;
4552 if (munmap (region_end - nbytes, nbytes) == -1)
4553 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4554 else
4556 r->nbytes_mapped -= nbytes;
4557 success = 1;
4560 else if (npages > 0)
4562 nbytes = npages * mmap_page_size;
4564 /* Try to map additional pages at the end of the region. We
4565 cannot do this if the address range is already occupied by
4566 something else because mmap deletes any previous mapping.
4567 I'm not sure this is worth doing, let's see. */
4568 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4570 POINTER_TYPE *p;
4572 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4573 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4574 if (p == MAP_FAILED)
4575 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4576 else if (p != (POINTER_TYPE *) region_end)
4578 /* Kernels are free to choose a different address. In
4579 that case, unmap what we've mapped above; we have
4580 no use for it. */
4581 if (munmap (p, nbytes) == -1)
4582 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4584 else
4586 r->nbytes_mapped += nbytes;
4587 success = 1;
4592 return success;
4596 /* Set or reset variables holding references to mapped regions. If
4597 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4598 non-zero, set all variables to the start of the user-areas
4599 of mapped regions.
4601 This function is called from Fdump_emacs to ensure that the dumped
4602 Emacs doesn't contain references to memory that won't be mapped
4603 when Emacs starts. */
4605 void
4606 mmap_set_vars (int restore_p)
4608 struct mmap_region *r;
4610 if (restore_p)
4612 mmap_regions = mmap_regions_1;
4613 mmap_fd = mmap_fd_1;
4614 for (r = mmap_regions; r; r = r->next)
4615 *r->var = MMAP_USER_AREA (r);
4617 else
4619 for (r = mmap_regions; r; r = r->next)
4620 *r->var = NULL;
4621 mmap_regions_1 = mmap_regions;
4622 mmap_regions = NULL;
4623 mmap_fd_1 = mmap_fd;
4624 mmap_fd = -1;
4629 /* Allocate a block of storage large enough to hold NBYTES bytes of
4630 data. A pointer to the data is returned in *VAR. VAR is thus the
4631 address of some variable which will use the data area.
4633 The allocation of 0 bytes is valid.
4635 If we can't allocate the necessary memory, set *VAR to null, and
4636 return null. */
4638 static POINTER_TYPE *
4639 mmap_alloc (POINTER_TYPE **var, size_t nbytes)
4641 void *p;
4642 size_t map;
4644 mmap_init ();
4646 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4647 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4648 mmap_fd, 0);
4650 if (p == MAP_FAILED)
4652 if (errno != ENOMEM)
4653 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4654 p = NULL;
4656 else
4658 struct mmap_region *r = (struct mmap_region *) p;
4660 r->nbytes_specified = nbytes;
4661 r->nbytes_mapped = map;
4662 r->var = var;
4663 r->prev = NULL;
4664 r->next = mmap_regions;
4665 if (r->next)
4666 r->next->prev = r;
4667 mmap_regions = r;
4669 p = MMAP_USER_AREA (p);
4672 return *var = p;
4676 /* Free a block of relocatable storage whose data is pointed to by
4677 PTR. Store 0 in *PTR to show there's no block allocated. */
4679 static void
4680 mmap_free (POINTER_TYPE **var)
4682 mmap_init ();
4684 if (*var)
4686 mmap_free_1 (MMAP_REGION (*var));
4687 *var = NULL;
4692 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4693 resize it to size NBYTES. Change *VAR to reflect the new block,
4694 and return this value. If more memory cannot be allocated, then
4695 leave *VAR unchanged, and return null. */
4697 static POINTER_TYPE *
4698 mmap_realloc (POINTER_TYPE **var, size_t nbytes)
4700 POINTER_TYPE *result;
4702 mmap_init ();
4704 if (*var == NULL)
4705 result = mmap_alloc (var, nbytes);
4706 else if (nbytes == 0)
4708 mmap_free (var);
4709 result = mmap_alloc (var, nbytes);
4711 else
4713 struct mmap_region *r = MMAP_REGION (*var);
4714 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4716 if (room < nbytes)
4718 /* Must enlarge. */
4719 POINTER_TYPE *old_ptr = *var;
4721 /* Try to map additional pages at the end of the region.
4722 If that fails, allocate a new region, copy data
4723 from the old region, then free it. */
4724 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4725 / mmap_page_size)))
4727 r->nbytes_specified = nbytes;
4728 *var = result = old_ptr;
4730 else if (mmap_alloc (var, nbytes))
4732 memcpy (*var, old_ptr, r->nbytes_specified);
4733 mmap_free_1 (MMAP_REGION (old_ptr));
4734 result = *var;
4735 r = MMAP_REGION (result);
4736 r->nbytes_specified = nbytes;
4738 else
4740 *var = old_ptr;
4741 result = NULL;
4744 else if (room - nbytes >= mmap_page_size)
4746 /* Shrinking by at least a page. Let's give some
4747 memory back to the system.
4749 The extra parens are to make the division happens first,
4750 on positive values, so we know it will round towards
4751 zero. */
4752 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4753 result = *var;
4754 r->nbytes_specified = nbytes;
4756 else
4758 /* Leave it alone. */
4759 result = *var;
4760 r->nbytes_specified = nbytes;
4764 return result;
4768 #endif /* USE_MMAP_FOR_BUFFERS */
4772 /***********************************************************************
4773 Buffer-text Allocation
4774 ***********************************************************************/
4776 #ifdef REL_ALLOC
4777 extern POINTER_TYPE *r_alloc (POINTER_TYPE **, size_t);
4778 extern POINTER_TYPE *r_re_alloc (POINTER_TYPE **, size_t);
4779 extern void r_alloc_free (POINTER_TYPE **ptr);
4780 #endif /* REL_ALLOC */
4783 /* Allocate NBYTES bytes for buffer B's text buffer. */
4785 static void
4786 alloc_buffer_text (struct buffer *b, ptrdiff_t nbytes)
4788 POINTER_TYPE *p;
4790 BLOCK_INPUT;
4791 #if defined USE_MMAP_FOR_BUFFERS
4792 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4793 #elif defined REL_ALLOC
4794 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4795 #else
4796 p = xmalloc (nbytes);
4797 #endif
4799 if (p == NULL)
4801 UNBLOCK_INPUT;
4802 memory_full (nbytes);
4805 b->text->beg = (unsigned char *) p;
4806 UNBLOCK_INPUT;
4809 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4810 shrink it. */
4812 void
4813 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
4815 POINTER_TYPE *p;
4816 ptrdiff_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4817 + delta);
4818 BLOCK_INPUT;
4819 #if defined USE_MMAP_FOR_BUFFERS
4820 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4821 #elif defined REL_ALLOC
4822 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4823 #else
4824 p = xrealloc (b->text->beg, nbytes);
4825 #endif
4827 if (p == NULL)
4829 UNBLOCK_INPUT;
4830 memory_full (nbytes);
4833 BUF_BEG_ADDR (b) = (unsigned char *) p;
4834 UNBLOCK_INPUT;
4838 /* Free buffer B's text buffer. */
4840 static void
4841 free_buffer_text (struct buffer *b)
4843 BLOCK_INPUT;
4845 #if defined USE_MMAP_FOR_BUFFERS
4846 mmap_free ((POINTER_TYPE **) &b->text->beg);
4847 #elif defined REL_ALLOC
4848 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4849 #else
4850 xfree (b->text->beg);
4851 #endif
4853 BUF_BEG_ADDR (b) = NULL;
4854 UNBLOCK_INPUT;
4859 /***********************************************************************
4860 Initialization
4861 ***********************************************************************/
4863 void
4864 init_buffer_once (void)
4866 int idx;
4868 memset (buffer_permanent_local_flags, 0, sizeof buffer_permanent_local_flags);
4870 /* Make sure all markable slots in buffer_defaults
4871 are initialized reasonably, so mark_buffer won't choke. */
4872 reset_buffer (&buffer_defaults);
4873 eassert (EQ (BVAR (&buffer_defaults, name), make_number (0)));
4874 reset_buffer_local_variables (&buffer_defaults, 1);
4875 eassert (EQ (BVAR (&buffer_local_symbols, name), make_number (0)));
4876 reset_buffer (&buffer_local_symbols);
4877 reset_buffer_local_variables (&buffer_local_symbols, 1);
4878 /* Prevent GC from getting confused. */
4879 buffer_defaults.text = &buffer_defaults.own_text;
4880 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4881 BUF_INTERVALS (&buffer_defaults) = 0;
4882 BUF_INTERVALS (&buffer_local_symbols) = 0;
4883 XSETPVECTYPESIZE (&buffer_defaults, PVEC_BUFFER, 0);
4884 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4885 XSETPVECTYPESIZE (&buffer_local_symbols, PVEC_BUFFER, 0);
4886 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4888 /* Set up the default values of various buffer slots. */
4889 /* Must do these before making the first buffer! */
4891 /* real setup is done in bindings.el */
4892 BVAR (&buffer_defaults, mode_line_format) = make_pure_c_string ("%-");
4893 BVAR (&buffer_defaults, header_line_format) = Qnil;
4894 BVAR (&buffer_defaults, abbrev_mode) = Qnil;
4895 BVAR (&buffer_defaults, overwrite_mode) = Qnil;
4896 BVAR (&buffer_defaults, case_fold_search) = Qt;
4897 BVAR (&buffer_defaults, auto_fill_function) = Qnil;
4898 BVAR (&buffer_defaults, selective_display) = Qnil;
4899 #ifndef old
4900 BVAR (&buffer_defaults, selective_display_ellipses) = Qt;
4901 #endif
4902 BVAR (&buffer_defaults, abbrev_table) = Qnil;
4903 BVAR (&buffer_defaults, display_table) = Qnil;
4904 BVAR (&buffer_defaults, undo_list) = Qnil;
4905 BVAR (&buffer_defaults, mark_active) = Qnil;
4906 BVAR (&buffer_defaults, file_format) = Qnil;
4907 BVAR (&buffer_defaults, auto_save_file_format) = Qt;
4908 buffer_defaults.overlays_before = NULL;
4909 buffer_defaults.overlays_after = NULL;
4910 buffer_defaults.overlay_center = BEG;
4912 XSETFASTINT (BVAR (&buffer_defaults, tab_width), 8);
4913 BVAR (&buffer_defaults, truncate_lines) = Qnil;
4914 BVAR (&buffer_defaults, word_wrap) = Qnil;
4915 BVAR (&buffer_defaults, ctl_arrow) = Qt;
4916 BVAR (&buffer_defaults, bidi_display_reordering) = Qt;
4917 BVAR (&buffer_defaults, bidi_paragraph_direction) = Qnil;
4918 BVAR (&buffer_defaults, cursor_type) = Qt;
4919 BVAR (&buffer_defaults, extra_line_spacing) = Qnil;
4920 BVAR (&buffer_defaults, cursor_in_non_selected_windows) = Qt;
4922 BVAR (&buffer_defaults, enable_multibyte_characters) = Qt;
4923 BVAR (&buffer_defaults, buffer_file_coding_system) = Qnil;
4924 XSETFASTINT (BVAR (&buffer_defaults, fill_column), 70);
4925 XSETFASTINT (BVAR (&buffer_defaults, left_margin), 0);
4926 BVAR (&buffer_defaults, cache_long_line_scans) = Qnil;
4927 BVAR (&buffer_defaults, file_truename) = Qnil;
4928 XSETFASTINT (BVAR (&buffer_defaults, display_count), 0);
4929 XSETFASTINT (BVAR (&buffer_defaults, left_margin_cols), 0);
4930 XSETFASTINT (BVAR (&buffer_defaults, right_margin_cols), 0);
4931 BVAR (&buffer_defaults, left_fringe_width) = Qnil;
4932 BVAR (&buffer_defaults, right_fringe_width) = Qnil;
4933 BVAR (&buffer_defaults, fringes_outside_margins) = Qnil;
4934 BVAR (&buffer_defaults, scroll_bar_width) = Qnil;
4935 BVAR (&buffer_defaults, vertical_scroll_bar_type) = Qt;
4936 BVAR (&buffer_defaults, indicate_empty_lines) = Qnil;
4937 BVAR (&buffer_defaults, indicate_buffer_boundaries) = Qnil;
4938 BVAR (&buffer_defaults, fringe_indicator_alist) = Qnil;
4939 BVAR (&buffer_defaults, fringe_cursor_alist) = Qnil;
4940 BVAR (&buffer_defaults, scroll_up_aggressively) = Qnil;
4941 BVAR (&buffer_defaults, scroll_down_aggressively) = Qnil;
4942 BVAR (&buffer_defaults, display_time) = Qnil;
4944 /* Assign the local-flags to the slots that have default values.
4945 The local flag is a bit that is used in the buffer
4946 to say that it has its own local value for the slot.
4947 The local flag bits are in the local_var_flags slot of the buffer. */
4949 /* Nothing can work if this isn't true */
4950 { verify (sizeof (EMACS_INT) == sizeof (Lisp_Object)); }
4952 /* 0 means not a lisp var, -1 means always local, else mask */
4953 memset (&buffer_local_flags, 0, sizeof buffer_local_flags);
4954 XSETINT (BVAR (&buffer_local_flags, filename), -1);
4955 XSETINT (BVAR (&buffer_local_flags, directory), -1);
4956 XSETINT (BVAR (&buffer_local_flags, backed_up), -1);
4957 XSETINT (BVAR (&buffer_local_flags, save_length), -1);
4958 XSETINT (BVAR (&buffer_local_flags, auto_save_file_name), -1);
4959 XSETINT (BVAR (&buffer_local_flags, read_only), -1);
4960 XSETINT (BVAR (&buffer_local_flags, major_mode), -1);
4961 XSETINT (BVAR (&buffer_local_flags, mode_name), -1);
4962 XSETINT (BVAR (&buffer_local_flags, undo_list), -1);
4963 XSETINT (BVAR (&buffer_local_flags, mark_active), -1);
4964 XSETINT (BVAR (&buffer_local_flags, point_before_scroll), -1);
4965 XSETINT (BVAR (&buffer_local_flags, file_truename), -1);
4966 XSETINT (BVAR (&buffer_local_flags, invisibility_spec), -1);
4967 XSETINT (BVAR (&buffer_local_flags, file_format), -1);
4968 XSETINT (BVAR (&buffer_local_flags, auto_save_file_format), -1);
4969 XSETINT (BVAR (&buffer_local_flags, display_count), -1);
4970 XSETINT (BVAR (&buffer_local_flags, display_time), -1);
4971 XSETINT (BVAR (&buffer_local_flags, enable_multibyte_characters), -1);
4973 idx = 1;
4974 XSETFASTINT (BVAR (&buffer_local_flags, mode_line_format), idx); ++idx;
4975 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_mode), idx); ++idx;
4976 XSETFASTINT (BVAR (&buffer_local_flags, overwrite_mode), idx); ++idx;
4977 XSETFASTINT (BVAR (&buffer_local_flags, case_fold_search), idx); ++idx;
4978 XSETFASTINT (BVAR (&buffer_local_flags, auto_fill_function), idx); ++idx;
4979 XSETFASTINT (BVAR (&buffer_local_flags, selective_display), idx); ++idx;
4980 #ifndef old
4981 XSETFASTINT (BVAR (&buffer_local_flags, selective_display_ellipses), idx); ++idx;
4982 #endif
4983 XSETFASTINT (BVAR (&buffer_local_flags, tab_width), idx); ++idx;
4984 XSETFASTINT (BVAR (&buffer_local_flags, truncate_lines), idx); ++idx;
4985 XSETFASTINT (BVAR (&buffer_local_flags, word_wrap), idx); ++idx;
4986 XSETFASTINT (BVAR (&buffer_local_flags, ctl_arrow), idx); ++idx;
4987 XSETFASTINT (BVAR (&buffer_local_flags, fill_column), idx); ++idx;
4988 XSETFASTINT (BVAR (&buffer_local_flags, left_margin), idx); ++idx;
4989 XSETFASTINT (BVAR (&buffer_local_flags, abbrev_table), idx); ++idx;
4990 XSETFASTINT (BVAR (&buffer_local_flags, display_table), idx); ++idx;
4991 XSETFASTINT (BVAR (&buffer_local_flags, syntax_table), idx); ++idx;
4992 XSETFASTINT (BVAR (&buffer_local_flags, cache_long_line_scans), idx); ++idx;
4993 XSETFASTINT (BVAR (&buffer_local_flags, category_table), idx); ++idx;
4994 XSETFASTINT (BVAR (&buffer_local_flags, bidi_display_reordering), idx); ++idx;
4995 XSETFASTINT (BVAR (&buffer_local_flags, bidi_paragraph_direction), idx); ++idx;
4996 XSETFASTINT (BVAR (&buffer_local_flags, buffer_file_coding_system), idx);
4997 /* Make this one a permanent local. */
4998 buffer_permanent_local_flags[idx++] = 1;
4999 XSETFASTINT (BVAR (&buffer_local_flags, left_margin_cols), idx); ++idx;
5000 XSETFASTINT (BVAR (&buffer_local_flags, right_margin_cols), idx); ++idx;
5001 XSETFASTINT (BVAR (&buffer_local_flags, left_fringe_width), idx); ++idx;
5002 XSETFASTINT (BVAR (&buffer_local_flags, right_fringe_width), idx); ++idx;
5003 XSETFASTINT (BVAR (&buffer_local_flags, fringes_outside_margins), idx); ++idx;
5004 XSETFASTINT (BVAR (&buffer_local_flags, scroll_bar_width), idx); ++idx;
5005 XSETFASTINT (BVAR (&buffer_local_flags, vertical_scroll_bar_type), idx); ++idx;
5006 XSETFASTINT (BVAR (&buffer_local_flags, indicate_empty_lines), idx); ++idx;
5007 XSETFASTINT (BVAR (&buffer_local_flags, indicate_buffer_boundaries), idx); ++idx;
5008 XSETFASTINT (BVAR (&buffer_local_flags, fringe_indicator_alist), idx); ++idx;
5009 XSETFASTINT (BVAR (&buffer_local_flags, fringe_cursor_alist), idx); ++idx;
5010 XSETFASTINT (BVAR (&buffer_local_flags, scroll_up_aggressively), idx); ++idx;
5011 XSETFASTINT (BVAR (&buffer_local_flags, scroll_down_aggressively), idx); ++idx;
5012 XSETFASTINT (BVAR (&buffer_local_flags, header_line_format), idx); ++idx;
5013 XSETFASTINT (BVAR (&buffer_local_flags, cursor_type), idx); ++idx;
5014 XSETFASTINT (BVAR (&buffer_local_flags, extra_line_spacing), idx); ++idx;
5015 XSETFASTINT (BVAR (&buffer_local_flags, cursor_in_non_selected_windows), idx); ++idx;
5017 /* Need more room? */
5018 if (idx >= MAX_PER_BUFFER_VARS)
5019 abort ();
5020 last_per_buffer_idx = idx;
5022 Vbuffer_alist = Qnil;
5023 current_buffer = 0;
5024 all_buffers = 0;
5026 QSFundamental = make_pure_c_string ("Fundamental");
5028 Qfundamental_mode = intern_c_string ("fundamental-mode");
5029 BVAR (&buffer_defaults, major_mode) = Qfundamental_mode;
5031 Qmode_class = intern_c_string ("mode-class");
5033 Qprotected_field = intern_c_string ("protected-field");
5035 Qpermanent_local = intern_c_string ("permanent-local");
5037 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5038 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5040 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5042 /* super-magic invisible buffer */
5043 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5044 Vbuffer_alist = Qnil;
5046 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5048 inhibit_modification_hooks = 0;
5051 void
5052 init_buffer (void)
5054 char *pwd;
5055 Lisp_Object temp;
5056 ptrdiff_t len;
5058 #ifdef USE_MMAP_FOR_BUFFERS
5060 /* When using the ralloc implementation based on mmap(2), buffer
5061 text pointers will have been set to null in the dumped Emacs.
5062 Map new memory. */
5063 struct buffer *b;
5065 for (b = all_buffers; b; b = b->header.next.buffer)
5066 if (b->text->beg == NULL)
5067 enlarge_buffer_text (b, 0);
5069 #endif /* USE_MMAP_FOR_BUFFERS */
5071 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5072 if (NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5073 Fset_buffer_multibyte (Qnil);
5075 pwd = get_current_dir_name ();
5077 if (!pwd)
5078 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5080 /* Maybe this should really use some standard subroutine
5081 whose definition is filename syntax dependent. */
5082 len = strlen (pwd);
5083 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5085 /* Grow buffer to add directory separator and '\0'. */
5086 pwd = (char *) realloc (pwd, len + 2);
5087 if (!pwd)
5088 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5089 pwd[len] = DIRECTORY_SEP;
5090 pwd[len + 1] = '\0';
5093 BVAR (current_buffer, directory) = make_unibyte_string (pwd, strlen (pwd));
5094 if (! NILP (BVAR (&buffer_defaults, enable_multibyte_characters)))
5095 /* At this moment, we still don't know how to decode the
5096 directory name. So, we keep the bytes in multibyte form so
5097 that ENCODE_FILE correctly gets the original bytes. */
5098 BVAR (current_buffer, directory)
5099 = string_to_multibyte (BVAR (current_buffer, directory));
5101 /* Add /: to the front of the name
5102 if it would otherwise be treated as magic. */
5103 temp = Ffind_file_name_handler (BVAR (current_buffer, directory), Qt);
5104 if (! NILP (temp)
5105 /* If the default dir is just /, TEMP is non-nil
5106 because of the ange-ftp completion handler.
5107 However, it is not necessary to turn / into /:/.
5108 So avoid doing that. */
5109 && strcmp ("/", SSDATA (BVAR (current_buffer, directory))))
5110 BVAR (current_buffer, directory)
5111 = concat2 (build_string ("/:"), BVAR (current_buffer, directory));
5113 temp = get_minibuffer (0);
5114 BVAR (XBUFFER (temp), directory) = BVAR (current_buffer, directory);
5116 free (pwd);
5119 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5120 Object stored in the current buffer. address is the address of the slot
5121 in the buffer that is current now. */
5123 /* TYPE is nil for a general Lisp variable.
5124 An integer specifies a type; then only Lisp values
5125 with that type code are allowed (except that nil is allowed too).
5126 LNAME is the Lisp-level variable name.
5127 VNAME is the name of the buffer slot.
5128 DOC is a dummy where you write the doc string as a comment. */
5129 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5130 do { \
5131 static struct Lisp_Buffer_Objfwd bo_fwd; \
5132 defvar_per_buffer (&bo_fwd, lname, vname, type); \
5133 } while (0)
5135 static void
5136 defvar_per_buffer (struct Lisp_Buffer_Objfwd *bo_fwd, const char *namestring,
5137 Lisp_Object *address, Lisp_Object type)
5139 struct Lisp_Symbol *sym;
5140 int offset;
5142 sym = XSYMBOL (intern (namestring));
5143 offset = (char *)address - (char *)current_buffer;
5145 bo_fwd->type = Lisp_Fwd_Buffer_Obj;
5146 bo_fwd->offset = offset;
5147 bo_fwd->slottype = type;
5148 sym->declared_special = 1;
5149 sym->redirect = SYMBOL_FORWARDED;
5151 /* I tried to do the job without a cast, but it seems impossible.
5152 union Lisp_Fwd *fwd; &(fwd->u_buffer_objfwd) = bo_fwd; */
5153 SET_SYMBOL_FWD (sym, (union Lisp_Fwd *)bo_fwd);
5155 XSETSYMBOL (PER_BUFFER_SYMBOL (offset), sym);
5157 if (PER_BUFFER_IDX (offset) == 0)
5158 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5159 slot of buffer_local_flags */
5160 abort ();
5164 /* initialize the buffer routines */
5165 void
5166 syms_of_buffer (void)
5168 staticpro (&last_overlay_modification_hooks);
5169 last_overlay_modification_hooks
5170 = Fmake_vector (make_number (10), Qnil);
5172 staticpro (&Vbuffer_defaults);
5173 staticpro (&Vbuffer_local_symbols);
5174 staticpro (&Qfundamental_mode);
5175 staticpro (&Qmode_class);
5176 staticpro (&QSFundamental);
5177 staticpro (&Vbuffer_alist);
5178 staticpro (&Qprotected_field);
5179 staticpro (&Qpermanent_local);
5180 staticpro (&Qkill_buffer_hook);
5182 DEFSYM (Qpermanent_local_hook, "permanent-local-hook");
5183 DEFSYM (Qoverlayp, "overlayp");
5184 DEFSYM (Qevaporate, "evaporate");
5185 DEFSYM (Qmodification_hooks, "modification-hooks");
5186 DEFSYM (Qinsert_in_front_hooks, "insert-in-front-hooks");
5187 DEFSYM (Qinsert_behind_hooks, "insert-behind-hooks");
5188 DEFSYM (Qget_file_buffer, "get-file-buffer");
5189 DEFSYM (Qpriority, "priority");
5190 DEFSYM (Qbefore_string, "before-string");
5191 DEFSYM (Qafter_string, "after-string");
5192 DEFSYM (Qfirst_change_hook, "first-change-hook");
5193 DEFSYM (Qbefore_change_functions, "before-change-functions");
5194 DEFSYM (Qafter_change_functions, "after-change-functions");
5195 DEFSYM (Qkill_buffer_query_functions, "kill-buffer-query-functions");
5197 /* The next one is initialized in init_buffer_once. */
5198 staticpro (&Qucs_set_table_for_input);
5200 Fput (Qprotected_field, Qerror_conditions,
5201 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5202 Fput (Qprotected_field, Qerror_message,
5203 make_pure_c_string ("Attempt to modify a protected field"));
5205 DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format",
5206 mode_line_format,
5207 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5208 This is the same as (default-value 'mode-line-format). */);
5210 DEFVAR_BUFFER_DEFAULTS ("default-header-line-format",
5211 header_line_format,
5212 doc: /* Default value of `header-line-format' for buffers that don't override it.
5213 This is the same as (default-value 'header-line-format). */);
5215 DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type,
5216 doc: /* Default value of `cursor-type' for buffers that don't override it.
5217 This is the same as (default-value 'cursor-type). */);
5219 DEFVAR_BUFFER_DEFAULTS ("default-line-spacing",
5220 extra_line_spacing,
5221 doc: /* Default value of `line-spacing' for buffers that don't override it.
5222 This is the same as (default-value 'line-spacing). */);
5224 DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows",
5225 cursor_in_non_selected_windows,
5226 doc: /* Default value of `cursor-in-non-selected-windows'.
5227 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5229 DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode",
5230 abbrev_mode,
5231 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5232 This is the same as (default-value 'abbrev-mode). */);
5234 DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow",
5235 ctl_arrow,
5236 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5237 This is the same as (default-value 'ctl-arrow). */);
5239 DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters",
5240 enable_multibyte_characters,
5241 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5242 This is the same as (default-value 'enable-multibyte-characters). */);
5244 DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system",
5245 buffer_file_coding_system,
5246 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5247 This is the same as (default-value 'buffer-file-coding-system). */);
5249 DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines",
5250 truncate_lines,
5251 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5252 This is the same as (default-value 'truncate-lines). */);
5254 DEFVAR_BUFFER_DEFAULTS ("default-fill-column",
5255 fill_column,
5256 doc: /* Default value of `fill-column' for buffers that do not override it.
5257 This is the same as (default-value 'fill-column). */);
5259 DEFVAR_BUFFER_DEFAULTS ("default-left-margin",
5260 left_margin,
5261 doc: /* Default value of `left-margin' for buffers that do not override it.
5262 This is the same as (default-value 'left-margin). */);
5264 DEFVAR_BUFFER_DEFAULTS ("default-tab-width",
5265 tab_width,
5266 doc: /* Default value of `tab-width' for buffers that do not override it.
5267 This is the same as (default-value 'tab-width). */);
5269 DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search",
5270 case_fold_search,
5271 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5272 This is the same as (default-value 'case-fold-search). */);
5274 DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width",
5275 left_margin_cols,
5276 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5277 This is the same as (default-value 'left-margin-width). */);
5279 DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width",
5280 right_margin_cols,
5281 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5282 This is the same as (default-value 'right-margin-width). */);
5284 DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width",
5285 left_fringe_width,
5286 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5287 This is the same as (default-value 'left-fringe-width). */);
5289 DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width",
5290 right_fringe_width,
5291 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5292 This is the same as (default-value 'right-fringe-width). */);
5294 DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins",
5295 fringes_outside_margins,
5296 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5297 This is the same as (default-value 'fringes-outside-margins). */);
5299 DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width",
5300 scroll_bar_width,
5301 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5302 This is the same as (default-value 'scroll-bar-width). */);
5304 DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar",
5305 vertical_scroll_bar_type,
5306 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5307 This is the same as (default-value 'vertical-scroll-bar). */);
5309 DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines",
5310 indicate_empty_lines,
5311 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5312 This is the same as (default-value 'indicate-empty-lines). */);
5314 DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries",
5315 indicate_buffer_boundaries,
5316 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5317 This is the same as (default-value 'indicate-buffer-boundaries). */);
5319 DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist",
5320 fringe_indicator_alist,
5321 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5322 This is the same as (default-value 'fringe-indicator-alist'). */);
5324 DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist",
5325 fringe_cursor_alist,
5326 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5327 This is the same as (default-value 'fringe-cursor-alist'). */);
5329 DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively",
5330 scroll_up_aggressively,
5331 doc: /* Default value of `scroll-up-aggressively'.
5332 This value applies in buffers that don't have their own local values.
5333 This is the same as (default-value 'scroll-up-aggressively). */);
5335 DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively",
5336 scroll_down_aggressively,
5337 doc: /* Default value of `scroll-down-aggressively'.
5338 This value applies in buffers that don't have their own local values.
5339 This is the same as (default-value 'scroll-down-aggressively). */);
5341 DEFVAR_PER_BUFFER ("header-line-format",
5342 &BVAR (current_buffer, header_line_format),
5343 Qnil,
5344 doc: /* Analogous to `mode-line-format', but controls the header line.
5345 The header line appears, optionally, at the top of a window;
5346 the mode line appears at the bottom. */);
5348 DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
5349 Qnil,
5350 doc: /* Template for displaying mode line for current buffer.
5351 Each buffer has its own value of this variable.
5352 Value may be nil, a string, a symbol or a list or cons cell.
5353 A value of nil means don't display a mode line.
5354 For a symbol, its value is used (but it is ignored if t or nil).
5355 A string appearing directly as the value of a symbol is processed verbatim
5356 in that the %-constructs below are not recognized.
5357 Note that unless the symbol is marked as a `risky-local-variable', all
5358 properties in any strings, as well as all :eval and :propertize forms
5359 in the value of that symbol will be ignored.
5360 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5361 is used as a mode line element. Be careful--FORM should not load any files,
5362 because that can cause an infinite recursion.
5363 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5364 with the specified properties PROPS applied.
5365 For a list whose car is a symbol, the symbol's value is taken,
5366 and if that is non-nil, the cadr of the list is processed recursively.
5367 Otherwise, the caddr of the list (if there is one) is processed.
5368 For a list whose car is a string or list, each element is processed
5369 recursively and the results are effectively concatenated.
5370 For a list whose car is an integer, the cdr of the list is processed
5371 and padded (if the number is positive) or truncated (if negative)
5372 to the width specified by that number.
5373 A string is printed verbatim in the mode line except for %-constructs:
5374 (%-constructs are allowed when the string is the entire mode-line-format
5375 or when it is found in a cons-cell or a list)
5376 %b -- print buffer name. %f -- print visited file name.
5377 %F -- print frame name.
5378 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5379 %& is like %*, but ignore read-only-ness.
5380 % means buffer is read-only and * means it is modified.
5381 For a modified read-only buffer, %* gives % and %+ gives *.
5382 %s -- print process status. %l -- print the current line number.
5383 %c -- print the current column number (this makes editing slower).
5384 To make the column number update correctly in all cases,
5385 `column-number-mode' must be non-nil.
5386 %i -- print the size of the buffer.
5387 %I -- like %i, but use k, M, G, etc., to abbreviate.
5388 %p -- print percent of buffer above top of window, or Top, Bot or All.
5389 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5390 or print Bottom or All.
5391 %n -- print Narrow if appropriate.
5392 %t -- visited file is text or binary (if OS supports this distinction).
5393 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5394 %Z -- like %z, but including the end-of-line format.
5395 %e -- print error message about full memory.
5396 %@ -- print @ or hyphen. @ means that default-directory is on a
5397 remote machine.
5398 %[ -- print one [ for each recursive editing level. %] similar.
5399 %% -- print %. %- -- print infinitely many dashes.
5400 Decimal digits after the % specify field width to which to pad. */);
5402 DEFVAR_BUFFER_DEFAULTS ("default-major-mode", major_mode,
5403 doc: /* *Value of `major-mode' for new buffers. */);
5405 DEFVAR_PER_BUFFER ("major-mode", &BVAR (current_buffer, major_mode),
5406 make_number (Lisp_Symbol),
5407 doc: /* Symbol for current buffer's major mode.
5408 The default value (normally `fundamental-mode') affects new buffers.
5409 A value of nil means to use the current buffer's major mode, provided
5410 it is not marked as "special".
5412 When a mode is used by default, `find-file' switches to it before it
5413 reads the contents into the buffer and before it finishes setting up
5414 the buffer. Thus, the mode and its hooks should not expect certain
5415 variables such as `buffer-read-only' and `buffer-file-coding-system'
5416 to be set up. */);
5418 DEFVAR_PER_BUFFER ("mode-name", &BVAR (current_buffer, mode_name),
5419 Qnil,
5420 doc: /* Pretty name of current buffer's major mode.
5421 Usually a string, but can use any of the constructs for `mode-line-format',
5422 which see.
5423 Format with `format-mode-line' to produce a string value. */);
5425 DEFVAR_PER_BUFFER ("local-abbrev-table", &BVAR (current_buffer, abbrev_table), Qnil,
5426 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5428 DEFVAR_PER_BUFFER ("abbrev-mode", &BVAR (current_buffer, abbrev_mode), Qnil,
5429 doc: /* Non-nil if Abbrev mode is enabled.
5430 Use the command `abbrev-mode' to change this variable. */);
5432 DEFVAR_PER_BUFFER ("case-fold-search", &BVAR (current_buffer, case_fold_search),
5433 Qnil,
5434 doc: /* *Non-nil if searches and matches should ignore case. */);
5436 DEFVAR_PER_BUFFER ("fill-column", &BVAR (current_buffer, fill_column),
5437 make_number (LISP_INT_TAG),
5438 doc: /* *Column beyond which automatic line-wrapping should happen.
5439 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5441 DEFVAR_PER_BUFFER ("left-margin", &BVAR (current_buffer, left_margin),
5442 make_number (LISP_INT_TAG),
5443 doc: /* *Column for the default `indent-line-function' to indent to.
5444 Linefeed indents to this column in Fundamental mode. */);
5446 DEFVAR_PER_BUFFER ("tab-width", &BVAR (current_buffer, tab_width),
5447 make_number (LISP_INT_TAG),
5448 doc: /* *Distance between tab stops (for display of tab characters), in columns.
5449 This should be an integer greater than zero. */);
5451 DEFVAR_PER_BUFFER ("ctl-arrow", &BVAR (current_buffer, ctl_arrow), Qnil,
5452 doc: /* *Non-nil means display control chars with uparrow.
5453 A value of nil means use backslash and octal digits.
5454 This variable does not apply to characters whose display is specified
5455 in the current display table (if there is one). */);
5457 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5458 &BVAR (current_buffer, enable_multibyte_characters),
5459 Qnil,
5460 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5461 Otherwise they are regarded as unibyte. This affects the display,
5462 file I/O and the behavior of various editing commands.
5464 This variable is buffer-local but you cannot set it directly;
5465 use the function `set-buffer-multibyte' to change a buffer's representation.
5466 See also Info node `(elisp)Text Representations'. */);
5467 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5469 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5470 &BVAR (current_buffer, buffer_file_coding_system), Qnil,
5471 doc: /* Coding system to be used for encoding the buffer contents on saving.
5472 This variable applies to saving the buffer, and also to `write-region'
5473 and other functions that use `write-region'.
5474 It does not apply to sending output to subprocesses, however.
5476 If this is nil, the buffer is saved without any code conversion
5477 unless some coding system is specified in `file-coding-system-alist'
5478 for the buffer file.
5480 If the text to be saved cannot be encoded as specified by this variable,
5481 an alternative encoding is selected by `select-safe-coding-system', which see.
5483 The variable `coding-system-for-write', if non-nil, overrides this variable.
5485 This variable is never applied to a way of decoding a file while reading it. */);
5487 DEFVAR_PER_BUFFER ("bidi-display-reordering",
5488 &BVAR (current_buffer, bidi_display_reordering), Qnil,
5489 doc: /* Non-nil means reorder bidirectional text for display in the visual order. */);
5491 DEFVAR_PER_BUFFER ("bidi-paragraph-direction",
5492 &BVAR (current_buffer, bidi_paragraph_direction), Qnil,
5493 doc: /* *If non-nil, forces directionality of text paragraphs in the buffer.
5495 If this is nil (the default), the direction of each paragraph is
5496 determined by the first strong directional character of its text.
5497 The values of `right-to-left' and `left-to-right' override that.
5498 Any other value is treated as nil.
5500 This variable has no effect unless the buffer's value of
5501 \`bidi-display-reordering' is non-nil. */);
5503 DEFVAR_PER_BUFFER ("truncate-lines", &BVAR (current_buffer, truncate_lines), Qnil,
5504 doc: /* *Non-nil means do not display continuation lines.
5505 Instead, give each line of text just one screen line.
5507 Note that this is overridden by the variable
5508 `truncate-partial-width-windows' if that variable is non-nil
5509 and this buffer is not full-frame width.
5511 Minibuffers set this variable to nil. */);
5513 DEFVAR_PER_BUFFER ("word-wrap", &BVAR (current_buffer, word_wrap), Qnil,
5514 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5515 When word-wrapping is on, continuation lines are wrapped at the space
5516 or tab character nearest to the right window edge.
5517 If nil, continuation lines are wrapped at the right screen edge.
5519 This variable has no effect if long lines are truncated (see
5520 `truncate-lines' and `truncate-partial-width-windows'). If you use
5521 word-wrapping, you might want to reduce the value of
5522 `truncate-partial-width-windows', since wrapping can make text readable
5523 in narrower windows. */);
5525 DEFVAR_PER_BUFFER ("default-directory", &BVAR (current_buffer, directory),
5526 make_number (Lisp_String),
5527 doc: /* Name of default directory of current buffer. Should end with slash.
5528 To interactively change the default directory, use command `cd'. */);
5530 DEFVAR_PER_BUFFER ("auto-fill-function", &BVAR (current_buffer, auto_fill_function),
5531 Qnil,
5532 doc: /* Function called (if non-nil) to perform auto-fill.
5533 It is called after self-inserting any character specified in
5534 the `auto-fill-chars' table.
5535 NOTE: This variable is not a hook;
5536 its value may not be a list of functions. */);
5538 DEFVAR_PER_BUFFER ("buffer-file-name", &BVAR (current_buffer, filename),
5539 make_number (Lisp_String),
5540 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5542 DEFVAR_PER_BUFFER ("buffer-file-truename", &BVAR (current_buffer, file_truename),
5543 make_number (Lisp_String),
5544 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5545 The truename of a file is calculated by `file-truename'
5546 and then abbreviated with `abbreviate-file-name'. */);
5548 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5549 &BVAR (current_buffer, auto_save_file_name),
5550 make_number (Lisp_String),
5551 doc: /* Name of file for auto-saving current buffer.
5552 If it is nil, that means don't auto-save this buffer. */);
5554 DEFVAR_PER_BUFFER ("buffer-read-only", &BVAR (current_buffer, read_only), Qnil,
5555 doc: /* Non-nil if this buffer is read-only. */);
5557 DEFVAR_PER_BUFFER ("buffer-backed-up", &BVAR (current_buffer, backed_up), Qnil,
5558 doc: /* Non-nil if this buffer's file has been backed up.
5559 Backing up is done before the first time the file is saved. */);
5561 DEFVAR_PER_BUFFER ("buffer-saved-size", &BVAR (current_buffer, save_length),
5562 make_number (LISP_INT_TAG),
5563 doc: /* Length of current buffer when last read in, saved or auto-saved.
5564 0 initially.
5565 -1 means auto-saving turned off until next real save.
5567 If you set this to -2, that means don't turn off auto-saving in this buffer
5568 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5569 you probably should set this to -2 in that buffer. */);
5571 DEFVAR_PER_BUFFER ("selective-display", &BVAR (current_buffer, selective_display),
5572 Qnil,
5573 doc: /* Non-nil enables selective display.
5574 An integer N as value means display only lines
5575 that start with less than N columns of space.
5576 A value of t means that the character ^M makes itself and
5577 all the rest of the line invisible; also, when saving the buffer
5578 in a file, save the ^M as a newline. */);
5580 #ifndef old
5581 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5582 &BVAR (current_buffer, selective_display_ellipses),
5583 Qnil,
5584 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5585 #endif
5587 DEFVAR_PER_BUFFER ("overwrite-mode", &BVAR (current_buffer, overwrite_mode), Qnil,
5588 doc: /* Non-nil if self-insertion should replace existing text.
5589 The value should be one of `overwrite-mode-textual',
5590 `overwrite-mode-binary', or nil.
5591 If it is `overwrite-mode-textual', self-insertion still
5592 inserts at the end of a line, and inserts when point is before a tab,
5593 until the tab is filled in.
5594 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5596 DEFVAR_PER_BUFFER ("buffer-display-table", &BVAR (current_buffer, display_table),
5597 Qnil,
5598 doc: /* Display table that controls display of the contents of current buffer.
5600 If this variable is nil, the value of `standard-display-table' is used.
5601 Each window can have its own, overriding display table, see
5602 `set-window-display-table' and `window-display-table'.
5604 The display table is a char-table created with `make-display-table'.
5605 A char-table is an array indexed by character codes. Normal array
5606 primitives `aref' and `aset' can be used to access elements of a char-table.
5608 Each of the char-table elements control how to display the corresponding
5609 text character: the element at index C in the table says how to display
5610 the character whose code is C. Each element should be a vector of
5611 characters or nil. The value nil means display the character in the
5612 default fashion; otherwise, the characters from the vector are delivered
5613 to the screen instead of the original character.
5615 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5616 to display a capital Y instead of each X character.
5618 In addition, a char-table has six extra slots to control the display of:
5620 the end of a truncated screen line (extra-slot 0, a single character);
5621 the end of a continued line (extra-slot 1, a single character);
5622 the escape character used to display character codes in octal
5623 (extra-slot 2, a single character);
5624 the character used as an arrow for control characters (extra-slot 3,
5625 a single character);
5626 the decoration indicating the presence of invisible lines (extra-slot 4,
5627 a vector of characters);
5628 the character used to draw the border between side-by-side windows
5629 (extra-slot 5, a single character).
5631 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5633 DEFVAR_PER_BUFFER ("left-margin-width", &BVAR (current_buffer, left_margin_cols),
5634 Qnil,
5635 doc: /* *Width of left marginal area for display of a buffer.
5636 A value of nil means no marginal area. */);
5638 DEFVAR_PER_BUFFER ("right-margin-width", &BVAR (current_buffer, right_margin_cols),
5639 Qnil,
5640 doc: /* *Width of right marginal area for display of a buffer.
5641 A value of nil means no marginal area. */);
5643 DEFVAR_PER_BUFFER ("left-fringe-width", &BVAR (current_buffer, left_fringe_width),
5644 Qnil,
5645 doc: /* *Width of this buffer's left fringe (in pixels).
5646 A value of 0 means no left fringe is shown in this buffer's window.
5647 A value of nil means to use the left fringe width from the window's frame. */);
5649 DEFVAR_PER_BUFFER ("right-fringe-width", &BVAR (current_buffer, right_fringe_width),
5650 Qnil,
5651 doc: /* *Width of this buffer's right fringe (in pixels).
5652 A value of 0 means no right fringe is shown in this buffer's window.
5653 A value of nil means to use the right fringe width from the window's frame. */);
5655 DEFVAR_PER_BUFFER ("fringes-outside-margins", &BVAR (current_buffer, fringes_outside_margins),
5656 Qnil,
5657 doc: /* *Non-nil means to display fringes outside display margins.
5658 A value of nil means to display fringes between margins and buffer text. */);
5660 DEFVAR_PER_BUFFER ("scroll-bar-width", &BVAR (current_buffer, scroll_bar_width),
5661 Qnil,
5662 doc: /* *Width of this buffer's scroll bars in pixels.
5663 A value of nil means to use the scroll bar width from the window's frame. */);
5665 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &BVAR (current_buffer, vertical_scroll_bar_type),
5666 Qnil,
5667 doc: /* *Position of this buffer's vertical scroll bar.
5668 The value takes effect whenever you tell a window to display this buffer;
5669 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5671 A value of `left' or `right' means put the vertical scroll bar at that side
5672 of the window; a value of nil means don't show any vertical scroll bars.
5673 A value of t (the default) means do whatever the window's frame specifies. */);
5675 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5676 &BVAR (current_buffer, indicate_empty_lines), Qnil,
5677 doc: /* *Visually indicate empty lines after the buffer end.
5678 If non-nil, a bitmap is displayed in the left fringe of a window on
5679 window-systems. */);
5681 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5682 &BVAR (current_buffer, indicate_buffer_boundaries), Qnil,
5683 doc: /* *Visually indicate buffer boundaries and scrolling.
5684 If non-nil, the first and last line of the buffer are marked in the fringe
5685 of a window on window-systems with angle bitmaps, or if the window can be
5686 scrolled, the top and bottom line of the window are marked with up and down
5687 arrow bitmaps.
5689 If value is a symbol `left' or `right', both angle and arrow bitmaps
5690 are displayed in the left or right fringe, resp. Any other value
5691 that doesn't look like an alist means display the angle bitmaps in
5692 the left fringe but no arrows.
5694 You can exercise more precise control by using an alist as the
5695 value. Each alist element (INDICATOR . POSITION) specifies
5696 where to show one of the indicators. INDICATOR is one of `top',
5697 `bottom', `up', `down', or t, which specifies the default position,
5698 and POSITION is one of `left', `right', or nil, meaning do not show
5699 this indicator.
5701 For example, ((top . left) (t . right)) places the top angle bitmap in
5702 left fringe, the bottom angle bitmap in right fringe, and both arrow
5703 bitmaps in right fringe. To show just the angle bitmaps in the left
5704 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5706 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5707 &BVAR (current_buffer, fringe_indicator_alist), Qnil,
5708 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5709 The value is an alist where each element (INDICATOR . BITMAPS)
5710 specifies the fringe bitmaps used to display a specific logical
5711 fringe indicator.
5713 INDICATOR specifies the logical indicator type which is one of the
5714 following symbols: `truncation' , `continuation', `overlay-arrow',
5715 `top', `bottom', `top-bottom', `up', `down', empty-line', or `unknown'.
5717 BITMAPS is a list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5718 the actual bitmap shown in the left or right fringe for the logical
5719 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5720 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5721 are used only for the `bottom' and `top-bottom' indicators when the
5722 last (only) line has no final newline. BITMAPS may also be a single
5723 symbol which is used in both left and right fringes. */);
5725 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5726 &BVAR (current_buffer, fringe_cursor_alist), Qnil,
5727 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5728 The value is an alist where each element (CURSOR . BITMAP)
5729 specifies the fringe bitmaps used to display a specific logical
5730 cursor type in the fringe.
5732 CURSOR specifies the logical cursor type which is one of the following
5733 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5734 one is used to show a hollow cursor on narrow lines display lines
5735 where the normal hollow cursor will not fit.
5737 BITMAP is the corresponding fringe bitmap shown for the logical
5738 cursor type. */);
5740 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5741 &BVAR (current_buffer, scroll_up_aggressively), Qnil,
5742 doc: /* How far to scroll windows upward.
5743 If you move point off the bottom, the window scrolls automatically.
5744 This variable controls how far it scrolls. The value nil, the default,
5745 means scroll to center point. A fraction means scroll to put point
5746 that fraction of the window's height from the bottom of the window.
5747 When the value is 0.0, point goes at the bottom line, which in the
5748 simple case that you moved off with C-f means scrolling just one line.
5749 1.0 means point goes at the top, so that in that simple case, the
5750 window scrolls by a full window height. Meaningful values are
5751 between 0.0 and 1.0, inclusive. */);
5753 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5754 &BVAR (current_buffer, scroll_down_aggressively), Qnil,
5755 doc: /* How far to scroll windows downward.
5756 If you move point off the top, the window scrolls automatically.
5757 This variable controls how far it scrolls. The value nil, the default,
5758 means scroll to center point. A fraction means scroll to put point
5759 that fraction of the window's height from the top of the window.
5760 When the value is 0.0, point goes at the top line, which in the
5761 simple case that you moved off with C-b means scrolling just one line.
5762 1.0 means point goes at the bottom, so that in that simple case, the
5763 window scrolls by a full window height. Meaningful values are
5764 between 0.0 and 1.0, inclusive. */);
5766 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5767 "Don't ask.");
5770 DEFVAR_LISP ("before-change-functions", Vbefore_change_functions,
5771 doc: /* List of functions to call before each text change.
5772 Two arguments are passed to each function: the positions of
5773 the beginning and end of the range of old text to be changed.
5774 \(For an insertion, the beginning and end are at the same place.)
5775 No information is given about the length of the text after the change.
5777 Buffer changes made while executing the `before-change-functions'
5778 don't call any before-change or after-change functions.
5779 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5781 If an unhandled error happens in running these functions,
5782 the variable's value remains nil. That prevents the error
5783 from happening repeatedly and making Emacs nonfunctional. */);
5784 Vbefore_change_functions = Qnil;
5786 DEFVAR_LISP ("after-change-functions", Vafter_change_functions,
5787 doc: /* List of functions to call after each text change.
5788 Three arguments are passed to each function: the positions of
5789 the beginning and end of the range of changed text,
5790 and the length in bytes of the pre-change text replaced by that range.
5791 \(For an insertion, the pre-change length is zero;
5792 for a deletion, that length is the number of bytes deleted,
5793 and the post-change beginning and end are at the same place.)
5795 Buffer changes made while executing the `after-change-functions'
5796 don't call any before-change or after-change functions.
5797 That's because `inhibit-modification-hooks' is temporarily set non-nil.
5799 If an unhandled error happens in running these functions,
5800 the variable's value remains nil. That prevents the error
5801 from happening repeatedly and making Emacs nonfunctional. */);
5802 Vafter_change_functions = Qnil;
5804 DEFVAR_LISP ("first-change-hook", Vfirst_change_hook,
5805 doc: /* A list of functions to call before changing a buffer which is unmodified.
5806 The functions are run using the `run-hooks' function. */);
5807 Vfirst_change_hook = Qnil;
5809 DEFVAR_PER_BUFFER ("buffer-undo-list", &BVAR (current_buffer, undo_list), Qnil,
5810 doc: /* List of undo entries in current buffer.
5811 Recent changes come first; older changes follow newer.
5813 An entry (BEG . END) represents an insertion which begins at
5814 position BEG and ends at position END.
5816 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5817 from (abs POSITION). If POSITION is positive, point was at the front
5818 of the text being deleted; if negative, point was at the end.
5820 An entry (t HIGH . LOW) indicates that the buffer previously had
5821 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5822 of the visited file's modification time, as of that time. If the
5823 modification time of the most recent save is different, this entry is
5824 obsolete.
5826 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5827 was modified between BEG and END. PROPERTY is the property name,
5828 and VALUE is the old value.
5830 An entry (apply FUN-NAME . ARGS) means undo the change with
5831 \(apply FUN-NAME ARGS).
5833 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5834 in the active region. BEG and END is the range affected by this entry
5835 and DELTA is the number of bytes added or deleted in that range by
5836 this change.
5838 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5839 was adjusted in position by the offset DISTANCE (an integer).
5841 An entry of the form POSITION indicates that point was at the buffer
5842 location given by the integer. Undoing an entry of this form places
5843 point at POSITION.
5845 Entries with value `nil' mark undo boundaries. The undo command treats
5846 the changes between two undo boundaries as a single step to be undone.
5848 If the value of the variable is t, undo information is not recorded. */);
5850 DEFVAR_PER_BUFFER ("mark-active", &BVAR (current_buffer, mark_active), Qnil,
5851 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5853 DEFVAR_PER_BUFFER ("cache-long-line-scans", &BVAR (current_buffer, cache_long_line_scans), Qnil,
5854 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5856 Normally, the line-motion functions work by scanning the buffer for
5857 newlines. Columnar operations (like `move-to-column' and
5858 `compute-motion') also work by scanning the buffer, summing character
5859 widths as they go. This works well for ordinary text, but if the
5860 buffer's lines are very long (say, more than 500 characters), these
5861 motion functions will take longer to execute. Emacs may also take
5862 longer to update the display.
5864 If `cache-long-line-scans' is non-nil, these motion functions cache the
5865 results of their scans, and consult the cache to avoid rescanning
5866 regions of the buffer until the text is modified. The caches are most
5867 beneficial when they prevent the most searching---that is, when the
5868 buffer contains long lines and large regions of characters with the
5869 same, fixed screen width.
5871 When `cache-long-line-scans' is non-nil, processing short lines will
5872 become slightly slower (because of the overhead of consulting the
5873 cache), and the caches will use memory roughly proportional to the
5874 number of newlines and characters whose screen width varies.
5876 The caches require no explicit maintenance; their accuracy is
5877 maintained internally by the Emacs primitives. Enabling or disabling
5878 the cache should not affect the behavior of any of the motion
5879 functions; it should only affect their performance. */);
5881 DEFVAR_PER_BUFFER ("point-before-scroll", &BVAR (current_buffer, point_before_scroll), Qnil,
5882 doc: /* Value of point before the last series of scroll operations, or nil. */);
5884 DEFVAR_PER_BUFFER ("buffer-file-format", &BVAR (current_buffer, file_format), Qnil,
5885 doc: /* List of formats to use when saving this buffer.
5886 Formats are defined by `format-alist'. This variable is
5887 set when a file is visited. */);
5889 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5890 &BVAR (current_buffer, auto_save_file_format), Qnil,
5891 doc: /* *Format in which to write auto-save files.
5892 Should be a list of symbols naming formats that are defined in `format-alist'.
5893 If it is t, which is the default, auto-save files are written in the
5894 same format as a regular save would use. */);
5896 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5897 &BVAR (current_buffer, invisibility_spec), Qnil,
5898 doc: /* Invisibility spec of this buffer.
5899 The default is t, which means that text is invisible
5900 if it has a non-nil `invisible' property.
5901 If the value is a list, a text character is invisible if its `invisible'
5902 property is an element in that list (or is a list with members in common).
5903 If an element is a cons cell of the form (PROP . ELLIPSIS),
5904 then characters with property value PROP are invisible,
5905 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5907 DEFVAR_PER_BUFFER ("buffer-display-count",
5908 &BVAR (current_buffer, display_count), Qnil,
5909 doc: /* A number incremented each time this buffer is displayed in a window.
5910 The function `set-window-buffer' increments it. */);
5912 DEFVAR_PER_BUFFER ("buffer-display-time",
5913 &BVAR (current_buffer, display_time), Qnil,
5914 doc: /* Time stamp updated each time this buffer is displayed in a window.
5915 The function `set-window-buffer' updates this variable
5916 to the value obtained by calling `current-time'.
5917 If the buffer has never been shown in a window, the value is nil. */);
5919 DEFVAR_LISP ("transient-mark-mode", Vtransient_mark_mode,
5920 doc: /* Non-nil if Transient Mark mode is enabled.
5921 See the command `transient-mark-mode' for a description of this minor mode.
5923 Non-nil also enables highlighting of the region whenever the mark is active.
5924 The variable `highlight-nonselected-windows' controls whether to highlight
5925 all windows or just the selected window.
5927 Lisp programs may give this variable certain special values:
5929 - A value of `lambda' enables Transient Mark mode temporarily.
5930 It is disabled again after any subsequent action that would
5931 normally deactivate the mark (e.g. buffer modification).
5933 - A value of (only . OLDVAL) enables Transient Mark mode
5934 temporarily. After any subsequent point motion command that is
5935 not shift-translated, or any other action that would normally
5936 deactivate the mark (e.g. buffer modification), the value of
5937 `transient-mark-mode' is set to OLDVAL. */);
5938 Vtransient_mark_mode = Qnil;
5940 DEFVAR_LISP ("inhibit-read-only", Vinhibit_read_only,
5941 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5942 If the value is t, disregard `buffer-read-only' and all `read-only'
5943 text properties. If the value is a list, disregard `buffer-read-only'
5944 and disregard a `read-only' text property if the property value
5945 is a member of the list. */);
5946 Vinhibit_read_only = Qnil;
5948 DEFVAR_PER_BUFFER ("cursor-type", &BVAR (current_buffer, cursor_type), Qnil,
5949 doc: /* Cursor to use when this buffer is in the selected window.
5950 Values are interpreted as follows:
5952 t use the cursor specified for the frame
5953 nil don't display a cursor
5954 box display a filled box cursor
5955 hollow display a hollow box cursor
5956 bar display a vertical bar cursor with default width
5957 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5958 hbar display a horizontal bar cursor with default height
5959 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
5960 ANYTHING ELSE display a hollow box cursor
5962 When the buffer is displayed in a non-selected window, the
5963 cursor's appearance is instead controlled by the variable
5964 `cursor-in-non-selected-windows'. */);
5966 DEFVAR_PER_BUFFER ("line-spacing",
5967 &BVAR (current_buffer, extra_line_spacing), Qnil,
5968 doc: /* Additional space to put between lines when displaying a buffer.
5969 The space is measured in pixels, and put below lines on graphic displays,
5970 see `display-graphic-p'.
5971 If value is a floating point number, it specifies the spacing relative
5972 to the default frame line height. A value of nil means add no extra space. */);
5974 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
5975 &BVAR (current_buffer, cursor_in_non_selected_windows), Qnil,
5976 doc: /* *Non-nil means show a cursor in non-selected windows.
5977 If nil, only shows a cursor in the selected window.
5978 If t, displays a cursor related to the usual cursor type
5979 \(a solid box becomes hollow, a bar becomes a narrower bar).
5980 You can also specify the cursor type as in the `cursor-type' variable.
5981 Use Custom to set this variable and update the display." */);
5983 DEFVAR_LISP ("kill-buffer-query-functions", Vkill_buffer_query_functions,
5984 doc: /* List of functions called with no args to query before killing a buffer.
5985 The buffer being killed will be current while the functions are running.
5986 If any of them returns nil, the buffer is not killed. */);
5987 Vkill_buffer_query_functions = Qnil;
5989 DEFVAR_LISP ("change-major-mode-hook", Vchange_major_mode_hook,
5990 doc: /* Normal hook run before changing the major mode of a buffer.
5991 The function `kill-all-local-variables' runs this before doing anything else. */);
5992 Vchange_major_mode_hook = Qnil;
5993 DEFSYM (Qchange_major_mode_hook, "change-major-mode-hook");
5995 DEFVAR_LISP ("buffer-list-update-hook", Vbuffer_list_update_hook,
5996 doc: /* Hook run when the buffer list changes.
5997 Functions running this hook are `get-buffer-create',
5998 `make-indirect-buffer', `rename-buffer', `kill-buffer',
5999 and `bury-buffer-internal'. */);
6000 Vbuffer_list_update_hook = Qnil;
6001 DEFSYM (Qbuffer_list_update_hook, "buffer-list-update-hook");
6003 defsubr (&Sbuffer_live_p);
6004 defsubr (&Sbuffer_list);
6005 defsubr (&Sget_buffer);
6006 defsubr (&Sget_file_buffer);
6007 defsubr (&Sget_buffer_create);
6008 defsubr (&Smake_indirect_buffer);
6009 defsubr (&Sgenerate_new_buffer_name);
6010 defsubr (&Sbuffer_name);
6011 /*defsubr (&Sbuffer_number);*/
6012 defsubr (&Sbuffer_file_name);
6013 defsubr (&Sbuffer_base_buffer);
6014 defsubr (&Sbuffer_local_value);
6015 defsubr (&Sbuffer_local_variables);
6016 defsubr (&Sbuffer_modified_p);
6017 defsubr (&Sset_buffer_modified_p);
6018 defsubr (&Sbuffer_modified_tick);
6019 defsubr (&Sbuffer_chars_modified_tick);
6020 defsubr (&Srename_buffer);
6021 defsubr (&Sother_buffer);
6022 defsubr (&Sbuffer_enable_undo);
6023 defsubr (&Skill_buffer);
6024 defsubr (&Sbury_buffer_internal);
6025 defsubr (&Sset_buffer_major_mode);
6026 defsubr (&Scurrent_buffer);
6027 defsubr (&Sset_buffer);
6028 defsubr (&Sbarf_if_buffer_read_only);
6029 defsubr (&Serase_buffer);
6030 defsubr (&Sbuffer_swap_text);
6031 defsubr (&Sset_buffer_multibyte);
6032 defsubr (&Skill_all_local_variables);
6034 defsubr (&Soverlayp);
6035 defsubr (&Smake_overlay);
6036 defsubr (&Sdelete_overlay);
6037 defsubr (&Smove_overlay);
6038 defsubr (&Soverlay_start);
6039 defsubr (&Soverlay_end);
6040 defsubr (&Soverlay_buffer);
6041 defsubr (&Soverlay_properties);
6042 defsubr (&Soverlays_at);
6043 defsubr (&Soverlays_in);
6044 defsubr (&Snext_overlay_change);
6045 defsubr (&Sprevious_overlay_change);
6046 defsubr (&Soverlay_recenter);
6047 defsubr (&Soverlay_lists);
6048 defsubr (&Soverlay_get);
6049 defsubr (&Soverlay_put);
6050 defsubr (&Srestore_buffer_modified_p);
6053 void
6054 keys_of_buffer (void)
6056 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6057 initial_define_key (control_x_map, 'k', "kill-buffer");
6059 /* This must not be in syms_of_buffer, because Qdisabled is not
6060 initialized when that function gets called. */
6061 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);