* message.el (message-pop-to-buffer): Add switch-function argument.
[emacs.git] / src / buffer.c
blobba23cc6ae3317f9afacb329e675bf408ca914091
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994,
3 1995, 1997, 1998, 1999, 2000, 2001, 2002,
4 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #include <config.h>
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <sys/param.h>
28 #include <errno.h>
29 #include <stdio.h>
31 #ifndef USE_CRT_DLL
32 extern int errno;
33 #endif
36 #ifdef HAVE_UNISTD_H
37 #include <unistd.h>
38 #endif
40 #include "lisp.h"
41 #include "intervals.h"
42 #include "window.h"
43 #include "commands.h"
44 #include "buffer.h"
45 #include "charset.h"
46 #include "region-cache.h"
47 #include "indent.h"
48 #include "blockinput.h"
49 #include "keyboard.h"
50 #include "keymap.h"
51 #include "frame.h"
53 struct buffer *current_buffer; /* the current buffer */
55 /* First buffer in chain of all buffers (in reverse order of creation).
56 Threaded through ->next. */
58 struct buffer *all_buffers;
60 /* This structure holds the default values of the buffer-local variables
61 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
62 The default value occupies the same slot in this structure
63 as an individual buffer's value occupies in that buffer.
64 Setting the default value also goes through the alist of buffers
65 and stores into each buffer that does not say it has a local value. */
67 DECL_ALIGN (struct buffer, buffer_defaults);
69 /* A Lisp_Object pointer to the above, used for staticpro */
71 static Lisp_Object Vbuffer_defaults;
73 /* This structure marks which slots in a buffer have corresponding
74 default values in buffer_defaults.
75 Each such slot has a nonzero value in this structure.
76 The value has only one nonzero bit.
78 When a buffer has its own local value for a slot,
79 the entry for that slot (found in the same slot in this structure)
80 is turned on in the buffer's local_flags array.
82 If a slot in this structure is -1, then even though there may
83 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
84 and the corresponding slot in buffer_defaults is not used.
86 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
87 but there is a default value which is copied into each buffer.
89 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
90 zero, that is a bug */
92 struct buffer buffer_local_flags;
94 /* This structure holds the names of symbols whose values may be
95 buffer-local. It is indexed and accessed in the same way as the above. */
97 DECL_ALIGN (struct buffer, buffer_local_symbols);
99 /* A Lisp_Object pointer to the above, used for staticpro */
100 static Lisp_Object Vbuffer_local_symbols;
102 /* This structure holds the required types for the values in the
103 buffer-local slots. If a slot contains Qnil, then the
104 corresponding buffer slot may contain a value of any type. If a
105 slot contains an integer, then prospective values' tags must be
106 equal to that integer (except nil is always allowed).
107 When a tag does not match, the function
108 buffer_slot_type_mismatch will signal an error.
110 If a slot here contains -1, the corresponding variable is read-only. */
111 struct buffer buffer_local_types;
113 /* Flags indicating which built-in buffer-local variables
114 are permanent locals. */
115 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
117 /* Number of per-buffer variables used. */
119 int last_per_buffer_idx;
121 Lisp_Object Fset_buffer ();
122 void set_buffer_internal ();
123 void set_buffer_internal_1 ();
124 static void call_overlay_mod_hooks ();
125 static void swap_out_buffer_local_variables ();
126 static void reset_buffer_local_variables ();
128 /* Alist of all buffer names vs the buffers. */
129 /* This used to be a variable, but is no longer,
130 to prevent lossage due to user rplac'ing this alist or its elements. */
131 Lisp_Object Vbuffer_alist;
133 /* Functions to call before and after each text change. */
134 Lisp_Object Vbefore_change_functions;
135 Lisp_Object Vafter_change_functions;
137 Lisp_Object Vtransient_mark_mode;
139 /* t means ignore all read-only text properties.
140 A list means ignore such a property if its value is a member of the list.
141 Any non-nil value means ignore buffer-read-only. */
142 Lisp_Object Vinhibit_read_only;
144 /* List of functions to call that can query about killing a buffer.
145 If any of these functions returns nil, we don't kill it. */
146 Lisp_Object Vkill_buffer_query_functions;
147 Lisp_Object Qkill_buffer_query_functions;
149 /* Hook run before changing a major mode. */
150 Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;
152 /* List of functions to call before changing an unmodified buffer. */
153 Lisp_Object Vfirst_change_hook;
155 Lisp_Object Qfirst_change_hook;
156 Lisp_Object Qbefore_change_functions;
157 Lisp_Object Qafter_change_functions;
158 Lisp_Object Qucs_set_table_for_input;
160 /* If nonzero, all modification hooks are suppressed. */
161 int inhibit_modification_hooks;
163 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
165 Lisp_Object Qprotected_field;
167 Lisp_Object QSFundamental; /* A string "Fundamental" */
169 Lisp_Object Qkill_buffer_hook;
171 Lisp_Object Qget_file_buffer;
173 Lisp_Object Qoverlayp;
175 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
177 Lisp_Object Qmodification_hooks;
178 Lisp_Object Qinsert_in_front_hooks;
179 Lisp_Object Qinsert_behind_hooks;
181 static void alloc_buffer_text P_ ((struct buffer *, size_t));
182 static void free_buffer_text P_ ((struct buffer *b));
183 static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
184 static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
185 static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
188 /* For debugging; temporary. See set_buffer_internal. */
189 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
191 void
192 nsberror (spec)
193 Lisp_Object spec;
195 if (STRINGP (spec))
196 error ("No buffer named %s", SDATA (spec));
197 error ("Invalid buffer argument");
200 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
201 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
202 Value is nil if OBJECT is not a buffer or if it has been killed. */)
203 (object)
204 Lisp_Object object;
206 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
207 ? Qt : Qnil);
210 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
211 doc: /* Return a list of all existing live buffers.
212 If the optional arg FRAME is a frame, we return the buffer list
213 in the proper order for that frame: the buffers in FRAME's `buffer-list'
214 frame parameter come first, followed by the rest of the buffers. */)
215 (frame)
216 Lisp_Object frame;
218 Lisp_Object framelist, general;
219 general = Fmapcar (Qcdr, Vbuffer_alist);
221 if (FRAMEP (frame))
223 Lisp_Object tail;
225 CHECK_FRAME (frame);
227 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
229 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
230 tail = framelist;
231 while (! NILP (tail))
233 general = Fdelq (XCAR (tail), general);
234 tail = XCDR (tail);
236 return nconc2 (framelist, general);
239 return general;
242 /* Like Fassoc, but use Fstring_equal to compare
243 (which ignores text properties),
244 and don't ever QUIT. */
246 static Lisp_Object
247 assoc_ignore_text_properties (key, list)
248 register Lisp_Object key;
249 Lisp_Object list;
251 register Lisp_Object tail;
252 for (tail = list; CONSP (tail); tail = XCDR (tail))
254 register Lisp_Object elt, tem;
255 elt = XCAR (tail);
256 tem = Fstring_equal (Fcar (elt), key);
257 if (!NILP (tem))
258 return elt;
260 return Qnil;
263 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
264 doc: /* Return the buffer named NAME (a string).
265 If there is no live buffer named NAME, return nil.
266 NAME may also be a buffer; if so, the value is that buffer. */)
267 (name)
268 register Lisp_Object name;
270 if (BUFFERP (name))
271 return name;
272 CHECK_STRING (name);
274 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
277 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
278 doc: /* Return the buffer visiting file FILENAME (a string).
279 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
280 If there is no such live buffer, return nil.
281 See also `find-buffer-visiting'. */)
282 (filename)
283 register Lisp_Object filename;
285 register Lisp_Object tail, buf, tem;
286 Lisp_Object handler;
288 CHECK_STRING (filename);
289 filename = Fexpand_file_name (filename, Qnil);
291 /* If the file name has special constructs in it,
292 call the corresponding file handler. */
293 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
294 if (!NILP (handler))
295 return call2 (handler, Qget_file_buffer, filename);
297 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
299 buf = Fcdr (XCAR (tail));
300 if (!BUFFERP (buf)) continue;
301 if (!STRINGP (XBUFFER (buf)->filename)) continue;
302 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
303 if (!NILP (tem))
304 return buf;
306 return Qnil;
309 Lisp_Object
310 get_truename_buffer (filename)
311 register Lisp_Object filename;
313 register Lisp_Object tail, buf, tem;
315 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
317 buf = Fcdr (XCAR (tail));
318 if (!BUFFERP (buf)) continue;
319 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
320 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
321 if (!NILP (tem))
322 return buf;
324 return Qnil;
327 /* Incremented for each buffer created, to assign the buffer number. */
328 int buffer_count;
330 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
331 doc: /* Return the buffer named NAME, or create such a buffer and return it.
332 A new buffer is created if there is no live buffer named NAME.
333 If NAME starts with a space, the new buffer does not keep undo information.
334 If NAME is a buffer instead of a string, then it is the value returned.
335 The value is never nil. */)
336 (name)
337 register Lisp_Object name;
339 register Lisp_Object buf;
340 register struct buffer *b;
342 buf = Fget_buffer (name);
343 if (!NILP (buf))
344 return buf;
346 if (SCHARS (name) == 0)
347 error ("Empty string for buffer name is not allowed");
349 b = (struct buffer *) allocate_buffer ();
351 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
353 /* An ordinary buffer uses its own struct buffer_text. */
354 b->text = &b->own_text;
355 b->base_buffer = 0;
357 BUF_GAP_SIZE (b) = 20;
358 BLOCK_INPUT;
359 /* We allocate extra 1-byte at the tail and keep it always '\0' for
360 anchoring a search. */
361 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
362 UNBLOCK_INPUT;
363 if (! BUF_BEG_ADDR (b))
364 buffer_memory_full ();
366 BUF_PT (b) = BEG;
367 BUF_GPT (b) = BEG;
368 BUF_BEGV (b) = BEG;
369 BUF_ZV (b) = BEG;
370 BUF_Z (b) = BEG;
371 BUF_PT_BYTE (b) = BEG_BYTE;
372 BUF_GPT_BYTE (b) = BEG_BYTE;
373 BUF_BEGV_BYTE (b) = BEG_BYTE;
374 BUF_ZV_BYTE (b) = BEG_BYTE;
375 BUF_Z_BYTE (b) = BEG_BYTE;
376 BUF_MODIFF (b) = 1;
377 BUF_CHARS_MODIFF (b) = 1;
378 BUF_OVERLAY_MODIFF (b) = 1;
379 BUF_SAVE_MODIFF (b) = 1;
380 BUF_INTERVALS (b) = 0;
381 BUF_UNCHANGED_MODIFIED (b) = 1;
382 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
383 BUF_END_UNCHANGED (b) = 0;
384 BUF_BEG_UNCHANGED (b) = 0;
385 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
387 b->newline_cache = 0;
388 b->width_run_cache = 0;
389 b->width_table = Qnil;
390 b->prevent_redisplay_optimizations_p = 1;
392 /* Put this on the chain of all buffers including killed ones. */
393 b->next = all_buffers;
394 all_buffers = b;
396 /* An ordinary buffer normally doesn't need markers
397 to handle BEGV and ZV. */
398 b->pt_marker = Qnil;
399 b->begv_marker = Qnil;
400 b->zv_marker = Qnil;
402 name = Fcopy_sequence (name);
403 STRING_SET_INTERVALS (name, NULL_INTERVAL);
404 b->name = name;
406 if (SREF (name, 0) != ' ')
407 b->undo_list = Qnil;
408 else
409 b->undo_list = Qt;
411 reset_buffer (b);
412 reset_buffer_local_variables (b, 1);
414 b->mark = Fmake_marker ();
415 BUF_MARKERS (b) = NULL;
416 b->name = name;
418 /* Put this in the alist of all live buffers. */
419 XSETBUFFER (buf, b);
420 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
422 /* An error in calling the function here (should someone redefine it)
423 can lead to infinite regress until you run out of stack. rms
424 says that's not worth protecting against. */
425 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
426 /* buf is on buffer-alist, so no gcpro. */
427 call1 (Qucs_set_table_for_input, buf);
429 return buf;
433 /* Return a list of overlays which is a copy of the overlay list
434 LIST, but for buffer B. */
436 static struct Lisp_Overlay *
437 copy_overlays (b, list)
438 struct buffer *b;
439 struct Lisp_Overlay *list;
441 Lisp_Object buffer;
442 struct Lisp_Overlay *result = NULL, *tail = NULL;
444 XSETBUFFER (buffer, b);
446 for (; list; list = list->next)
448 Lisp_Object overlay, start, end, old_overlay;
449 EMACS_INT charpos;
451 XSETMISC (old_overlay, list);
452 charpos = marker_position (OVERLAY_START (old_overlay));
453 start = Fmake_marker ();
454 Fset_marker (start, make_number (charpos), buffer);
455 XMARKER (start)->insertion_type
456 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
458 charpos = marker_position (OVERLAY_END (old_overlay));
459 end = Fmake_marker ();
460 Fset_marker (end, make_number (charpos), buffer);
461 XMARKER (end)->insertion_type
462 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
464 overlay = allocate_misc ();
465 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
466 OVERLAY_START (overlay) = start;
467 OVERLAY_END (overlay) = end;
468 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
469 XOVERLAY (overlay)->next = NULL;
471 if (tail)
472 tail = tail->next = XOVERLAY (overlay);
473 else
474 result = tail = XOVERLAY (overlay);
477 return result;
481 /* Clone per-buffer values of buffer FROM.
483 Buffer TO gets the same per-buffer values as FROM, with the
484 following exceptions: (1) TO's name is left untouched, (2) markers
485 are copied and made to refer to TO, and (3) overlay lists are
486 copied. */
488 static void
489 clone_per_buffer_values (from, to)
490 struct buffer *from, *to;
492 Lisp_Object to_buffer;
493 int offset;
495 XSETBUFFER (to_buffer, to);
497 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
498 offset < sizeof *to;
499 offset += sizeof (Lisp_Object))
501 Lisp_Object obj;
503 obj = PER_BUFFER_VALUE (from, offset);
504 if (MARKERP (obj))
506 struct Lisp_Marker *m = XMARKER (obj);
507 obj = Fmake_marker ();
508 XMARKER (obj)->insertion_type = m->insertion_type;
509 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
512 PER_BUFFER_VALUE (to, offset) = obj;
515 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
517 to->overlays_before = copy_overlays (to, from->overlays_before);
518 to->overlays_after = copy_overlays (to, from->overlays_after);
520 /* Get (a copy of) the alist of Lisp-level local variables of FROM
521 and install that in TO. */
522 to->local_var_alist = buffer_lisp_local_variables (from);
525 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
526 2, 3,
527 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
528 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
529 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
530 NAME should be a string which is not the name of an existing buffer.
531 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
532 such as major and minor modes, in the indirect buffer.
533 CLONE nil means the indirect buffer's state is reset to default values. */)
534 (base_buffer, name, clone)
535 Lisp_Object base_buffer, name, clone;
537 Lisp_Object buf, tem;
538 struct buffer *b;
540 CHECK_STRING (name);
541 buf = Fget_buffer (name);
542 if (!NILP (buf))
543 error ("Buffer name `%s' is in use", SDATA (name));
545 tem = base_buffer;
546 base_buffer = Fget_buffer (base_buffer);
547 if (NILP (base_buffer))
548 error ("No such buffer: `%s'", SDATA (tem));
549 if (NILP (XBUFFER (base_buffer)->name))
550 error ("Base buffer has been killed");
552 if (SCHARS (name) == 0)
553 error ("Empty string for buffer name is not allowed");
555 b = (struct buffer *) allocate_buffer ();
556 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
558 if (XBUFFER (base_buffer)->base_buffer)
559 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
560 else
561 b->base_buffer = XBUFFER (base_buffer);
563 /* Use the base buffer's text object. */
564 b->text = b->base_buffer->text;
566 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
567 BUF_ZV (b) = BUF_ZV (b->base_buffer);
568 BUF_PT (b) = BUF_PT (b->base_buffer);
569 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
570 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
571 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
573 b->newline_cache = 0;
574 b->width_run_cache = 0;
575 b->width_table = Qnil;
577 /* Put this on the chain of all buffers including killed ones. */
578 b->next = all_buffers;
579 all_buffers = b;
581 name = Fcopy_sequence (name);
582 STRING_SET_INTERVALS (name, NULL_INTERVAL);
583 b->name = name;
585 reset_buffer (b);
586 reset_buffer_local_variables (b, 1);
588 /* Put this in the alist of all live buffers. */
589 XSETBUFFER (buf, b);
590 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
592 b->mark = Fmake_marker ();
593 b->name = name;
595 /* The multibyte status belongs to the base buffer. */
596 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
598 /* Make sure the base buffer has markers for its narrowing. */
599 if (NILP (b->base_buffer->pt_marker))
601 b->base_buffer->pt_marker = Fmake_marker ();
602 set_marker_both (b->base_buffer->pt_marker, base_buffer,
603 BUF_PT (b->base_buffer),
604 BUF_PT_BYTE (b->base_buffer));
606 if (NILP (b->base_buffer->begv_marker))
608 b->base_buffer->begv_marker = Fmake_marker ();
609 set_marker_both (b->base_buffer->begv_marker, base_buffer,
610 BUF_BEGV (b->base_buffer),
611 BUF_BEGV_BYTE (b->base_buffer));
613 if (NILP (b->base_buffer->zv_marker))
615 b->base_buffer->zv_marker = Fmake_marker ();
616 set_marker_both (b->base_buffer->zv_marker, base_buffer,
617 BUF_ZV (b->base_buffer),
618 BUF_ZV_BYTE (b->base_buffer));
619 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
622 if (NILP (clone))
624 /* Give the indirect buffer markers for its narrowing. */
625 b->pt_marker = Fmake_marker ();
626 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
627 b->begv_marker = Fmake_marker ();
628 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
629 b->zv_marker = Fmake_marker ();
630 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
631 XMARKER (b->zv_marker)->insertion_type = 1;
633 else
635 struct buffer *old_b = current_buffer;
637 clone_per_buffer_values (b->base_buffer, b);
638 b->filename = Qnil;
639 b->file_truename = Qnil;
640 b->display_count = make_number (0);
641 b->backed_up = Qnil;
642 b->auto_save_file_name = Qnil;
643 set_buffer_internal_1 (b);
644 Fset (intern ("buffer-save-without-query"), Qnil);
645 Fset (intern ("buffer-file-number"), Qnil);
646 Fset (intern ("buffer-stale-function"), Qnil);
647 set_buffer_internal_1 (old_b);
650 return buf;
653 void
654 delete_all_overlays (b)
655 struct buffer *b;
657 Lisp_Object overlay;
659 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
660 have to empty the list, otherwise we end up with overlays that
661 think they belong to this buffer while the buffer doesn't know about
662 them any more. */
663 while (b->overlays_before)
665 XSETMISC (overlay, b->overlays_before);
666 Fdelete_overlay (overlay);
668 while (b->overlays_after)
670 XSETMISC (overlay, b->overlays_after);
671 Fdelete_overlay (overlay);
673 eassert (b->overlays_before == NULL);
674 eassert (b->overlays_after == NULL);
677 /* Reinitialize everything about a buffer except its name and contents
678 and local variables.
679 If called on an already-initialized buffer, the list of overlays
680 should be deleted before calling this function, otherwise we end up
681 with overlays that claim to belong to the buffer but the buffer
682 claims it doesn't belong to it. */
684 void
685 reset_buffer (b)
686 register struct buffer *b;
688 b->filename = Qnil;
689 b->file_truename = Qnil;
690 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
691 b->modtime = 0;
692 XSETFASTINT (b->save_length, 0);
693 b->last_window_start = 1;
694 /* It is more conservative to start out "changed" than "unchanged". */
695 b->clip_changed = 0;
696 b->prevent_redisplay_optimizations_p = 1;
697 b->backed_up = Qnil;
698 b->auto_save_modified = 0;
699 b->auto_save_failure_time = -1;
700 b->auto_save_file_name = Qnil;
701 b->read_only = Qnil;
702 b->overlays_before = NULL;
703 b->overlays_after = NULL;
704 b->overlay_center = BEG;
705 b->mark_active = Qnil;
706 b->point_before_scroll = Qnil;
707 b->file_format = Qnil;
708 b->auto_save_file_format = Qt;
709 b->last_selected_window = Qnil;
710 XSETINT (b->display_count, 0);
711 b->display_time = Qnil;
712 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
713 b->cursor_type = buffer_defaults.cursor_type;
714 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
716 b->display_error_modiff = 0;
719 /* Reset buffer B's local variables info.
720 Don't use this on a buffer that has already been in use;
721 it does not treat permanent locals consistently.
722 Instead, use Fkill_all_local_variables.
724 If PERMANENT_TOO is 1, then we reset permanent built-in
725 buffer-local variables. If PERMANENT_TOO is 0,
726 we preserve those. */
728 static void
729 reset_buffer_local_variables (b, permanent_too)
730 register struct buffer *b;
731 int permanent_too;
733 register int offset;
734 int i;
736 /* Reset the major mode to Fundamental, together with all the
737 things that depend on the major mode.
738 default-major-mode is handled at a higher level.
739 We ignore it here. */
740 b->major_mode = Qfundamental_mode;
741 b->keymap = Qnil;
742 b->mode_name = QSFundamental;
743 b->minor_modes = Qnil;
745 /* If the standard case table has been altered and invalidated,
746 fix up its insides first. */
747 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
748 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
749 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
750 Fset_standard_case_table (Vascii_downcase_table);
752 b->downcase_table = Vascii_downcase_table;
753 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
754 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
755 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
756 b->invisibility_spec = Qt;
757 #ifndef DOS_NT
758 b->buffer_file_type = Qnil;
759 #endif
761 /* Reset all (or most) per-buffer variables to their defaults. */
762 b->local_var_alist = Qnil;
763 for (i = 0; i < last_per_buffer_idx; ++i)
764 if (permanent_too || buffer_permanent_local_flags[i] == 0)
765 SET_PER_BUFFER_VALUE_P (b, i, 0);
767 /* For each slot that has a default value,
768 copy that into the slot. */
770 for (offset = PER_BUFFER_VAR_OFFSET (name);
771 offset < sizeof *b;
772 offset += sizeof (Lisp_Object))
774 int idx = PER_BUFFER_IDX (offset);
775 if ((idx > 0
776 && (permanent_too
777 || buffer_permanent_local_flags[idx] == 0))
778 /* Is -2 used anywhere? */
779 || idx == -2)
780 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
784 /* We split this away from generate-new-buffer, because rename-buffer
785 and set-visited-file-name ought to be able to use this to really
786 rename the buffer properly. */
788 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
789 1, 2, 0,
790 doc: /* Return a string that is the name of no existing buffer based on NAME.
791 If there is no live buffer named NAME, then return NAME.
792 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
793 \(starting at 2) until an unused name is found, and then return that name.
794 Optional second argument IGNORE specifies a name that is okay to use (if
795 it is in the sequence to be tried) even if a buffer with that name exists. */)
796 (name, ignore)
797 register Lisp_Object name, ignore;
799 register Lisp_Object gentemp, tem;
800 int count;
801 char number[10];
803 CHECK_STRING (name);
805 tem = Fstring_equal (name, ignore);
806 if (!NILP (tem))
807 return name;
808 tem = Fget_buffer (name);
809 if (NILP (tem))
810 return name;
812 count = 1;
813 while (1)
815 sprintf (number, "<%d>", ++count);
816 gentemp = concat2 (name, build_string (number));
817 tem = Fstring_equal (gentemp, ignore);
818 if (!NILP (tem))
819 return gentemp;
820 tem = Fget_buffer (gentemp);
821 if (NILP (tem))
822 return gentemp;
827 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
828 doc: /* Return the name of BUFFER, as a string.
829 With no argument or nil as argument, return the name of the current buffer. */)
830 (buffer)
831 register Lisp_Object buffer;
833 if (NILP (buffer))
834 return current_buffer->name;
835 CHECK_BUFFER (buffer);
836 return XBUFFER (buffer)->name;
839 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
840 doc: /* Return name of file BUFFER is visiting, or nil if none.
841 No argument or nil as argument means use the current buffer. */)
842 (buffer)
843 register Lisp_Object buffer;
845 if (NILP (buffer))
846 return current_buffer->filename;
847 CHECK_BUFFER (buffer);
848 return XBUFFER (buffer)->filename;
851 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
852 0, 1, 0,
853 doc: /* Return the base buffer of indirect buffer BUFFER.
854 If BUFFER is not indirect, return nil.
855 BUFFER defaults to the current buffer. */)
856 (buffer)
857 register Lisp_Object buffer;
859 struct buffer *base;
860 Lisp_Object base_buffer;
862 if (NILP (buffer))
863 base = current_buffer->base_buffer;
864 else
866 CHECK_BUFFER (buffer);
867 base = XBUFFER (buffer)->base_buffer;
870 if (! base)
871 return Qnil;
872 XSETBUFFER (base_buffer, base);
873 return base_buffer;
876 DEFUN ("buffer-local-value", Fbuffer_local_value,
877 Sbuffer_local_value, 2, 2, 0,
878 doc: /* Return the value of VARIABLE in BUFFER.
879 If VARIABLE does not have a buffer-local binding in BUFFER, the value
880 is the default binding of the variable. */)
881 (variable, buffer)
882 register Lisp_Object variable;
883 register Lisp_Object buffer;
885 register struct buffer *buf;
886 register Lisp_Object result;
888 CHECK_SYMBOL (variable);
889 CHECK_BUFFER (buffer);
890 buf = XBUFFER (buffer);
892 if (SYMBOLP (variable))
893 variable = indirect_variable (variable);
895 /* Look in local_var_list */
896 result = Fassoc (variable, buf->local_var_alist);
897 if (NILP (result))
899 int offset, idx;
900 int found = 0;
902 /* Look in special slots */
903 for (offset = PER_BUFFER_VAR_OFFSET (name);
904 offset < sizeof (struct buffer);
905 /* sizeof EMACS_INT == sizeof Lisp_Object */
906 offset += (sizeof (EMACS_INT)))
908 idx = PER_BUFFER_IDX (offset);
909 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
910 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
911 && EQ (PER_BUFFER_SYMBOL (offset), variable))
913 result = PER_BUFFER_VALUE (buf, offset);
914 found = 1;
915 break;
919 if (!found)
920 result = Fdefault_value (variable);
922 else
924 Lisp_Object valcontents;
925 Lisp_Object current_alist_element;
927 /* What binding is loaded right now? */
928 valcontents = SYMBOL_VALUE (variable);
929 current_alist_element
930 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
932 /* The value of the currently loaded binding is not
933 stored in it, but rather in the realvalue slot.
934 Store that value into the binding it belongs to
935 in case that is the one we are about to use. */
937 Fsetcdr (current_alist_element,
938 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
940 /* Now get the (perhaps updated) value out of the binding. */
941 result = XCDR (result);
944 if (!EQ (result, Qunbound))
945 return result;
947 xsignal1 (Qvoid_variable, variable);
950 /* Return an alist of the Lisp-level buffer-local bindings of
951 buffer BUF. That is, don't include the variables maintained
952 in special slots in the buffer object. */
954 static Lisp_Object
955 buffer_lisp_local_variables (buf)
956 struct buffer *buf;
958 Lisp_Object result = Qnil;
959 register Lisp_Object tail;
960 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
962 Lisp_Object val, elt;
964 elt = XCAR (tail);
966 /* Reference each variable in the alist in buf.
967 If inquiring about the current buffer, this gets the current values,
968 so store them into the alist so the alist is up to date.
969 If inquiring about some other buffer, this swaps out any values
970 for that buffer, making the alist up to date automatically. */
971 val = find_symbol_value (XCAR (elt));
972 /* Use the current buffer value only if buf is the current buffer. */
973 if (buf != current_buffer)
974 val = XCDR (elt);
976 /* If symbol is unbound, put just the symbol in the list. */
977 if (EQ (val, Qunbound))
978 result = Fcons (XCAR (elt), result);
979 /* Otherwise, put (symbol . value) in the list. */
980 else
981 result = Fcons (Fcons (XCAR (elt), val), result);
984 return result;
987 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
988 Sbuffer_local_variables, 0, 1, 0,
989 doc: /* Return an alist of variables that are buffer-local in BUFFER.
990 Most elements look like (SYMBOL . VALUE), describing one variable.
991 For a symbol that is locally unbound, just the symbol appears in the value.
992 Note that storing new VALUEs in these elements doesn't change the variables.
993 No argument or nil as argument means use current buffer as BUFFER. */)
994 (buffer)
995 register Lisp_Object buffer;
997 register struct buffer *buf;
998 register Lisp_Object result;
1000 if (NILP (buffer))
1001 buf = current_buffer;
1002 else
1004 CHECK_BUFFER (buffer);
1005 buf = XBUFFER (buffer);
1008 result = buffer_lisp_local_variables (buf);
1010 /* Add on all the variables stored in special slots. */
1012 int offset, idx;
1014 for (offset = PER_BUFFER_VAR_OFFSET (name);
1015 offset < sizeof (struct buffer);
1016 /* sizeof EMACS_INT == sizeof Lisp_Object */
1017 offset += (sizeof (EMACS_INT)))
1019 idx = PER_BUFFER_IDX (offset);
1020 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1021 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1022 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1023 PER_BUFFER_VALUE (buf, offset)),
1024 result);
1028 return result;
1031 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1032 0, 1, 0,
1033 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1034 No argument or nil as argument means use current buffer as BUFFER. */)
1035 (buffer)
1036 register Lisp_Object buffer;
1038 register struct buffer *buf;
1039 if (NILP (buffer))
1040 buf = current_buffer;
1041 else
1043 CHECK_BUFFER (buffer);
1044 buf = XBUFFER (buffer);
1047 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1050 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1051 1, 1, 0,
1052 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1053 A non-nil FLAG means mark the buffer modified. */)
1054 (flag)
1055 register Lisp_Object flag;
1057 register int already;
1058 register Lisp_Object fn;
1059 Lisp_Object buffer, window;
1061 #ifdef CLASH_DETECTION
1062 /* If buffer becoming modified, lock the file.
1063 If buffer becoming unmodified, unlock the file. */
1065 fn = current_buffer->file_truename;
1066 /* Test buffer-file-name so that binding it to nil is effective. */
1067 if (!NILP (fn) && ! NILP (current_buffer->filename))
1069 already = SAVE_MODIFF < MODIFF;
1070 if (!already && !NILP (flag))
1071 lock_file (fn);
1072 else if (already && NILP (flag))
1073 unlock_file (fn);
1075 #endif /* CLASH_DETECTION */
1077 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1079 /* Set update_mode_lines only if buffer is displayed in some window.
1080 Packages like jit-lock or lazy-lock preserve a buffer's modified
1081 state by recording/restoring the state around blocks of code.
1082 Setting update_mode_lines makes redisplay consider all windows
1083 (on all frames). Stealth fontification of buffers not displayed
1084 would incur additional redisplay costs if we'd set
1085 update_modes_lines unconditionally.
1087 Ideally, I think there should be another mechanism for fontifying
1088 buffers without "modifying" buffers, or redisplay should be
1089 smarter about updating the `*' in mode lines. --gerd */
1090 XSETBUFFER (buffer, current_buffer);
1091 window = Fget_buffer_window (buffer, Qt);
1092 if (WINDOWP (window))
1094 ++update_mode_lines;
1095 current_buffer->prevent_redisplay_optimizations_p = 1;
1098 return flag;
1101 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1102 Srestore_buffer_modified_p, 1, 1, 0,
1103 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1104 It is not ensured that mode lines will be updated to show the modified
1105 state of the current buffer. Use with care. */)
1106 (flag)
1107 Lisp_Object flag;
1109 #ifdef CLASH_DETECTION
1110 Lisp_Object fn;
1112 /* If buffer becoming modified, lock the file.
1113 If buffer becoming unmodified, unlock the file. */
1115 fn = current_buffer->file_truename;
1116 /* Test buffer-file-name so that binding it to nil is effective. */
1117 if (!NILP (fn) && ! NILP (current_buffer->filename))
1119 int already = SAVE_MODIFF < MODIFF;
1120 if (!already && !NILP (flag))
1121 lock_file (fn);
1122 else if (already && NILP (flag))
1123 unlock_file (fn);
1125 #endif /* CLASH_DETECTION */
1127 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1128 return flag;
1131 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1132 0, 1, 0,
1133 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1134 Each buffer has a tick counter which is incremented each time the
1135 text in that buffer is changed. It wraps around occasionally.
1136 No argument or nil as argument means use current buffer as BUFFER. */)
1137 (buffer)
1138 register Lisp_Object buffer;
1140 register struct buffer *buf;
1141 if (NILP (buffer))
1142 buf = current_buffer;
1143 else
1145 CHECK_BUFFER (buffer);
1146 buf = XBUFFER (buffer);
1149 return make_number (BUF_MODIFF (buf));
1152 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1153 Sbuffer_chars_modified_tick, 0, 1, 0,
1154 doc: /* Return BUFFER's character-change tick counter.
1155 Each buffer has a character-change tick counter, which is set to the
1156 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1157 time text in that buffer is inserted or deleted. By comparing the
1158 values returned by two individual calls of `buffer-chars-modified-tick',
1159 you can tell whether a character change occurred in that buffer in
1160 between these calls. No argument or nil as argument means use current
1161 buffer as BUFFER. */)
1162 (buffer)
1163 register Lisp_Object buffer;
1165 register struct buffer *buf;
1166 if (NILP (buffer))
1167 buf = current_buffer;
1168 else
1170 CHECK_BUFFER (buffer);
1171 buf = XBUFFER (buffer);
1174 return make_number (BUF_CHARS_MODIFF (buf));
1177 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1178 "sRename buffer (to new name): \nP",
1179 doc: /* Change current buffer's name to NEWNAME (a string).
1180 If second arg UNIQUE is nil or omitted, it is an error if a
1181 buffer named NEWNAME already exists.
1182 If UNIQUE is non-nil, come up with a new name using
1183 `generate-new-buffer-name'.
1184 Interactively, you can set UNIQUE with a prefix argument.
1185 We return the name we actually gave the buffer.
1186 This does not change the name of the visited file (if any). */)
1187 (newname, unique)
1188 register Lisp_Object newname, unique;
1190 register Lisp_Object tem, buf;
1192 CHECK_STRING (newname);
1194 if (SCHARS (newname) == 0)
1195 error ("Empty string is invalid as a buffer name");
1197 tem = Fget_buffer (newname);
1198 if (!NILP (tem))
1200 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1201 rename the buffer automatically so you can create another
1202 with the original name. It makes UNIQUE equivalent to
1203 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1204 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1205 return current_buffer->name;
1206 if (!NILP (unique))
1207 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1208 else
1209 error ("Buffer name `%s' is in use", SDATA (newname));
1212 current_buffer->name = newname;
1214 /* Catch redisplay's attention. Unless we do this, the mode lines for
1215 any windows displaying current_buffer will stay unchanged. */
1216 update_mode_lines++;
1218 XSETBUFFER (buf, current_buffer);
1219 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1220 if (NILP (current_buffer->filename)
1221 && !NILP (current_buffer->auto_save_file_name))
1222 call0 (intern ("rename-auto-save-file"));
1223 /* Refetch since that last call may have done GC. */
1224 return current_buffer->name;
1227 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1228 doc: /* Return most recently selected buffer other than BUFFER.
1229 Buffers not visible in windows are preferred to visible buffers,
1230 unless optional second argument VISIBLE-OK is non-nil.
1231 If the optional third argument FRAME is non-nil, use that frame's
1232 buffer list instead of the selected frame's buffer list.
1233 If no other buffer exists, the buffer `*scratch*' is returned.
1234 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1235 (buffer, visible_ok, frame)
1236 register Lisp_Object buffer, visible_ok, frame;
1238 Lisp_Object Fset_buffer_major_mode ();
1239 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1240 notsogood = Qnil;
1242 if (NILP (frame))
1243 frame = selected_frame;
1245 tail = Vbuffer_alist;
1246 pred = frame_buffer_predicate (frame);
1248 /* Consider buffers that have been seen in the selected frame
1249 before other buffers. */
1251 tem = frame_buffer_list (frame);
1252 add_ons = Qnil;
1253 while (CONSP (tem))
1255 if (BUFFERP (XCAR (tem)))
1256 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1257 tem = XCDR (tem);
1259 tail = nconc2 (Fnreverse (add_ons), tail);
1261 for (; CONSP (tail); tail = XCDR (tail))
1263 buf = Fcdr (XCAR (tail));
1264 if (EQ (buf, buffer))
1265 continue;
1266 if (NILP (buf))
1267 continue;
1268 if (NILP (XBUFFER (buf)->name))
1269 continue;
1270 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1271 continue;
1272 /* If the selected frame has a buffer_predicate,
1273 disregard buffers that don't fit the predicate. */
1274 if (!NILP (pred))
1276 tem = call1 (pred, buf);
1277 if (NILP (tem))
1278 continue;
1281 if (NILP (visible_ok))
1282 tem = Fget_buffer_window (buf, Qvisible);
1283 else
1284 tem = Qnil;
1285 if (NILP (tem))
1286 return buf;
1287 if (NILP (notsogood))
1288 notsogood = buf;
1290 if (!NILP (notsogood))
1291 return notsogood;
1292 buf = Fget_buffer (build_string ("*scratch*"));
1293 if (NILP (buf))
1295 buf = Fget_buffer_create (build_string ("*scratch*"));
1296 Fset_buffer_major_mode (buf);
1298 return buf;
1301 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1302 0, 1, "",
1303 doc: /* Start keeping undo information for buffer BUFFER.
1304 No argument or nil as argument means do this for the current buffer. */)
1305 (buffer)
1306 register Lisp_Object buffer;
1308 Lisp_Object real_buffer;
1310 if (NILP (buffer))
1311 XSETBUFFER (real_buffer, current_buffer);
1312 else
1314 real_buffer = Fget_buffer (buffer);
1315 if (NILP (real_buffer))
1316 nsberror (buffer);
1319 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1320 XBUFFER (real_buffer)->undo_list = Qnil;
1322 return Qnil;
1326 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1327 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1328 The buffer being killed will be current while the hook is running.\n\
1329 See `kill-buffer'."
1331 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1332 doc: /* Kill the buffer BUFFER.
1333 The argument may be a buffer or the name of a buffer.
1334 With a nil argument, kill the current buffer.
1336 Value is t if the buffer is actually killed, nil otherwise.
1338 The functions in `kill-buffer-query-functions' are called with BUFFER as
1339 the current buffer. If any of them returns nil, the buffer is not killed.
1341 The hook `kill-buffer-hook' is run before the buffer is actually killed.
1342 The buffer being killed will be current while the hook is running.
1344 Any processes that have this buffer as the `process-buffer' are killed
1345 with SIGHUP. */)
1346 (buffer)
1347 Lisp_Object buffer;
1349 Lisp_Object buf;
1350 register struct buffer *b;
1351 register Lisp_Object tem;
1352 register struct Lisp_Marker *m;
1353 struct gcpro gcpro1;
1355 if (NILP (buffer))
1356 buf = Fcurrent_buffer ();
1357 else
1358 buf = Fget_buffer (buffer);
1359 if (NILP (buf))
1360 nsberror (buffer);
1362 b = XBUFFER (buf);
1364 /* Avoid trouble for buffer already dead. */
1365 if (NILP (b->name))
1366 return Qnil;
1368 /* Query if the buffer is still modified. */
1369 if (INTERACTIVE && !NILP (b->filename)
1370 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1372 GCPRO1 (buf);
1373 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1374 b->name, make_number (0)));
1375 UNGCPRO;
1376 if (NILP (tem))
1377 return Qnil;
1380 /* Run hooks with the buffer to be killed the current buffer. */
1382 int count = SPECPDL_INDEX ();
1383 Lisp_Object arglist[1];
1385 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1386 set_buffer_internal (b);
1388 /* First run the query functions; if any query is answered no,
1389 don't kill the buffer. */
1390 arglist[0] = Qkill_buffer_query_functions;
1391 tem = Frun_hook_with_args_until_failure (1, arglist);
1392 if (NILP (tem))
1393 return unbind_to (count, Qnil);
1395 /* Then run the hooks. */
1396 Frun_hooks (1, &Qkill_buffer_hook);
1397 unbind_to (count, Qnil);
1400 /* We have no more questions to ask. Verify that it is valid
1401 to kill the buffer. This must be done after the questions
1402 since anything can happen within do_yes_or_no_p. */
1404 /* Don't kill the minibuffer now current. */
1405 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1406 return Qnil;
1408 if (NILP (b->name))
1409 return Qnil;
1411 /* When we kill a base buffer, kill all its indirect buffers.
1412 We do it at this stage so nothing terrible happens if they
1413 ask questions or their hooks get errors. */
1414 if (! b->base_buffer)
1416 struct buffer *other;
1418 GCPRO1 (buf);
1420 for (other = all_buffers; other; other = other->next)
1421 /* all_buffers contains dead buffers too;
1422 don't re-kill them. */
1423 if (other->base_buffer == b && !NILP (other->name))
1425 Lisp_Object buf;
1426 XSETBUFFER (buf, other);
1427 Fkill_buffer (buf);
1430 UNGCPRO;
1433 /* Make this buffer not be current.
1434 In the process, notice if this is the sole visible buffer
1435 and give up if so. */
1436 if (b == current_buffer)
1438 tem = Fother_buffer (buf, Qnil, Qnil);
1439 Fset_buffer (tem);
1440 if (b == current_buffer)
1441 return Qnil;
1444 /* Notice if the buffer to kill is the sole visible buffer
1445 when we're currently in the mini-buffer, and give up if so. */
1446 XSETBUFFER (tem, current_buffer);
1447 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1449 tem = Fother_buffer (buf, Qnil, Qnil);
1450 if (EQ (buf, tem))
1451 return Qnil;
1454 /* Now there is no question: we can kill the buffer. */
1456 #ifdef CLASH_DETECTION
1457 /* Unlock this buffer's file, if it is locked. */
1458 unlock_buffer (b);
1459 #endif /* CLASH_DETECTION */
1461 GCPRO1 (buf);
1462 kill_buffer_processes (buf);
1463 UNGCPRO;
1465 /* Killing buffer processes may run sentinels which may
1466 have called kill-buffer. */
1468 if (NILP (b->name))
1469 return Qnil;
1471 clear_charpos_cache (b);
1473 tem = Vinhibit_quit;
1474 Vinhibit_quit = Qt;
1475 replace_buffer_in_all_windows (buf);
1476 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1477 frames_discard_buffer (buf);
1478 Vinhibit_quit = tem;
1480 /* Delete any auto-save file, if we saved it in this session.
1481 But not if the buffer is modified. */
1482 if (STRINGP (b->auto_save_file_name)
1483 && b->auto_save_modified != 0
1484 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1485 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1486 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1488 Lisp_Object tem;
1489 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1490 if (! NILP (tem))
1491 internal_delete_file (b->auto_save_file_name);
1494 if (b->base_buffer)
1496 /* Unchain all markers that belong to this indirect buffer.
1497 Don't unchain the markers that belong to the base buffer
1498 or its other indirect buffers. */
1499 for (m = BUF_MARKERS (b); m; )
1501 struct Lisp_Marker *next = m->next;
1502 if (m->buffer == b)
1503 unchain_marker (m);
1504 m = next;
1507 else
1509 /* Unchain all markers of this buffer and its indirect buffers.
1510 and leave them pointing nowhere. */
1511 for (m = BUF_MARKERS (b); m; )
1513 struct Lisp_Marker *next = m->next;
1514 m->buffer = 0;
1515 m->next = NULL;
1516 m = next;
1518 BUF_MARKERS (b) = NULL;
1519 BUF_INTERVALS (b) = NULL_INTERVAL;
1521 /* Perhaps we should explicitly free the interval tree here... */
1524 /* Reset the local variables, so that this buffer's local values
1525 won't be protected from GC. They would be protected
1526 if they happened to remain encached in their symbols.
1527 This gets rid of them for certain. */
1528 swap_out_buffer_local_variables (b);
1529 reset_buffer_local_variables (b, 1);
1531 b->name = Qnil;
1533 BLOCK_INPUT;
1534 if (! b->base_buffer)
1535 free_buffer_text (b);
1537 if (b->newline_cache)
1539 free_region_cache (b->newline_cache);
1540 b->newline_cache = 0;
1542 if (b->width_run_cache)
1544 free_region_cache (b->width_run_cache);
1545 b->width_run_cache = 0;
1547 b->width_table = Qnil;
1548 UNBLOCK_INPUT;
1549 b->undo_list = Qnil;
1551 return Qt;
1554 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1555 we do this each time BUF is selected visibly, the more recently
1556 selected buffers are always closer to the front of the list. This
1557 means that other_buffer is more likely to choose a relevant buffer. */
1559 void
1560 record_buffer (buf)
1561 Lisp_Object buf;
1563 register Lisp_Object link, prev;
1564 Lisp_Object frame;
1565 frame = selected_frame;
1567 prev = Qnil;
1568 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1570 if (EQ (XCDR (XCAR (link)), buf))
1571 break;
1572 prev = link;
1575 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1576 we cannot use Fdelq itself here because it allows quitting. */
1578 if (NILP (prev))
1579 Vbuffer_alist = XCDR (Vbuffer_alist);
1580 else
1581 XSETCDR (prev, XCDR (XCDR (prev)));
1583 XSETCDR (link, Vbuffer_alist);
1584 Vbuffer_alist = link;
1586 /* Now move this buffer to the front of frame_buffer_list also. */
1588 prev = Qnil;
1589 for (link = frame_buffer_list (frame); CONSP (link);
1590 link = XCDR (link))
1592 if (EQ (XCAR (link), buf))
1593 break;
1594 prev = link;
1597 /* Effectively do delq. */
1599 if (CONSP (link))
1601 if (NILP (prev))
1602 set_frame_buffer_list (frame,
1603 XCDR (frame_buffer_list (frame)));
1604 else
1605 XSETCDR (prev, XCDR (XCDR (prev)));
1607 XSETCDR (link, frame_buffer_list (frame));
1608 set_frame_buffer_list (frame, link);
1610 else
1611 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1614 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1615 doc: /* Set an appropriate major mode for BUFFER.
1616 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1617 according to `default-major-mode'.
1618 Use this function before selecting the buffer, since it may need to inspect
1619 the current buffer's major mode. */)
1620 (buffer)
1621 Lisp_Object buffer;
1623 int count;
1624 Lisp_Object function;
1626 CHECK_BUFFER (buffer);
1628 if (STRINGP (XBUFFER (buffer)->name)
1629 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1630 function = find_symbol_value (intern ("initial-major-mode"));
1631 else
1633 function = buffer_defaults.major_mode;
1634 if (NILP (function)
1635 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1636 function = current_buffer->major_mode;
1639 if (NILP (function) || EQ (function, Qfundamental_mode))
1640 return Qnil;
1642 count = SPECPDL_INDEX ();
1644 /* To select a nonfundamental mode,
1645 select the buffer temporarily and then call the mode function. */
1647 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1649 Fset_buffer (buffer);
1650 call0 (function);
1652 return unbind_to (count, Qnil);
1655 /* If switching buffers in WINDOW would be an error, return
1656 a C string saying what the error would be. */
1658 char *
1659 no_switch_window (window)
1660 Lisp_Object window;
1662 Lisp_Object tem;
1663 if (EQ (minibuf_window, window))
1664 return "Cannot switch buffers in minibuffer window";
1665 tem = Fwindow_dedicated_p (window);
1666 if (EQ (tem, Qt))
1667 return "Cannot switch buffers in a dedicated window";
1668 return NULL;
1671 /* Switch to buffer BUFFER in the selected window.
1672 If NORECORD is non-nil, don't call record_buffer. */
1674 Lisp_Object
1675 switch_to_buffer_1 (buffer, norecord)
1676 Lisp_Object buffer, norecord;
1678 register Lisp_Object buf;
1680 if (NILP (buffer))
1681 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1682 else
1684 buf = Fget_buffer (buffer);
1685 if (NILP (buf))
1687 buf = Fget_buffer_create (buffer);
1688 Fset_buffer_major_mode (buf);
1691 Fset_buffer (buf);
1692 if (NILP (norecord))
1693 record_buffer (buf);
1695 Fset_window_buffer (EQ (selected_window, minibuf_window)
1696 ? Fnext_window (minibuf_window, Qnil, Qnil)
1697 : selected_window,
1698 buf, Qnil);
1700 return buf;
1703 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1704 doc: /* Select buffer BUFFER in the current window.
1705 If BUFFER does not identify an existing buffer,
1706 then this function creates a buffer with that name.
1708 When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1709 or nil. If BUFFER is nil, then this function chooses a buffer
1710 using `other-buffer'.
1711 Optional second arg NORECORD non-nil means
1712 do not put this buffer at the front of the list of recently selected ones.
1713 This function returns the buffer it switched to.
1715 WARNING: This is NOT the way to work on another buffer temporarily
1716 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1717 the window-buffer correspondences. */)
1718 (buffer, norecord)
1719 Lisp_Object buffer, norecord;
1721 char *err;
1723 if (EQ (buffer, Fwindow_buffer (selected_window)))
1725 /* Basically a NOP. Avoid signalling an error in the case where
1726 the selected window is dedicated, or a minibuffer. */
1728 /* But do put this buffer at the front of the buffer list,
1729 unless that has been inhibited. Note that even if
1730 BUFFER is at the front of the main buffer-list already,
1731 we still want to move it to the front of the frame's buffer list. */
1732 if (NILP (norecord))
1733 record_buffer (buffer);
1734 return Fset_buffer (buffer);
1737 err = no_switch_window (selected_window);
1738 if (err) error (err);
1740 return switch_to_buffer_1 (buffer, norecord);
1743 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1744 doc: /* Select buffer BUFFER in some window, preferably a different one.
1745 BUFFER may be a buffer, a string \(a buffer name), or nil.
1746 If BUFFER is a string which is not the name of an existing buffer,
1747 then this function creates a buffer with that name.
1748 If BUFFER is nil, then it chooses some other buffer.
1749 If `pop-up-windows' is non-nil, windows can be split to do this.
1750 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1751 window even if BUFFER is already visible in the selected window,
1752 and ignore `same-window-regexps' and `same-window-buffer-names'.
1753 This function returns the buffer it switched to.
1754 This uses the function `display-buffer' as a subroutine; see the documentation
1755 of `display-buffer' for additional customization information.
1757 Optional third arg NORECORD non-nil means
1758 do not put this buffer at the front of the list of recently selected ones. */)
1759 (buffer, other_window, norecord)
1760 Lisp_Object buffer, other_window, norecord;
1762 register Lisp_Object buf;
1763 if (NILP (buffer))
1764 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1765 else
1767 buf = Fget_buffer (buffer);
1768 if (NILP (buf))
1770 buf = Fget_buffer_create (buffer);
1771 Fset_buffer_major_mode (buf);
1774 Fset_buffer (buf);
1775 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1776 return buf;
1779 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1780 doc: /* Return the current buffer as a Lisp object. */)
1783 register Lisp_Object buf;
1784 XSETBUFFER (buf, current_buffer);
1785 return buf;
1788 /* Set the current buffer to B.
1790 We previously set windows_or_buffers_changed here to invalidate
1791 global unchanged information in beg_unchanged and end_unchanged.
1792 This is no longer necessary because we now compute unchanged
1793 information on a buffer-basis. Every action affecting other
1794 windows than the selected one requires a select_window at some
1795 time, and that increments windows_or_buffers_changed. */
1797 void
1798 set_buffer_internal (b)
1799 register struct buffer *b;
1801 if (current_buffer != b)
1802 set_buffer_internal_1 (b);
1805 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1806 This is used by redisplay. */
1808 void
1809 set_buffer_internal_1 (b)
1810 register struct buffer *b;
1812 register struct buffer *old_buf;
1813 register Lisp_Object tail, valcontents;
1814 Lisp_Object tem;
1816 #ifdef USE_MMAP_FOR_BUFFERS
1817 if (b->text->beg == NULL)
1818 enlarge_buffer_text (b, 0);
1819 #endif /* USE_MMAP_FOR_BUFFERS */
1821 if (current_buffer == b)
1822 return;
1824 old_buf = current_buffer;
1825 current_buffer = b;
1826 last_known_column_point = -1; /* invalidate indentation cache */
1828 if (old_buf)
1830 /* Put the undo list back in the base buffer, so that it appears
1831 that an indirect buffer shares the undo list of its base. */
1832 if (old_buf->base_buffer)
1833 old_buf->base_buffer->undo_list = old_buf->undo_list;
1835 /* If the old current buffer has markers to record PT, BEGV and ZV
1836 when it is not current, update them now. */
1837 if (! NILP (old_buf->pt_marker))
1839 Lisp_Object obuf;
1840 XSETBUFFER (obuf, old_buf);
1841 set_marker_both (old_buf->pt_marker, obuf,
1842 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1844 if (! NILP (old_buf->begv_marker))
1846 Lisp_Object obuf;
1847 XSETBUFFER (obuf, old_buf);
1848 set_marker_both (old_buf->begv_marker, obuf,
1849 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1851 if (! NILP (old_buf->zv_marker))
1853 Lisp_Object obuf;
1854 XSETBUFFER (obuf, old_buf);
1855 set_marker_both (old_buf->zv_marker, obuf,
1856 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1860 /* Get the undo list from the base buffer, so that it appears
1861 that an indirect buffer shares the undo list of its base. */
1862 if (b->base_buffer)
1863 b->undo_list = b->base_buffer->undo_list;
1865 /* If the new current buffer has markers to record PT, BEGV and ZV
1866 when it is not current, fetch them now. */
1867 if (! NILP (b->pt_marker))
1869 BUF_PT (b) = marker_position (b->pt_marker);
1870 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1872 if (! NILP (b->begv_marker))
1874 BUF_BEGV (b) = marker_position (b->begv_marker);
1875 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1877 if (! NILP (b->zv_marker))
1879 BUF_ZV (b) = marker_position (b->zv_marker);
1880 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1883 /* Look down buffer's list of local Lisp variables
1884 to find and update any that forward into C variables. */
1886 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1888 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1889 if ((BUFFER_LOCAL_VALUEP (valcontents)
1890 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1891 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1892 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1893 /* Just reference the variable
1894 to cause it to become set for this buffer. */
1895 Fsymbol_value (XCAR (XCAR (tail)));
1898 /* Do the same with any others that were local to the previous buffer */
1900 if (old_buf)
1901 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1903 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1904 if ((BUFFER_LOCAL_VALUEP (valcontents)
1905 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1906 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1907 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1908 /* Just reference the variable
1909 to cause it to become set for this buffer. */
1910 Fsymbol_value (XCAR (XCAR (tail)));
1914 /* Switch to buffer B temporarily for redisplay purposes.
1915 This avoids certain things that don't need to be done within redisplay. */
1917 void
1918 set_buffer_temp (b)
1919 struct buffer *b;
1921 register struct buffer *old_buf;
1923 if (current_buffer == b)
1924 return;
1926 old_buf = current_buffer;
1927 current_buffer = b;
1929 if (old_buf)
1931 /* If the old current buffer has markers to record PT, BEGV and ZV
1932 when it is not current, update them now. */
1933 if (! NILP (old_buf->pt_marker))
1935 Lisp_Object obuf;
1936 XSETBUFFER (obuf, old_buf);
1937 set_marker_both (old_buf->pt_marker, obuf,
1938 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1940 if (! NILP (old_buf->begv_marker))
1942 Lisp_Object obuf;
1943 XSETBUFFER (obuf, old_buf);
1944 set_marker_both (old_buf->begv_marker, obuf,
1945 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1947 if (! NILP (old_buf->zv_marker))
1949 Lisp_Object obuf;
1950 XSETBUFFER (obuf, old_buf);
1951 set_marker_both (old_buf->zv_marker, obuf,
1952 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1956 /* If the new current buffer has markers to record PT, BEGV and ZV
1957 when it is not current, fetch them now. */
1958 if (! NILP (b->pt_marker))
1960 BUF_PT (b) = marker_position (b->pt_marker);
1961 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1963 if (! NILP (b->begv_marker))
1965 BUF_BEGV (b) = marker_position (b->begv_marker);
1966 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1968 if (! NILP (b->zv_marker))
1970 BUF_ZV (b) = marker_position (b->zv_marker);
1971 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1975 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1976 doc: /* Make the buffer BUFFER current for editing operations.
1977 BUFFER may be a buffer or the name of an existing buffer.
1978 See also `save-excursion' when you want to make a buffer current temporarily.
1979 This function does not display the buffer, so its effect ends
1980 when the current command terminates.
1981 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1982 (buffer)
1983 register Lisp_Object buffer;
1985 register Lisp_Object buf;
1986 buf = Fget_buffer (buffer);
1987 if (NILP (buf))
1988 nsberror (buffer);
1989 if (NILP (XBUFFER (buf)->name))
1990 error ("Selecting deleted buffer");
1991 set_buffer_internal (XBUFFER (buf));
1992 return buf;
1995 /* Set the current buffer to BUFFER provided it is alive. */
1997 Lisp_Object
1998 set_buffer_if_live (buffer)
1999 Lisp_Object buffer;
2001 if (! NILP (XBUFFER (buffer)->name))
2002 Fset_buffer (buffer);
2003 return Qnil;
2006 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
2007 Sbarf_if_buffer_read_only, 0, 0, 0,
2008 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2011 if (!NILP (current_buffer->read_only)
2012 && NILP (Vinhibit_read_only))
2013 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2014 return Qnil;
2017 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
2018 doc: /* Put BUFFER at the end of the list of all buffers.
2019 There it is the least likely candidate for `other-buffer' to return;
2020 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
2021 You can specify a buffer name as BUFFER, or an actual buffer object.
2022 If BUFFER is nil or omitted, bury the current buffer.
2023 Also, if BUFFER is nil or omitted, remove the current buffer from the
2024 selected window if it is displayed there. */)
2025 (buffer)
2026 register Lisp_Object buffer;
2028 /* Figure out what buffer we're going to bury. */
2029 if (NILP (buffer))
2031 Lisp_Object tem;
2032 XSETBUFFER (buffer, current_buffer);
2034 tem = Fwindow_buffer (selected_window);
2035 /* If we're burying the current buffer, unshow it. */
2036 if (EQ (buffer, tem))
2038 if (NILP (Fwindow_dedicated_p (selected_window)))
2039 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
2040 else if (NILP (XWINDOW (selected_window)->parent))
2041 Ficonify_frame (Fwindow_frame (selected_window));
2042 else
2043 Fdelete_window (selected_window);
2046 else
2048 Lisp_Object buf1;
2050 buf1 = Fget_buffer (buffer);
2051 if (NILP (buf1))
2052 nsberror (buffer);
2053 buffer = buf1;
2056 /* Move buffer to the end of the buffer list. Do nothing if the
2057 buffer is killed. */
2058 if (!NILP (XBUFFER (buffer)->name))
2060 Lisp_Object aelt, link;
2062 aelt = Frassq (buffer, Vbuffer_alist);
2063 link = Fmemq (aelt, Vbuffer_alist);
2064 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2065 XSETCDR (link, Qnil);
2066 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2068 /* Removing BUFFER from frame-specific lists
2069 has the effect of putting BUFFER at the end
2070 of the combined list in each frame. */
2071 frames_discard_buffer (buffer);
2074 return Qnil;
2077 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2078 doc: /* Delete the entire contents of the current buffer.
2079 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2080 so the buffer is truly empty after this. */)
2083 Fwiden ();
2085 del_range (BEG, Z);
2087 current_buffer->last_window_start = 1;
2088 /* Prevent warnings, or suspension of auto saving, that would happen
2089 if future size is less than past size. Use of erase-buffer
2090 implies that the future text is not really related to the past text. */
2091 XSETFASTINT (current_buffer->save_length, 0);
2092 return Qnil;
2095 void
2096 validate_region (b, e)
2097 register Lisp_Object *b, *e;
2099 CHECK_NUMBER_COERCE_MARKER (*b);
2100 CHECK_NUMBER_COERCE_MARKER (*e);
2102 if (XINT (*b) > XINT (*e))
2104 Lisp_Object tem;
2105 tem = *b; *b = *e; *e = tem;
2108 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2109 && XINT (*e) <= ZV))
2110 args_out_of_range (*b, *e);
2113 /* Advance BYTE_POS up to a character boundary
2114 and return the adjusted position. */
2116 static int
2117 advance_to_char_boundary (byte_pos)
2118 int byte_pos;
2120 int c;
2122 if (byte_pos == BEG)
2123 /* Beginning of buffer is always a character boundary. */
2124 return BEG;
2126 c = FETCH_BYTE (byte_pos);
2127 if (! CHAR_HEAD_P (c))
2129 /* We should advance BYTE_POS only when C is a constituent of a
2130 multibyte sequence. */
2131 int orig_byte_pos = byte_pos;
2135 byte_pos--;
2136 c = FETCH_BYTE (byte_pos);
2138 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2139 INC_POS (byte_pos);
2140 if (byte_pos < orig_byte_pos)
2141 byte_pos = orig_byte_pos;
2142 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2143 surely advance to the correct character boundary. If C is
2144 not, BYTE_POS was unchanged. */
2147 return byte_pos;
2150 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2151 1, 1, 0,
2152 doc: /* Set the multibyte flag of the current buffer to FLAG.
2153 If FLAG is t, this makes the buffer a multibyte buffer.
2154 If FLAG is nil, this makes the buffer a single-byte buffer.
2155 The buffer contents remain unchanged as a sequence of bytes
2156 but the contents viewed as characters do change.
2157 If the multibyte flag was really changed, undo information of the
2158 current buffer is cleared. */)
2159 (flag)
2160 Lisp_Object flag;
2162 struct Lisp_Marker *tail, *markers;
2163 struct buffer *other;
2164 int begv, zv;
2165 int narrowed = (BEG != BEGV || Z != ZV);
2166 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2167 Lisp_Object old_undo = current_buffer->undo_list;
2168 struct gcpro gcpro1;
2170 if (current_buffer->base_buffer)
2171 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2173 /* Do nothing if nothing actually changes. */
2174 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2175 return flag;
2177 GCPRO1 (old_undo);
2179 /* Don't record these buffer changes. We will put a special undo entry
2180 instead. */
2181 current_buffer->undo_list = Qt;
2183 /* If the cached position is for this buffer, clear it out. */
2184 clear_charpos_cache (current_buffer);
2186 if (NILP (flag))
2187 begv = BEGV_BYTE, zv = ZV_BYTE;
2188 else
2189 begv = BEGV, zv = ZV;
2191 if (narrowed)
2192 Fwiden ();
2194 if (NILP (flag))
2196 int pos, stop;
2197 unsigned char *p;
2199 /* Do this first, so it can use CHAR_TO_BYTE
2200 to calculate the old correspondences. */
2201 set_intervals_multibyte (0);
2203 current_buffer->enable_multibyte_characters = Qnil;
2205 Z = Z_BYTE;
2206 BEGV = BEGV_BYTE;
2207 ZV = ZV_BYTE;
2208 GPT = GPT_BYTE;
2209 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2212 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2213 tail->charpos = tail->bytepos;
2215 /* Convert multibyte form of 8-bit characters to unibyte. */
2216 pos = BEG;
2217 stop = GPT;
2218 p = BEG_ADDR;
2219 while (1)
2221 int c, bytes;
2223 if (pos == stop)
2225 if (pos == Z)
2226 break;
2227 p = GAP_END_ADDR;
2228 stop = Z;
2230 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2231 p += bytes, pos += bytes;
2232 else
2234 c = STRING_CHAR (p, stop - pos);
2235 /* Delete all bytes for this 8-bit character but the
2236 last one, and change the last one to the charcter
2237 code. */
2238 bytes--;
2239 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2240 p = GAP_END_ADDR;
2241 *p++ = c;
2242 pos++;
2243 if (begv > pos)
2244 begv -= bytes;
2245 if (zv > pos)
2246 zv -= bytes;
2247 stop = Z;
2250 if (narrowed)
2251 Fnarrow_to_region (make_number (begv), make_number (zv));
2253 else
2255 int pt = PT;
2256 int pos, stop;
2257 unsigned char *p;
2259 /* Be sure not to have a multibyte sequence striding over the GAP.
2260 Ex: We change this: "...abc\201 _GAP_ \241def..."
2261 to: "...abc _GAP_ \201\241def..." */
2263 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2264 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2266 unsigned char *p = GPT_ADDR - 1;
2268 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2269 if (BASE_LEADING_CODE_P (*p))
2271 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2273 move_gap_both (new_gpt, new_gpt);
2277 /* Make the buffer contents valid as multibyte by converting
2278 8-bit characters to multibyte form. */
2279 pos = BEG;
2280 stop = GPT;
2281 p = BEG_ADDR;
2282 while (1)
2284 int bytes;
2286 if (pos == stop)
2288 if (pos == Z)
2289 break;
2290 p = GAP_END_ADDR;
2291 stop = Z;
2294 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2295 p += bytes, pos += bytes;
2296 else
2298 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2300 bytes = CHAR_STRING (*p, tmp);
2301 *p = tmp[0];
2302 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2303 bytes--;
2304 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2305 /* Now the gap is after the just inserted data. */
2306 pos = GPT;
2307 p = GAP_END_ADDR;
2308 if (pos <= begv)
2309 begv += bytes;
2310 if (pos <= zv)
2311 zv += bytes;
2312 if (pos <= pt)
2313 pt += bytes;
2314 stop = Z;
2318 if (pt != PT)
2319 TEMP_SET_PT (pt);
2321 if (narrowed)
2322 Fnarrow_to_region (make_number (begv), make_number (zv));
2324 /* Do this first, so that chars_in_text asks the right question.
2325 set_intervals_multibyte needs it too. */
2326 current_buffer->enable_multibyte_characters = Qt;
2328 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2329 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2331 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2333 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2334 if (BEGV_BYTE > GPT_BYTE)
2335 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2336 else
2337 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2339 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2340 if (ZV_BYTE > GPT_BYTE)
2341 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2342 else
2343 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2346 int pt_byte = advance_to_char_boundary (PT_BYTE);
2347 int pt;
2349 if (pt_byte > GPT_BYTE)
2350 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2351 else
2352 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2353 TEMP_SET_PT_BOTH (pt, pt_byte);
2356 tail = markers = BUF_MARKERS (current_buffer);
2358 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2359 getting confused by the markers that have not yet been updated.
2360 It is also a signal that it should never create a marker. */
2361 BUF_MARKERS (current_buffer) = NULL;
2363 for (; tail; tail = tail->next)
2365 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2366 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2369 /* Make sure no markers were put on the chain
2370 while the chain value was incorrect. */
2371 if (BUF_MARKERS (current_buffer))
2372 abort ();
2374 BUF_MARKERS (current_buffer) = markers;
2376 /* Do this last, so it can calculate the new correspondences
2377 between chars and bytes. */
2378 set_intervals_multibyte (1);
2381 if (!EQ (old_undo, Qt))
2383 /* Represent all the above changes by a special undo entry. */
2384 extern Lisp_Object Qapply;
2385 current_buffer->undo_list = Fcons (list3 (Qapply,
2386 intern ("set-buffer-multibyte"),
2387 NILP (flag) ? Qt : Qnil),
2388 old_undo);
2391 UNGCPRO;
2393 /* Changing the multibyteness of a buffer means that all windows
2394 showing that buffer must be updated thoroughly. */
2395 current_buffer->prevent_redisplay_optimizations_p = 1;
2396 ++windows_or_buffers_changed;
2398 /* Copy this buffer's new multibyte status
2399 into all of its indirect buffers. */
2400 for (other = all_buffers; other; other = other->next)
2401 if (other->base_buffer == current_buffer && !NILP (other->name))
2403 other->enable_multibyte_characters
2404 = current_buffer->enable_multibyte_characters;
2405 other->prevent_redisplay_optimizations_p = 1;
2408 /* Restore the modifiedness of the buffer. */
2409 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2410 Fset_buffer_modified_p (Qnil);
2412 #ifdef subprocesses
2413 /* Update coding systems of this buffer's process (if any). */
2415 Lisp_Object process;
2417 process = Fget_buffer_process (Fcurrent_buffer ());
2418 if (PROCESSP (process))
2419 setup_process_coding_systems (process);
2421 #endif /* subprocesses */
2423 return flag;
2426 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2427 0, 0, 0,
2428 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2429 Most local variable bindings are eliminated so that the default values
2430 become effective once more. Also, the syntax table is set from
2431 `standard-syntax-table', the local keymap is set to nil,
2432 and the abbrev table from `fundamental-mode-abbrev-table'.
2433 This function also forces redisplay of the mode line.
2435 Every function to select a new major mode starts by
2436 calling this function.
2438 As a special exception, local variables whose names have
2439 a non-nil `permanent-local' property are not eliminated by this function.
2441 The first thing this function does is run
2442 the normal hook `change-major-mode-hook'. */)
2445 register Lisp_Object alist, sym, tem;
2446 Lisp_Object oalist;
2448 if (!NILP (Vrun_hooks))
2449 call1 (Vrun_hooks, Qchange_major_mode_hook);
2450 oalist = current_buffer->local_var_alist;
2452 /* Make sure none of the bindings in oalist
2453 remain swapped in, in their symbols. */
2455 swap_out_buffer_local_variables (current_buffer);
2457 /* Actually eliminate all local bindings of this buffer. */
2459 reset_buffer_local_variables (current_buffer, 0);
2461 /* Any which are supposed to be permanent,
2462 make local again, with the same values they had. */
2464 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2466 sym = XCAR (XCAR (alist));
2467 tem = Fget (sym, Qpermanent_local);
2468 if (! NILP (tem))
2470 Fmake_local_variable (sym);
2471 Fset (sym, XCDR (XCAR (alist)));
2475 /* Force mode-line redisplay. Useful here because all major mode
2476 commands call this function. */
2477 update_mode_lines++;
2479 return Qnil;
2482 /* Make sure no local variables remain set up with buffer B
2483 for their current values. */
2485 static void
2486 swap_out_buffer_local_variables (b)
2487 struct buffer *b;
2489 Lisp_Object oalist, alist, sym, tem, buffer;
2491 XSETBUFFER (buffer, b);
2492 oalist = b->local_var_alist;
2494 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2496 sym = XCAR (XCAR (alist));
2498 /* Need not do anything if some other buffer's binding is now encached. */
2499 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2500 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2502 /* Symbol is set up for this buffer's old local value.
2503 Set it up for the current buffer with the default value. */
2505 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2506 /* Store the symbol's current value into the alist entry
2507 it is currently set up for. This is so that, if the
2508 local is marked permanent, and we make it local again
2509 later in Fkill_all_local_variables, we don't lose the value. */
2510 XSETCDR (XCAR (tem),
2511 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2512 /* Switch to the symbol's default-value alist entry. */
2513 XSETCAR (tem, tem);
2514 /* Mark it as current for buffer B. */
2515 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2516 /* Store the current value into any forwarding in the symbol. */
2517 store_symval_forwarding (sym,
2518 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2519 XCDR (tem), NULL);
2524 /* Find all the overlays in the current buffer that contain position POS.
2525 Return the number found, and store them in a vector in *VEC_PTR.
2526 Store in *LEN_PTR the size allocated for the vector.
2527 Store in *NEXT_PTR the next position after POS where an overlay starts,
2528 or ZV if there are no more overlays between POS and ZV.
2529 Store in *PREV_PTR the previous position before POS where an overlay ends,
2530 or where an overlay starts which ends at or after POS;
2531 or BEGV if there are no such overlays from BEGV to POS.
2532 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2534 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2535 when this function is called.
2537 If EXTEND is non-zero, we make the vector bigger if necessary.
2538 If EXTEND is zero, we never extend the vector,
2539 and we store only as many overlays as will fit.
2540 But we still return the total number of overlays.
2542 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2543 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2544 default (BEGV or ZV). */
2547 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2548 EMACS_INT pos;
2549 int extend;
2550 Lisp_Object **vec_ptr;
2551 int *len_ptr;
2552 int *next_ptr;
2553 int *prev_ptr;
2554 int change_req;
2556 Lisp_Object overlay, start, end;
2557 struct Lisp_Overlay *tail;
2558 int idx = 0;
2559 int len = *len_ptr;
2560 Lisp_Object *vec = *vec_ptr;
2561 int next = ZV;
2562 int prev = BEGV;
2563 int inhibit_storing = 0;
2565 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2567 int startpos, endpos;
2569 XSETMISC (overlay, tail);
2571 start = OVERLAY_START (overlay);
2572 end = OVERLAY_END (overlay);
2573 endpos = OVERLAY_POSITION (end);
2574 if (endpos < pos)
2576 if (prev < endpos)
2577 prev = endpos;
2578 break;
2580 startpos = OVERLAY_POSITION (start);
2581 /* This one ends at or after POS
2582 so its start counts for PREV_PTR if it's before POS. */
2583 if (prev < startpos && startpos < pos)
2584 prev = startpos;
2585 if (endpos == pos)
2586 continue;
2587 if (startpos <= pos)
2589 if (idx == len)
2591 /* The supplied vector is full.
2592 Either make it bigger, or don't store any more in it. */
2593 if (extend)
2595 /* Make it work with an initial len == 0. */
2596 len *= 2;
2597 if (len == 0)
2598 len = 4;
2599 *len_ptr = len;
2600 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2601 *vec_ptr = vec;
2603 else
2604 inhibit_storing = 1;
2607 if (!inhibit_storing)
2608 vec[idx] = overlay;
2609 /* Keep counting overlays even if we can't return them all. */
2610 idx++;
2612 else if (startpos < next)
2613 next = startpos;
2616 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2618 int startpos, endpos;
2620 XSETMISC (overlay, tail);
2622 start = OVERLAY_START (overlay);
2623 end = OVERLAY_END (overlay);
2624 startpos = OVERLAY_POSITION (start);
2625 if (pos < startpos)
2627 if (startpos < next)
2628 next = startpos;
2629 break;
2631 endpos = OVERLAY_POSITION (end);
2632 if (pos < endpos)
2634 if (idx == len)
2636 if (extend)
2638 /* Make it work with an initial len == 0. */
2639 len *= 2;
2640 if (len == 0)
2641 len = 4;
2642 *len_ptr = len;
2643 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2644 *vec_ptr = vec;
2646 else
2647 inhibit_storing = 1;
2650 if (!inhibit_storing)
2651 vec[idx] = overlay;
2652 idx++;
2654 if (startpos < pos && startpos > prev)
2655 prev = startpos;
2657 else if (endpos < pos && endpos > prev)
2658 prev = endpos;
2659 else if (endpos == pos && startpos > prev
2660 && (!change_req || startpos < pos))
2661 prev = startpos;
2664 if (next_ptr)
2665 *next_ptr = next;
2666 if (prev_ptr)
2667 *prev_ptr = prev;
2668 return idx;
2671 /* Find all the overlays in the current buffer that overlap the range BEG-END
2672 or are empty at BEG.
2674 Return the number found, and store them in a vector in *VEC_PTR.
2675 Store in *LEN_PTR the size allocated for the vector.
2676 Store in *NEXT_PTR the next position after POS where an overlay starts,
2677 or ZV if there are no more overlays.
2678 Store in *PREV_PTR the previous position before POS where an overlay ends,
2679 or BEGV if there are no previous overlays.
2680 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2682 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2683 when this function is called.
2685 If EXTEND is non-zero, we make the vector bigger if necessary.
2686 If EXTEND is zero, we never extend the vector,
2687 and we store only as many overlays as will fit.
2688 But we still return the total number of overlays. */
2690 static int
2691 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2692 int beg, end;
2693 int extend;
2694 Lisp_Object **vec_ptr;
2695 int *len_ptr;
2696 int *next_ptr;
2697 int *prev_ptr;
2699 Lisp_Object overlay, ostart, oend;
2700 struct Lisp_Overlay *tail;
2701 int idx = 0;
2702 int len = *len_ptr;
2703 Lisp_Object *vec = *vec_ptr;
2704 int next = ZV;
2705 int prev = BEGV;
2706 int inhibit_storing = 0;
2708 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2710 int startpos, endpos;
2712 XSETMISC (overlay, tail);
2714 ostart = OVERLAY_START (overlay);
2715 oend = OVERLAY_END (overlay);
2716 endpos = OVERLAY_POSITION (oend);
2717 if (endpos < beg)
2719 if (prev < endpos)
2720 prev = endpos;
2721 break;
2723 startpos = OVERLAY_POSITION (ostart);
2724 /* Count an interval if it either overlaps the range
2725 or is empty at the start of the range. */
2726 if ((beg < endpos && startpos < end)
2727 || (startpos == endpos && beg == endpos))
2729 if (idx == len)
2731 /* The supplied vector is full.
2732 Either make it bigger, or don't store any more in it. */
2733 if (extend)
2735 /* Make it work with an initial len == 0. */
2736 len *= 2;
2737 if (len == 0)
2738 len = 4;
2739 *len_ptr = len;
2740 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2741 *vec_ptr = vec;
2743 else
2744 inhibit_storing = 1;
2747 if (!inhibit_storing)
2748 vec[idx] = overlay;
2749 /* Keep counting overlays even if we can't return them all. */
2750 idx++;
2752 else if (startpos < next)
2753 next = startpos;
2756 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2758 int startpos, endpos;
2760 XSETMISC (overlay, tail);
2762 ostart = OVERLAY_START (overlay);
2763 oend = OVERLAY_END (overlay);
2764 startpos = OVERLAY_POSITION (ostart);
2765 if (end < startpos)
2767 if (startpos < next)
2768 next = startpos;
2769 break;
2771 endpos = OVERLAY_POSITION (oend);
2772 /* Count an interval if it either overlaps the range
2773 or is empty at the start of the range. */
2774 if ((beg < endpos && startpos < end)
2775 || (startpos == endpos && beg == endpos))
2777 if (idx == len)
2779 if (extend)
2781 /* Make it work with an initial len == 0. */
2782 len *= 2;
2783 if (len == 0)
2784 len = 4;
2785 *len_ptr = len;
2786 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2787 *vec_ptr = vec;
2789 else
2790 inhibit_storing = 1;
2793 if (!inhibit_storing)
2794 vec[idx] = overlay;
2795 idx++;
2797 else if (endpos < beg && endpos > prev)
2798 prev = endpos;
2801 if (next_ptr)
2802 *next_ptr = next;
2803 if (prev_ptr)
2804 *prev_ptr = prev;
2805 return idx;
2809 /* Return non-zero if there exists an overlay with a non-nil
2810 `mouse-face' property overlapping OVERLAY. */
2813 mouse_face_overlay_overlaps (overlay)
2814 Lisp_Object overlay;
2816 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2817 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2818 int n, i, size;
2819 Lisp_Object *v, tem;
2821 size = 10;
2822 v = (Lisp_Object *) alloca (size * sizeof *v);
2823 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2824 if (n > size)
2826 v = (Lisp_Object *) alloca (n * sizeof *v);
2827 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2830 for (i = 0; i < n; ++i)
2831 if (!EQ (v[i], overlay)
2832 && (tem = Foverlay_get (overlay, Qmouse_face),
2833 !NILP (tem)))
2834 break;
2836 return i < n;
2841 /* Fast function to just test if we're at an overlay boundary. */
2843 overlay_touches_p (pos)
2844 int pos;
2846 Lisp_Object overlay;
2847 struct Lisp_Overlay *tail;
2849 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2851 int endpos;
2853 XSETMISC (overlay ,tail);
2854 if (!GC_OVERLAYP (overlay))
2855 abort ();
2857 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2858 if (endpos < pos)
2859 break;
2860 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2861 return 1;
2864 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2866 int startpos;
2868 XSETMISC (overlay, tail);
2869 if (!GC_OVERLAYP (overlay))
2870 abort ();
2872 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2873 if (pos < startpos)
2874 break;
2875 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2876 return 1;
2878 return 0;
2881 struct sortvec
2883 Lisp_Object overlay;
2884 int beg, end;
2885 int priority;
2888 static int
2889 compare_overlays (v1, v2)
2890 const void *v1, *v2;
2892 const struct sortvec *s1 = (const struct sortvec *) v1;
2893 const struct sortvec *s2 = (const struct sortvec *) v2;
2894 if (s1->priority != s2->priority)
2895 return s1->priority - s2->priority;
2896 if (s1->beg != s2->beg)
2897 return s1->beg - s2->beg;
2898 if (s1->end != s2->end)
2899 return s2->end - s1->end;
2900 return 0;
2903 /* Sort an array of overlays by priority. The array is modified in place.
2904 The return value is the new size; this may be smaller than the original
2905 size if some of the overlays were invalid or were window-specific. */
2907 sort_overlays (overlay_vec, noverlays, w)
2908 Lisp_Object *overlay_vec;
2909 int noverlays;
2910 struct window *w;
2912 int i, j;
2913 struct sortvec *sortvec;
2914 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2916 /* Put the valid and relevant overlays into sortvec. */
2918 for (i = 0, j = 0; i < noverlays; i++)
2920 Lisp_Object tem;
2921 Lisp_Object overlay;
2923 overlay = overlay_vec[i];
2924 if (OVERLAY_VALID (overlay)
2925 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2926 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2928 /* If we're interested in a specific window, then ignore
2929 overlays that are limited to some other window. */
2930 if (w)
2932 Lisp_Object window;
2934 window = Foverlay_get (overlay, Qwindow);
2935 if (WINDOWP (window) && XWINDOW (window) != w)
2936 continue;
2939 /* This overlay is good and counts: put it into sortvec. */
2940 sortvec[j].overlay = overlay;
2941 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2942 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2943 tem = Foverlay_get (overlay, Qpriority);
2944 if (INTEGERP (tem))
2945 sortvec[j].priority = XINT (tem);
2946 else
2947 sortvec[j].priority = 0;
2948 j++;
2951 noverlays = j;
2953 /* Sort the overlays into the proper order: increasing priority. */
2955 if (noverlays > 1)
2956 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2958 for (i = 0; i < noverlays; i++)
2959 overlay_vec[i] = sortvec[i].overlay;
2960 return (noverlays);
2963 struct sortstr
2965 Lisp_Object string, string2;
2966 int size;
2967 int priority;
2970 struct sortstrlist
2972 struct sortstr *buf; /* An array that expands as needed; never freed. */
2973 int size; /* Allocated length of that array. */
2974 int used; /* How much of the array is currently in use. */
2975 int bytes; /* Total length of the strings in buf. */
2978 /* Buffers for storing information about the overlays touching a given
2979 position. These could be automatic variables in overlay_strings, but
2980 it's more efficient to hold onto the memory instead of repeatedly
2981 allocating and freeing it. */
2982 static struct sortstrlist overlay_heads, overlay_tails;
2983 static unsigned char *overlay_str_buf;
2985 /* Allocated length of overlay_str_buf. */
2986 static int overlay_str_len;
2988 /* A comparison function suitable for passing to qsort. */
2989 static int
2990 cmp_for_strings (as1, as2)
2991 char *as1, *as2;
2993 struct sortstr *s1 = (struct sortstr *)as1;
2994 struct sortstr *s2 = (struct sortstr *)as2;
2995 if (s1->size != s2->size)
2996 return s2->size - s1->size;
2997 if (s1->priority != s2->priority)
2998 return s1->priority - s2->priority;
2999 return 0;
3002 static void
3003 record_overlay_string (ssl, str, str2, pri, size)
3004 struct sortstrlist *ssl;
3005 Lisp_Object str, str2, pri;
3006 int size;
3008 int nbytes;
3010 if (ssl->used == ssl->size)
3012 if (ssl->buf)
3013 ssl->size *= 2;
3014 else
3015 ssl->size = 5;
3016 ssl->buf = ((struct sortstr *)
3017 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
3019 ssl->buf[ssl->used].string = str;
3020 ssl->buf[ssl->used].string2 = str2;
3021 ssl->buf[ssl->used].size = size;
3022 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3023 ssl->used++;
3025 if (NILP (current_buffer->enable_multibyte_characters))
3026 nbytes = SCHARS (str);
3027 else if (! STRING_MULTIBYTE (str))
3028 nbytes = count_size_as_multibyte (SDATA (str),
3029 SBYTES (str));
3030 else
3031 nbytes = SBYTES (str);
3033 ssl->bytes += nbytes;
3035 if (STRINGP (str2))
3037 if (NILP (current_buffer->enable_multibyte_characters))
3038 nbytes = SCHARS (str2);
3039 else if (! STRING_MULTIBYTE (str2))
3040 nbytes = count_size_as_multibyte (SDATA (str2),
3041 SBYTES (str2));
3042 else
3043 nbytes = SBYTES (str2);
3045 ssl->bytes += nbytes;
3049 /* Return the concatenation of the strings associated with overlays that
3050 begin or end at POS, ignoring overlays that are specific to a window
3051 other than W. The strings are concatenated in the appropriate order:
3052 shorter overlays nest inside longer ones, and higher priority inside
3053 lower. Normally all of the after-strings come first, but zero-sized
3054 overlays have their after-strings ride along with the before-strings
3055 because it would look strange to print them inside-out.
3057 Returns the string length, and stores the contents indirectly through
3058 PSTR, if that variable is non-null. The string may be overwritten by
3059 subsequent calls. */
3062 overlay_strings (pos, w, pstr)
3063 EMACS_INT pos;
3064 struct window *w;
3065 unsigned char **pstr;
3067 Lisp_Object overlay, window, str;
3068 struct Lisp_Overlay *ov;
3069 int startpos, endpos;
3070 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3072 overlay_heads.used = overlay_heads.bytes = 0;
3073 overlay_tails.used = overlay_tails.bytes = 0;
3074 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3076 XSETMISC (overlay, ov);
3077 eassert (OVERLAYP (overlay));
3079 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3080 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3081 if (endpos < pos)
3082 break;
3083 if (endpos != pos && startpos != pos)
3084 continue;
3085 window = Foverlay_get (overlay, Qwindow);
3086 if (WINDOWP (window) && XWINDOW (window) != w)
3087 continue;
3088 if (startpos == pos
3089 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3090 record_overlay_string (&overlay_heads, str,
3091 (startpos == endpos
3092 ? Foverlay_get (overlay, Qafter_string)
3093 : Qnil),
3094 Foverlay_get (overlay, Qpriority),
3095 endpos - startpos);
3096 else if (endpos == pos
3097 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3098 record_overlay_string (&overlay_tails, str, Qnil,
3099 Foverlay_get (overlay, Qpriority),
3100 endpos - startpos);
3102 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3104 XSETMISC (overlay, ov);
3105 eassert (OVERLAYP (overlay));
3107 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3108 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3109 if (startpos > pos)
3110 break;
3111 if (endpos != pos && startpos != pos)
3112 continue;
3113 window = Foverlay_get (overlay, Qwindow);
3114 if (WINDOWP (window) && XWINDOW (window) != w)
3115 continue;
3116 if (startpos == pos
3117 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3118 record_overlay_string (&overlay_heads, str,
3119 (startpos == endpos
3120 ? Foverlay_get (overlay, Qafter_string)
3121 : Qnil),
3122 Foverlay_get (overlay, Qpriority),
3123 endpos - startpos);
3124 else if (endpos == pos
3125 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3126 record_overlay_string (&overlay_tails, str, Qnil,
3127 Foverlay_get (overlay, Qpriority),
3128 endpos - startpos);
3130 if (overlay_tails.used > 1)
3131 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3132 cmp_for_strings);
3133 if (overlay_heads.used > 1)
3134 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3135 cmp_for_strings);
3136 if (overlay_heads.bytes || overlay_tails.bytes)
3138 Lisp_Object tem;
3139 int i;
3140 unsigned char *p;
3141 int total = overlay_heads.bytes + overlay_tails.bytes;
3143 if (total > overlay_str_len)
3145 overlay_str_len = total;
3146 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3147 total);
3149 p = overlay_str_buf;
3150 for (i = overlay_tails.used; --i >= 0;)
3152 int nbytes;
3153 tem = overlay_tails.buf[i].string;
3154 nbytes = copy_text (SDATA (tem), p,
3155 SBYTES (tem),
3156 STRING_MULTIBYTE (tem), multibyte);
3157 p += nbytes;
3159 for (i = 0; i < overlay_heads.used; ++i)
3161 int nbytes;
3162 tem = overlay_heads.buf[i].string;
3163 nbytes = copy_text (SDATA (tem), p,
3164 SBYTES (tem),
3165 STRING_MULTIBYTE (tem), multibyte);
3166 p += nbytes;
3167 tem = overlay_heads.buf[i].string2;
3168 if (STRINGP (tem))
3170 nbytes = copy_text (SDATA (tem), p,
3171 SBYTES (tem),
3172 STRING_MULTIBYTE (tem), multibyte);
3173 p += nbytes;
3176 if (p != overlay_str_buf + total)
3177 abort ();
3178 if (pstr)
3179 *pstr = overlay_str_buf;
3180 return total;
3182 return 0;
3185 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3187 void
3188 recenter_overlay_lists (buf, pos)
3189 struct buffer *buf;
3190 EMACS_INT pos;
3192 Lisp_Object overlay, beg, end;
3193 struct Lisp_Overlay *prev, *tail, *next;
3195 /* See if anything in overlays_before should move to overlays_after. */
3197 /* We don't strictly need prev in this loop; it should always be nil.
3198 But we use it for symmetry and in case that should cease to be true
3199 with some future change. */
3200 prev = NULL;
3201 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3203 next = tail->next;
3204 XSETMISC (overlay, tail);
3206 /* If the overlay is not valid, get rid of it. */
3207 if (!OVERLAY_VALID (overlay))
3208 #if 1
3209 abort ();
3210 #else
3212 /* Splice the cons cell TAIL out of overlays_before. */
3213 if (!NILP (prev))
3214 XCDR (prev) = next;
3215 else
3216 buf->overlays_before = next;
3217 tail = prev;
3218 continue;
3220 #endif
3222 beg = OVERLAY_START (overlay);
3223 end = OVERLAY_END (overlay);
3225 if (OVERLAY_POSITION (end) > pos)
3227 /* OVERLAY needs to be moved. */
3228 int where = OVERLAY_POSITION (beg);
3229 struct Lisp_Overlay *other, *other_prev;
3231 /* Splice the cons cell TAIL out of overlays_before. */
3232 if (prev)
3233 prev->next = next;
3234 else
3235 buf->overlays_before = next;
3237 /* Search thru overlays_after for where to put it. */
3238 other_prev = NULL;
3239 for (other = buf->overlays_after; other;
3240 other_prev = other, other = other->next)
3242 Lisp_Object otherbeg, otheroverlay;
3244 XSETMISC (otheroverlay, other);
3245 eassert (OVERLAY_VALID (otheroverlay));
3247 otherbeg = OVERLAY_START (otheroverlay);
3248 if (OVERLAY_POSITION (otherbeg) >= where)
3249 break;
3252 /* Add TAIL to overlays_after before OTHER. */
3253 tail->next = other;
3254 if (other_prev)
3255 other_prev->next = tail;
3256 else
3257 buf->overlays_after = tail;
3258 tail = prev;
3260 else
3261 /* We've reached the things that should stay in overlays_before.
3262 All the rest of overlays_before must end even earlier,
3263 so stop now. */
3264 break;
3267 /* See if anything in overlays_after should be in overlays_before. */
3268 prev = NULL;
3269 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3271 next = tail->next;
3272 XSETMISC (overlay, tail);
3274 /* If the overlay is not valid, get rid of it. */
3275 if (!OVERLAY_VALID (overlay))
3276 #if 1
3277 abort ();
3278 #else
3280 /* Splice the cons cell TAIL out of overlays_after. */
3281 if (!NILP (prev))
3282 XCDR (prev) = next;
3283 else
3284 buf->overlays_after = next;
3285 tail = prev;
3286 continue;
3288 #endif
3290 beg = OVERLAY_START (overlay);
3291 end = OVERLAY_END (overlay);
3293 /* Stop looking, when we know that nothing further
3294 can possibly end before POS. */
3295 if (OVERLAY_POSITION (beg) > pos)
3296 break;
3298 if (OVERLAY_POSITION (end) <= pos)
3300 /* OVERLAY needs to be moved. */
3301 int where = OVERLAY_POSITION (end);
3302 struct Lisp_Overlay *other, *other_prev;
3304 /* Splice the cons cell TAIL out of overlays_after. */
3305 if (prev)
3306 prev->next = next;
3307 else
3308 buf->overlays_after = next;
3310 /* Search thru overlays_before for where to put it. */
3311 other_prev = NULL;
3312 for (other = buf->overlays_before; other;
3313 other_prev = other, other = other->next)
3315 Lisp_Object otherend, otheroverlay;
3317 XSETMISC (otheroverlay, other);
3318 eassert (OVERLAY_VALID (otheroverlay));
3320 otherend = OVERLAY_END (otheroverlay);
3321 if (OVERLAY_POSITION (otherend) <= where)
3322 break;
3325 /* Add TAIL to overlays_before before OTHER. */
3326 tail->next = other;
3327 if (other_prev)
3328 other_prev->next = tail;
3329 else
3330 buf->overlays_before = tail;
3331 tail = prev;
3335 buf->overlay_center = pos;
3338 void
3339 adjust_overlays_for_insert (pos, length)
3340 EMACS_INT pos;
3341 EMACS_INT length;
3343 /* After an insertion, the lists are still sorted properly,
3344 but we may need to update the value of the overlay center. */
3345 if (current_buffer->overlay_center >= pos)
3346 current_buffer->overlay_center += length;
3349 void
3350 adjust_overlays_for_delete (pos, length)
3351 EMACS_INT pos;
3352 EMACS_INT length;
3354 if (current_buffer->overlay_center < pos)
3355 /* The deletion was to our right. No change needed; the before- and
3356 after-lists are still consistent. */
3358 else if (current_buffer->overlay_center > pos + length)
3359 /* The deletion was to our left. We need to adjust the center value
3360 to account for the change in position, but the lists are consistent
3361 given the new value. */
3362 current_buffer->overlay_center -= length;
3363 else
3364 /* We're right in the middle. There might be things on the after-list
3365 that now belong on the before-list. Recentering will move them,
3366 and also update the center point. */
3367 recenter_overlay_lists (current_buffer, pos);
3370 /* Fix up overlays that were garbled as a result of permuting markers
3371 in the range START through END. Any overlay with at least one
3372 endpoint in this range will need to be unlinked from the overlay
3373 list and reinserted in its proper place.
3374 Such an overlay might even have negative size at this point.
3375 If so, we'll make the overlay empty. */
3376 void
3377 fix_start_end_in_overlays (start, end)
3378 register int start, end;
3380 Lisp_Object overlay;
3381 struct Lisp_Overlay *before_list, *after_list;
3382 /* These are either nil, indicating that before_list or after_list
3383 should be assigned, or the cons cell the cdr of which should be
3384 assigned. */
3385 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3386 /* 'Parent', likewise, indicates a cons cell or
3387 current_buffer->overlays_before or overlays_after, depending
3388 which loop we're in. */
3389 struct Lisp_Overlay *tail, *parent;
3390 int startpos, endpos;
3392 /* This algorithm shifts links around instead of consing and GCing.
3393 The loop invariant is that before_list (resp. after_list) is a
3394 well-formed list except that its last element, the CDR of beforep
3395 (resp. afterp) if beforep (afterp) isn't nil or before_list
3396 (after_list) if it is, is still uninitialized. So it's not a bug
3397 that before_list isn't initialized, although it may look
3398 strange. */
3399 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3401 XSETMISC (overlay, tail);
3403 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3404 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3406 /* If the overlay is backwards, make it empty. */
3407 if (endpos < startpos)
3409 startpos = endpos;
3410 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3411 Qnil);
3414 if (endpos < start)
3415 break;
3417 if (endpos < end
3418 || (startpos >= start && startpos < end))
3420 /* Add it to the end of the wrong list. Later on,
3421 recenter_overlay_lists will move it to the right place. */
3422 if (endpos < current_buffer->overlay_center)
3424 if (!afterp)
3425 after_list = tail;
3426 else
3427 afterp->next = tail;
3428 afterp = tail;
3430 else
3432 if (!beforep)
3433 before_list = tail;
3434 else
3435 beforep->next = tail;
3436 beforep = tail;
3438 if (!parent)
3439 current_buffer->overlays_before = tail->next;
3440 else
3441 parent->next = tail->next;
3442 tail = tail->next;
3444 else
3445 parent = tail, tail = parent->next;
3447 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3449 XSETMISC (overlay, tail);
3451 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3452 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3454 /* If the overlay is backwards, make it empty. */
3455 if (endpos < startpos)
3457 startpos = endpos;
3458 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3459 Qnil);
3462 if (startpos >= end)
3463 break;
3465 if (startpos >= start
3466 || (endpos >= start && endpos < end))
3468 if (endpos < current_buffer->overlay_center)
3470 if (!afterp)
3471 after_list = tail;
3472 else
3473 afterp->next = tail;
3474 afterp = tail;
3476 else
3478 if (!beforep)
3479 before_list = tail;
3480 else
3481 beforep->next = tail;
3482 beforep = tail;
3484 if (!parent)
3485 current_buffer->overlays_after = tail->next;
3486 else
3487 parent->next = tail->next;
3488 tail = tail->next;
3490 else
3491 parent = tail, tail = parent->next;
3494 /* Splice the constructed (wrong) lists into the buffer's lists,
3495 and let the recenter function make it sane again. */
3496 if (beforep)
3498 beforep->next = current_buffer->overlays_before;
3499 current_buffer->overlays_before = before_list;
3501 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3503 if (afterp)
3505 afterp->next = current_buffer->overlays_after;
3506 current_buffer->overlays_after = after_list;
3508 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3511 /* We have two types of overlay: the one whose ending marker is
3512 after-insertion-marker (this is the usual case) and the one whose
3513 ending marker is before-insertion-marker. When `overlays_before'
3514 contains overlays of the latter type and the former type in this
3515 order and both overlays end at inserting position, inserting a text
3516 increases only the ending marker of the latter type, which results
3517 in incorrect ordering of `overlays_before'.
3519 This function fixes ordering of overlays in the slot
3520 `overlays_before' of the buffer *BP. Before the insertion, `point'
3521 was at PREV, and now is at POS. */
3523 void
3524 fix_overlays_before (bp, prev, pos)
3525 struct buffer *bp;
3526 EMACS_INT prev, pos;
3528 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3529 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3530 Lisp_Object tem;
3531 EMACS_INT end;
3533 /* After the insertion, the several overlays may be in incorrect
3534 order. The possibility is that, in the list `overlays_before',
3535 an overlay which ends at POS appears after an overlay which ends
3536 at PREV. Since POS is greater than PREV, we must fix the
3537 ordering of these overlays, by moving overlays ends at POS before
3538 the overlays ends at PREV. */
3540 /* At first, find a place where disordered overlays should be linked
3541 in. It is where an overlay which end before POS exists. (i.e. an
3542 overlay whose ending marker is after-insertion-marker if disorder
3543 exists). */
3544 while (tail
3545 && (XSETMISC (tem, tail),
3546 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3548 parent = tail;
3549 tail = tail->next;
3552 /* If we don't find such an overlay,
3553 or the found one ends before PREV,
3554 or the found one is the last one in the list,
3555 we don't have to fix anything. */
3556 if (!tail || end < prev || !tail->next)
3557 return;
3559 right_pair = parent;
3560 parent = tail;
3561 tail = tail->next;
3563 /* Now, end position of overlays in the list TAIL should be before
3564 or equal to PREV. In the loop, an overlay which ends at POS is
3565 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3566 we found an overlay which ends before PREV, the remaining
3567 overlays are in correct order. */
3568 while (tail)
3570 XSETMISC (tem, tail);
3571 end = OVERLAY_POSITION (OVERLAY_END (tem));
3573 if (end == pos)
3574 { /* This overlay is disordered. */
3575 struct Lisp_Overlay *found = tail;
3577 /* Unlink the found overlay. */
3578 tail = found->next;
3579 parent->next = tail;
3580 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3581 and link it into the right place. */
3582 if (!right_pair)
3584 found->next = bp->overlays_before;
3585 bp->overlays_before = found;
3587 else
3589 found->next = right_pair->next;
3590 right_pair->next = found;
3593 else if (end == prev)
3595 parent = tail;
3596 tail = tail->next;
3598 else /* No more disordered overlay. */
3599 break;
3603 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3604 doc: /* Return t if OBJECT is an overlay. */)
3605 (object)
3606 Lisp_Object object;
3608 return (OVERLAYP (object) ? Qt : Qnil);
3611 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3612 doc: /* Create a new overlay with range BEG to END in BUFFER.
3613 If omitted, BUFFER defaults to the current buffer.
3614 BEG and END may be integers or markers.
3615 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3616 for the front of the overlay advance when text is inserted there
3617 \(which means the text *is not* included in the overlay).
3618 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3619 for the rear of the overlay advance when text is inserted there
3620 \(which means the text *is* included in the overlay). */)
3621 (beg, end, buffer, front_advance, rear_advance)
3622 Lisp_Object beg, end, buffer;
3623 Lisp_Object front_advance, rear_advance;
3625 Lisp_Object overlay;
3626 struct buffer *b;
3628 if (NILP (buffer))
3629 XSETBUFFER (buffer, current_buffer);
3630 else
3631 CHECK_BUFFER (buffer);
3632 if (MARKERP (beg)
3633 && ! EQ (Fmarker_buffer (beg), buffer))
3634 error ("Marker points into wrong buffer");
3635 if (MARKERP (end)
3636 && ! EQ (Fmarker_buffer (end), buffer))
3637 error ("Marker points into wrong buffer");
3639 CHECK_NUMBER_COERCE_MARKER (beg);
3640 CHECK_NUMBER_COERCE_MARKER (end);
3642 if (XINT (beg) > XINT (end))
3644 Lisp_Object temp;
3645 temp = beg; beg = end; end = temp;
3648 b = XBUFFER (buffer);
3650 beg = Fset_marker (Fmake_marker (), beg, buffer);
3651 end = Fset_marker (Fmake_marker (), end, buffer);
3653 if (!NILP (front_advance))
3654 XMARKER (beg)->insertion_type = 1;
3655 if (!NILP (rear_advance))
3656 XMARKER (end)->insertion_type = 1;
3658 overlay = allocate_misc ();
3659 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3660 XOVERLAY (overlay)->start = beg;
3661 XOVERLAY (overlay)->end = end;
3662 XOVERLAY (overlay)->plist = Qnil;
3663 XOVERLAY (overlay)->next = NULL;
3665 /* Put the new overlay on the wrong list. */
3666 end = OVERLAY_END (overlay);
3667 if (OVERLAY_POSITION (end) < b->overlay_center)
3669 if (b->overlays_after)
3670 XOVERLAY (overlay)->next = b->overlays_after;
3671 b->overlays_after = XOVERLAY (overlay);
3673 else
3675 if (b->overlays_before)
3676 XOVERLAY (overlay)->next = b->overlays_before;
3677 b->overlays_before = XOVERLAY (overlay);
3680 /* This puts it in the right list, and in the right order. */
3681 recenter_overlay_lists (b, b->overlay_center);
3683 /* We don't need to redisplay the region covered by the overlay, because
3684 the overlay has no properties at the moment. */
3686 return overlay;
3689 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3691 static void
3692 modify_overlay (buf, start, end)
3693 struct buffer *buf;
3694 EMACS_INT start, end;
3696 if (start > end)
3698 int temp = start;
3699 start = end;
3700 end = temp;
3703 BUF_COMPUTE_UNCHANGED (buf, start, end);
3705 /* If this is a buffer not in the selected window,
3706 we must do other windows. */
3707 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3708 windows_or_buffers_changed = 1;
3709 /* If multiple windows show this buffer, we must do other windows. */
3710 else if (buffer_shared > 1)
3711 windows_or_buffers_changed = 1;
3712 /* If we modify an overlay at the end of the buffer, we cannot
3713 be sure that window end is still valid. */
3714 else if (end >= ZV && start <= ZV)
3715 windows_or_buffers_changed = 1;
3717 ++BUF_OVERLAY_MODIFF (buf);
3721 Lisp_Object Fdelete_overlay ();
3723 static struct Lisp_Overlay *
3724 unchain_overlay (list, overlay)
3725 struct Lisp_Overlay *list, *overlay;
3727 struct Lisp_Overlay *tmp, *prev;
3728 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3729 if (tmp == overlay)
3731 if (prev)
3732 prev->next = tmp->next;
3733 else
3734 list = tmp->next;
3735 overlay->next = NULL;
3736 break;
3738 return list;
3741 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3742 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3743 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3744 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3745 buffer. */)
3746 (overlay, beg, end, buffer)
3747 Lisp_Object overlay, beg, end, buffer;
3749 struct buffer *b, *ob;
3750 Lisp_Object obuffer;
3751 int count = SPECPDL_INDEX ();
3753 CHECK_OVERLAY (overlay);
3754 if (NILP (buffer))
3755 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3756 if (NILP (buffer))
3757 XSETBUFFER (buffer, current_buffer);
3758 CHECK_BUFFER (buffer);
3760 if (MARKERP (beg)
3761 && ! EQ (Fmarker_buffer (beg), buffer))
3762 error ("Marker points into wrong buffer");
3763 if (MARKERP (end)
3764 && ! EQ (Fmarker_buffer (end), buffer))
3765 error ("Marker points into wrong buffer");
3767 CHECK_NUMBER_COERCE_MARKER (beg);
3768 CHECK_NUMBER_COERCE_MARKER (end);
3770 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3771 return Fdelete_overlay (overlay);
3773 if (XINT (beg) > XINT (end))
3775 Lisp_Object temp;
3776 temp = beg; beg = end; end = temp;
3779 specbind (Qinhibit_quit, Qt);
3781 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3782 b = XBUFFER (buffer);
3783 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3785 /* If the overlay has changed buffers, do a thorough redisplay. */
3786 if (!EQ (buffer, obuffer))
3788 /* Redisplay where the overlay was. */
3789 if (!NILP (obuffer))
3791 int o_beg;
3792 int o_end;
3794 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3795 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3797 modify_overlay (ob, o_beg, o_end);
3800 /* Redisplay where the overlay is going to be. */
3801 modify_overlay (b, XINT (beg), XINT (end));
3803 else
3804 /* Redisplay the area the overlay has just left, or just enclosed. */
3806 int o_beg, o_end;
3808 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3809 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3811 if (o_beg == XINT (beg))
3812 modify_overlay (b, o_end, XINT (end));
3813 else if (o_end == XINT (end))
3814 modify_overlay (b, o_beg, XINT (beg));
3815 else
3817 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3818 if (XINT (end) > o_end) o_end = XINT (end);
3819 modify_overlay (b, o_beg, o_end);
3823 if (!NILP (obuffer))
3825 ob->overlays_before
3826 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3827 ob->overlays_after
3828 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3829 eassert (XOVERLAY (overlay)->next == NULL);
3832 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3833 Fset_marker (OVERLAY_END (overlay), end, buffer);
3835 /* Put the overlay on the wrong list. */
3836 end = OVERLAY_END (overlay);
3837 if (OVERLAY_POSITION (end) < b->overlay_center)
3839 XOVERLAY (overlay)->next = b->overlays_after;
3840 b->overlays_after = XOVERLAY (overlay);
3842 else
3844 XOVERLAY (overlay)->next = b->overlays_before;
3845 b->overlays_before = XOVERLAY (overlay);
3848 /* This puts it in the right list, and in the right order. */
3849 recenter_overlay_lists (b, b->overlay_center);
3851 return unbind_to (count, overlay);
3854 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3855 doc: /* Delete the overlay OVERLAY from its buffer. */)
3856 (overlay)
3857 Lisp_Object overlay;
3859 Lisp_Object buffer;
3860 struct buffer *b;
3861 int count = SPECPDL_INDEX ();
3863 CHECK_OVERLAY (overlay);
3865 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3866 if (NILP (buffer))
3867 return Qnil;
3869 b = XBUFFER (buffer);
3870 specbind (Qinhibit_quit, Qt);
3872 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3873 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3874 eassert (XOVERLAY (overlay)->next == NULL);
3875 modify_overlay (b,
3876 marker_position (OVERLAY_START (overlay)),
3877 marker_position (OVERLAY_END (overlay)));
3878 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3879 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3881 /* When deleting an overlay with before or after strings, turn off
3882 display optimizations for the affected buffer, on the basis that
3883 these strings may contain newlines. This is easier to do than to
3884 check for that situation during redisplay. */
3885 if (!windows_or_buffers_changed
3886 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3887 || !NILP (Foverlay_get (overlay, Qafter_string))))
3888 b->prevent_redisplay_optimizations_p = 1;
3890 return unbind_to (count, Qnil);
3893 /* Overlay dissection functions. */
3895 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3896 doc: /* Return the position at which OVERLAY starts. */)
3897 (overlay)
3898 Lisp_Object overlay;
3900 CHECK_OVERLAY (overlay);
3902 return (Fmarker_position (OVERLAY_START (overlay)));
3905 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3906 doc: /* Return the position at which OVERLAY ends. */)
3907 (overlay)
3908 Lisp_Object overlay;
3910 CHECK_OVERLAY (overlay);
3912 return (Fmarker_position (OVERLAY_END (overlay)));
3915 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3916 doc: /* Return the buffer OVERLAY belongs to.
3917 Return nil if OVERLAY has been deleted. */)
3918 (overlay)
3919 Lisp_Object overlay;
3921 CHECK_OVERLAY (overlay);
3923 return Fmarker_buffer (OVERLAY_START (overlay));
3926 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3927 doc: /* Return a list of the properties on OVERLAY.
3928 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3929 OVERLAY. */)
3930 (overlay)
3931 Lisp_Object overlay;
3933 CHECK_OVERLAY (overlay);
3935 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3939 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3940 doc: /* Return a list of the overlays that contain position POS. */)
3941 (pos)
3942 Lisp_Object pos;
3944 int noverlays;
3945 Lisp_Object *overlay_vec;
3946 int len;
3947 Lisp_Object result;
3949 CHECK_NUMBER_COERCE_MARKER (pos);
3951 len = 10;
3952 /* We can't use alloca here because overlays_at can call xrealloc. */
3953 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3955 /* Put all the overlays we want in a vector in overlay_vec.
3956 Store the length in len. */
3957 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3958 (int *) 0, (int *) 0, 0);
3960 /* Make a list of them all. */
3961 result = Flist (noverlays, overlay_vec);
3963 xfree (overlay_vec);
3964 return result;
3967 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3968 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3969 Overlap means that at least one character is contained within the overlay
3970 and also contained within the specified region.
3971 Empty overlays are included in the result if they are located at BEG
3972 or between BEG and END. */)
3973 (beg, end)
3974 Lisp_Object beg, end;
3976 int noverlays;
3977 Lisp_Object *overlay_vec;
3978 int len;
3979 Lisp_Object result;
3981 CHECK_NUMBER_COERCE_MARKER (beg);
3982 CHECK_NUMBER_COERCE_MARKER (end);
3984 len = 10;
3985 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3987 /* Put all the overlays we want in a vector in overlay_vec.
3988 Store the length in len. */
3989 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3990 (int *) 0, (int *) 0);
3992 /* Make a list of them all. */
3993 result = Flist (noverlays, overlay_vec);
3995 xfree (overlay_vec);
3996 return result;
3999 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
4000 1, 1, 0,
4001 doc: /* Return the next position after POS where an overlay starts or ends.
4002 If there are no overlay boundaries from POS to (point-max),
4003 the value is (point-max). */)
4004 (pos)
4005 Lisp_Object pos;
4007 int noverlays;
4008 int endpos;
4009 Lisp_Object *overlay_vec;
4010 int len;
4011 int i;
4013 CHECK_NUMBER_COERCE_MARKER (pos);
4015 len = 10;
4016 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4018 /* Put all the overlays we want in a vector in overlay_vec.
4019 Store the length in len.
4020 endpos gets the position where the next overlay starts. */
4021 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4022 &endpos, (int *) 0, 1);
4024 /* If any of these overlays ends before endpos,
4025 use its ending point instead. */
4026 for (i = 0; i < noverlays; i++)
4028 Lisp_Object oend;
4029 int oendpos;
4031 oend = OVERLAY_END (overlay_vec[i]);
4032 oendpos = OVERLAY_POSITION (oend);
4033 if (oendpos < endpos)
4034 endpos = oendpos;
4037 xfree (overlay_vec);
4038 return make_number (endpos);
4041 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
4042 Sprevious_overlay_change, 1, 1, 0,
4043 doc: /* Return the previous position before POS where an overlay starts or ends.
4044 If there are no overlay boundaries from (point-min) to POS,
4045 the value is (point-min). */)
4046 (pos)
4047 Lisp_Object pos;
4049 int noverlays;
4050 int prevpos;
4051 Lisp_Object *overlay_vec;
4052 int len;
4054 CHECK_NUMBER_COERCE_MARKER (pos);
4056 /* At beginning of buffer, we know the answer;
4057 avoid bug subtracting 1 below. */
4058 if (XINT (pos) == BEGV)
4059 return pos;
4061 len = 10;
4062 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4064 /* Put all the overlays we want in a vector in overlay_vec.
4065 Store the length in len.
4066 prevpos gets the position of the previous change. */
4067 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4068 (int *) 0, &prevpos, 1);
4070 xfree (overlay_vec);
4071 return make_number (prevpos);
4074 /* These functions are for debugging overlays. */
4076 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4077 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4078 The car has all the overlays before the overlay center;
4079 the cdr has all the overlays after the overlay center.
4080 Recentering overlays moves overlays between these lists.
4081 The lists you get are copies, so that changing them has no effect.
4082 However, the overlays you get are the real objects that the buffer uses. */)
4085 struct Lisp_Overlay *ol;
4086 Lisp_Object before = Qnil, after = Qnil, tmp;
4087 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4089 XSETMISC (tmp, ol);
4090 before = Fcons (tmp, before);
4092 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4094 XSETMISC (tmp, ol);
4095 after = Fcons (tmp, after);
4097 return Fcons (Fnreverse (before), Fnreverse (after));
4100 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4101 doc: /* Recenter the overlays of the current buffer around position POS.
4102 That makes overlay lookup faster for positions near POS (but perhaps slower
4103 for positions far away from POS). */)
4104 (pos)
4105 Lisp_Object pos;
4107 CHECK_NUMBER_COERCE_MARKER (pos);
4109 recenter_overlay_lists (current_buffer, XINT (pos));
4110 return Qnil;
4113 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4114 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4115 (overlay, prop)
4116 Lisp_Object overlay, prop;
4118 CHECK_OVERLAY (overlay);
4119 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4122 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4123 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4124 (overlay, prop, value)
4125 Lisp_Object overlay, prop, value;
4127 Lisp_Object tail, buffer;
4128 int changed;
4130 CHECK_OVERLAY (overlay);
4132 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4134 for (tail = XOVERLAY (overlay)->plist;
4135 CONSP (tail) && CONSP (XCDR (tail));
4136 tail = XCDR (XCDR (tail)))
4137 if (EQ (XCAR (tail), prop))
4139 changed = !EQ (XCAR (XCDR (tail)), value);
4140 XSETCAR (XCDR (tail), value);
4141 goto found;
4143 /* It wasn't in the list, so add it to the front. */
4144 changed = !NILP (value);
4145 XOVERLAY (overlay)->plist
4146 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4147 found:
4148 if (! NILP (buffer))
4150 if (changed)
4151 modify_overlay (XBUFFER (buffer),
4152 marker_position (OVERLAY_START (overlay)),
4153 marker_position (OVERLAY_END (overlay)));
4154 if (EQ (prop, Qevaporate) && ! NILP (value)
4155 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4156 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4157 Fdelete_overlay (overlay);
4160 return value;
4163 /* Subroutine of report_overlay_modification. */
4165 /* Lisp vector holding overlay hook functions to call.
4166 Vector elements come in pairs.
4167 Each even-index element is a list of hook functions.
4168 The following odd-index element is the overlay they came from.
4170 Before the buffer change, we fill in this vector
4171 as we call overlay hook functions.
4172 After the buffer change, we get the functions to call from this vector.
4173 This way we always call the same functions before and after the change. */
4174 static Lisp_Object last_overlay_modification_hooks;
4176 /* Number of elements actually used in last_overlay_modification_hooks. */
4177 static int last_overlay_modification_hooks_used;
4179 /* Add one functionlist/overlay pair
4180 to the end of last_overlay_modification_hooks. */
4182 static void
4183 add_overlay_mod_hooklist (functionlist, overlay)
4184 Lisp_Object functionlist, overlay;
4186 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4188 if (last_overlay_modification_hooks_used == oldsize)
4190 Lisp_Object old;
4191 old = last_overlay_modification_hooks;
4192 last_overlay_modification_hooks
4193 = Fmake_vector (make_number (oldsize * 2), Qnil);
4194 bcopy (XVECTOR (old)->contents,
4195 XVECTOR (last_overlay_modification_hooks)->contents,
4196 sizeof (Lisp_Object) * oldsize);
4198 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4199 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4202 /* Run the modification-hooks of overlays that include
4203 any part of the text in START to END.
4204 If this change is an insertion, also
4205 run the insert-before-hooks of overlay starting at END,
4206 and the insert-after-hooks of overlay ending at START.
4208 This is called both before and after the modification.
4209 AFTER is nonzero when we call after the modification.
4211 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4212 When AFTER is nonzero, they are the start position,
4213 the position after the inserted new text,
4214 and the length of deleted or replaced old text. */
4216 void
4217 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4218 Lisp_Object start, end;
4219 int after;
4220 Lisp_Object arg1, arg2, arg3;
4222 Lisp_Object prop, overlay;
4223 struct Lisp_Overlay *tail;
4224 /* 1 if this change is an insertion. */
4225 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4226 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4228 overlay = Qnil;
4229 tail = NULL;
4231 /* We used to run the functions as soon as we found them and only register
4232 them in last_overlay_modification_hooks for the purpose of the `after'
4233 case. But running elisp code as we traverse the list of overlays is
4234 painful because the list can be modified by the elisp code so we had to
4235 copy at several places. We now simply do a read-only traversal that
4236 only collects the functions to run and we run them afterwards. It's
4237 simpler, especially since all the code was already there. -stef */
4239 if (!after)
4241 /* We are being called before a change.
4242 Scan the overlays to find the functions to call. */
4243 last_overlay_modification_hooks_used = 0;
4244 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4246 int startpos, endpos;
4247 Lisp_Object ostart, oend;
4249 XSETMISC (overlay, tail);
4251 ostart = OVERLAY_START (overlay);
4252 oend = OVERLAY_END (overlay);
4253 endpos = OVERLAY_POSITION (oend);
4254 if (XFASTINT (start) > endpos)
4255 break;
4256 startpos = OVERLAY_POSITION (ostart);
4257 if (insertion && (XFASTINT (start) == startpos
4258 || XFASTINT (end) == startpos))
4260 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4261 if (!NILP (prop))
4262 add_overlay_mod_hooklist (prop, overlay);
4264 if (insertion && (XFASTINT (start) == endpos
4265 || XFASTINT (end) == endpos))
4267 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4268 if (!NILP (prop))
4269 add_overlay_mod_hooklist (prop, overlay);
4271 /* Test for intersecting intervals. This does the right thing
4272 for both insertion and deletion. */
4273 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4275 prop = Foverlay_get (overlay, Qmodification_hooks);
4276 if (!NILP (prop))
4277 add_overlay_mod_hooklist (prop, overlay);
4281 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4283 int startpos, endpos;
4284 Lisp_Object ostart, oend;
4286 XSETMISC (overlay, tail);
4288 ostart = OVERLAY_START (overlay);
4289 oend = OVERLAY_END (overlay);
4290 startpos = OVERLAY_POSITION (ostart);
4291 endpos = OVERLAY_POSITION (oend);
4292 if (XFASTINT (end) < startpos)
4293 break;
4294 if (insertion && (XFASTINT (start) == startpos
4295 || XFASTINT (end) == startpos))
4297 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4298 if (!NILP (prop))
4299 add_overlay_mod_hooklist (prop, overlay);
4301 if (insertion && (XFASTINT (start) == endpos
4302 || XFASTINT (end) == endpos))
4304 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4305 if (!NILP (prop))
4306 add_overlay_mod_hooklist (prop, overlay);
4308 /* Test for intersecting intervals. This does the right thing
4309 for both insertion and deletion. */
4310 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4312 prop = Foverlay_get (overlay, Qmodification_hooks);
4313 if (!NILP (prop))
4314 add_overlay_mod_hooklist (prop, overlay);
4319 GCPRO4 (overlay, arg1, arg2, arg3);
4321 /* Call the functions recorded in last_overlay_modification_hooks.
4322 First copy the vector contents, in case some of these hooks
4323 do subsequent modification of the buffer. */
4324 int size = last_overlay_modification_hooks_used;
4325 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4326 int i;
4328 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4329 copy, size * sizeof (Lisp_Object));
4330 gcpro1.var = copy;
4331 gcpro1.nvars = size;
4333 for (i = 0; i < size;)
4335 Lisp_Object prop, overlay;
4336 prop = copy[i++];
4337 overlay = copy[i++];
4338 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4341 UNGCPRO;
4344 static void
4345 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4346 Lisp_Object list, overlay;
4347 int after;
4348 Lisp_Object arg1, arg2, arg3;
4350 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4352 GCPRO4 (list, arg1, arg2, arg3);
4354 while (CONSP (list))
4356 if (NILP (arg3))
4357 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4358 else
4359 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4360 list = XCDR (list);
4362 UNGCPRO;
4365 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4366 property is set. */
4367 void
4368 evaporate_overlays (pos)
4369 EMACS_INT pos;
4371 Lisp_Object overlay, hit_list;
4372 struct Lisp_Overlay *tail;
4374 hit_list = Qnil;
4375 if (pos <= current_buffer->overlay_center)
4376 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4378 int endpos;
4379 XSETMISC (overlay, tail);
4380 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4381 if (endpos < pos)
4382 break;
4383 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4384 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4385 hit_list = Fcons (overlay, hit_list);
4387 else
4388 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4390 int startpos;
4391 XSETMISC (overlay, tail);
4392 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4393 if (startpos > pos)
4394 break;
4395 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4396 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4397 hit_list = Fcons (overlay, hit_list);
4399 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4400 Fdelete_overlay (XCAR (hit_list));
4403 /* Somebody has tried to store a value with an unacceptable type
4404 in the slot with offset OFFSET. */
4406 void
4407 buffer_slot_type_mismatch (offset)
4408 int offset;
4410 Lisp_Object sym;
4411 char *type_name;
4413 switch (XINT (PER_BUFFER_TYPE (offset)))
4415 case Lisp_Int:
4416 type_name = "integers";
4417 break;
4419 case Lisp_String:
4420 type_name = "strings";
4421 break;
4423 case Lisp_Symbol:
4424 type_name = "symbols";
4425 break;
4427 default:
4428 abort ();
4431 sym = PER_BUFFER_SYMBOL (offset);
4432 error ("Only %s should be stored in the buffer-local variable %s",
4433 type_name, SDATA (SYMBOL_NAME (sym)));
4437 /***********************************************************************
4438 Allocation with mmap
4439 ***********************************************************************/
4441 #ifdef USE_MMAP_FOR_BUFFERS
4443 #include <sys/types.h>
4444 #include <sys/mman.h>
4446 #ifndef MAP_ANON
4447 #ifdef MAP_ANONYMOUS
4448 #define MAP_ANON MAP_ANONYMOUS
4449 #else
4450 #define MAP_ANON 0
4451 #endif
4452 #endif
4454 #ifndef MAP_FAILED
4455 #define MAP_FAILED ((void *) -1)
4456 #endif
4458 #include <stdio.h>
4459 #include <errno.h>
4461 #if MAP_ANON == 0
4462 #include <fcntl.h>
4463 #endif
4465 #include "coding.h"
4468 /* Memory is allocated in regions which are mapped using mmap(2).
4469 The current implementation lets the system select mapped
4470 addresses; we're not using MAP_FIXED in general, except when
4471 trying to enlarge regions.
4473 Each mapped region starts with a mmap_region structure, the user
4474 area starts after that structure, aligned to MEM_ALIGN.
4476 +-----------------------+
4477 | struct mmap_info + |
4478 | padding |
4479 +-----------------------+
4480 | user data |
4483 +-----------------------+ */
4485 struct mmap_region
4487 /* User-specified size. */
4488 size_t nbytes_specified;
4490 /* Number of bytes mapped */
4491 size_t nbytes_mapped;
4493 /* Pointer to the location holding the address of the memory
4494 allocated with the mmap'd block. The variable actually points
4495 after this structure. */
4496 POINTER_TYPE **var;
4498 /* Next and previous in list of all mmap'd regions. */
4499 struct mmap_region *next, *prev;
4502 /* Doubly-linked list of mmap'd regions. */
4504 static struct mmap_region *mmap_regions;
4506 /* File descriptor for mmap. If we don't have anonymous mapping,
4507 /dev/zero will be opened on it. */
4509 static int mmap_fd;
4511 /* Temporary storage for mmap_set_vars, see there. */
4513 static struct mmap_region *mmap_regions_1;
4514 static int mmap_fd_1;
4516 /* Page size on this system. */
4518 static int mmap_page_size;
4520 /* 1 means mmap has been intialized. */
4522 static int mmap_initialized_p;
4524 /* Value is X rounded up to the next multiple of N. */
4526 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4528 /* Size of mmap_region structure plus padding. */
4530 #define MMAP_REGION_STRUCT_SIZE \
4531 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4533 /* Given a pointer P to the start of the user-visible part of a mapped
4534 region, return a pointer to the start of the region. */
4536 #define MMAP_REGION(P) \
4537 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4539 /* Given a pointer P to the start of a mapped region, return a pointer
4540 to the start of the user-visible part of the region. */
4542 #define MMAP_USER_AREA(P) \
4543 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4545 #define MEM_ALIGN sizeof (double)
4547 /* Predicate returning true if part of the address range [START .. END]
4548 is currently mapped. Used to prevent overwriting an existing
4549 memory mapping.
4551 Default is to conservativly assume the address range is occupied by
4552 something else. This can be overridden by system configuration
4553 files if system-specific means to determine this exists. */
4555 #ifndef MMAP_ALLOCATED_P
4556 #define MMAP_ALLOCATED_P(start, end) 1
4557 #endif
4559 /* Function prototypes. */
4561 static int mmap_free_1 P_ ((struct mmap_region *));
4562 static int mmap_enlarge P_ ((struct mmap_region *, int));
4563 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4564 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4565 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4566 static void mmap_free P_ ((POINTER_TYPE **ptr));
4567 static void mmap_init P_ ((void));
4570 /* Return a region overlapping address range START...END, or null if
4571 none. END is not including, i.e. the last byte in the range
4572 is at END - 1. */
4574 static struct mmap_region *
4575 mmap_find (start, end)
4576 POINTER_TYPE *start, *end;
4578 struct mmap_region *r;
4579 char *s = (char *) start, *e = (char *) end;
4581 for (r = mmap_regions; r; r = r->next)
4583 char *rstart = (char *) r;
4584 char *rend = rstart + r->nbytes_mapped;
4586 if (/* First byte of range, i.e. START, in this region? */
4587 (s >= rstart && s < rend)
4588 /* Last byte of range, i.e. END - 1, in this region? */
4589 || (e > rstart && e <= rend)
4590 /* First byte of this region in the range? */
4591 || (rstart >= s && rstart < e)
4592 /* Last byte of this region in the range? */
4593 || (rend > s && rend <= e))
4594 break;
4597 return r;
4601 /* Unmap a region. P is a pointer to the start of the user-araa of
4602 the region. Value is non-zero if successful. */
4604 static int
4605 mmap_free_1 (r)
4606 struct mmap_region *r;
4608 if (r->next)
4609 r->next->prev = r->prev;
4610 if (r->prev)
4611 r->prev->next = r->next;
4612 else
4613 mmap_regions = r->next;
4615 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4617 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4618 return 0;
4621 return 1;
4625 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4626 Value is non-zero if successful. */
4628 static int
4629 mmap_enlarge (r, npages)
4630 struct mmap_region *r;
4631 int npages;
4633 char *region_end = (char *) r + r->nbytes_mapped;
4634 size_t nbytes;
4635 int success = 0;
4637 if (npages < 0)
4639 /* Unmap pages at the end of the region. */
4640 nbytes = - npages * mmap_page_size;
4641 if (munmap (region_end - nbytes, nbytes) == -1)
4642 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4643 else
4645 r->nbytes_mapped -= nbytes;
4646 success = 1;
4649 else if (npages > 0)
4651 nbytes = npages * mmap_page_size;
4653 /* Try to map additional pages at the end of the region. We
4654 cannot do this if the address range is already occupied by
4655 something else because mmap deletes any previous mapping.
4656 I'm not sure this is worth doing, let's see. */
4657 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4659 POINTER_TYPE *p;
4661 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4662 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4663 if (p == MAP_FAILED)
4664 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4665 else if (p != (POINTER_TYPE *) region_end)
4667 /* Kernels are free to choose a different address. In
4668 that case, unmap what we've mapped above; we have
4669 no use for it. */
4670 if (munmap (p, nbytes) == -1)
4671 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4673 else
4675 r->nbytes_mapped += nbytes;
4676 success = 1;
4681 return success;
4685 /* Set or reset variables holding references to mapped regions. If
4686 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4687 non-zero, set all variables to the start of the user-areas
4688 of mapped regions.
4690 This function is called from Fdump_emacs to ensure that the dumped
4691 Emacs doesn't contain references to memory that won't be mapped
4692 when Emacs starts. */
4694 void
4695 mmap_set_vars (restore_p)
4696 int restore_p;
4698 struct mmap_region *r;
4700 if (restore_p)
4702 mmap_regions = mmap_regions_1;
4703 mmap_fd = mmap_fd_1;
4704 for (r = mmap_regions; r; r = r->next)
4705 *r->var = MMAP_USER_AREA (r);
4707 else
4709 for (r = mmap_regions; r; r = r->next)
4710 *r->var = NULL;
4711 mmap_regions_1 = mmap_regions;
4712 mmap_regions = NULL;
4713 mmap_fd_1 = mmap_fd;
4714 mmap_fd = -1;
4719 /* Allocate a block of storage large enough to hold NBYTES bytes of
4720 data. A pointer to the data is returned in *VAR. VAR is thus the
4721 address of some variable which will use the data area.
4723 The allocation of 0 bytes is valid.
4725 If we can't allocate the necessary memory, set *VAR to null, and
4726 return null. */
4728 static POINTER_TYPE *
4729 mmap_alloc (var, nbytes)
4730 POINTER_TYPE **var;
4731 size_t nbytes;
4733 void *p;
4734 size_t map;
4736 mmap_init ();
4738 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4739 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4740 mmap_fd, 0);
4742 if (p == MAP_FAILED)
4744 if (errno != ENOMEM)
4745 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4746 p = NULL;
4748 else
4750 struct mmap_region *r = (struct mmap_region *) p;
4752 r->nbytes_specified = nbytes;
4753 r->nbytes_mapped = map;
4754 r->var = var;
4755 r->prev = NULL;
4756 r->next = mmap_regions;
4757 if (r->next)
4758 r->next->prev = r;
4759 mmap_regions = r;
4761 p = MMAP_USER_AREA (p);
4764 return *var = p;
4768 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4769 resize it to size NBYTES. Change *VAR to reflect the new block,
4770 and return this value. If more memory cannot be allocated, then
4771 leave *VAR unchanged, and return null. */
4773 static POINTER_TYPE *
4774 mmap_realloc (var, nbytes)
4775 POINTER_TYPE **var;
4776 size_t nbytes;
4778 POINTER_TYPE *result;
4780 mmap_init ();
4782 if (*var == NULL)
4783 result = mmap_alloc (var, nbytes);
4784 else if (nbytes == 0)
4786 mmap_free (var);
4787 result = mmap_alloc (var, nbytes);
4789 else
4791 struct mmap_region *r = MMAP_REGION (*var);
4792 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4794 if (room < nbytes)
4796 /* Must enlarge. */
4797 POINTER_TYPE *old_ptr = *var;
4799 /* Try to map additional pages at the end of the region.
4800 If that fails, allocate a new region, copy data
4801 from the old region, then free it. */
4802 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4803 / mmap_page_size)))
4805 r->nbytes_specified = nbytes;
4806 *var = result = old_ptr;
4808 else if (mmap_alloc (var, nbytes))
4810 bcopy (old_ptr, *var, r->nbytes_specified);
4811 mmap_free_1 (MMAP_REGION (old_ptr));
4812 result = *var;
4813 r = MMAP_REGION (result);
4814 r->nbytes_specified = nbytes;
4816 else
4818 *var = old_ptr;
4819 result = NULL;
4822 else if (room - nbytes >= mmap_page_size)
4824 /* Shrinking by at least a page. Let's give some
4825 memory back to the system.
4827 The extra parens are to make the division happens first,
4828 on positive values, so we know it will round towards
4829 zero. */
4830 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4831 result = *var;
4832 r->nbytes_specified = nbytes;
4834 else
4836 /* Leave it alone. */
4837 result = *var;
4838 r->nbytes_specified = nbytes;
4842 return result;
4846 /* Free a block of relocatable storage whose data is pointed to by
4847 PTR. Store 0 in *PTR to show there's no block allocated. */
4849 static void
4850 mmap_free (var)
4851 POINTER_TYPE **var;
4853 mmap_init ();
4855 if (*var)
4857 mmap_free_1 (MMAP_REGION (*var));
4858 *var = NULL;
4863 /* Perform necessary intializations for the use of mmap. */
4865 static void
4866 mmap_init ()
4868 #if MAP_ANON == 0
4869 /* The value of mmap_fd is initially 0 in temacs, and -1
4870 in a dumped Emacs. */
4871 if (mmap_fd <= 0)
4873 /* No anonymous mmap -- we need the file descriptor. */
4874 mmap_fd = open ("/dev/zero", O_RDONLY);
4875 if (mmap_fd == -1)
4876 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4878 #endif /* MAP_ANON == 0 */
4880 if (mmap_initialized_p)
4881 return;
4882 mmap_initialized_p = 1;
4884 #if MAP_ANON != 0
4885 mmap_fd = -1;
4886 #endif
4888 mmap_page_size = getpagesize ();
4891 #endif /* USE_MMAP_FOR_BUFFERS */
4895 /***********************************************************************
4896 Buffer-text Allocation
4897 ***********************************************************************/
4899 #ifdef REL_ALLOC
4900 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4901 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4902 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4903 #endif /* REL_ALLOC */
4906 /* Allocate NBYTES bytes for buffer B's text buffer. */
4908 static void
4909 alloc_buffer_text (b, nbytes)
4910 struct buffer *b;
4911 size_t nbytes;
4913 POINTER_TYPE *p;
4915 BLOCK_INPUT;
4916 #if defined USE_MMAP_FOR_BUFFERS
4917 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4918 #elif defined REL_ALLOC
4919 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4920 #else
4921 p = xmalloc (nbytes);
4922 #endif
4924 if (p == NULL)
4926 UNBLOCK_INPUT;
4927 memory_full ();
4930 b->text->beg = (unsigned char *) p;
4931 UNBLOCK_INPUT;
4934 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4935 shrink it. */
4937 void
4938 enlarge_buffer_text (b, delta)
4939 struct buffer *b;
4940 int delta;
4942 POINTER_TYPE *p;
4943 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4944 + delta);
4945 BLOCK_INPUT;
4946 #if defined USE_MMAP_FOR_BUFFERS
4947 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4948 #elif defined REL_ALLOC
4949 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4950 #else
4951 p = xrealloc (b->text->beg, nbytes);
4952 #endif
4954 if (p == NULL)
4956 UNBLOCK_INPUT;
4957 memory_full ();
4960 BUF_BEG_ADDR (b) = (unsigned char *) p;
4961 UNBLOCK_INPUT;
4965 /* Free buffer B's text buffer. */
4967 static void
4968 free_buffer_text (b)
4969 struct buffer *b;
4971 BLOCK_INPUT;
4973 #if defined USE_MMAP_FOR_BUFFERS
4974 mmap_free ((POINTER_TYPE **) &b->text->beg);
4975 #elif defined REL_ALLOC
4976 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4977 #else
4978 xfree (b->text->beg);
4979 #endif
4981 BUF_BEG_ADDR (b) = NULL;
4982 UNBLOCK_INPUT;
4987 /***********************************************************************
4988 Initialization
4989 ***********************************************************************/
4991 void
4992 init_buffer_once ()
4994 int idx;
4996 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4998 /* Make sure all markable slots in buffer_defaults
4999 are initialized reasonably, so mark_buffer won't choke. */
5000 reset_buffer (&buffer_defaults);
5001 reset_buffer_local_variables (&buffer_defaults, 1);
5002 reset_buffer (&buffer_local_symbols);
5003 reset_buffer_local_variables (&buffer_local_symbols, 1);
5004 /* Prevent GC from getting confused. */
5005 buffer_defaults.text = &buffer_defaults.own_text;
5006 buffer_local_symbols.text = &buffer_local_symbols.own_text;
5007 BUF_INTERVALS (&buffer_defaults) = 0;
5008 BUF_INTERVALS (&buffer_local_symbols) = 0;
5009 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
5010 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
5012 /* Set up the default values of various buffer slots. */
5013 /* Must do these before making the first buffer! */
5015 /* real setup is done in bindings.el */
5016 buffer_defaults.mode_line_format = build_string ("%-");
5017 buffer_defaults.header_line_format = Qnil;
5018 buffer_defaults.abbrev_mode = Qnil;
5019 buffer_defaults.overwrite_mode = Qnil;
5020 buffer_defaults.case_fold_search = Qt;
5021 buffer_defaults.auto_fill_function = Qnil;
5022 buffer_defaults.selective_display = Qnil;
5023 #ifndef old
5024 buffer_defaults.selective_display_ellipses = Qt;
5025 #endif
5026 buffer_defaults.abbrev_table = Qnil;
5027 buffer_defaults.display_table = Qnil;
5028 buffer_defaults.undo_list = Qnil;
5029 buffer_defaults.mark_active = Qnil;
5030 buffer_defaults.file_format = Qnil;
5031 buffer_defaults.auto_save_file_format = Qt;
5032 buffer_defaults.overlays_before = NULL;
5033 buffer_defaults.overlays_after = NULL;
5034 buffer_defaults.overlay_center = BEG;
5036 XSETFASTINT (buffer_defaults.tab_width, 8);
5037 buffer_defaults.truncate_lines = Qnil;
5038 buffer_defaults.ctl_arrow = Qt;
5039 buffer_defaults.direction_reversed = Qnil;
5040 buffer_defaults.cursor_type = Qt;
5041 buffer_defaults.extra_line_spacing = Qnil;
5042 buffer_defaults.cursor_in_non_selected_windows = Qt;
5044 #ifdef DOS_NT
5045 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
5046 #endif
5047 buffer_defaults.enable_multibyte_characters = Qt;
5048 buffer_defaults.buffer_file_coding_system = Qnil;
5049 XSETFASTINT (buffer_defaults.fill_column, 70);
5050 XSETFASTINT (buffer_defaults.left_margin, 0);
5051 buffer_defaults.cache_long_line_scans = Qnil;
5052 buffer_defaults.file_truename = Qnil;
5053 XSETFASTINT (buffer_defaults.display_count, 0);
5054 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
5055 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
5056 buffer_defaults.left_fringe_width = Qnil;
5057 buffer_defaults.right_fringe_width = Qnil;
5058 buffer_defaults.fringes_outside_margins = Qnil;
5059 buffer_defaults.scroll_bar_width = Qnil;
5060 buffer_defaults.vertical_scroll_bar_type = Qt;
5061 buffer_defaults.indicate_empty_lines = Qnil;
5062 buffer_defaults.indicate_buffer_boundaries = Qnil;
5063 buffer_defaults.fringe_indicator_alist = Qnil;
5064 buffer_defaults.fringe_cursor_alist = Qnil;
5065 buffer_defaults.scroll_up_aggressively = Qnil;
5066 buffer_defaults.scroll_down_aggressively = Qnil;
5067 buffer_defaults.display_time = Qnil;
5069 /* Assign the local-flags to the slots that have default values.
5070 The local flag is a bit that is used in the buffer
5071 to say that it has its own local value for the slot.
5072 The local flag bits are in the local_var_flags slot of the buffer. */
5074 /* Nothing can work if this isn't true */
5075 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
5077 /* 0 means not a lisp var, -1 means always local, else mask */
5078 bzero (&buffer_local_flags, sizeof buffer_local_flags);
5079 XSETINT (buffer_local_flags.filename, -1);
5080 XSETINT (buffer_local_flags.directory, -1);
5081 XSETINT (buffer_local_flags.backed_up, -1);
5082 XSETINT (buffer_local_flags.save_length, -1);
5083 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5084 XSETINT (buffer_local_flags.read_only, -1);
5085 XSETINT (buffer_local_flags.major_mode, -1);
5086 XSETINT (buffer_local_flags.mode_name, -1);
5087 XSETINT (buffer_local_flags.undo_list, -1);
5088 XSETINT (buffer_local_flags.mark_active, -1);
5089 XSETINT (buffer_local_flags.point_before_scroll, -1);
5090 XSETINT (buffer_local_flags.file_truename, -1);
5091 XSETINT (buffer_local_flags.invisibility_spec, -1);
5092 XSETINT (buffer_local_flags.file_format, -1);
5093 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5094 XSETINT (buffer_local_flags.display_count, -1);
5095 XSETINT (buffer_local_flags.display_time, -1);
5096 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5098 idx = 1;
5099 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5100 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5101 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5102 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5103 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5104 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5105 #ifndef old
5106 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5107 #endif
5108 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5109 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5110 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5111 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5112 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5113 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5114 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5115 #ifdef DOS_NT
5116 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5117 /* Make this one a permanent local. */
5118 buffer_permanent_local_flags[idx++] = 1;
5119 #endif
5120 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5121 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5122 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5123 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5124 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5125 /* Make this one a permanent local. */
5126 buffer_permanent_local_flags[idx++] = 1;
5127 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5128 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5129 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5130 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5131 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5132 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5133 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5134 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5135 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5136 XSETFASTINT (buffer_local_flags.fringe_indicator_alist, idx); ++idx;
5137 XSETFASTINT (buffer_local_flags.fringe_cursor_alist, idx); ++idx;
5138 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5139 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5140 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5141 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5142 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5143 XSETFASTINT (buffer_local_flags.cursor_in_non_selected_windows, idx); ++idx;
5145 /* Need more room? */
5146 if (idx >= MAX_PER_BUFFER_VARS)
5147 abort ();
5148 last_per_buffer_idx = idx;
5150 Vbuffer_alist = Qnil;
5151 current_buffer = 0;
5152 all_buffers = 0;
5154 QSFundamental = build_string ("Fundamental");
5156 Qfundamental_mode = intern ("fundamental-mode");
5157 buffer_defaults.major_mode = Qfundamental_mode;
5159 Qmode_class = intern ("mode-class");
5161 Qprotected_field = intern ("protected-field");
5163 Qpermanent_local = intern ("permanent-local");
5165 Qkill_buffer_hook = intern ("kill-buffer-hook");
5166 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5168 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5170 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5172 /* super-magic invisible buffer */
5173 Vbuffer_alist = Qnil;
5175 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5177 inhibit_modification_hooks = 0;
5180 void
5181 init_buffer ()
5183 char *pwd;
5184 Lisp_Object temp;
5185 int len;
5187 #ifdef USE_MMAP_FOR_BUFFERS
5189 /* When using the ralloc implementation based on mmap(2), buffer
5190 text pointers will have been set to null in the dumped Emacs.
5191 Map new memory. */
5192 struct buffer *b;
5194 for (b = all_buffers; b; b = b->next)
5195 if (b->text->beg == NULL)
5196 enlarge_buffer_text (b, 0);
5198 #endif /* USE_MMAP_FOR_BUFFERS */
5200 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5201 if (NILP (buffer_defaults.enable_multibyte_characters))
5202 Fset_buffer_multibyte (Qnil);
5204 pwd = get_current_dir_name ();
5206 if (!pwd)
5207 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5209 #ifndef VMS
5210 /* Maybe this should really use some standard subroutine
5211 whose definition is filename syntax dependent. */
5212 len = strlen (pwd);
5213 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5215 /* Grow buffer to add directory separator and '\0'. */
5216 pwd = (char *) xrealloc (pwd, len + 2);
5217 pwd[len] = DIRECTORY_SEP;
5218 pwd[len + 1] = '\0';
5220 #endif /* not VMS */
5222 current_buffer->directory = make_unibyte_string (pwd, strlen (pwd));
5223 if (! NILP (buffer_defaults.enable_multibyte_characters))
5224 /* At this moment, we still don't know how to decode the
5225 directory name. So, we keep the bytes in multibyte form so
5226 that ENCODE_FILE correctly gets the original bytes. */
5227 current_buffer->directory
5228 = string_to_multibyte (current_buffer->directory);
5230 /* Add /: to the front of the name
5231 if it would otherwise be treated as magic. */
5232 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5233 if (! NILP (temp)
5234 /* If the default dir is just /, TEMP is non-nil
5235 because of the ange-ftp completion handler.
5236 However, it is not necessary to turn / into /:/.
5237 So avoid doing that. */
5238 && strcmp ("/", SDATA (current_buffer->directory)))
5239 current_buffer->directory
5240 = concat2 (build_string ("/:"), current_buffer->directory);
5242 temp = get_minibuffer (0);
5243 XBUFFER (temp)->directory = current_buffer->directory;
5245 free (pwd);
5248 /* initialize the buffer routines */
5249 void
5250 syms_of_buffer ()
5252 staticpro (&last_overlay_modification_hooks);
5253 last_overlay_modification_hooks
5254 = Fmake_vector (make_number (10), Qnil);
5256 staticpro (&Vbuffer_defaults);
5257 staticpro (&Vbuffer_local_symbols);
5258 staticpro (&Qfundamental_mode);
5259 staticpro (&Qmode_class);
5260 staticpro (&QSFundamental);
5261 staticpro (&Vbuffer_alist);
5262 staticpro (&Qprotected_field);
5263 staticpro (&Qpermanent_local);
5264 staticpro (&Qkill_buffer_hook);
5265 Qoverlayp = intern ("overlayp");
5266 staticpro (&Qoverlayp);
5267 Qevaporate = intern ("evaporate");
5268 staticpro (&Qevaporate);
5269 Qmodification_hooks = intern ("modification-hooks");
5270 staticpro (&Qmodification_hooks);
5271 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5272 staticpro (&Qinsert_in_front_hooks);
5273 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5274 staticpro (&Qinsert_behind_hooks);
5275 Qget_file_buffer = intern ("get-file-buffer");
5276 staticpro (&Qget_file_buffer);
5277 Qpriority = intern ("priority");
5278 staticpro (&Qpriority);
5279 Qwindow = intern ("window");
5280 staticpro (&Qwindow);
5281 Qbefore_string = intern ("before-string");
5282 staticpro (&Qbefore_string);
5283 Qafter_string = intern ("after-string");
5284 staticpro (&Qafter_string);
5285 Qfirst_change_hook = intern ("first-change-hook");
5286 staticpro (&Qfirst_change_hook);
5287 Qbefore_change_functions = intern ("before-change-functions");
5288 staticpro (&Qbefore_change_functions);
5289 Qafter_change_functions = intern ("after-change-functions");
5290 staticpro (&Qafter_change_functions);
5291 staticpro (&Qucs_set_table_for_input);
5293 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5294 staticpro (&Qkill_buffer_query_functions);
5296 Fput (Qprotected_field, Qerror_conditions,
5297 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5298 Fput (Qprotected_field, Qerror_message,
5299 build_string ("Attempt to modify a protected field"));
5301 /* All these use DEFVAR_LISP_NOPRO because the slots in
5302 buffer_defaults will all be marked via Vbuffer_defaults. */
5304 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5305 &buffer_defaults.mode_line_format,
5306 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5307 This is the same as (default-value 'mode-line-format). */);
5309 DEFVAR_LISP_NOPRO ("default-header-line-format",
5310 &buffer_defaults.header_line_format,
5311 doc: /* Default value of `header-line-format' for buffers that don't override it.
5312 This is the same as (default-value 'header-line-format). */);
5314 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5315 doc: /* Default value of `cursor-type' for buffers that don't override it.
5316 This is the same as (default-value 'cursor-type). */);
5318 DEFVAR_LISP_NOPRO ("default-line-spacing",
5319 &buffer_defaults.extra_line_spacing,
5320 doc: /* Default value of `line-spacing' for buffers that don't override it.
5321 This is the same as (default-value 'line-spacing). */);
5323 DEFVAR_LISP_NOPRO ("default-cursor-in-non-selected-windows",
5324 &buffer_defaults.cursor_in_non_selected_windows,
5325 doc: /* Default value of `cursor-in-non-selected-windows'.
5326 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5328 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5329 &buffer_defaults.abbrev_mode,
5330 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5331 This is the same as (default-value 'abbrev-mode). */);
5333 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5334 &buffer_defaults.ctl_arrow,
5335 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5336 This is the same as (default-value 'ctl-arrow). */);
5338 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5339 &buffer_defaults.direction_reversed,
5340 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5341 This is the same as (default-value 'direction-reversed). */);
5343 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5344 &buffer_defaults.enable_multibyte_characters,
5345 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5346 This is the same as (default-value 'enable-multibyte-characters). */);
5348 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5349 &buffer_defaults.buffer_file_coding_system,
5350 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5351 This is the same as (default-value 'buffer-file-coding-system). */);
5353 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5354 &buffer_defaults.truncate_lines,
5355 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5356 This is the same as (default-value 'truncate-lines). */);
5358 DEFVAR_LISP_NOPRO ("default-fill-column",
5359 &buffer_defaults.fill_column,
5360 doc: /* Default value of `fill-column' for buffers that do not override it.
5361 This is the same as (default-value 'fill-column). */);
5363 DEFVAR_LISP_NOPRO ("default-left-margin",
5364 &buffer_defaults.left_margin,
5365 doc: /* Default value of `left-margin' for buffers that do not override it.
5366 This is the same as (default-value 'left-margin). */);
5368 DEFVAR_LISP_NOPRO ("default-tab-width",
5369 &buffer_defaults.tab_width,
5370 doc: /* Default value of `tab-width' for buffers that do not override it.
5371 This is the same as (default-value 'tab-width). */);
5373 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5374 &buffer_defaults.case_fold_search,
5375 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5376 This is the same as (default-value 'case-fold-search). */);
5378 #ifdef DOS_NT
5379 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5380 &buffer_defaults.buffer_file_type,
5381 doc: /* Default file type for buffers that do not override it.
5382 This is the same as (default-value 'buffer-file-type).
5383 The file type is nil for text, t for binary. */);
5384 #endif
5386 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5387 &buffer_defaults.left_margin_cols,
5388 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5389 This is the same as (default-value 'left-margin-width). */);
5391 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5392 &buffer_defaults.right_margin_cols,
5393 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5394 This is the same as (default-value 'right-margin-width). */);
5396 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5397 &buffer_defaults.left_fringe_width,
5398 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5399 This is the same as (default-value 'left-fringe-width). */);
5401 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5402 &buffer_defaults.right_fringe_width,
5403 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5404 This is the same as (default-value 'right-fringe-width). */);
5406 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5407 &buffer_defaults.fringes_outside_margins,
5408 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5409 This is the same as (default-value 'fringes-outside-margins). */);
5411 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5412 &buffer_defaults.scroll_bar_width,
5413 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5414 This is the same as (default-value 'scroll-bar-width). */);
5416 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5417 &buffer_defaults.vertical_scroll_bar_type,
5418 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5419 This is the same as (default-value 'vertical-scroll-bar). */);
5421 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5422 &buffer_defaults.indicate_empty_lines,
5423 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5424 This is the same as (default-value 'indicate-empty-lines). */);
5426 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5427 &buffer_defaults.indicate_buffer_boundaries,
5428 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5429 This is the same as (default-value 'indicate-buffer-boundaries). */);
5431 DEFVAR_LISP_NOPRO ("default-fringe-indicator-alist",
5432 &buffer_defaults.fringe_indicator_alist,
5433 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5434 This is the same as (default-value 'fringe-indicator-alist'). */);
5436 DEFVAR_LISP_NOPRO ("default-fringe-cursor-alist",
5437 &buffer_defaults.fringe_cursor_alist,
5438 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5439 This is the same as (default-value 'fringe-cursor-alist'). */);
5441 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5442 &buffer_defaults.scroll_up_aggressively,
5443 doc: /* Default value of `scroll-up-aggressively'.
5444 This value applies in buffers that don't have their own local values.
5445 This is the same as (default-value 'scroll-up-aggressively). */);
5447 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5448 &buffer_defaults.scroll_down_aggressively,
5449 doc: /* Default value of `scroll-down-aggressively'.
5450 This value applies in buffers that don't have their own local values.
5451 This is the same as (default-value 'scroll-down-aggressively). */);
5453 DEFVAR_PER_BUFFER ("header-line-format",
5454 &current_buffer->header_line_format,
5455 Qnil,
5456 doc: /* Analogous to `mode-line-format', but controls the header line.
5457 The header line appears, optionally, at the top of a window;
5458 the mode line appears at the bottom. */);
5460 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5461 Qnil,
5462 doc: /* Template for displaying mode line for current buffer.
5463 Each buffer has its own value of this variable.
5464 Value may be nil, a string, a symbol or a list or cons cell.
5465 A value of nil means don't display a mode line.
5466 For a symbol, its value is used (but it is ignored if t or nil).
5467 A string appearing directly as the value of a symbol is processed verbatim
5468 in that the %-constructs below are not recognized.
5469 Note that unless the symbol is marked as a `risky-local-variable', all
5470 properties in any strings, as well as all :eval and :propertize forms
5471 in the value of that symbol will be ignored.
5472 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5473 is used as a mode line element. Be careful--FORM should not load any files,
5474 because that can cause an infinite recursion.
5475 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5476 with the specified properties PROPS applied.
5477 For a list whose car is a symbol, the symbol's value is taken,
5478 and if that is non-nil, the cadr of the list is processed recursively.
5479 Otherwise, the caddr of the list (if there is one) is processed.
5480 For a list whose car is a string or list, each element is processed
5481 recursively and the results are effectively concatenated.
5482 For a list whose car is an integer, the cdr of the list is processed
5483 and padded (if the number is positive) or truncated (if negative)
5484 to the width specified by that number.
5485 A string is printed verbatim in the mode line except for %-constructs:
5486 (%-constructs are allowed when the string is the entire mode-line-format
5487 or when it is found in a cons-cell or a list)
5488 %b -- print buffer name. %f -- print visited file name.
5489 %F -- print frame name.
5490 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5491 %& is like %*, but ignore read-only-ness.
5492 % means buffer is read-only and * means it is modified.
5493 For a modified read-only buffer, %* gives % and %+ gives *.
5494 %s -- print process status. %l -- print the current line number.
5495 %c -- print the current column number (this makes editing slower).
5496 To make the column number update correctly in all cases,
5497 `column-number-mode' must be non-nil.
5498 %i -- print the size of the buffer.
5499 %I -- like %i, but use k, M, G, etc., to abbreviate.
5500 %p -- print percent of buffer above top of window, or Top, Bot or All.
5501 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5502 or print Bottom or All.
5503 %n -- print Narrow if appropriate.
5504 %t -- visited file is text or binary (if OS supports this distinction).
5505 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5506 %Z -- like %z, but including the end-of-line format.
5507 %e -- print error message about full memory.
5508 %[ -- print one [ for each recursive editing level. %] similar.
5509 %% -- print %. %- -- print infinitely many dashes.
5510 Decimal digits after the % specify field width to which to pad. */);
5512 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5513 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5514 A value of nil means use current buffer's major mode,
5515 provided it is not marked as "special".
5517 When a mode is used by default, `find-file' switches to it
5518 before it reads the contents into the buffer and before
5519 it finishes setting up the buffer. Thus, the mode and
5520 its hooks should not expect certain variables such as
5521 `buffer-read-only' and `buffer-file-coding-system' to be set up. */);
5523 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5524 make_number (Lisp_Symbol),
5525 doc: /* Symbol for current buffer's major mode. */);
5527 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5528 Qnil,
5529 doc: /* Pretty name of current buffer's major mode (a string). */);
5531 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5532 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5534 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5535 Qnil,
5536 doc: /* *Non-nil if searches and matches should ignore case. */);
5538 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5539 make_number (Lisp_Int),
5540 doc: /* *Column beyond which automatic line-wrapping should happen.
5541 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5543 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5544 make_number (Lisp_Int),
5545 doc: /* *Column for the default `indent-line-function' to indent to.
5546 Linefeed indents to this column in Fundamental mode. */);
5548 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5549 make_number (Lisp_Int),
5550 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5552 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5553 doc: /* *Non-nil means display control chars with uparrow.
5554 A value of nil means use backslash and octal digits.
5555 This variable does not apply to characters whose display is specified
5556 in the current display table (if there is one). */);
5558 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5559 &current_buffer->enable_multibyte_characters,
5560 Qnil,
5561 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5562 Otherwise they are regarded as unibyte. This affects the display,
5563 file I/O and the behavior of various editing commands.
5565 This variable is buffer-local but you cannot set it directly;
5566 use the function `set-buffer-multibyte' to change a buffer's representation.
5567 Changing its default value with `setq-default' is supported.
5568 See also variable `default-enable-multibyte-characters' and Info node
5569 `(elisp)Text Representations'. */);
5570 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5572 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5573 &current_buffer->buffer_file_coding_system, Qnil,
5574 doc: /* Coding system to be used for encoding the buffer contents on saving.
5575 This variable applies to saving the buffer, and also to `write-region'
5576 and other functions that use `write-region'.
5577 It does not apply to sending output to subprocesses, however.
5579 If this is nil, the buffer is saved without any code conversion
5580 unless some coding system is specified in `file-coding-system-alist'
5581 for the buffer file.
5583 If the text to be saved cannot be encoded as specified by this variable,
5584 an alternative encoding is selected by `select-safe-coding-system', which see.
5586 The variable `coding-system-for-write', if non-nil, overrides this variable.
5588 This variable is never applied to a way of decoding a file while reading it. */);
5590 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5591 Qnil,
5592 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5594 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5595 doc: /* *Non-nil means do not display continuation lines.
5596 Instead, give each line of text just one screen line.
5598 Note that this is overridden by the variable
5599 `truncate-partial-width-windows' if that variable is non-nil
5600 and this buffer is not full-frame width. */);
5602 #ifdef DOS_NT
5603 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5604 Qnil,
5605 doc: /* Non-nil if the visited file is a binary file.
5606 This variable is meaningful on MS-DOG and Windows NT.
5607 On those systems, it is automatically local in every buffer.
5608 On other systems, this variable is normally always nil. */);
5609 #endif
5611 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5612 make_number (Lisp_String),
5613 doc: /* Name of default directory of current buffer. Should end with slash.
5614 To interactively change the default directory, use command `cd'. */);
5616 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5617 Qnil,
5618 doc: /* Function called (if non-nil) to perform auto-fill.
5619 It is called after self-inserting any character specified in
5620 the `auto-fill-chars' table.
5621 NOTE: This variable is not a hook;
5622 its value may not be a list of functions. */);
5624 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5625 make_number (Lisp_String),
5626 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5628 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5629 make_number (Lisp_String),
5630 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5631 The truename of a file is calculated by `file-truename'
5632 and then abbreviated with `abbreviate-file-name'. */);
5634 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5635 &current_buffer->auto_save_file_name,
5636 make_number (Lisp_String),
5637 doc: /* Name of file for auto-saving current buffer.
5638 If it is nil, that means don't auto-save this buffer. */);
5640 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5641 doc: /* Non-nil if this buffer is read-only. */);
5643 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5644 doc: /* Non-nil if this buffer's file has been backed up.
5645 Backing up is done before the first time the file is saved. */);
5647 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5648 make_number (Lisp_Int),
5649 doc: /* Length of current buffer when last read in, saved or auto-saved.
5650 0 initially. */);
5652 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5653 Qnil,
5654 doc: /* Non-nil enables selective display.
5655 An Integer N as value means display only lines
5656 that start with less than n columns of space.
5657 A value of t means that the character ^M makes itself and
5658 all the rest of the line invisible; also, when saving the buffer
5659 in a file, save the ^M as a newline. */);
5661 #ifndef old
5662 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5663 &current_buffer->selective_display_ellipses,
5664 Qnil,
5665 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5666 #endif
5668 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5669 doc: /* Non-nil if self-insertion should replace existing text.
5670 The value should be one of `overwrite-mode-textual',
5671 `overwrite-mode-binary', or nil.
5672 If it is `overwrite-mode-textual', self-insertion still
5673 inserts at the end of a line, and inserts when point is before a tab,
5674 until the tab is filled in.
5675 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5677 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5678 Qnil,
5679 doc: /* Display table that controls display of the contents of current buffer.
5681 If this variable is nil, the value of `standard-display-table' is used.
5682 Each window can have its own, overriding display table, see
5683 `set-window-display-table' and `window-display-table'.
5685 The display table is a char-table created with `make-display-table'.
5686 A char-table is an array indexed by character codes. Normal array
5687 primitives `aref' and `aset' can be used to access elements of a char-table.
5689 Each of the char-table elements control how to display the corresponding
5690 text character: the element at index C in the table says how to display
5691 the character whose code is C. Each element should be a vector of
5692 characters or nil. The value nil means display the character in the
5693 default fashion; otherwise, the characters from the vector are delivered
5694 to the screen instead of the original character.
5696 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5697 to display a capital Y instead of each X character.
5699 In addition, a char-table has six extra slots to control the display of:
5701 the end of a truncated screen line (extra-slot 0, a single character);
5702 the end of a continued line (extra-slot 1, a single character);
5703 the escape character used to display character codes in octal
5704 (extra-slot 2, a single character);
5705 the character used as an arrow for control characters (extra-slot 3,
5706 a single character);
5707 the decoration indicating the presence of invisible lines (extra-slot 4,
5708 a vector of characters);
5709 the character used to draw the border between side-by-side windows
5710 (extra-slot 5, a single character).
5712 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5714 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5715 Qnil,
5716 doc: /* *Width of left marginal area for display of a buffer.
5717 A value of nil means no marginal area. */);
5719 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5720 Qnil,
5721 doc: /* *Width of right marginal area for display of a buffer.
5722 A value of nil means no marginal area. */);
5724 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5725 Qnil,
5726 doc: /* *Width of this buffer's left fringe (in pixels).
5727 A value of 0 means no left fringe is shown in this buffer's window.
5728 A value of nil means to use the left fringe width from the window's frame. */);
5730 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5731 Qnil,
5732 doc: /* *Width of this buffer's right fringe (in pixels).
5733 A value of 0 means no right fringe is shown in this buffer's window.
5734 A value of nil means to use the right fringe width from the window's frame. */);
5736 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5737 Qnil,
5738 doc: /* *Non-nil means to display fringes outside display margins.
5739 A value of nil means to display fringes between margins and buffer text. */);
5741 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5742 Qnil,
5743 doc: /* *Width of this buffer's scroll bars in pixels.
5744 A value of nil means to use the scroll bar width from the window's frame. */);
5746 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5747 Qnil,
5748 doc: /* *Position of this buffer's vertical scroll bar.
5749 The value takes effect whenever you tell a window to display this buffer;
5750 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5752 A value of `left' or `right' means put the vertical scroll bar at that side
5753 of the window; a value of nil means don't show any vertical scroll bars.
5754 A value of t (the default) means do whatever the window's frame specifies. */);
5756 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5757 &current_buffer->indicate_empty_lines, Qnil,
5758 doc: /* *Visually indicate empty lines after the buffer end.
5759 If non-nil, a bitmap is displayed in the left fringe of a window on
5760 window-systems. */);
5762 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5763 &current_buffer->indicate_buffer_boundaries, Qnil,
5764 doc: /* *Visually indicate buffer boundaries and scrolling.
5765 If non-nil, the first and last line of the buffer are marked in the fringe
5766 of a window on window-systems with angle bitmaps, or if the window can be
5767 scrolled, the top and bottom line of the window are marked with up and down
5768 arrow bitmaps.
5770 If value is a symbol `left' or `right', both angle and arrow bitmaps
5771 are displayed in the left or right fringe, resp. Any other value
5772 that doesn't look like an alist means display the angle bitmaps in
5773 the left fringe but no arrows.
5775 You can exercise more precise control by using an alist as the
5776 value. Each alist element (INDICATOR . POSITION) specifies
5777 where to show one of the indicators. INDICATOR is one of `top',
5778 `bottom', `up', `down', or t, which specifies the default position,
5779 and POSITION is one of `left', `right', or nil, meaning do not show
5780 this indicator.
5782 For example, ((top . left) (t . right)) places the top angle bitmap in
5783 left fringe, the bottom angle bitmap in right fringe, and both arrow
5784 bitmaps in right fringe. To show just the angle bitmaps in the left
5785 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5787 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5788 &current_buffer->fringe_indicator_alist, Qnil,
5789 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5790 The value is an alist where each element (INDICATOR . BITMAPS)
5791 specifies the fringe bitmaps used to display a specific logical
5792 fringe indicator.
5794 INDICATOR specifies the logical indicator type which is one of the
5795 following symbols: `truncation' , `continuation', `overlay-arrow',
5796 `top', `bottom', `up', `down', `one-line', `empty-line', or `unknown'.
5798 BITMAPS is list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5799 the actual bitmap shown in the left or right fringe for the logical
5800 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5801 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5802 are used only for the `bottom' and `one-line' indicators when the last
5803 \(only) line in has no final newline. BITMAPS may also be a single
5804 symbol which is used in both left and right fringes. */);
5806 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5807 &current_buffer->fringe_cursor_alist, Qnil,
5808 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5809 The value is an alist where each element (CURSOR . BITMAP)
5810 specifies the fringe bitmaps used to display a specific logical
5811 cursor type in the fringe.
5813 CURSOR specifies the logical cursor type which is one of the following
5814 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5815 one is used to show a hollow cursor on narrow lines display lines
5816 where the normal hollow cursor will not fit.
5818 BITMAP is the corresponding fringe bitmap shown for the logical
5819 cursor type. */);
5821 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5822 &current_buffer->scroll_up_aggressively, Qnil,
5823 doc: /* How far to scroll windows upward.
5824 If you move point off the bottom, the window scrolls automatically.
5825 This variable controls how far it scrolls. The value nil, the default,
5826 means scroll to center point. A fraction means scroll to put point
5827 that fraction of the window's height from the bottom of the window.
5828 When the value is 0.0, point goes at the bottom line, which in the simple
5829 case that you moved off with C-f means scrolling just one line. 1.0 means
5830 point goes at the top, so that in that simple case, the window
5831 scrolls by a full window height. Meaningful values are
5832 between 0.0 and 1.0, inclusive. */);
5834 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5835 &current_buffer->scroll_down_aggressively, Qnil,
5836 doc: /* How far to scroll windows downward.
5837 If you move point off the top, the window scrolls automatically.
5838 This variable controls how far it scrolls. The value nil, the default,
5839 means scroll to center point. A fraction means scroll to put point
5840 that fraction of the window's height from the top of the window.
5841 When the value is 0.0, point goes at the top line, which in the simple
5842 case that you moved off with C-b means scrolling just one line. 1.0 means
5843 point goes at the bottom, so that in that simple case, the window
5844 scrolls by a full window height. Meaningful values are
5845 between 0.0 and 1.0, inclusive. */);
5847 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5848 "Don't ask.");
5851 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5852 doc: /* List of functions to call before each text change.
5853 Two arguments are passed to each function: the positions of
5854 the beginning and end of the range of old text to be changed.
5855 \(For an insertion, the beginning and end are at the same place.)
5856 No information is given about the length of the text after the change.
5858 Buffer changes made while executing the `before-change-functions'
5859 don't call any before-change or after-change functions.
5860 That's because these variables are temporarily set to nil.
5861 As a result, a hook function cannot straightforwardly alter the value of
5862 these variables. See the Emacs Lisp manual for a way of
5863 accomplishing an equivalent result by using other variables.
5865 If an unhandled error happens in running these functions,
5866 the variable's value remains nil. That prevents the error
5867 from happening repeatedly and making Emacs nonfunctional. */);
5868 Vbefore_change_functions = Qnil;
5870 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5871 doc: /* List of functions to call after each text change.
5872 Three arguments are passed to each function: the positions of
5873 the beginning and end of the range of changed text,
5874 and the length in bytes of the pre-change text replaced by that range.
5875 \(For an insertion, the pre-change length is zero;
5876 for a deletion, that length is the number of bytes deleted,
5877 and the post-change beginning and end are at the same place.)
5879 Buffer changes made while executing the `after-change-functions'
5880 don't call any before-change or after-change functions.
5881 That's because these variables are temporarily set to nil.
5882 As a result, a hook function cannot straightforwardly alter the value of
5883 these variables. See the Emacs Lisp manual for a way of
5884 accomplishing an equivalent result by using other variables.
5886 If an unhandled error happens in running these functions,
5887 the variable's value remains nil. That prevents the error
5888 from happening repeatedly and making Emacs nonfunctional. */);
5889 Vafter_change_functions = Qnil;
5891 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5892 doc: /* A list of functions to call before changing a buffer which is unmodified.
5893 The functions are run using the `run-hooks' function. */);
5894 Vfirst_change_hook = Qnil;
5896 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5897 doc: /* List of undo entries in current buffer.
5898 Recent changes come first; older changes follow newer.
5900 An entry (BEG . END) represents an insertion which begins at
5901 position BEG and ends at position END.
5903 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5904 from (abs POSITION). If POSITION is positive, point was at the front
5905 of the text being deleted; if negative, point was at the end.
5907 An entry (t HIGH . LOW) indicates that the buffer previously had
5908 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5909 of the visited file's modification time, as of that time. If the
5910 modification time of the most recent save is different, this entry is
5911 obsolete.
5913 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5914 was modified between BEG and END. PROPERTY is the property name,
5915 and VALUE is the old value.
5917 An entry (apply FUN-NAME . ARGS) means undo the change with
5918 \(apply FUN-NAME ARGS).
5920 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5921 in the active region. BEG and END is the range affected by this entry
5922 and DELTA is the number of bytes added or deleted in that range by
5923 this change.
5925 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5926 was adjusted in position by the offset DISTANCE (an integer).
5928 An entry of the form POSITION indicates that point was at the buffer
5929 location given by the integer. Undoing an entry of this form places
5930 point at POSITION.
5932 Entries with value `nil' mark undo boundaries. The undo command treats
5933 the changes between two undo boundaries as a single step to be undone.
5935 If the value of the variable is t, undo information is not recorded. */);
5937 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5938 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5940 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5941 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5943 Normally, the line-motion functions work by scanning the buffer for
5944 newlines. Columnar operations (like `move-to-column' and
5945 `compute-motion') also work by scanning the buffer, summing character
5946 widths as they go. This works well for ordinary text, but if the
5947 buffer's lines are very long (say, more than 500 characters), these
5948 motion functions will take longer to execute. Emacs may also take
5949 longer to update the display.
5951 If `cache-long-line-scans' is non-nil, these motion functions cache the
5952 results of their scans, and consult the cache to avoid rescanning
5953 regions of the buffer until the text is modified. The caches are most
5954 beneficial when they prevent the most searching---that is, when the
5955 buffer contains long lines and large regions of characters with the
5956 same, fixed screen width.
5958 When `cache-long-line-scans' is non-nil, processing short lines will
5959 become slightly slower (because of the overhead of consulting the
5960 cache), and the caches will use memory roughly proportional to the
5961 number of newlines and characters whose screen width varies.
5963 The caches require no explicit maintenance; their accuracy is
5964 maintained internally by the Emacs primitives. Enabling or disabling
5965 the cache should not affect the behavior of any of the motion
5966 functions; it should only affect their performance. */);
5968 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5969 doc: /* Value of point before the last series of scroll operations, or nil. */);
5971 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5972 doc: /* List of formats to use when saving this buffer.
5973 Formats are defined by `format-alist'. This variable is
5974 set when a file is visited. */);
5976 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5977 &current_buffer->auto_save_file_format, Qnil,
5978 doc: /* *Format in which to write auto-save files.
5979 Should be a list of symbols naming formats that are defined in `format-alist'.
5980 If it is t, which is the default, auto-save files are written in the
5981 same format as a regular save would use. */);
5983 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5984 &current_buffer->invisibility_spec, Qnil,
5985 doc: /* Invisibility spec of this buffer.
5986 The default is t, which means that text is invisible
5987 if it has a non-nil `invisible' property.
5988 If the value is a list, a text character is invisible if its `invisible'
5989 property is an element in that list.
5990 If an element is a cons cell of the form (PROP . ELLIPSIS),
5991 then characters with property value PROP are invisible,
5992 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5994 DEFVAR_PER_BUFFER ("buffer-display-count",
5995 &current_buffer->display_count, Qnil,
5996 doc: /* A number incremented each time this buffer is displayed in a window.
5997 The function `set-window-buffer' increments it. */);
5999 DEFVAR_PER_BUFFER ("buffer-display-time",
6000 &current_buffer->display_time, Qnil,
6001 doc: /* Time stamp updated each time this buffer is displayed in a window.
6002 The function `set-window-buffer' updates this variable
6003 to the value obtained by calling `current-time'.
6004 If the buffer has never been shown in a window, the value is nil. */);
6006 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
6007 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
6008 Non-nil also enables highlighting of the region whenever the mark is active.
6009 The variable `highlight-nonselected-windows' controls whether to highlight
6010 all windows or just the selected window.
6012 If the value is `lambda', that enables Transient Mark mode temporarily
6013 until the next buffer modification. If a command sets the value to `only',
6014 that enables Transient Mark mode for the following command only.
6015 During that following command, the value of `transient-mark-mode'
6016 is `identity'. If it is still `identity' at the end of that command,
6017 it changes to nil. */);
6018 Vtransient_mark_mode = Qnil;
6020 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
6021 doc: /* *Non-nil means disregard read-only status of buffers or characters.
6022 If the value is t, disregard `buffer-read-only' and all `read-only'
6023 text properties. If the value is a list, disregard `buffer-read-only'
6024 and disregard a `read-only' text property if the property value
6025 is a member of the list. */);
6026 Vinhibit_read_only = Qnil;
6028 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
6029 doc: /* Cursor to use when this buffer is in the selected window.
6030 Values are interpreted as follows:
6032 t use the cursor specified for the frame
6033 nil don't display a cursor
6034 box display a filled box cursor
6035 hollow display a hollow box cursor
6036 bar display a vertical bar cursor with default width
6037 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6038 hbar display a horizontal bar cursor with default height
6039 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6040 ANYTHING ELSE display a hollow box cursor
6042 When the buffer is displayed in a nonselected window,
6043 this variable has no effect; the cursor appears as a hollow box. */);
6045 DEFVAR_PER_BUFFER ("line-spacing",
6046 &current_buffer->extra_line_spacing, Qnil,
6047 doc: /* Additional space to put between lines when displaying a buffer.
6048 The space is measured in pixels, and put below lines on window systems.
6049 If value is a floating point number, it specifies the spacing relative
6050 to the default frame line height. A value of nil means add no extra space. */);
6052 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6053 &current_buffer->cursor_in_non_selected_windows, Qnil,
6054 doc: /* *Cursor type to display in non-selected windows.
6055 The value t means to use hollow box cursor. See `cursor-type' for other values. */);
6057 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
6058 doc: /* List of functions called with no args to query before killing a buffer.
6059 The buffer being killed will be current while the functions are running.
6060 If any of them returns nil, the buffer is not killed. */);
6061 Vkill_buffer_query_functions = Qnil;
6063 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook,
6064 doc: /* Normal hook run before changing the major mode of a buffer.
6065 The function `kill-all-local-variables' runs this before doing anything else. */);
6066 Vchange_major_mode_hook = Qnil;
6067 Qchange_major_mode_hook = intern ("change-major-mode-hook");
6068 staticpro (&Qchange_major_mode_hook);
6070 defsubr (&Sbuffer_live_p);
6071 defsubr (&Sbuffer_list);
6072 defsubr (&Sget_buffer);
6073 defsubr (&Sget_file_buffer);
6074 defsubr (&Sget_buffer_create);
6075 defsubr (&Smake_indirect_buffer);
6076 defsubr (&Sgenerate_new_buffer_name);
6077 defsubr (&Sbuffer_name);
6078 /*defsubr (&Sbuffer_number);*/
6079 defsubr (&Sbuffer_file_name);
6080 defsubr (&Sbuffer_base_buffer);
6081 defsubr (&Sbuffer_local_value);
6082 defsubr (&Sbuffer_local_variables);
6083 defsubr (&Sbuffer_modified_p);
6084 defsubr (&Sset_buffer_modified_p);
6085 defsubr (&Sbuffer_modified_tick);
6086 defsubr (&Sbuffer_chars_modified_tick);
6087 defsubr (&Srename_buffer);
6088 defsubr (&Sother_buffer);
6089 defsubr (&Sbuffer_enable_undo);
6090 defsubr (&Skill_buffer);
6091 defsubr (&Sset_buffer_major_mode);
6092 defsubr (&Sswitch_to_buffer);
6093 defsubr (&Spop_to_buffer);
6094 defsubr (&Scurrent_buffer);
6095 defsubr (&Sset_buffer);
6096 defsubr (&Sbarf_if_buffer_read_only);
6097 defsubr (&Sbury_buffer);
6098 defsubr (&Serase_buffer);
6099 defsubr (&Sset_buffer_multibyte);
6100 defsubr (&Skill_all_local_variables);
6102 defsubr (&Soverlayp);
6103 defsubr (&Smake_overlay);
6104 defsubr (&Sdelete_overlay);
6105 defsubr (&Smove_overlay);
6106 defsubr (&Soverlay_start);
6107 defsubr (&Soverlay_end);
6108 defsubr (&Soverlay_buffer);
6109 defsubr (&Soverlay_properties);
6110 defsubr (&Soverlays_at);
6111 defsubr (&Soverlays_in);
6112 defsubr (&Snext_overlay_change);
6113 defsubr (&Sprevious_overlay_change);
6114 defsubr (&Soverlay_recenter);
6115 defsubr (&Soverlay_lists);
6116 defsubr (&Soverlay_get);
6117 defsubr (&Soverlay_put);
6118 defsubr (&Srestore_buffer_modified_p);
6121 void
6122 keys_of_buffer ()
6124 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6125 initial_define_key (control_x_map, 'k', "kill-buffer");
6127 /* This must not be in syms_of_buffer, because Qdisabled is not
6128 initialized when that function gets called. */
6129 Fput (intern ("erase-buffer"), Qdisabled, Qt);
6132 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
6133 (do not change this comment) */