(holiday-list): Add autoload cookie.
[emacs.git] / src / buffer.c
blob675992db316407fd85974a1fac8d872e92877def
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 3, 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 /* Flags indicating which built-in buffer-local variables
103 are permanent locals. */
104 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
106 /* Number of per-buffer variables used. */
108 int last_per_buffer_idx;
110 Lisp_Object Fset_buffer ();
111 void set_buffer_internal ();
112 void set_buffer_internal_1 ();
113 static void call_overlay_mod_hooks ();
114 static void swap_out_buffer_local_variables ();
115 static void reset_buffer_local_variables ();
117 /* Alist of all buffer names vs the buffers. */
118 /* This used to be a variable, but is no longer,
119 to prevent lossage due to user rplac'ing this alist or its elements. */
120 Lisp_Object Vbuffer_alist;
122 /* Functions to call before and after each text change. */
123 Lisp_Object Vbefore_change_functions;
124 Lisp_Object Vafter_change_functions;
126 Lisp_Object Vtransient_mark_mode;
128 /* t means ignore all read-only text properties.
129 A list means ignore such a property if its value is a member of the list.
130 Any non-nil value means ignore buffer-read-only. */
131 Lisp_Object Vinhibit_read_only;
133 /* List of functions to call that can query about killing a buffer.
134 If any of these functions returns nil, we don't kill it. */
135 Lisp_Object Vkill_buffer_query_functions;
136 Lisp_Object Qkill_buffer_query_functions;
138 /* Hook run before changing a major mode. */
139 Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;
141 /* List of functions to call before changing an unmodified buffer. */
142 Lisp_Object Vfirst_change_hook;
144 Lisp_Object Qfirst_change_hook;
145 Lisp_Object Qbefore_change_functions;
146 Lisp_Object Qafter_change_functions;
147 Lisp_Object Qucs_set_table_for_input;
149 /* If nonzero, all modification hooks are suppressed. */
150 int inhibit_modification_hooks;
152 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
154 Lisp_Object Qprotected_field;
156 Lisp_Object QSFundamental; /* A string "Fundamental" */
158 Lisp_Object Qkill_buffer_hook;
160 Lisp_Object Qget_file_buffer;
162 Lisp_Object Qoverlayp;
164 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
166 Lisp_Object Qmodification_hooks;
167 Lisp_Object Qinsert_in_front_hooks;
168 Lisp_Object Qinsert_behind_hooks;
170 static void alloc_buffer_text P_ ((struct buffer *, size_t));
171 static void free_buffer_text P_ ((struct buffer *b));
172 static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
173 static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
174 static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
177 /* For debugging; temporary. See set_buffer_internal. */
178 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
180 void
181 nsberror (spec)
182 Lisp_Object spec;
184 if (STRINGP (spec))
185 error ("No buffer named %s", SDATA (spec));
186 error ("Invalid buffer argument");
189 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
190 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
191 Value is nil if OBJECT is not a buffer or if it has been killed. */)
192 (object)
193 Lisp_Object object;
195 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
196 ? Qt : Qnil);
199 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
200 doc: /* Return a list of all existing live buffers.
201 If the optional arg FRAME is a frame, we return the buffer list
202 in the proper order for that frame: the buffers in FRAME's `buffer-list'
203 frame parameter come first, followed by the rest of the buffers. */)
204 (frame)
205 Lisp_Object frame;
207 Lisp_Object general;
208 general = Fmapcar (Qcdr, Vbuffer_alist);
210 if (FRAMEP (frame))
212 Lisp_Object framelist, prevlist, tail;
213 Lisp_Object args[3];
215 CHECK_FRAME (frame);
217 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
218 prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
220 /* Remove from GENERAL any buffer that duplicates one in
221 FRAMELIST or PREVLIST. */
222 tail = framelist;
223 while (CONSP (tail))
225 general = Fdelq (XCAR (tail), general);
226 tail = XCDR (tail);
228 tail = prevlist;
229 while (CONSP (tail))
231 general = Fdelq (XCAR (tail), general);
232 tail = XCDR (tail);
235 args[0] = framelist;
236 args[1] = general;
237 args[2] = prevlist;
238 return Fnconc (3, args);
241 return general;
244 /* Like Fassoc, but use Fstring_equal to compare
245 (which ignores text properties),
246 and don't ever QUIT. */
248 static Lisp_Object
249 assoc_ignore_text_properties (key, list)
250 register Lisp_Object key;
251 Lisp_Object list;
253 register Lisp_Object tail;
254 for (tail = list; CONSP (tail); tail = XCDR (tail))
256 register Lisp_Object elt, tem;
257 elt = XCAR (tail);
258 tem = Fstring_equal (Fcar (elt), key);
259 if (!NILP (tem))
260 return elt;
262 return Qnil;
265 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
266 doc: /* Return the buffer named NAME (a string).
267 If there is no live buffer named NAME, return nil.
268 NAME may also be a buffer; if so, the value is that buffer. */)
269 (name)
270 register Lisp_Object name;
272 if (BUFFERP (name))
273 return name;
274 CHECK_STRING (name);
276 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
279 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
280 doc: /* Return the buffer visiting file FILENAME (a string).
281 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
282 If there is no such live buffer, return nil.
283 See also `find-buffer-visiting'. */)
284 (filename)
285 register Lisp_Object filename;
287 register Lisp_Object tail, buf, tem;
288 Lisp_Object handler;
290 CHECK_STRING (filename);
291 filename = Fexpand_file_name (filename, Qnil);
293 /* If the file name has special constructs in it,
294 call the corresponding file handler. */
295 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
296 if (!NILP (handler))
297 return call2 (handler, Qget_file_buffer, filename);
299 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
301 buf = Fcdr (XCAR (tail));
302 if (!BUFFERP (buf)) continue;
303 if (!STRINGP (XBUFFER (buf)->filename)) continue;
304 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
305 if (!NILP (tem))
306 return buf;
308 return Qnil;
311 Lisp_Object
312 get_truename_buffer (filename)
313 register Lisp_Object filename;
315 register Lisp_Object tail, buf, tem;
317 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
319 buf = Fcdr (XCAR (tail));
320 if (!BUFFERP (buf)) continue;
321 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
322 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
323 if (!NILP (tem))
324 return buf;
326 return Qnil;
329 /* Incremented for each buffer created, to assign the buffer number. */
330 int buffer_count;
332 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
333 doc: /* Return the buffer named NAME, or create such a buffer and return it.
334 A new buffer is created if there is no live buffer named NAME.
335 If NAME starts with a space, the new buffer does not keep undo information.
336 If NAME is a buffer instead of a string, then it is the value returned.
337 The value is never nil. */)
338 (name)
339 register Lisp_Object name;
341 register Lisp_Object buf;
342 register struct buffer *b;
344 buf = Fget_buffer (name);
345 if (!NILP (buf))
346 return buf;
348 if (SCHARS (name) == 0)
349 error ("Empty string for buffer name is not allowed");
351 b = (struct buffer *) allocate_buffer ();
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 b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
408 reset_buffer (b);
409 reset_buffer_local_variables (b, 1);
411 b->mark = Fmake_marker ();
412 BUF_MARKERS (b) = NULL;
413 b->name = name;
415 /* Put this in the alist of all live buffers. */
416 XSETBUFFER (buf, b);
417 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
419 /* An error in calling the function here (should someone redefine it)
420 can lead to infinite regress until you run out of stack. rms
421 says that's not worth protecting against. */
422 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
423 /* buf is on buffer-alist, so no gcpro. */
424 call1 (Qucs_set_table_for_input, buf);
426 return buf;
430 /* Return a list of overlays which is a copy of the overlay list
431 LIST, but for buffer B. */
433 static struct Lisp_Overlay *
434 copy_overlays (b, list)
435 struct buffer *b;
436 struct Lisp_Overlay *list;
438 Lisp_Object buffer;
439 struct Lisp_Overlay *result = NULL, *tail = NULL;
441 XSETBUFFER (buffer, b);
443 for (; list; list = list->next)
445 Lisp_Object overlay, start, end, old_overlay;
446 EMACS_INT charpos;
448 XSETMISC (old_overlay, list);
449 charpos = marker_position (OVERLAY_START (old_overlay));
450 start = Fmake_marker ();
451 Fset_marker (start, make_number (charpos), buffer);
452 XMARKER (start)->insertion_type
453 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
455 charpos = marker_position (OVERLAY_END (old_overlay));
456 end = Fmake_marker ();
457 Fset_marker (end, make_number (charpos), buffer);
458 XMARKER (end)->insertion_type
459 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
461 overlay = allocate_misc ();
462 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
463 OVERLAY_START (overlay) = start;
464 OVERLAY_END (overlay) = end;
465 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
466 XOVERLAY (overlay)->next = NULL;
468 if (tail)
469 tail = tail->next = XOVERLAY (overlay);
470 else
471 result = tail = XOVERLAY (overlay);
474 return result;
478 /* Clone per-buffer values of buffer FROM.
480 Buffer TO gets the same per-buffer values as FROM, with the
481 following exceptions: (1) TO's name is left untouched, (2) markers
482 are copied and made to refer to TO, and (3) overlay lists are
483 copied. */
485 static void
486 clone_per_buffer_values (from, to)
487 struct buffer *from, *to;
489 Lisp_Object to_buffer;
490 int offset;
492 XSETBUFFER (to_buffer, to);
494 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
495 offset < sizeof *to;
496 offset += sizeof (Lisp_Object))
498 Lisp_Object obj;
500 obj = PER_BUFFER_VALUE (from, offset);
501 if (MARKERP (obj))
503 struct Lisp_Marker *m = XMARKER (obj);
504 obj = Fmake_marker ();
505 XMARKER (obj)->insertion_type = m->insertion_type;
506 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
509 PER_BUFFER_VALUE (to, offset) = obj;
512 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
514 to->overlays_before = copy_overlays (to, from->overlays_before);
515 to->overlays_after = copy_overlays (to, from->overlays_after);
517 /* Get (a copy of) the alist of Lisp-level local variables of FROM
518 and install that in TO. */
519 to->local_var_alist = buffer_lisp_local_variables (from);
522 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
523 2, 3,
524 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
525 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
526 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
527 NAME should be a string which is not the name of an existing buffer.
528 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
529 such as major and minor modes, in the indirect buffer.
530 CLONE nil means the indirect buffer's state is reset to default values. */)
531 (base_buffer, name, clone)
532 Lisp_Object base_buffer, name, clone;
534 Lisp_Object buf, tem;
535 struct buffer *b;
537 CHECK_STRING (name);
538 buf = Fget_buffer (name);
539 if (!NILP (buf))
540 error ("Buffer name `%s' is in use", SDATA (name));
542 tem = base_buffer;
543 base_buffer = Fget_buffer (base_buffer);
544 if (NILP (base_buffer))
545 error ("No such buffer: `%s'", SDATA (tem));
546 if (NILP (XBUFFER (base_buffer)->name))
547 error ("Base buffer has been killed");
549 if (SCHARS (name) == 0)
550 error ("Empty string for buffer name is not allowed");
552 b = (struct buffer *) allocate_buffer ();
554 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
555 ? XBUFFER (base_buffer)->base_buffer
556 : XBUFFER (base_buffer));
558 /* Use the base buffer's text object. */
559 b->text = b->base_buffer->text;
561 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
562 BUF_ZV (b) = BUF_ZV (b->base_buffer);
563 BUF_PT (b) = BUF_PT (b->base_buffer);
564 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
565 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
566 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
568 b->newline_cache = 0;
569 b->width_run_cache = 0;
570 b->width_table = Qnil;
572 /* Put this on the chain of all buffers including killed ones. */
573 b->next = all_buffers;
574 all_buffers = b;
576 name = Fcopy_sequence (name);
577 STRING_SET_INTERVALS (name, NULL_INTERVAL);
578 b->name = name;
580 reset_buffer (b);
581 reset_buffer_local_variables (b, 1);
583 /* Put this in the alist of all live buffers. */
584 XSETBUFFER (buf, b);
585 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
587 b->mark = Fmake_marker ();
588 b->name = name;
590 /* The multibyte status belongs to the base buffer. */
591 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
593 /* Make sure the base buffer has markers for its narrowing. */
594 if (NILP (b->base_buffer->pt_marker))
596 b->base_buffer->pt_marker = Fmake_marker ();
597 set_marker_both (b->base_buffer->pt_marker, base_buffer,
598 BUF_PT (b->base_buffer),
599 BUF_PT_BYTE (b->base_buffer));
601 if (NILP (b->base_buffer->begv_marker))
603 b->base_buffer->begv_marker = Fmake_marker ();
604 set_marker_both (b->base_buffer->begv_marker, base_buffer,
605 BUF_BEGV (b->base_buffer),
606 BUF_BEGV_BYTE (b->base_buffer));
608 if (NILP (b->base_buffer->zv_marker))
610 b->base_buffer->zv_marker = Fmake_marker ();
611 set_marker_both (b->base_buffer->zv_marker, base_buffer,
612 BUF_ZV (b->base_buffer),
613 BUF_ZV_BYTE (b->base_buffer));
614 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
617 if (NILP (clone))
619 /* Give the indirect buffer markers for its narrowing. */
620 b->pt_marker = Fmake_marker ();
621 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
622 b->begv_marker = Fmake_marker ();
623 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
624 b->zv_marker = Fmake_marker ();
625 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
626 XMARKER (b->zv_marker)->insertion_type = 1;
628 else
630 struct buffer *old_b = current_buffer;
632 clone_per_buffer_values (b->base_buffer, b);
633 b->filename = Qnil;
634 b->file_truename = Qnil;
635 b->display_count = make_number (0);
636 b->backed_up = Qnil;
637 b->auto_save_file_name = Qnil;
638 set_buffer_internal_1 (b);
639 Fset (intern ("buffer-save-without-query"), Qnil);
640 Fset (intern ("buffer-file-number"), Qnil);
641 Fset (intern ("buffer-stale-function"), Qnil);
642 set_buffer_internal_1 (old_b);
645 return buf;
648 void
649 delete_all_overlays (b)
650 struct buffer *b;
652 Lisp_Object overlay;
654 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
655 have to empty the list, otherwise we end up with overlays that
656 think they belong to this buffer while the buffer doesn't know about
657 them any more. */
658 while (b->overlays_before)
660 XSETMISC (overlay, b->overlays_before);
661 Fdelete_overlay (overlay);
663 while (b->overlays_after)
665 XSETMISC (overlay, b->overlays_after);
666 Fdelete_overlay (overlay);
668 eassert (b->overlays_before == NULL);
669 eassert (b->overlays_after == NULL);
672 /* Reinitialize everything about a buffer except its name and contents
673 and local variables.
674 If called on an already-initialized buffer, the list of overlays
675 should be deleted before calling this function, otherwise we end up
676 with overlays that claim to belong to the buffer but the buffer
677 claims it doesn't belong to it. */
679 void
680 reset_buffer (b)
681 register struct buffer *b;
683 b->filename = Qnil;
684 b->file_truename = Qnil;
685 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
686 b->modtime = 0;
687 XSETFASTINT (b->save_length, 0);
688 b->last_window_start = 1;
689 /* It is more conservative to start out "changed" than "unchanged". */
690 b->clip_changed = 0;
691 b->prevent_redisplay_optimizations_p = 1;
692 b->backed_up = Qnil;
693 b->auto_save_modified = 0;
694 b->auto_save_failure_time = -1;
695 b->auto_save_file_name = Qnil;
696 b->read_only = Qnil;
697 b->overlays_before = NULL;
698 b->overlays_after = NULL;
699 b->overlay_center = BEG;
700 b->mark_active = Qnil;
701 b->point_before_scroll = Qnil;
702 b->file_format = Qnil;
703 b->auto_save_file_format = Qt;
704 b->last_selected_window = Qnil;
705 XSETINT (b->display_count, 0);
706 b->display_time = Qnil;
707 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
708 b->cursor_type = buffer_defaults.cursor_type;
709 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
711 b->display_error_modiff = 0;
714 /* Reset buffer B's local variables info.
715 Don't use this on a buffer that has already been in use;
716 it does not treat permanent locals consistently.
717 Instead, use Fkill_all_local_variables.
719 If PERMANENT_TOO is 1, then we reset permanent built-in
720 buffer-local variables. If PERMANENT_TOO is 0,
721 we preserve those. */
723 static void
724 reset_buffer_local_variables (b, permanent_too)
725 register struct buffer *b;
726 int permanent_too;
728 register int offset;
729 int i;
731 /* Reset the major mode to Fundamental, together with all the
732 things that depend on the major mode.
733 default-major-mode is handled at a higher level.
734 We ignore it here. */
735 b->major_mode = Qfundamental_mode;
736 b->keymap = Qnil;
737 b->mode_name = QSFundamental;
738 b->minor_modes = Qnil;
740 /* If the standard case table has been altered and invalidated,
741 fix up its insides first. */
742 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
743 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
744 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
745 Fset_standard_case_table (Vascii_downcase_table);
747 b->downcase_table = Vascii_downcase_table;
748 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
749 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
750 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
751 b->invisibility_spec = Qt;
752 #ifndef DOS_NT
753 b->buffer_file_type = Qnil;
754 #endif
756 /* Reset all (or most) per-buffer variables to their defaults. */
757 b->local_var_alist = Qnil;
758 for (i = 0; i < last_per_buffer_idx; ++i)
759 if (permanent_too || buffer_permanent_local_flags[i] == 0)
760 SET_PER_BUFFER_VALUE_P (b, i, 0);
762 /* For each slot that has a default value,
763 copy that into the slot. */
765 for (offset = PER_BUFFER_VAR_OFFSET (name);
766 offset < sizeof *b;
767 offset += sizeof (Lisp_Object))
769 int idx = PER_BUFFER_IDX (offset);
770 if ((idx > 0
771 && (permanent_too
772 || buffer_permanent_local_flags[idx] == 0))
773 /* Is -2 used anywhere? */
774 || idx == -2)
775 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
779 /* We split this away from generate-new-buffer, because rename-buffer
780 and set-visited-file-name ought to be able to use this to really
781 rename the buffer properly. */
783 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
784 1, 2, 0,
785 doc: /* Return a string that is the name of no existing buffer based on NAME.
786 If there is no live buffer named NAME, then return NAME.
787 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
788 \(starting at 2) until an unused name is found, and then return that name.
789 Optional second argument IGNORE specifies a name that is okay to use (if
790 it is in the sequence to be tried) even if a buffer with that name exists. */)
791 (name, ignore)
792 register Lisp_Object name, ignore;
794 register Lisp_Object gentemp, tem;
795 int count;
796 char number[10];
798 CHECK_STRING (name);
800 tem = Fstring_equal (name, ignore);
801 if (!NILP (tem))
802 return name;
803 tem = Fget_buffer (name);
804 if (NILP (tem))
805 return name;
807 count = 1;
808 while (1)
810 sprintf (number, "<%d>", ++count);
811 gentemp = concat2 (name, build_string (number));
812 tem = Fstring_equal (gentemp, ignore);
813 if (!NILP (tem))
814 return gentemp;
815 tem = Fget_buffer (gentemp);
816 if (NILP (tem))
817 return gentemp;
822 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
823 doc: /* Return the name of BUFFER, as a string.
824 With no argument or nil as argument, return the name of the current buffer. */)
825 (buffer)
826 register Lisp_Object buffer;
828 if (NILP (buffer))
829 return current_buffer->name;
830 CHECK_BUFFER (buffer);
831 return XBUFFER (buffer)->name;
834 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
835 doc: /* Return name of file BUFFER is visiting, or nil if none.
836 No argument or nil as argument means use the current buffer. */)
837 (buffer)
838 register Lisp_Object buffer;
840 if (NILP (buffer))
841 return current_buffer->filename;
842 CHECK_BUFFER (buffer);
843 return XBUFFER (buffer)->filename;
846 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
847 0, 1, 0,
848 doc: /* Return the base buffer of indirect buffer BUFFER.
849 If BUFFER is not indirect, return nil.
850 BUFFER defaults to the current buffer. */)
851 (buffer)
852 register Lisp_Object buffer;
854 struct buffer *base;
855 Lisp_Object base_buffer;
857 if (NILP (buffer))
858 base = current_buffer->base_buffer;
859 else
861 CHECK_BUFFER (buffer);
862 base = XBUFFER (buffer)->base_buffer;
865 if (! base)
866 return Qnil;
867 XSETBUFFER (base_buffer, base);
868 return base_buffer;
871 DEFUN ("buffer-local-value", Fbuffer_local_value,
872 Sbuffer_local_value, 2, 2, 0,
873 doc: /* Return the value of VARIABLE in BUFFER.
874 If VARIABLE does not have a buffer-local binding in BUFFER, the value
875 is the default binding of the variable. */)
876 (variable, buffer)
877 register Lisp_Object variable;
878 register Lisp_Object buffer;
880 register struct buffer *buf;
881 register Lisp_Object result;
883 CHECK_SYMBOL (variable);
884 CHECK_BUFFER (buffer);
885 buf = XBUFFER (buffer);
887 variable = indirect_variable (variable);
889 /* Look in local_var_list */
890 result = Fassoc (variable, buf->local_var_alist);
891 if (NILP (result))
893 int offset, idx;
894 int found = 0;
896 /* Look in special slots */
897 for (offset = PER_BUFFER_VAR_OFFSET (name);
898 offset < sizeof (struct buffer);
899 /* sizeof EMACS_INT == sizeof Lisp_Object */
900 offset += (sizeof (EMACS_INT)))
902 idx = PER_BUFFER_IDX (offset);
903 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
904 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
905 && EQ (PER_BUFFER_SYMBOL (offset), variable))
907 result = PER_BUFFER_VALUE (buf, offset);
908 found = 1;
909 break;
913 if (!found)
914 result = Fdefault_value (variable);
916 else
918 Lisp_Object valcontents;
919 Lisp_Object current_alist_element;
921 /* What binding is loaded right now? */
922 valcontents = SYMBOL_VALUE (variable);
923 current_alist_element
924 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
926 /* The value of the currently loaded binding is not
927 stored in it, but rather in the realvalue slot.
928 Store that value into the binding it belongs to
929 in case that is the one we are about to use. */
931 Fsetcdr (current_alist_element,
932 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
934 /* Now get the (perhaps updated) value out of the binding. */
935 result = XCDR (result);
938 if (!EQ (result, Qunbound))
939 return result;
941 xsignal1 (Qvoid_variable, variable);
944 /* Return an alist of the Lisp-level buffer-local bindings of
945 buffer BUF. That is, don't include the variables maintained
946 in special slots in the buffer object. */
948 static Lisp_Object
949 buffer_lisp_local_variables (buf)
950 struct buffer *buf;
952 Lisp_Object result = Qnil;
953 register Lisp_Object tail;
954 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
956 Lisp_Object val, elt;
958 elt = XCAR (tail);
960 /* Reference each variable in the alist in buf.
961 If inquiring about the current buffer, this gets the current values,
962 so store them into the alist so the alist is up to date.
963 If inquiring about some other buffer, this swaps out any values
964 for that buffer, making the alist up to date automatically. */
965 val = find_symbol_value (XCAR (elt));
966 /* Use the current buffer value only if buf is the current buffer. */
967 if (buf != current_buffer)
968 val = XCDR (elt);
970 /* If symbol is unbound, put just the symbol in the list. */
971 if (EQ (val, Qunbound))
972 result = Fcons (XCAR (elt), result);
973 /* Otherwise, put (symbol . value) in the list. */
974 else
975 result = Fcons (Fcons (XCAR (elt), val), result);
978 return result;
981 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
982 Sbuffer_local_variables, 0, 1, 0,
983 doc: /* Return an alist of variables that are buffer-local in BUFFER.
984 Most elements look like (SYMBOL . VALUE), describing one variable.
985 For a symbol that is locally unbound, just the symbol appears in the value.
986 Note that storing new VALUEs in these elements doesn't change the variables.
987 No argument or nil as argument means use current buffer as BUFFER. */)
988 (buffer)
989 register Lisp_Object buffer;
991 register struct buffer *buf;
992 register Lisp_Object result;
994 if (NILP (buffer))
995 buf = current_buffer;
996 else
998 CHECK_BUFFER (buffer);
999 buf = XBUFFER (buffer);
1002 result = buffer_lisp_local_variables (buf);
1004 /* Add on all the variables stored in special slots. */
1006 int offset, idx;
1008 for (offset = PER_BUFFER_VAR_OFFSET (name);
1009 offset < sizeof (struct buffer);
1010 /* sizeof EMACS_INT == sizeof Lisp_Object */
1011 offset += (sizeof (EMACS_INT)))
1013 idx = PER_BUFFER_IDX (offset);
1014 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1015 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1016 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1017 PER_BUFFER_VALUE (buf, offset)),
1018 result);
1022 return result;
1025 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1026 0, 1, 0,
1027 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1028 No argument or nil as argument means use current buffer as BUFFER. */)
1029 (buffer)
1030 register Lisp_Object buffer;
1032 register struct buffer *buf;
1033 if (NILP (buffer))
1034 buf = current_buffer;
1035 else
1037 CHECK_BUFFER (buffer);
1038 buf = XBUFFER (buffer);
1041 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1044 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1045 1, 1, 0,
1046 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1047 A non-nil FLAG means mark the buffer modified. */)
1048 (flag)
1049 register Lisp_Object flag;
1051 register int already;
1052 register Lisp_Object fn;
1053 Lisp_Object buffer, window;
1055 #ifdef CLASH_DETECTION
1056 /* If buffer becoming modified, lock the file.
1057 If buffer becoming unmodified, unlock the file. */
1059 fn = current_buffer->file_truename;
1060 /* Test buffer-file-name so that binding it to nil is effective. */
1061 if (!NILP (fn) && ! NILP (current_buffer->filename))
1063 already = SAVE_MODIFF < MODIFF;
1064 if (!already && !NILP (flag))
1065 lock_file (fn);
1066 else if (already && NILP (flag))
1067 unlock_file (fn);
1069 #endif /* CLASH_DETECTION */
1071 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1073 /* Set update_mode_lines only if buffer is displayed in some window.
1074 Packages like jit-lock or lazy-lock preserve a buffer's modified
1075 state by recording/restoring the state around blocks of code.
1076 Setting update_mode_lines makes redisplay consider all windows
1077 (on all frames). Stealth fontification of buffers not displayed
1078 would incur additional redisplay costs if we'd set
1079 update_modes_lines unconditionally.
1081 Ideally, I think there should be another mechanism for fontifying
1082 buffers without "modifying" buffers, or redisplay should be
1083 smarter about updating the `*' in mode lines. --gerd */
1084 XSETBUFFER (buffer, current_buffer);
1085 window = Fget_buffer_window (buffer, Qt);
1086 if (WINDOWP (window))
1088 ++update_mode_lines;
1089 current_buffer->prevent_redisplay_optimizations_p = 1;
1092 return flag;
1095 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1096 Srestore_buffer_modified_p, 1, 1, 0,
1097 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1098 It is not ensured that mode lines will be updated to show the modified
1099 state of the current buffer. Use with care. */)
1100 (flag)
1101 Lisp_Object flag;
1103 #ifdef CLASH_DETECTION
1104 Lisp_Object fn;
1106 /* If buffer becoming modified, lock the file.
1107 If buffer becoming unmodified, unlock the file. */
1109 fn = current_buffer->file_truename;
1110 /* Test buffer-file-name so that binding it to nil is effective. */
1111 if (!NILP (fn) && ! NILP (current_buffer->filename))
1113 int already = SAVE_MODIFF < MODIFF;
1114 if (!already && !NILP (flag))
1115 lock_file (fn);
1116 else if (already && NILP (flag))
1117 unlock_file (fn);
1119 #endif /* CLASH_DETECTION */
1121 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1122 return flag;
1125 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1126 0, 1, 0,
1127 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1128 Each buffer has a tick counter which is incremented each time the
1129 text in that buffer is changed. It wraps around occasionally.
1130 No argument or nil as argument means use current buffer as BUFFER. */)
1131 (buffer)
1132 register Lisp_Object buffer;
1134 register struct buffer *buf;
1135 if (NILP (buffer))
1136 buf = current_buffer;
1137 else
1139 CHECK_BUFFER (buffer);
1140 buf = XBUFFER (buffer);
1143 return make_number (BUF_MODIFF (buf));
1146 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1147 Sbuffer_chars_modified_tick, 0, 1, 0,
1148 doc: /* Return BUFFER's character-change tick counter.
1149 Each buffer has a character-change tick counter, which is set to the
1150 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1151 time text in that buffer is inserted or deleted. By comparing the
1152 values returned by two individual calls of `buffer-chars-modified-tick',
1153 you can tell whether a character change occurred in that buffer in
1154 between these calls. No argument or nil as argument means use current
1155 buffer as BUFFER. */)
1156 (buffer)
1157 register Lisp_Object buffer;
1159 register struct buffer *buf;
1160 if (NILP (buffer))
1161 buf = current_buffer;
1162 else
1164 CHECK_BUFFER (buffer);
1165 buf = XBUFFER (buffer);
1168 return make_number (BUF_CHARS_MODIFF (buf));
1171 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1172 "sRename buffer (to new name): \nP",
1173 doc: /* Change current buffer's name to NEWNAME (a string).
1174 If second arg UNIQUE is nil or omitted, it is an error if a
1175 buffer named NEWNAME already exists.
1176 If UNIQUE is non-nil, come up with a new name using
1177 `generate-new-buffer-name'.
1178 Interactively, you can set UNIQUE with a prefix argument.
1179 We return the name we actually gave the buffer.
1180 This does not change the name of the visited file (if any). */)
1181 (newname, unique)
1182 register Lisp_Object newname, unique;
1184 register Lisp_Object tem, buf;
1186 CHECK_STRING (newname);
1188 if (SCHARS (newname) == 0)
1189 error ("Empty string is invalid as a buffer name");
1191 tem = Fget_buffer (newname);
1192 if (!NILP (tem))
1194 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1195 rename the buffer automatically so you can create another
1196 with the original name. It makes UNIQUE equivalent to
1197 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1198 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1199 return current_buffer->name;
1200 if (!NILP (unique))
1201 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1202 else
1203 error ("Buffer name `%s' is in use", SDATA (newname));
1206 current_buffer->name = newname;
1208 /* Catch redisplay's attention. Unless we do this, the mode lines for
1209 any windows displaying current_buffer will stay unchanged. */
1210 update_mode_lines++;
1212 XSETBUFFER (buf, current_buffer);
1213 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1214 if (NILP (current_buffer->filename)
1215 && !NILP (current_buffer->auto_save_file_name))
1216 call0 (intern ("rename-auto-save-file"));
1217 /* Refetch since that last call may have done GC. */
1218 return current_buffer->name;
1221 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1222 doc: /* Return most recently selected buffer other than BUFFER.
1223 Buffers not visible in windows are preferred to visible buffers,
1224 unless optional second argument VISIBLE-OK is non-nil.
1225 If the optional third argument FRAME is non-nil, use that frame's
1226 buffer list instead of the selected frame's buffer list.
1227 If no other buffer exists, the buffer `*scratch*' is returned.
1228 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1229 (buffer, visible_ok, frame)
1230 register Lisp_Object buffer, visible_ok, frame;
1232 Lisp_Object Fset_buffer_major_mode ();
1233 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1234 notsogood = Qnil;
1236 if (NILP (frame))
1237 frame = selected_frame;
1239 tail = Vbuffer_alist;
1240 pred = frame_buffer_predicate (frame);
1242 /* Consider buffers that have been seen in the selected frame
1243 before other buffers. */
1245 tem = frame_buffer_list (frame);
1246 add_ons = Qnil;
1247 while (CONSP (tem))
1249 if (BUFFERP (XCAR (tem)))
1250 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1251 tem = XCDR (tem);
1253 tail = nconc2 (Fnreverse (add_ons), tail);
1255 for (; CONSP (tail); tail = XCDR (tail))
1257 buf = Fcdr (XCAR (tail));
1258 if (EQ (buf, buffer))
1259 continue;
1260 if (NILP (buf))
1261 continue;
1262 if (NILP (XBUFFER (buf)->name))
1263 continue;
1264 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1265 continue;
1266 /* If the selected frame has a buffer_predicate,
1267 disregard buffers that don't fit the predicate. */
1268 if (!NILP (pred))
1270 tem = call1 (pred, buf);
1271 if (NILP (tem))
1272 continue;
1275 if (NILP (visible_ok))
1276 tem = Fget_buffer_window (buf, Qvisible);
1277 else
1278 tem = Qnil;
1279 if (NILP (tem))
1280 return buf;
1281 if (NILP (notsogood))
1282 notsogood = buf;
1284 if (!NILP (notsogood))
1285 return notsogood;
1286 buf = Fget_buffer (build_string ("*scratch*"));
1287 if (NILP (buf))
1289 buf = Fget_buffer_create (build_string ("*scratch*"));
1290 Fset_buffer_major_mode (buf);
1292 return buf;
1295 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1296 0, 1, "",
1297 doc: /* Start keeping undo information for buffer BUFFER.
1298 No argument or nil as argument means do this for the current buffer. */)
1299 (buffer)
1300 register Lisp_Object buffer;
1302 Lisp_Object real_buffer;
1304 if (NILP (buffer))
1305 XSETBUFFER (real_buffer, current_buffer);
1306 else
1308 real_buffer = Fget_buffer (buffer);
1309 if (NILP (real_buffer))
1310 nsberror (buffer);
1313 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1314 XBUFFER (real_buffer)->undo_list = Qnil;
1316 return Qnil;
1320 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1321 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1322 The buffer being killed will be current while the hook is running.\n\
1323 See `kill-buffer'."
1325 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1326 doc: /* Kill the buffer BUFFER.
1327 The argument may be a buffer or the name of a buffer.
1328 With a nil argument, kill the current buffer.
1330 Value is t if the buffer is actually killed, nil otherwise.
1332 The functions in `kill-buffer-query-functions' are called with BUFFER as
1333 the current buffer. If any of them returns nil, the buffer is not killed.
1335 The hook `kill-buffer-hook' is run before the buffer is actually killed.
1336 The buffer being killed will be current while the hook is running.
1338 Any processes that have this buffer as the `process-buffer' are killed
1339 with SIGHUP. */)
1340 (buffer)
1341 Lisp_Object buffer;
1343 Lisp_Object buf;
1344 register struct buffer *b;
1345 register Lisp_Object tem;
1346 register struct Lisp_Marker *m;
1347 struct gcpro gcpro1;
1349 if (NILP (buffer))
1350 buf = Fcurrent_buffer ();
1351 else
1352 buf = Fget_buffer (buffer);
1353 if (NILP (buf))
1354 nsberror (buffer);
1356 b = XBUFFER (buf);
1358 /* Avoid trouble for buffer already dead. */
1359 if (NILP (b->name))
1360 return Qnil;
1362 /* Query if the buffer is still modified. */
1363 if (INTERACTIVE && !NILP (b->filename)
1364 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1366 GCPRO1 (buf);
1367 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1368 b->name, make_number (0)));
1369 UNGCPRO;
1370 if (NILP (tem))
1371 return Qnil;
1374 /* Run hooks with the buffer to be killed the current buffer. */
1376 int count = SPECPDL_INDEX ();
1377 Lisp_Object arglist[1];
1379 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1380 set_buffer_internal (b);
1382 /* First run the query functions; if any query is answered no,
1383 don't kill the buffer. */
1384 arglist[0] = Qkill_buffer_query_functions;
1385 tem = Frun_hook_with_args_until_failure (1, arglist);
1386 if (NILP (tem))
1387 return unbind_to (count, Qnil);
1389 /* Then run the hooks. */
1390 Frun_hooks (1, &Qkill_buffer_hook);
1391 unbind_to (count, Qnil);
1394 /* We have no more questions to ask. Verify that it is valid
1395 to kill the buffer. This must be done after the questions
1396 since anything can happen within do_yes_or_no_p. */
1398 /* Don't kill the minibuffer now current. */
1399 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1400 return Qnil;
1402 if (NILP (b->name))
1403 return Qnil;
1405 /* When we kill a base buffer, kill all its indirect buffers.
1406 We do it at this stage so nothing terrible happens if they
1407 ask questions or their hooks get errors. */
1408 if (! b->base_buffer)
1410 struct buffer *other;
1412 GCPRO1 (buf);
1414 for (other = all_buffers; other; other = other->next)
1415 /* all_buffers contains dead buffers too;
1416 don't re-kill them. */
1417 if (other->base_buffer == b && !NILP (other->name))
1419 Lisp_Object buf;
1420 XSETBUFFER (buf, other);
1421 Fkill_buffer (buf);
1424 UNGCPRO;
1427 /* Make this buffer not be current.
1428 In the process, notice if this is the sole visible buffer
1429 and give up if so. */
1430 if (b == current_buffer)
1432 tem = Fother_buffer (buf, Qnil, Qnil);
1433 Fset_buffer (tem);
1434 if (b == current_buffer)
1435 return Qnil;
1438 /* Notice if the buffer to kill is the sole visible buffer
1439 when we're currently in the mini-buffer, and give up if so. */
1440 XSETBUFFER (tem, current_buffer);
1441 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1443 tem = Fother_buffer (buf, Qnil, Qnil);
1444 if (EQ (buf, tem))
1445 return Qnil;
1448 /* Now there is no question: we can kill the buffer. */
1450 #ifdef CLASH_DETECTION
1451 /* Unlock this buffer's file, if it is locked. */
1452 unlock_buffer (b);
1453 #endif /* CLASH_DETECTION */
1455 GCPRO1 (buf);
1456 kill_buffer_processes (buf);
1457 UNGCPRO;
1459 /* Killing buffer processes may run sentinels which may
1460 have called kill-buffer. */
1462 if (NILP (b->name))
1463 return Qnil;
1465 clear_charpos_cache (b);
1467 tem = Vinhibit_quit;
1468 Vinhibit_quit = Qt;
1469 replace_buffer_in_all_windows (buf);
1470 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1471 frames_discard_buffer (buf);
1472 Vinhibit_quit = tem;
1474 /* Delete any auto-save file, if we saved it in this session.
1475 But not if the buffer is modified. */
1476 if (STRINGP (b->auto_save_file_name)
1477 && b->auto_save_modified != 0
1478 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1479 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1480 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1482 Lisp_Object tem;
1483 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1484 if (! NILP (tem))
1485 internal_delete_file (b->auto_save_file_name);
1488 if (b->base_buffer)
1490 /* Unchain all markers that belong to this indirect buffer.
1491 Don't unchain the markers that belong to the base buffer
1492 or its other indirect buffers. */
1493 for (m = BUF_MARKERS (b); m; )
1495 struct Lisp_Marker *next = m->next;
1496 if (m->buffer == b)
1497 unchain_marker (m);
1498 m = next;
1501 else
1503 /* Unchain all markers of this buffer and its indirect buffers.
1504 and leave them pointing nowhere. */
1505 for (m = BUF_MARKERS (b); m; )
1507 struct Lisp_Marker *next = m->next;
1508 m->buffer = 0;
1509 m->next = NULL;
1510 m = next;
1512 BUF_MARKERS (b) = NULL;
1513 BUF_INTERVALS (b) = NULL_INTERVAL;
1515 /* Perhaps we should explicitly free the interval tree here... */
1518 /* Reset the local variables, so that this buffer's local values
1519 won't be protected from GC. They would be protected
1520 if they happened to remain encached in their symbols.
1521 This gets rid of them for certain. */
1522 swap_out_buffer_local_variables (b);
1523 reset_buffer_local_variables (b, 1);
1525 b->name = Qnil;
1527 BLOCK_INPUT;
1528 if (! b->base_buffer)
1529 free_buffer_text (b);
1531 if (b->newline_cache)
1533 free_region_cache (b->newline_cache);
1534 b->newline_cache = 0;
1536 if (b->width_run_cache)
1538 free_region_cache (b->width_run_cache);
1539 b->width_run_cache = 0;
1541 b->width_table = Qnil;
1542 UNBLOCK_INPUT;
1543 b->undo_list = Qnil;
1545 return Qt;
1548 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1549 we do this each time BUF is selected visibly, the more recently
1550 selected buffers are always closer to the front of the list. This
1551 means that other_buffer is more likely to choose a relevant buffer. */
1553 void
1554 record_buffer (buf)
1555 Lisp_Object buf;
1557 register Lisp_Object link, prev;
1558 Lisp_Object frame;
1559 frame = selected_frame;
1561 prev = Qnil;
1562 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1564 if (EQ (XCDR (XCAR (link)), buf))
1565 break;
1566 prev = link;
1569 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1570 we cannot use Fdelq itself here because it allows quitting. */
1572 if (NILP (prev))
1573 Vbuffer_alist = XCDR (Vbuffer_alist);
1574 else
1575 XSETCDR (prev, XCDR (XCDR (prev)));
1577 XSETCDR (link, Vbuffer_alist);
1578 Vbuffer_alist = link;
1580 /* Effectively do a delq on buried_buffer_list. */
1582 prev = Qnil;
1583 for (link = XFRAME (frame)->buried_buffer_list; CONSP (link);
1584 link = XCDR (link))
1586 if (EQ (XCAR (link), buf))
1588 if (NILP (prev))
1589 XFRAME (frame)->buried_buffer_list = XCDR (link);
1590 else
1591 XSETCDR (prev, XCDR (XCDR (prev)));
1592 break;
1594 prev = link;
1597 /* Now move this buffer to the front of frame_buffer_list also. */
1599 prev = Qnil;
1600 for (link = frame_buffer_list (frame); CONSP (link);
1601 link = XCDR (link))
1603 if (EQ (XCAR (link), buf))
1604 break;
1605 prev = link;
1608 /* Effectively do delq. */
1610 if (CONSP (link))
1612 if (NILP (prev))
1613 set_frame_buffer_list (frame,
1614 XCDR (frame_buffer_list (frame)));
1615 else
1616 XSETCDR (prev, XCDR (XCDR (prev)));
1618 XSETCDR (link, frame_buffer_list (frame));
1619 set_frame_buffer_list (frame, link);
1621 else
1622 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1625 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1626 doc: /* Set an appropriate major mode for BUFFER.
1627 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1628 according to `default-major-mode'.
1629 Use this function before selecting the buffer, since it may need to inspect
1630 the current buffer's major mode. */)
1631 (buffer)
1632 Lisp_Object buffer;
1634 int count;
1635 Lisp_Object function;
1637 CHECK_BUFFER (buffer);
1639 if (STRINGP (XBUFFER (buffer)->name)
1640 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1641 function = find_symbol_value (intern ("initial-major-mode"));
1642 else
1644 function = buffer_defaults.major_mode;
1645 if (NILP (function)
1646 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1647 function = current_buffer->major_mode;
1650 if (NILP (function) || EQ (function, Qfundamental_mode))
1651 return Qnil;
1653 count = SPECPDL_INDEX ();
1655 /* To select a nonfundamental mode,
1656 select the buffer temporarily and then call the mode function. */
1658 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1660 Fset_buffer (buffer);
1661 call0 (function);
1663 return unbind_to (count, Qnil);
1666 /* If switching buffers in WINDOW would be an error, return
1667 a C string saying what the error would be. */
1669 char *
1670 no_switch_window (window)
1671 Lisp_Object window;
1673 Lisp_Object tem;
1674 if (EQ (minibuf_window, window))
1675 return "Cannot switch buffers in minibuffer window";
1676 tem = Fwindow_dedicated_p (window);
1677 if (EQ (tem, Qt))
1678 return "Cannot switch buffers in a dedicated window";
1679 return NULL;
1682 /* Switch to buffer BUFFER in the selected window.
1683 If NORECORD is non-nil, don't call record_buffer. */
1685 Lisp_Object
1686 switch_to_buffer_1 (buffer, norecord)
1687 Lisp_Object buffer, norecord;
1689 register Lisp_Object buf;
1691 if (NILP (buffer))
1692 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1693 else
1695 buf = Fget_buffer (buffer);
1696 if (NILP (buf))
1698 buf = Fget_buffer_create (buffer);
1699 Fset_buffer_major_mode (buf);
1702 Fset_buffer (buf);
1703 if (NILP (norecord))
1704 record_buffer (buf);
1706 Fset_window_buffer (EQ (selected_window, minibuf_window)
1707 ? Fnext_window (minibuf_window, Qnil, Qnil)
1708 : selected_window,
1709 buf, Qnil);
1711 return buf;
1714 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1715 doc: /* Select buffer BUFFER in the current window.
1716 If BUFFER does not identify an existing buffer,
1717 then this function creates a buffer with that name.
1719 When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1720 or nil. If BUFFER is nil, then this function chooses a buffer
1721 using `other-buffer'.
1722 Optional second arg NORECORD non-nil means
1723 do not put this buffer at the front of the list of recently selected ones.
1724 This function returns the buffer it switched to.
1726 WARNING: This is NOT the way to work on another buffer temporarily
1727 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1728 the window-buffer correspondences. */)
1729 (buffer, norecord)
1730 Lisp_Object buffer, norecord;
1732 char *err;
1734 if (EQ (buffer, Fwindow_buffer (selected_window)))
1736 /* Basically a NOP. Avoid signalling an error in the case where
1737 the selected window is dedicated, or a minibuffer. */
1739 /* But do put this buffer at the front of the buffer list,
1740 unless that has been inhibited. Note that even if
1741 BUFFER is at the front of the main buffer-list already,
1742 we still want to move it to the front of the frame's buffer list. */
1743 if (NILP (norecord))
1744 record_buffer (buffer);
1745 return Fset_buffer (buffer);
1748 err = no_switch_window (selected_window);
1749 if (err) error (err);
1751 return switch_to_buffer_1 (buffer, norecord);
1754 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1755 doc: /* Select buffer BUFFER in some window, preferably a different one.
1756 BUFFER may be a buffer, a string \(a buffer name), or nil.
1757 If BUFFER is a string which is not the name of an existing buffer,
1758 then this function creates a buffer with that name.
1759 If BUFFER is nil, then it chooses some other buffer.
1760 If `pop-up-windows' is non-nil, windows can be split to do this.
1761 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1762 window even if BUFFER is already visible in the selected window,
1763 and ignore `same-window-regexps' and `same-window-buffer-names'.
1764 This function returns the buffer it switched to.
1765 This uses the function `display-buffer' as a subroutine; see the documentation
1766 of `display-buffer' for additional customization information.
1768 Optional third arg NORECORD non-nil means
1769 do not put this buffer at the front of the list of recently selected ones. */)
1770 (buffer, other_window, norecord)
1771 Lisp_Object buffer, other_window, norecord;
1773 register Lisp_Object buf;
1774 if (NILP (buffer))
1775 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1776 else
1778 buf = Fget_buffer (buffer);
1779 if (NILP (buf))
1781 buf = Fget_buffer_create (buffer);
1782 Fset_buffer_major_mode (buf);
1785 Fset_buffer (buf);
1786 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1787 return buf;
1790 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1791 doc: /* Return the current buffer as a Lisp object. */)
1794 register Lisp_Object buf;
1795 XSETBUFFER (buf, current_buffer);
1796 return buf;
1799 /* Set the current buffer to B.
1801 We previously set windows_or_buffers_changed here to invalidate
1802 global unchanged information in beg_unchanged and end_unchanged.
1803 This is no longer necessary because we now compute unchanged
1804 information on a buffer-basis. Every action affecting other
1805 windows than the selected one requires a select_window at some
1806 time, and that increments windows_or_buffers_changed. */
1808 void
1809 set_buffer_internal (b)
1810 register struct buffer *b;
1812 if (current_buffer != b)
1813 set_buffer_internal_1 (b);
1816 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1817 This is used by redisplay. */
1819 void
1820 set_buffer_internal_1 (b)
1821 register struct buffer *b;
1823 register struct buffer *old_buf;
1824 register Lisp_Object tail, valcontents;
1825 Lisp_Object tem;
1827 #ifdef USE_MMAP_FOR_BUFFERS
1828 if (b->text->beg == NULL)
1829 enlarge_buffer_text (b, 0);
1830 #endif /* USE_MMAP_FOR_BUFFERS */
1832 if (current_buffer == b)
1833 return;
1835 old_buf = current_buffer;
1836 current_buffer = b;
1837 last_known_column_point = -1; /* invalidate indentation cache */
1839 if (old_buf)
1841 /* Put the undo list back in the base buffer, so that it appears
1842 that an indirect buffer shares the undo list of its base. */
1843 if (old_buf->base_buffer)
1844 old_buf->base_buffer->undo_list = old_buf->undo_list;
1846 /* If the old current buffer has markers to record PT, BEGV and ZV
1847 when it is not current, update them now. */
1848 if (! NILP (old_buf->pt_marker))
1850 Lisp_Object obuf;
1851 XSETBUFFER (obuf, old_buf);
1852 set_marker_both (old_buf->pt_marker, obuf,
1853 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1855 if (! NILP (old_buf->begv_marker))
1857 Lisp_Object obuf;
1858 XSETBUFFER (obuf, old_buf);
1859 set_marker_both (old_buf->begv_marker, obuf,
1860 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1862 if (! NILP (old_buf->zv_marker))
1864 Lisp_Object obuf;
1865 XSETBUFFER (obuf, old_buf);
1866 set_marker_both (old_buf->zv_marker, obuf,
1867 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1871 /* Get the undo list from the base buffer, so that it appears
1872 that an indirect buffer shares the undo list of its base. */
1873 if (b->base_buffer)
1874 b->undo_list = b->base_buffer->undo_list;
1876 /* If the new current buffer has markers to record PT, BEGV and ZV
1877 when it is not current, fetch them now. */
1878 if (! NILP (b->pt_marker))
1880 BUF_PT (b) = marker_position (b->pt_marker);
1881 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1883 if (! NILP (b->begv_marker))
1885 BUF_BEGV (b) = marker_position (b->begv_marker);
1886 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1888 if (! NILP (b->zv_marker))
1890 BUF_ZV (b) = marker_position (b->zv_marker);
1891 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1894 /* Look down buffer's list of local Lisp variables
1895 to find and update any that forward into C variables. */
1897 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1899 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1900 if ((BUFFER_LOCAL_VALUEP (valcontents))
1901 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1902 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1903 /* Just reference the variable
1904 to cause it to become set for this buffer. */
1905 Fsymbol_value (XCAR (XCAR (tail)));
1908 /* Do the same with any others that were local to the previous buffer */
1910 if (old_buf)
1911 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1913 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1914 if ((BUFFER_LOCAL_VALUEP (valcontents))
1915 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1916 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1917 /* Just reference the variable
1918 to cause it to become set for this buffer. */
1919 Fsymbol_value (XCAR (XCAR (tail)));
1923 /* Switch to buffer B temporarily for redisplay purposes.
1924 This avoids certain things that don't need to be done within redisplay. */
1926 void
1927 set_buffer_temp (b)
1928 struct buffer *b;
1930 register struct buffer *old_buf;
1932 if (current_buffer == b)
1933 return;
1935 old_buf = current_buffer;
1936 current_buffer = b;
1938 if (old_buf)
1940 /* If the old current buffer has markers to record PT, BEGV and ZV
1941 when it is not current, update them now. */
1942 if (! NILP (old_buf->pt_marker))
1944 Lisp_Object obuf;
1945 XSETBUFFER (obuf, old_buf);
1946 set_marker_both (old_buf->pt_marker, obuf,
1947 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1949 if (! NILP (old_buf->begv_marker))
1951 Lisp_Object obuf;
1952 XSETBUFFER (obuf, old_buf);
1953 set_marker_both (old_buf->begv_marker, obuf,
1954 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1956 if (! NILP (old_buf->zv_marker))
1958 Lisp_Object obuf;
1959 XSETBUFFER (obuf, old_buf);
1960 set_marker_both (old_buf->zv_marker, obuf,
1961 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1965 /* If the new current buffer has markers to record PT, BEGV and ZV
1966 when it is not current, fetch them now. */
1967 if (! NILP (b->pt_marker))
1969 BUF_PT (b) = marker_position (b->pt_marker);
1970 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1972 if (! NILP (b->begv_marker))
1974 BUF_BEGV (b) = marker_position (b->begv_marker);
1975 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1977 if (! NILP (b->zv_marker))
1979 BUF_ZV (b) = marker_position (b->zv_marker);
1980 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1984 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1985 doc: /* Make the buffer BUFFER current for editing operations.
1986 BUFFER may be a buffer or the name of an existing buffer.
1987 See also `save-excursion' when you want to make a buffer current temporarily.
1988 This function does not display the buffer, so its effect ends
1989 when the current command terminates.
1990 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1991 (buffer)
1992 register Lisp_Object buffer;
1994 register Lisp_Object buf;
1995 buf = Fget_buffer (buffer);
1996 if (NILP (buf))
1997 nsberror (buffer);
1998 if (NILP (XBUFFER (buf)->name))
1999 error ("Selecting deleted buffer");
2000 set_buffer_internal (XBUFFER (buf));
2001 return buf;
2004 /* Set the current buffer to BUFFER provided it is alive. */
2006 Lisp_Object
2007 set_buffer_if_live (buffer)
2008 Lisp_Object buffer;
2010 if (! NILP (XBUFFER (buffer)->name))
2011 Fset_buffer (buffer);
2012 return Qnil;
2015 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
2016 Sbarf_if_buffer_read_only, 0, 0, 0,
2017 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2020 if (!NILP (current_buffer->read_only)
2021 && NILP (Vinhibit_read_only))
2022 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2023 return Qnil;
2026 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
2027 doc: /* Put BUFFER at the end of the list of all buffers.
2028 There it is the least likely candidate for `other-buffer' to return;
2029 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
2030 You can specify a buffer name as BUFFER, or an actual buffer object.
2031 If BUFFER is nil or omitted, bury the current buffer.
2032 Also, if BUFFER is nil or omitted, remove the current buffer from the
2033 selected window if it is displayed there. */)
2034 (buffer)
2035 register Lisp_Object buffer;
2037 /* Figure out what buffer we're going to bury. */
2038 if (NILP (buffer))
2040 Lisp_Object tem;
2041 XSETBUFFER (buffer, current_buffer);
2043 tem = Fwindow_buffer (selected_window);
2044 /* If we're burying the current buffer, unshow it. */
2045 if (EQ (buffer, tem))
2047 if (NILP (Fwindow_dedicated_p (selected_window)))
2048 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
2049 else if (NILP (XWINDOW (selected_window)->parent))
2050 Ficonify_frame (Fwindow_frame (selected_window));
2051 else
2052 Fdelete_window (selected_window);
2055 else
2057 Lisp_Object buf1;
2059 buf1 = Fget_buffer (buffer);
2060 if (NILP (buf1))
2061 nsberror (buffer);
2062 buffer = buf1;
2065 /* Move buffer to the end of the buffer list. Do nothing if the
2066 buffer is killed. */
2067 if (!NILP (XBUFFER (buffer)->name))
2069 Lisp_Object aelt, link;
2071 aelt = Frassq (buffer, Vbuffer_alist);
2072 link = Fmemq (aelt, Vbuffer_alist);
2073 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2074 XSETCDR (link, Qnil);
2075 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2077 XFRAME (selected_frame)->buffer_list
2078 = Fdelq (buffer, XFRAME (selected_frame)->buffer_list);
2079 XFRAME (selected_frame)->buried_buffer_list
2080 = Fcons (buffer, Fdelq (buffer, XFRAME (selected_frame)->buried_buffer_list));
2083 return Qnil;
2086 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2087 doc: /* Delete the entire contents of the current buffer.
2088 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2089 so the buffer is truly empty after this. */)
2092 Fwiden ();
2094 del_range (BEG, Z);
2096 current_buffer->last_window_start = 1;
2097 /* Prevent warnings, or suspension of auto saving, that would happen
2098 if future size is less than past size. Use of erase-buffer
2099 implies that the future text is not really related to the past text. */
2100 XSETFASTINT (current_buffer->save_length, 0);
2101 return Qnil;
2104 void
2105 validate_region (b, e)
2106 register Lisp_Object *b, *e;
2108 CHECK_NUMBER_COERCE_MARKER (*b);
2109 CHECK_NUMBER_COERCE_MARKER (*e);
2111 if (XINT (*b) > XINT (*e))
2113 Lisp_Object tem;
2114 tem = *b; *b = *e; *e = tem;
2117 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2118 && XINT (*e) <= ZV))
2119 args_out_of_range (*b, *e);
2122 /* Advance BYTE_POS up to a character boundary
2123 and return the adjusted position. */
2125 static int
2126 advance_to_char_boundary (byte_pos)
2127 int byte_pos;
2129 int c;
2131 if (byte_pos == BEG)
2132 /* Beginning of buffer is always a character boundary. */
2133 return BEG;
2135 c = FETCH_BYTE (byte_pos);
2136 if (! CHAR_HEAD_P (c))
2138 /* We should advance BYTE_POS only when C is a constituent of a
2139 multibyte sequence. */
2140 int orig_byte_pos = byte_pos;
2144 byte_pos--;
2145 c = FETCH_BYTE (byte_pos);
2147 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2148 INC_POS (byte_pos);
2149 if (byte_pos < orig_byte_pos)
2150 byte_pos = orig_byte_pos;
2151 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2152 surely advance to the correct character boundary. If C is
2153 not, BYTE_POS was unchanged. */
2156 return byte_pos;
2159 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2160 1, 1, 0,
2161 doc: /* Set the multibyte flag of the current buffer to FLAG.
2162 If FLAG is t, this makes the buffer a multibyte buffer.
2163 If FLAG is nil, this makes the buffer a single-byte buffer.
2164 The buffer contents remain unchanged as a sequence of bytes
2165 but the contents viewed as characters do change.
2166 If the multibyte flag was really changed, undo information of the
2167 current buffer is cleared. */)
2168 (flag)
2169 Lisp_Object flag;
2171 struct Lisp_Marker *tail, *markers;
2172 struct buffer *other;
2173 int begv, zv;
2174 int narrowed = (BEG != BEGV || Z != ZV);
2175 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2176 Lisp_Object old_undo = current_buffer->undo_list;
2177 struct gcpro gcpro1;
2179 if (current_buffer->base_buffer)
2180 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2182 /* Do nothing if nothing actually changes. */
2183 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2184 return flag;
2186 GCPRO1 (old_undo);
2188 /* Don't record these buffer changes. We will put a special undo entry
2189 instead. */
2190 current_buffer->undo_list = Qt;
2192 /* If the cached position is for this buffer, clear it out. */
2193 clear_charpos_cache (current_buffer);
2195 if (NILP (flag))
2196 begv = BEGV_BYTE, zv = ZV_BYTE;
2197 else
2198 begv = BEGV, zv = ZV;
2200 if (narrowed)
2201 Fwiden ();
2203 if (NILP (flag))
2205 int pos, stop;
2206 unsigned char *p;
2208 /* Do this first, so it can use CHAR_TO_BYTE
2209 to calculate the old correspondences. */
2210 set_intervals_multibyte (0);
2212 current_buffer->enable_multibyte_characters = Qnil;
2214 Z = Z_BYTE;
2215 BEGV = BEGV_BYTE;
2216 ZV = ZV_BYTE;
2217 GPT = GPT_BYTE;
2218 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2221 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2222 tail->charpos = tail->bytepos;
2224 /* Convert multibyte form of 8-bit characters to unibyte. */
2225 pos = BEG;
2226 stop = GPT;
2227 p = BEG_ADDR;
2228 while (1)
2230 int c, bytes;
2232 if (pos == stop)
2234 if (pos == Z)
2235 break;
2236 p = GAP_END_ADDR;
2237 stop = Z;
2239 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2240 p += bytes, pos += bytes;
2241 else
2243 c = STRING_CHAR (p, stop - pos);
2244 /* Delete all bytes for this 8-bit character but the
2245 last one, and change the last one to the charcter
2246 code. */
2247 bytes--;
2248 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2249 p = GAP_END_ADDR;
2250 *p++ = c;
2251 pos++;
2252 if (begv > pos)
2253 begv -= bytes;
2254 if (zv > pos)
2255 zv -= bytes;
2256 stop = Z;
2259 if (narrowed)
2260 Fnarrow_to_region (make_number (begv), make_number (zv));
2262 else
2264 int pt = PT;
2265 int pos, stop;
2266 unsigned char *p;
2268 /* Be sure not to have a multibyte sequence striding over the GAP.
2269 Ex: We change this: "...abc\201 _GAP_ \241def..."
2270 to: "...abc _GAP_ \201\241def..." */
2272 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2273 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2275 unsigned char *p = GPT_ADDR - 1;
2277 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2278 if (BASE_LEADING_CODE_P (*p))
2280 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2282 move_gap_both (new_gpt, new_gpt);
2286 /* Make the buffer contents valid as multibyte by converting
2287 8-bit characters to multibyte form. */
2288 pos = BEG;
2289 stop = GPT;
2290 p = BEG_ADDR;
2291 while (1)
2293 int bytes;
2295 if (pos == stop)
2297 if (pos == Z)
2298 break;
2299 p = GAP_END_ADDR;
2300 stop = Z;
2303 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2304 p += bytes, pos += bytes;
2305 else
2307 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2309 bytes = CHAR_STRING (*p, tmp);
2310 *p = tmp[0];
2311 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2312 bytes--;
2313 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2314 /* Now the gap is after the just inserted data. */
2315 pos = GPT;
2316 p = GAP_END_ADDR;
2317 if (pos <= begv)
2318 begv += bytes;
2319 if (pos <= zv)
2320 zv += bytes;
2321 if (pos <= pt)
2322 pt += bytes;
2323 stop = Z;
2327 if (pt != PT)
2328 TEMP_SET_PT (pt);
2330 if (narrowed)
2331 Fnarrow_to_region (make_number (begv), make_number (zv));
2333 /* Do this first, so that chars_in_text asks the right question.
2334 set_intervals_multibyte needs it too. */
2335 current_buffer->enable_multibyte_characters = Qt;
2337 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2338 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2340 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2342 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2343 if (BEGV_BYTE > GPT_BYTE)
2344 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2345 else
2346 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2348 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2349 if (ZV_BYTE > GPT_BYTE)
2350 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2351 else
2352 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2355 int pt_byte = advance_to_char_boundary (PT_BYTE);
2356 int pt;
2358 if (pt_byte > GPT_BYTE)
2359 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2360 else
2361 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2362 TEMP_SET_PT_BOTH (pt, pt_byte);
2365 tail = markers = BUF_MARKERS (current_buffer);
2367 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2368 getting confused by the markers that have not yet been updated.
2369 It is also a signal that it should never create a marker. */
2370 BUF_MARKERS (current_buffer) = NULL;
2372 for (; tail; tail = tail->next)
2374 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2375 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2378 /* Make sure no markers were put on the chain
2379 while the chain value was incorrect. */
2380 if (BUF_MARKERS (current_buffer))
2381 abort ();
2383 BUF_MARKERS (current_buffer) = markers;
2385 /* Do this last, so it can calculate the new correspondences
2386 between chars and bytes. */
2387 set_intervals_multibyte (1);
2390 if (!EQ (old_undo, Qt))
2392 /* Represent all the above changes by a special undo entry. */
2393 extern Lisp_Object Qapply;
2394 current_buffer->undo_list = Fcons (list3 (Qapply,
2395 intern ("set-buffer-multibyte"),
2396 NILP (flag) ? Qt : Qnil),
2397 old_undo);
2400 UNGCPRO;
2402 /* Changing the multibyteness of a buffer means that all windows
2403 showing that buffer must be updated thoroughly. */
2404 current_buffer->prevent_redisplay_optimizations_p = 1;
2405 ++windows_or_buffers_changed;
2407 /* Copy this buffer's new multibyte status
2408 into all of its indirect buffers. */
2409 for (other = all_buffers; other; other = other->next)
2410 if (other->base_buffer == current_buffer && !NILP (other->name))
2412 other->enable_multibyte_characters
2413 = current_buffer->enable_multibyte_characters;
2414 other->prevent_redisplay_optimizations_p = 1;
2417 /* Restore the modifiedness of the buffer. */
2418 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2419 Fset_buffer_modified_p (Qnil);
2421 #ifdef subprocesses
2422 /* Update coding systems of this buffer's process (if any). */
2424 Lisp_Object process;
2426 process = Fget_buffer_process (Fcurrent_buffer ());
2427 if (PROCESSP (process))
2428 setup_process_coding_systems (process);
2430 #endif /* subprocesses */
2432 return flag;
2435 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2436 0, 0, 0,
2437 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2438 Most local variable bindings are eliminated so that the default values
2439 become effective once more. Also, the syntax table is set from
2440 `standard-syntax-table', the local keymap is set to nil,
2441 and the abbrev table from `fundamental-mode-abbrev-table'.
2442 This function also forces redisplay of the mode line.
2444 Every function to select a new major mode starts by
2445 calling this function.
2447 As a special exception, local variables whose names have
2448 a non-nil `permanent-local' property are not eliminated by this function.
2450 The first thing this function does is run
2451 the normal hook `change-major-mode-hook'. */)
2454 register Lisp_Object alist, sym, tem;
2455 Lisp_Object oalist;
2457 if (!NILP (Vrun_hooks))
2458 call1 (Vrun_hooks, Qchange_major_mode_hook);
2459 oalist = current_buffer->local_var_alist;
2461 /* Make sure none of the bindings in oalist
2462 remain swapped in, in their symbols. */
2464 swap_out_buffer_local_variables (current_buffer);
2466 /* Actually eliminate all local bindings of this buffer. */
2468 reset_buffer_local_variables (current_buffer, 0);
2470 /* Any which are supposed to be permanent,
2471 make local again, with the same values they had. */
2473 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2475 sym = XCAR (XCAR (alist));
2476 tem = Fget (sym, Qpermanent_local);
2477 if (! NILP (tem))
2479 Fmake_local_variable (sym);
2480 Fset (sym, XCDR (XCAR (alist)));
2484 /* Force mode-line redisplay. Useful here because all major mode
2485 commands call this function. */
2486 update_mode_lines++;
2488 return Qnil;
2491 /* Make sure no local variables remain set up with buffer B
2492 for their current values. */
2494 static void
2495 swap_out_buffer_local_variables (b)
2496 struct buffer *b;
2498 Lisp_Object oalist, alist, sym, tem, buffer;
2500 XSETBUFFER (buffer, b);
2501 oalist = b->local_var_alist;
2503 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2505 sym = XCAR (XCAR (alist));
2507 /* Need not do anything if some other buffer's binding is now encached. */
2508 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2509 if (EQ (tem, buffer))
2511 /* Symbol is set up for this buffer's old local value:
2512 swap it out! */
2513 swap_in_global_binding (sym);
2518 /* Find all the overlays in the current buffer that contain position POS.
2519 Return the number found, and store them in a vector in *VEC_PTR.
2520 Store in *LEN_PTR the size allocated for the vector.
2521 Store in *NEXT_PTR the next position after POS where an overlay starts,
2522 or ZV if there are no more overlays between POS and ZV.
2523 Store in *PREV_PTR the previous position before POS where an overlay ends,
2524 or where an overlay starts which ends at or after POS;
2525 or BEGV if there are no such overlays from BEGV to POS.
2526 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2528 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2529 when this function is called.
2531 If EXTEND is non-zero, we make the vector bigger if necessary.
2532 If EXTEND is zero, we never extend the vector,
2533 and we store only as many overlays as will fit.
2534 But we still return the total number of overlays.
2536 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2537 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2538 default (BEGV or ZV). */
2541 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2542 EMACS_INT pos;
2543 int extend;
2544 Lisp_Object **vec_ptr;
2545 int *len_ptr;
2546 int *next_ptr;
2547 int *prev_ptr;
2548 int change_req;
2550 Lisp_Object overlay, start, end;
2551 struct Lisp_Overlay *tail;
2552 int idx = 0;
2553 int len = *len_ptr;
2554 Lisp_Object *vec = *vec_ptr;
2555 int next = ZV;
2556 int prev = BEGV;
2557 int inhibit_storing = 0;
2559 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2561 int startpos, endpos;
2563 XSETMISC (overlay, tail);
2565 start = OVERLAY_START (overlay);
2566 end = OVERLAY_END (overlay);
2567 endpos = OVERLAY_POSITION (end);
2568 if (endpos < pos)
2570 if (prev < endpos)
2571 prev = endpos;
2572 break;
2574 startpos = OVERLAY_POSITION (start);
2575 /* This one ends at or after POS
2576 so its start counts for PREV_PTR if it's before POS. */
2577 if (prev < startpos && startpos < pos)
2578 prev = startpos;
2579 if (endpos == pos)
2580 continue;
2581 if (startpos <= pos)
2583 if (idx == len)
2585 /* The supplied vector is full.
2586 Either make it bigger, or don't store any more in it. */
2587 if (extend)
2589 /* Make it work with an initial len == 0. */
2590 len *= 2;
2591 if (len == 0)
2592 len = 4;
2593 *len_ptr = len;
2594 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2595 *vec_ptr = vec;
2597 else
2598 inhibit_storing = 1;
2601 if (!inhibit_storing)
2602 vec[idx] = overlay;
2603 /* Keep counting overlays even if we can't return them all. */
2604 idx++;
2606 else if (startpos < next)
2607 next = startpos;
2610 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2612 int startpos, endpos;
2614 XSETMISC (overlay, tail);
2616 start = OVERLAY_START (overlay);
2617 end = OVERLAY_END (overlay);
2618 startpos = OVERLAY_POSITION (start);
2619 if (pos < startpos)
2621 if (startpos < next)
2622 next = startpos;
2623 break;
2625 endpos = OVERLAY_POSITION (end);
2626 if (pos < endpos)
2628 if (idx == len)
2630 if (extend)
2632 /* Make it work with an initial len == 0. */
2633 len *= 2;
2634 if (len == 0)
2635 len = 4;
2636 *len_ptr = len;
2637 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2638 *vec_ptr = vec;
2640 else
2641 inhibit_storing = 1;
2644 if (!inhibit_storing)
2645 vec[idx] = overlay;
2646 idx++;
2648 if (startpos < pos && startpos > prev)
2649 prev = startpos;
2651 else if (endpos < pos && endpos > prev)
2652 prev = endpos;
2653 else if (endpos == pos && startpos > prev
2654 && (!change_req || startpos < pos))
2655 prev = startpos;
2658 if (next_ptr)
2659 *next_ptr = next;
2660 if (prev_ptr)
2661 *prev_ptr = prev;
2662 return idx;
2665 /* Find all the overlays in the current buffer that overlap the range BEG-END
2666 or are empty at BEG.
2668 Return the number found, and store them in a vector in *VEC_PTR.
2669 Store in *LEN_PTR the size allocated for the vector.
2670 Store in *NEXT_PTR the next position after POS where an overlay starts,
2671 or ZV if there are no more overlays.
2672 Store in *PREV_PTR the previous position before POS where an overlay ends,
2673 or BEGV if there are no previous overlays.
2674 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2676 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2677 when this function is called.
2679 If EXTEND is non-zero, we make the vector bigger if necessary.
2680 If EXTEND is zero, we never extend the vector,
2681 and we store only as many overlays as will fit.
2682 But we still return the total number of overlays. */
2684 static int
2685 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2686 int beg, end;
2687 int extend;
2688 Lisp_Object **vec_ptr;
2689 int *len_ptr;
2690 int *next_ptr;
2691 int *prev_ptr;
2693 Lisp_Object overlay, ostart, oend;
2694 struct Lisp_Overlay *tail;
2695 int idx = 0;
2696 int len = *len_ptr;
2697 Lisp_Object *vec = *vec_ptr;
2698 int next = ZV;
2699 int prev = BEGV;
2700 int inhibit_storing = 0;
2702 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2704 int startpos, endpos;
2706 XSETMISC (overlay, tail);
2708 ostart = OVERLAY_START (overlay);
2709 oend = OVERLAY_END (overlay);
2710 endpos = OVERLAY_POSITION (oend);
2711 if (endpos < beg)
2713 if (prev < endpos)
2714 prev = endpos;
2715 break;
2717 startpos = OVERLAY_POSITION (ostart);
2718 /* Count an interval if it either overlaps the range
2719 or is empty at the start of the range. */
2720 if ((beg < endpos && startpos < end)
2721 || (startpos == endpos && beg == endpos))
2723 if (idx == len)
2725 /* The supplied vector is full.
2726 Either make it bigger, or don't store any more in it. */
2727 if (extend)
2729 /* Make it work with an initial len == 0. */
2730 len *= 2;
2731 if (len == 0)
2732 len = 4;
2733 *len_ptr = len;
2734 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2735 *vec_ptr = vec;
2737 else
2738 inhibit_storing = 1;
2741 if (!inhibit_storing)
2742 vec[idx] = overlay;
2743 /* Keep counting overlays even if we can't return them all. */
2744 idx++;
2746 else if (startpos < next)
2747 next = startpos;
2750 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2752 int startpos, endpos;
2754 XSETMISC (overlay, tail);
2756 ostart = OVERLAY_START (overlay);
2757 oend = OVERLAY_END (overlay);
2758 startpos = OVERLAY_POSITION (ostart);
2759 if (end < startpos)
2761 if (startpos < next)
2762 next = startpos;
2763 break;
2765 endpos = OVERLAY_POSITION (oend);
2766 /* Count an interval if it either overlaps the range
2767 or is empty at the start of the range. */
2768 if ((beg < endpos && startpos < end)
2769 || (startpos == endpos && beg == endpos))
2771 if (idx == len)
2773 if (extend)
2775 /* Make it work with an initial len == 0. */
2776 len *= 2;
2777 if (len == 0)
2778 len = 4;
2779 *len_ptr = len;
2780 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2781 *vec_ptr = vec;
2783 else
2784 inhibit_storing = 1;
2787 if (!inhibit_storing)
2788 vec[idx] = overlay;
2789 idx++;
2791 else if (endpos < beg && endpos > prev)
2792 prev = endpos;
2795 if (next_ptr)
2796 *next_ptr = next;
2797 if (prev_ptr)
2798 *prev_ptr = prev;
2799 return idx;
2803 /* Return non-zero if there exists an overlay with a non-nil
2804 `mouse-face' property overlapping OVERLAY. */
2807 mouse_face_overlay_overlaps (overlay)
2808 Lisp_Object overlay;
2810 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2811 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2812 int n, i, size;
2813 Lisp_Object *v, tem;
2815 size = 10;
2816 v = (Lisp_Object *) alloca (size * sizeof *v);
2817 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2818 if (n > size)
2820 v = (Lisp_Object *) alloca (n * sizeof *v);
2821 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2824 for (i = 0; i < n; ++i)
2825 if (!EQ (v[i], overlay)
2826 && (tem = Foverlay_get (overlay, Qmouse_face),
2827 !NILP (tem)))
2828 break;
2830 return i < n;
2835 /* Fast function to just test if we're at an overlay boundary. */
2837 overlay_touches_p (pos)
2838 int pos;
2840 Lisp_Object overlay;
2841 struct Lisp_Overlay *tail;
2843 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2845 int endpos;
2847 XSETMISC (overlay ,tail);
2848 if (!GC_OVERLAYP (overlay))
2849 abort ();
2851 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2852 if (endpos < pos)
2853 break;
2854 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2855 return 1;
2858 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2860 int startpos;
2862 XSETMISC (overlay, tail);
2863 if (!GC_OVERLAYP (overlay))
2864 abort ();
2866 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2867 if (pos < startpos)
2868 break;
2869 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2870 return 1;
2872 return 0;
2875 struct sortvec
2877 Lisp_Object overlay;
2878 int beg, end;
2879 int priority;
2882 static int
2883 compare_overlays (v1, v2)
2884 const void *v1, *v2;
2886 const struct sortvec *s1 = (const struct sortvec *) v1;
2887 const struct sortvec *s2 = (const struct sortvec *) v2;
2888 if (s1->priority != s2->priority)
2889 return s1->priority - s2->priority;
2890 if (s1->beg != s2->beg)
2891 return s1->beg - s2->beg;
2892 if (s1->end != s2->end)
2893 return s2->end - s1->end;
2894 return 0;
2897 /* Sort an array of overlays by priority. The array is modified in place.
2898 The return value is the new size; this may be smaller than the original
2899 size if some of the overlays were invalid or were window-specific. */
2901 sort_overlays (overlay_vec, noverlays, w)
2902 Lisp_Object *overlay_vec;
2903 int noverlays;
2904 struct window *w;
2906 int i, j;
2907 struct sortvec *sortvec;
2908 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2910 /* Put the valid and relevant overlays into sortvec. */
2912 for (i = 0, j = 0; i < noverlays; i++)
2914 Lisp_Object tem;
2915 Lisp_Object overlay;
2917 overlay = overlay_vec[i];
2918 if (OVERLAY_VALID (overlay)
2919 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2920 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2922 /* If we're interested in a specific window, then ignore
2923 overlays that are limited to some other window. */
2924 if (w)
2926 Lisp_Object window;
2928 window = Foverlay_get (overlay, Qwindow);
2929 if (WINDOWP (window) && XWINDOW (window) != w)
2930 continue;
2933 /* This overlay is good and counts: put it into sortvec. */
2934 sortvec[j].overlay = overlay;
2935 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2936 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2937 tem = Foverlay_get (overlay, Qpriority);
2938 if (INTEGERP (tem))
2939 sortvec[j].priority = XINT (tem);
2940 else
2941 sortvec[j].priority = 0;
2942 j++;
2945 noverlays = j;
2947 /* Sort the overlays into the proper order: increasing priority. */
2949 if (noverlays > 1)
2950 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2952 for (i = 0; i < noverlays; i++)
2953 overlay_vec[i] = sortvec[i].overlay;
2954 return (noverlays);
2957 struct sortstr
2959 Lisp_Object string, string2;
2960 int size;
2961 int priority;
2964 struct sortstrlist
2966 struct sortstr *buf; /* An array that expands as needed; never freed. */
2967 int size; /* Allocated length of that array. */
2968 int used; /* How much of the array is currently in use. */
2969 int bytes; /* Total length of the strings in buf. */
2972 /* Buffers for storing information about the overlays touching a given
2973 position. These could be automatic variables in overlay_strings, but
2974 it's more efficient to hold onto the memory instead of repeatedly
2975 allocating and freeing it. */
2976 static struct sortstrlist overlay_heads, overlay_tails;
2977 static unsigned char *overlay_str_buf;
2979 /* Allocated length of overlay_str_buf. */
2980 static int overlay_str_len;
2982 /* A comparison function suitable for passing to qsort. */
2983 static int
2984 cmp_for_strings (as1, as2)
2985 char *as1, *as2;
2987 struct sortstr *s1 = (struct sortstr *)as1;
2988 struct sortstr *s2 = (struct sortstr *)as2;
2989 if (s1->size != s2->size)
2990 return s2->size - s1->size;
2991 if (s1->priority != s2->priority)
2992 return s1->priority - s2->priority;
2993 return 0;
2996 static void
2997 record_overlay_string (ssl, str, str2, pri, size)
2998 struct sortstrlist *ssl;
2999 Lisp_Object str, str2, pri;
3000 int size;
3002 int nbytes;
3004 if (ssl->used == ssl->size)
3006 if (ssl->buf)
3007 ssl->size *= 2;
3008 else
3009 ssl->size = 5;
3010 ssl->buf = ((struct sortstr *)
3011 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
3013 ssl->buf[ssl->used].string = str;
3014 ssl->buf[ssl->used].string2 = str2;
3015 ssl->buf[ssl->used].size = size;
3016 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3017 ssl->used++;
3019 if (NILP (current_buffer->enable_multibyte_characters))
3020 nbytes = SCHARS (str);
3021 else if (! STRING_MULTIBYTE (str))
3022 nbytes = count_size_as_multibyte (SDATA (str),
3023 SBYTES (str));
3024 else
3025 nbytes = SBYTES (str);
3027 ssl->bytes += nbytes;
3029 if (STRINGP (str2))
3031 if (NILP (current_buffer->enable_multibyte_characters))
3032 nbytes = SCHARS (str2);
3033 else if (! STRING_MULTIBYTE (str2))
3034 nbytes = count_size_as_multibyte (SDATA (str2),
3035 SBYTES (str2));
3036 else
3037 nbytes = SBYTES (str2);
3039 ssl->bytes += nbytes;
3043 /* Return the concatenation of the strings associated with overlays that
3044 begin or end at POS, ignoring overlays that are specific to a window
3045 other than W. The strings are concatenated in the appropriate order:
3046 shorter overlays nest inside longer ones, and higher priority inside
3047 lower. Normally all of the after-strings come first, but zero-sized
3048 overlays have their after-strings ride along with the before-strings
3049 because it would look strange to print them inside-out.
3051 Returns the string length, and stores the contents indirectly through
3052 PSTR, if that variable is non-null. The string may be overwritten by
3053 subsequent calls. */
3056 overlay_strings (pos, w, pstr)
3057 EMACS_INT pos;
3058 struct window *w;
3059 unsigned char **pstr;
3061 Lisp_Object overlay, window, str;
3062 struct Lisp_Overlay *ov;
3063 int startpos, endpos;
3064 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3066 overlay_heads.used = overlay_heads.bytes = 0;
3067 overlay_tails.used = overlay_tails.bytes = 0;
3068 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3070 XSETMISC (overlay, ov);
3071 eassert (OVERLAYP (overlay));
3073 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3074 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3075 if (endpos < pos)
3076 break;
3077 if (endpos != pos && startpos != pos)
3078 continue;
3079 window = Foverlay_get (overlay, Qwindow);
3080 if (WINDOWP (window) && XWINDOW (window) != w)
3081 continue;
3082 if (startpos == pos
3083 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3084 record_overlay_string (&overlay_heads, str,
3085 (startpos == endpos
3086 ? Foverlay_get (overlay, Qafter_string)
3087 : Qnil),
3088 Foverlay_get (overlay, Qpriority),
3089 endpos - startpos);
3090 else if (endpos == pos
3091 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3092 record_overlay_string (&overlay_tails, str, Qnil,
3093 Foverlay_get (overlay, Qpriority),
3094 endpos - startpos);
3096 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3098 XSETMISC (overlay, ov);
3099 eassert (OVERLAYP (overlay));
3101 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3102 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3103 if (startpos > pos)
3104 break;
3105 if (endpos != pos && startpos != pos)
3106 continue;
3107 window = Foverlay_get (overlay, Qwindow);
3108 if (WINDOWP (window) && XWINDOW (window) != w)
3109 continue;
3110 if (startpos == pos
3111 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3112 record_overlay_string (&overlay_heads, str,
3113 (startpos == endpos
3114 ? Foverlay_get (overlay, Qafter_string)
3115 : Qnil),
3116 Foverlay_get (overlay, Qpriority),
3117 endpos - startpos);
3118 else if (endpos == pos
3119 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3120 record_overlay_string (&overlay_tails, str, Qnil,
3121 Foverlay_get (overlay, Qpriority),
3122 endpos - startpos);
3124 if (overlay_tails.used > 1)
3125 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3126 cmp_for_strings);
3127 if (overlay_heads.used > 1)
3128 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3129 cmp_for_strings);
3130 if (overlay_heads.bytes || overlay_tails.bytes)
3132 Lisp_Object tem;
3133 int i;
3134 unsigned char *p;
3135 int total = overlay_heads.bytes + overlay_tails.bytes;
3137 if (total > overlay_str_len)
3139 overlay_str_len = total;
3140 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3141 total);
3143 p = overlay_str_buf;
3144 for (i = overlay_tails.used; --i >= 0;)
3146 int nbytes;
3147 tem = overlay_tails.buf[i].string;
3148 nbytes = copy_text (SDATA (tem), p,
3149 SBYTES (tem),
3150 STRING_MULTIBYTE (tem), multibyte);
3151 p += nbytes;
3153 for (i = 0; i < overlay_heads.used; ++i)
3155 int nbytes;
3156 tem = overlay_heads.buf[i].string;
3157 nbytes = copy_text (SDATA (tem), p,
3158 SBYTES (tem),
3159 STRING_MULTIBYTE (tem), multibyte);
3160 p += nbytes;
3161 tem = overlay_heads.buf[i].string2;
3162 if (STRINGP (tem))
3164 nbytes = copy_text (SDATA (tem), p,
3165 SBYTES (tem),
3166 STRING_MULTIBYTE (tem), multibyte);
3167 p += nbytes;
3170 if (p != overlay_str_buf + total)
3171 abort ();
3172 if (pstr)
3173 *pstr = overlay_str_buf;
3174 return total;
3176 return 0;
3179 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3181 void
3182 recenter_overlay_lists (buf, pos)
3183 struct buffer *buf;
3184 EMACS_INT pos;
3186 Lisp_Object overlay, beg, end;
3187 struct Lisp_Overlay *prev, *tail, *next;
3189 /* See if anything in overlays_before should move to overlays_after. */
3191 /* We don't strictly need prev in this loop; it should always be nil.
3192 But we use it for symmetry and in case that should cease to be true
3193 with some future change. */
3194 prev = NULL;
3195 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3197 next = tail->next;
3198 XSETMISC (overlay, tail);
3200 /* If the overlay is not valid, get rid of it. */
3201 if (!OVERLAY_VALID (overlay))
3202 #if 1
3203 abort ();
3204 #else
3206 /* Splice the cons cell TAIL out of overlays_before. */
3207 if (!NILP (prev))
3208 XCDR (prev) = next;
3209 else
3210 buf->overlays_before = next;
3211 tail = prev;
3212 continue;
3214 #endif
3216 beg = OVERLAY_START (overlay);
3217 end = OVERLAY_END (overlay);
3219 if (OVERLAY_POSITION (end) > pos)
3221 /* OVERLAY needs to be moved. */
3222 int where = OVERLAY_POSITION (beg);
3223 struct Lisp_Overlay *other, *other_prev;
3225 /* Splice the cons cell TAIL out of overlays_before. */
3226 if (prev)
3227 prev->next = next;
3228 else
3229 buf->overlays_before = next;
3231 /* Search thru overlays_after for where to put it. */
3232 other_prev = NULL;
3233 for (other = buf->overlays_after; other;
3234 other_prev = other, other = other->next)
3236 Lisp_Object otherbeg, otheroverlay;
3238 XSETMISC (otheroverlay, other);
3239 eassert (OVERLAY_VALID (otheroverlay));
3241 otherbeg = OVERLAY_START (otheroverlay);
3242 if (OVERLAY_POSITION (otherbeg) >= where)
3243 break;
3246 /* Add TAIL to overlays_after before OTHER. */
3247 tail->next = other;
3248 if (other_prev)
3249 other_prev->next = tail;
3250 else
3251 buf->overlays_after = tail;
3252 tail = prev;
3254 else
3255 /* We've reached the things that should stay in overlays_before.
3256 All the rest of overlays_before must end even earlier,
3257 so stop now. */
3258 break;
3261 /* See if anything in overlays_after should be in overlays_before. */
3262 prev = NULL;
3263 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3265 next = tail->next;
3266 XSETMISC (overlay, tail);
3268 /* If the overlay is not valid, get rid of it. */
3269 if (!OVERLAY_VALID (overlay))
3270 #if 1
3271 abort ();
3272 #else
3274 /* Splice the cons cell TAIL out of overlays_after. */
3275 if (!NILP (prev))
3276 XCDR (prev) = next;
3277 else
3278 buf->overlays_after = next;
3279 tail = prev;
3280 continue;
3282 #endif
3284 beg = OVERLAY_START (overlay);
3285 end = OVERLAY_END (overlay);
3287 /* Stop looking, when we know that nothing further
3288 can possibly end before POS. */
3289 if (OVERLAY_POSITION (beg) > pos)
3290 break;
3292 if (OVERLAY_POSITION (end) <= pos)
3294 /* OVERLAY needs to be moved. */
3295 int where = OVERLAY_POSITION (end);
3296 struct Lisp_Overlay *other, *other_prev;
3298 /* Splice the cons cell TAIL out of overlays_after. */
3299 if (prev)
3300 prev->next = next;
3301 else
3302 buf->overlays_after = next;
3304 /* Search thru overlays_before for where to put it. */
3305 other_prev = NULL;
3306 for (other = buf->overlays_before; other;
3307 other_prev = other, other = other->next)
3309 Lisp_Object otherend, otheroverlay;
3311 XSETMISC (otheroverlay, other);
3312 eassert (OVERLAY_VALID (otheroverlay));
3314 otherend = OVERLAY_END (otheroverlay);
3315 if (OVERLAY_POSITION (otherend) <= where)
3316 break;
3319 /* Add TAIL to overlays_before before OTHER. */
3320 tail->next = other;
3321 if (other_prev)
3322 other_prev->next = tail;
3323 else
3324 buf->overlays_before = tail;
3325 tail = prev;
3329 buf->overlay_center = pos;
3332 void
3333 adjust_overlays_for_insert (pos, length)
3334 EMACS_INT pos;
3335 EMACS_INT length;
3337 /* After an insertion, the lists are still sorted properly,
3338 but we may need to update the value of the overlay center. */
3339 if (current_buffer->overlay_center >= pos)
3340 current_buffer->overlay_center += length;
3343 void
3344 adjust_overlays_for_delete (pos, length)
3345 EMACS_INT pos;
3346 EMACS_INT length;
3348 if (current_buffer->overlay_center < pos)
3349 /* The deletion was to our right. No change needed; the before- and
3350 after-lists are still consistent. */
3352 else if (current_buffer->overlay_center > pos + length)
3353 /* The deletion was to our left. We need to adjust the center value
3354 to account for the change in position, but the lists are consistent
3355 given the new value. */
3356 current_buffer->overlay_center -= length;
3357 else
3358 /* We're right in the middle. There might be things on the after-list
3359 that now belong on the before-list. Recentering will move them,
3360 and also update the center point. */
3361 recenter_overlay_lists (current_buffer, pos);
3364 /* Fix up overlays that were garbled as a result of permuting markers
3365 in the range START through END. Any overlay with at least one
3366 endpoint in this range will need to be unlinked from the overlay
3367 list and reinserted in its proper place.
3368 Such an overlay might even have negative size at this point.
3369 If so, we'll make the overlay empty. */
3370 void
3371 fix_start_end_in_overlays (start, end)
3372 register int start, end;
3374 Lisp_Object overlay;
3375 struct Lisp_Overlay *before_list, *after_list;
3376 /* These are either nil, indicating that before_list or after_list
3377 should be assigned, or the cons cell the cdr of which should be
3378 assigned. */
3379 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3380 /* 'Parent', likewise, indicates a cons cell or
3381 current_buffer->overlays_before or overlays_after, depending
3382 which loop we're in. */
3383 struct Lisp_Overlay *tail, *parent;
3384 int startpos, endpos;
3386 /* This algorithm shifts links around instead of consing and GCing.
3387 The loop invariant is that before_list (resp. after_list) is a
3388 well-formed list except that its last element, the CDR of beforep
3389 (resp. afterp) if beforep (afterp) isn't nil or before_list
3390 (after_list) if it is, is still uninitialized. So it's not a bug
3391 that before_list isn't initialized, although it may look
3392 strange. */
3393 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3395 XSETMISC (overlay, tail);
3397 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3398 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3400 /* If the overlay is backwards, make it empty. */
3401 if (endpos < startpos)
3403 startpos = endpos;
3404 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3405 Qnil);
3408 if (endpos < start)
3409 break;
3411 if (endpos < end
3412 || (startpos >= start && startpos < end))
3414 /* Add it to the end of the wrong list. Later on,
3415 recenter_overlay_lists will move it to the right place. */
3416 if (endpos < current_buffer->overlay_center)
3418 if (!afterp)
3419 after_list = tail;
3420 else
3421 afterp->next = tail;
3422 afterp = tail;
3424 else
3426 if (!beforep)
3427 before_list = tail;
3428 else
3429 beforep->next = tail;
3430 beforep = tail;
3432 if (!parent)
3433 current_buffer->overlays_before = tail->next;
3434 else
3435 parent->next = tail->next;
3436 tail = tail->next;
3438 else
3439 parent = tail, tail = parent->next;
3441 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3443 XSETMISC (overlay, tail);
3445 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3446 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3448 /* If the overlay is backwards, make it empty. */
3449 if (endpos < startpos)
3451 startpos = endpos;
3452 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3453 Qnil);
3456 if (startpos >= end)
3457 break;
3459 if (startpos >= start
3460 || (endpos >= start && endpos < end))
3462 if (endpos < current_buffer->overlay_center)
3464 if (!afterp)
3465 after_list = tail;
3466 else
3467 afterp->next = tail;
3468 afterp = tail;
3470 else
3472 if (!beforep)
3473 before_list = tail;
3474 else
3475 beforep->next = tail;
3476 beforep = tail;
3478 if (!parent)
3479 current_buffer->overlays_after = tail->next;
3480 else
3481 parent->next = tail->next;
3482 tail = tail->next;
3484 else
3485 parent = tail, tail = parent->next;
3488 /* Splice the constructed (wrong) lists into the buffer's lists,
3489 and let the recenter function make it sane again. */
3490 if (beforep)
3492 beforep->next = current_buffer->overlays_before;
3493 current_buffer->overlays_before = before_list;
3495 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3497 if (afterp)
3499 afterp->next = current_buffer->overlays_after;
3500 current_buffer->overlays_after = after_list;
3502 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3505 /* We have two types of overlay: the one whose ending marker is
3506 after-insertion-marker (this is the usual case) and the one whose
3507 ending marker is before-insertion-marker. When `overlays_before'
3508 contains overlays of the latter type and the former type in this
3509 order and both overlays end at inserting position, inserting a text
3510 increases only the ending marker of the latter type, which results
3511 in incorrect ordering of `overlays_before'.
3513 This function fixes ordering of overlays in the slot
3514 `overlays_before' of the buffer *BP. Before the insertion, `point'
3515 was at PREV, and now is at POS. */
3517 void
3518 fix_overlays_before (bp, prev, pos)
3519 struct buffer *bp;
3520 EMACS_INT prev, pos;
3522 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3523 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3524 Lisp_Object tem;
3525 EMACS_INT end;
3527 /* After the insertion, the several overlays may be in incorrect
3528 order. The possibility is that, in the list `overlays_before',
3529 an overlay which ends at POS appears after an overlay which ends
3530 at PREV. Since POS is greater than PREV, we must fix the
3531 ordering of these overlays, by moving overlays ends at POS before
3532 the overlays ends at PREV. */
3534 /* At first, find a place where disordered overlays should be linked
3535 in. It is where an overlay which end before POS exists. (i.e. an
3536 overlay whose ending marker is after-insertion-marker if disorder
3537 exists). */
3538 while (tail
3539 && (XSETMISC (tem, tail),
3540 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3542 parent = tail;
3543 tail = tail->next;
3546 /* If we don't find such an overlay,
3547 or the found one ends before PREV,
3548 or the found one is the last one in the list,
3549 we don't have to fix anything. */
3550 if (!tail || end < prev || !tail->next)
3551 return;
3553 right_pair = parent;
3554 parent = tail;
3555 tail = tail->next;
3557 /* Now, end position of overlays in the list TAIL should be before
3558 or equal to PREV. In the loop, an overlay which ends at POS is
3559 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3560 we found an overlay which ends before PREV, the remaining
3561 overlays are in correct order. */
3562 while (tail)
3564 XSETMISC (tem, tail);
3565 end = OVERLAY_POSITION (OVERLAY_END (tem));
3567 if (end == pos)
3568 { /* This overlay is disordered. */
3569 struct Lisp_Overlay *found = tail;
3571 /* Unlink the found overlay. */
3572 tail = found->next;
3573 parent->next = tail;
3574 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3575 and link it into the right place. */
3576 if (!right_pair)
3578 found->next = bp->overlays_before;
3579 bp->overlays_before = found;
3581 else
3583 found->next = right_pair->next;
3584 right_pair->next = found;
3587 else if (end == prev)
3589 parent = tail;
3590 tail = tail->next;
3592 else /* No more disordered overlay. */
3593 break;
3597 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3598 doc: /* Return t if OBJECT is an overlay. */)
3599 (object)
3600 Lisp_Object object;
3602 return (OVERLAYP (object) ? Qt : Qnil);
3605 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3606 doc: /* Create a new overlay with range BEG to END in BUFFER.
3607 If omitted, BUFFER defaults to the current buffer.
3608 BEG and END may be integers or markers.
3609 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3610 for the front of the overlay advance when text is inserted there
3611 \(which means the text *is not* included in the overlay).
3612 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3613 for the rear of the overlay advance when text is inserted there
3614 \(which means the text *is* included in the overlay). */)
3615 (beg, end, buffer, front_advance, rear_advance)
3616 Lisp_Object beg, end, buffer;
3617 Lisp_Object front_advance, rear_advance;
3619 Lisp_Object overlay;
3620 struct buffer *b;
3622 if (NILP (buffer))
3623 XSETBUFFER (buffer, current_buffer);
3624 else
3625 CHECK_BUFFER (buffer);
3626 if (MARKERP (beg)
3627 && ! EQ (Fmarker_buffer (beg), buffer))
3628 error ("Marker points into wrong buffer");
3629 if (MARKERP (end)
3630 && ! EQ (Fmarker_buffer (end), buffer))
3631 error ("Marker points into wrong buffer");
3633 CHECK_NUMBER_COERCE_MARKER (beg);
3634 CHECK_NUMBER_COERCE_MARKER (end);
3636 if (XINT (beg) > XINT (end))
3638 Lisp_Object temp;
3639 temp = beg; beg = end; end = temp;
3642 b = XBUFFER (buffer);
3644 beg = Fset_marker (Fmake_marker (), beg, buffer);
3645 end = Fset_marker (Fmake_marker (), end, buffer);
3647 if (!NILP (front_advance))
3648 XMARKER (beg)->insertion_type = 1;
3649 if (!NILP (rear_advance))
3650 XMARKER (end)->insertion_type = 1;
3652 overlay = allocate_misc ();
3653 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3654 XOVERLAY (overlay)->start = beg;
3655 XOVERLAY (overlay)->end = end;
3656 XOVERLAY (overlay)->plist = Qnil;
3657 XOVERLAY (overlay)->next = NULL;
3659 /* Put the new overlay on the wrong list. */
3660 end = OVERLAY_END (overlay);
3661 if (OVERLAY_POSITION (end) < b->overlay_center)
3663 if (b->overlays_after)
3664 XOVERLAY (overlay)->next = b->overlays_after;
3665 b->overlays_after = XOVERLAY (overlay);
3667 else
3669 if (b->overlays_before)
3670 XOVERLAY (overlay)->next = b->overlays_before;
3671 b->overlays_before = XOVERLAY (overlay);
3674 /* This puts it in the right list, and in the right order. */
3675 recenter_overlay_lists (b, b->overlay_center);
3677 /* We don't need to redisplay the region covered by the overlay, because
3678 the overlay has no properties at the moment. */
3680 return overlay;
3683 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3685 static void
3686 modify_overlay (buf, start, end)
3687 struct buffer *buf;
3688 EMACS_INT start, end;
3690 if (start > end)
3692 int temp = start;
3693 start = end;
3694 end = temp;
3697 BUF_COMPUTE_UNCHANGED (buf, start, end);
3699 /* If this is a buffer not in the selected window,
3700 we must do other windows. */
3701 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3702 windows_or_buffers_changed = 1;
3703 /* If multiple windows show this buffer, we must do other windows. */
3704 else if (buffer_shared > 1)
3705 windows_or_buffers_changed = 1;
3706 /* If we modify an overlay at the end of the buffer, we cannot
3707 be sure that window end is still valid. */
3708 else if (end >= ZV && start <= ZV)
3709 windows_or_buffers_changed = 1;
3711 ++BUF_OVERLAY_MODIFF (buf);
3715 Lisp_Object Fdelete_overlay ();
3717 static struct Lisp_Overlay *
3718 unchain_overlay (list, overlay)
3719 struct Lisp_Overlay *list, *overlay;
3721 struct Lisp_Overlay *tmp, *prev;
3722 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3723 if (tmp == overlay)
3725 if (prev)
3726 prev->next = tmp->next;
3727 else
3728 list = tmp->next;
3729 overlay->next = NULL;
3730 break;
3732 return list;
3735 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3736 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3737 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3738 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3739 buffer. */)
3740 (overlay, beg, end, buffer)
3741 Lisp_Object overlay, beg, end, buffer;
3743 struct buffer *b, *ob;
3744 Lisp_Object obuffer;
3745 int count = SPECPDL_INDEX ();
3747 CHECK_OVERLAY (overlay);
3748 if (NILP (buffer))
3749 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3750 if (NILP (buffer))
3751 XSETBUFFER (buffer, current_buffer);
3752 CHECK_BUFFER (buffer);
3754 if (MARKERP (beg)
3755 && ! EQ (Fmarker_buffer (beg), buffer))
3756 error ("Marker points into wrong buffer");
3757 if (MARKERP (end)
3758 && ! EQ (Fmarker_buffer (end), buffer))
3759 error ("Marker points into wrong buffer");
3761 CHECK_NUMBER_COERCE_MARKER (beg);
3762 CHECK_NUMBER_COERCE_MARKER (end);
3764 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3765 return Fdelete_overlay (overlay);
3767 if (XINT (beg) > XINT (end))
3769 Lisp_Object temp;
3770 temp = beg; beg = end; end = temp;
3773 specbind (Qinhibit_quit, Qt);
3775 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3776 b = XBUFFER (buffer);
3777 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3779 /* If the overlay has changed buffers, do a thorough redisplay. */
3780 if (!EQ (buffer, obuffer))
3782 /* Redisplay where the overlay was. */
3783 if (!NILP (obuffer))
3785 int o_beg;
3786 int o_end;
3788 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3789 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3791 modify_overlay (ob, o_beg, o_end);
3794 /* Redisplay where the overlay is going to be. */
3795 modify_overlay (b, XINT (beg), XINT (end));
3797 else
3798 /* Redisplay the area the overlay has just left, or just enclosed. */
3800 int o_beg, o_end;
3802 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3803 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3805 if (o_beg == XINT (beg))
3806 modify_overlay (b, o_end, XINT (end));
3807 else if (o_end == XINT (end))
3808 modify_overlay (b, o_beg, XINT (beg));
3809 else
3811 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3812 if (XINT (end) > o_end) o_end = XINT (end);
3813 modify_overlay (b, o_beg, o_end);
3817 if (!NILP (obuffer))
3819 ob->overlays_before
3820 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3821 ob->overlays_after
3822 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3823 eassert (XOVERLAY (overlay)->next == NULL);
3826 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3827 Fset_marker (OVERLAY_END (overlay), end, buffer);
3829 /* Put the overlay on the wrong list. */
3830 end = OVERLAY_END (overlay);
3831 if (OVERLAY_POSITION (end) < b->overlay_center)
3833 XOVERLAY (overlay)->next = b->overlays_after;
3834 b->overlays_after = XOVERLAY (overlay);
3836 else
3838 XOVERLAY (overlay)->next = b->overlays_before;
3839 b->overlays_before = XOVERLAY (overlay);
3842 /* This puts it in the right list, and in the right order. */
3843 recenter_overlay_lists (b, b->overlay_center);
3845 return unbind_to (count, overlay);
3848 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3849 doc: /* Delete the overlay OVERLAY from its buffer. */)
3850 (overlay)
3851 Lisp_Object overlay;
3853 Lisp_Object buffer;
3854 struct buffer *b;
3855 int count = SPECPDL_INDEX ();
3857 CHECK_OVERLAY (overlay);
3859 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3860 if (NILP (buffer))
3861 return Qnil;
3863 b = XBUFFER (buffer);
3864 specbind (Qinhibit_quit, Qt);
3866 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3867 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3868 eassert (XOVERLAY (overlay)->next == NULL);
3869 modify_overlay (b,
3870 marker_position (OVERLAY_START (overlay)),
3871 marker_position (OVERLAY_END (overlay)));
3872 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3873 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3875 /* When deleting an overlay with before or after strings, turn off
3876 display optimizations for the affected buffer, on the basis that
3877 these strings may contain newlines. This is easier to do than to
3878 check for that situation during redisplay. */
3879 if (!windows_or_buffers_changed
3880 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3881 || !NILP (Foverlay_get (overlay, Qafter_string))))
3882 b->prevent_redisplay_optimizations_p = 1;
3884 return unbind_to (count, Qnil);
3887 /* Overlay dissection functions. */
3889 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3890 doc: /* Return the position at which OVERLAY starts. */)
3891 (overlay)
3892 Lisp_Object overlay;
3894 CHECK_OVERLAY (overlay);
3896 return (Fmarker_position (OVERLAY_START (overlay)));
3899 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3900 doc: /* Return the position at which OVERLAY ends. */)
3901 (overlay)
3902 Lisp_Object overlay;
3904 CHECK_OVERLAY (overlay);
3906 return (Fmarker_position (OVERLAY_END (overlay)));
3909 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3910 doc: /* Return the buffer OVERLAY belongs to.
3911 Return nil if OVERLAY has been deleted. */)
3912 (overlay)
3913 Lisp_Object overlay;
3915 CHECK_OVERLAY (overlay);
3917 return Fmarker_buffer (OVERLAY_START (overlay));
3920 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3921 doc: /* Return a list of the properties on OVERLAY.
3922 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3923 OVERLAY. */)
3924 (overlay)
3925 Lisp_Object overlay;
3927 CHECK_OVERLAY (overlay);
3929 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3933 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3934 doc: /* Return a list of the overlays that contain the character at POS. */)
3935 (pos)
3936 Lisp_Object pos;
3938 int noverlays;
3939 Lisp_Object *overlay_vec;
3940 int len;
3941 Lisp_Object result;
3943 CHECK_NUMBER_COERCE_MARKER (pos);
3945 len = 10;
3946 /* We can't use alloca here because overlays_at can call xrealloc. */
3947 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3949 /* Put all the overlays we want in a vector in overlay_vec.
3950 Store the length in len. */
3951 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3952 (int *) 0, (int *) 0, 0);
3954 /* Make a list of them all. */
3955 result = Flist (noverlays, overlay_vec);
3957 xfree (overlay_vec);
3958 return result;
3961 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3962 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3963 Overlap means that at least one character is contained within the overlay
3964 and also contained within the specified region.
3965 Empty overlays are included in the result if they are located at BEG
3966 or between BEG and END. */)
3967 (beg, end)
3968 Lisp_Object beg, end;
3970 int noverlays;
3971 Lisp_Object *overlay_vec;
3972 int len;
3973 Lisp_Object result;
3975 CHECK_NUMBER_COERCE_MARKER (beg);
3976 CHECK_NUMBER_COERCE_MARKER (end);
3978 len = 10;
3979 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3981 /* Put all the overlays we want in a vector in overlay_vec.
3982 Store the length in len. */
3983 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3984 (int *) 0, (int *) 0);
3986 /* Make a list of them all. */
3987 result = Flist (noverlays, overlay_vec);
3989 xfree (overlay_vec);
3990 return result;
3993 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3994 1, 1, 0,
3995 doc: /* Return the next position after POS where an overlay starts or ends.
3996 If there are no overlay boundaries from POS to (point-max),
3997 the value is (point-max). */)
3998 (pos)
3999 Lisp_Object pos;
4001 int noverlays;
4002 int endpos;
4003 Lisp_Object *overlay_vec;
4004 int len;
4005 int i;
4007 CHECK_NUMBER_COERCE_MARKER (pos);
4009 len = 10;
4010 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4012 /* Put all the overlays we want in a vector in overlay_vec.
4013 Store the length in len.
4014 endpos gets the position where the next overlay starts. */
4015 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4016 &endpos, (int *) 0, 1);
4018 /* If any of these overlays ends before endpos,
4019 use its ending point instead. */
4020 for (i = 0; i < noverlays; i++)
4022 Lisp_Object oend;
4023 int oendpos;
4025 oend = OVERLAY_END (overlay_vec[i]);
4026 oendpos = OVERLAY_POSITION (oend);
4027 if (oendpos < endpos)
4028 endpos = oendpos;
4031 xfree (overlay_vec);
4032 return make_number (endpos);
4035 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
4036 Sprevious_overlay_change, 1, 1, 0,
4037 doc: /* Return the previous position before POS where an overlay starts or ends.
4038 If there are no overlay boundaries from (point-min) to POS,
4039 the value is (point-min). */)
4040 (pos)
4041 Lisp_Object pos;
4043 int noverlays;
4044 int prevpos;
4045 Lisp_Object *overlay_vec;
4046 int len;
4048 CHECK_NUMBER_COERCE_MARKER (pos);
4050 /* At beginning of buffer, we know the answer;
4051 avoid bug subtracting 1 below. */
4052 if (XINT (pos) == BEGV)
4053 return pos;
4055 len = 10;
4056 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4058 /* Put all the overlays we want in a vector in overlay_vec.
4059 Store the length in len.
4060 prevpos gets the position of the previous change. */
4061 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4062 (int *) 0, &prevpos, 1);
4064 xfree (overlay_vec);
4065 return make_number (prevpos);
4068 /* These functions are for debugging overlays. */
4070 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4071 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4072 The car has all the overlays before the overlay center;
4073 the cdr has all the overlays after the overlay center.
4074 Recentering overlays moves overlays between these lists.
4075 The lists you get are copies, so that changing them has no effect.
4076 However, the overlays you get are the real objects that the buffer uses. */)
4079 struct Lisp_Overlay *ol;
4080 Lisp_Object before = Qnil, after = Qnil, tmp;
4081 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4083 XSETMISC (tmp, ol);
4084 before = Fcons (tmp, before);
4086 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4088 XSETMISC (tmp, ol);
4089 after = Fcons (tmp, after);
4091 return Fcons (Fnreverse (before), Fnreverse (after));
4094 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4095 doc: /* Recenter the overlays of the current buffer around position POS.
4096 That makes overlay lookup faster for positions near POS (but perhaps slower
4097 for positions far away from POS). */)
4098 (pos)
4099 Lisp_Object pos;
4101 CHECK_NUMBER_COERCE_MARKER (pos);
4103 recenter_overlay_lists (current_buffer, XINT (pos));
4104 return Qnil;
4107 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4108 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4109 (overlay, prop)
4110 Lisp_Object overlay, prop;
4112 CHECK_OVERLAY (overlay);
4113 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4116 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4117 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4118 (overlay, prop, value)
4119 Lisp_Object overlay, prop, value;
4121 Lisp_Object tail, buffer;
4122 int changed;
4124 CHECK_OVERLAY (overlay);
4126 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4128 for (tail = XOVERLAY (overlay)->plist;
4129 CONSP (tail) && CONSP (XCDR (tail));
4130 tail = XCDR (XCDR (tail)))
4131 if (EQ (XCAR (tail), prop))
4133 changed = !EQ (XCAR (XCDR (tail)), value);
4134 XSETCAR (XCDR (tail), value);
4135 goto found;
4137 /* It wasn't in the list, so add it to the front. */
4138 changed = !NILP (value);
4139 XOVERLAY (overlay)->plist
4140 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4141 found:
4142 if (! NILP (buffer))
4144 if (changed)
4145 modify_overlay (XBUFFER (buffer),
4146 marker_position (OVERLAY_START (overlay)),
4147 marker_position (OVERLAY_END (overlay)));
4148 if (EQ (prop, Qevaporate) && ! NILP (value)
4149 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4150 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4151 Fdelete_overlay (overlay);
4154 return value;
4157 /* Subroutine of report_overlay_modification. */
4159 /* Lisp vector holding overlay hook functions to call.
4160 Vector elements come in pairs.
4161 Each even-index element is a list of hook functions.
4162 The following odd-index element is the overlay they came from.
4164 Before the buffer change, we fill in this vector
4165 as we call overlay hook functions.
4166 After the buffer change, we get the functions to call from this vector.
4167 This way we always call the same functions before and after the change. */
4168 static Lisp_Object last_overlay_modification_hooks;
4170 /* Number of elements actually used in last_overlay_modification_hooks. */
4171 static int last_overlay_modification_hooks_used;
4173 /* Add one functionlist/overlay pair
4174 to the end of last_overlay_modification_hooks. */
4176 static void
4177 add_overlay_mod_hooklist (functionlist, overlay)
4178 Lisp_Object functionlist, overlay;
4180 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4182 if (last_overlay_modification_hooks_used == oldsize)
4183 last_overlay_modification_hooks = larger_vector
4184 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4185 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4186 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4189 /* Run the modification-hooks of overlays that include
4190 any part of the text in START to END.
4191 If this change is an insertion, also
4192 run the insert-before-hooks of overlay starting at END,
4193 and the insert-after-hooks of overlay ending at START.
4195 This is called both before and after the modification.
4196 AFTER is nonzero when we call after the modification.
4198 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4199 When AFTER is nonzero, they are the start position,
4200 the position after the inserted new text,
4201 and the length of deleted or replaced old text. */
4203 void
4204 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4205 Lisp_Object start, end;
4206 int after;
4207 Lisp_Object arg1, arg2, arg3;
4209 Lisp_Object prop, overlay;
4210 struct Lisp_Overlay *tail;
4211 /* 1 if this change is an insertion. */
4212 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4213 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4215 overlay = Qnil;
4216 tail = NULL;
4218 /* We used to run the functions as soon as we found them and only register
4219 them in last_overlay_modification_hooks for the purpose of the `after'
4220 case. But running elisp code as we traverse the list of overlays is
4221 painful because the list can be modified by the elisp code so we had to
4222 copy at several places. We now simply do a read-only traversal that
4223 only collects the functions to run and we run them afterwards. It's
4224 simpler, especially since all the code was already there. -stef */
4226 if (!after)
4228 /* We are being called before a change.
4229 Scan the overlays to find the functions to call. */
4230 last_overlay_modification_hooks_used = 0;
4231 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4233 int startpos, endpos;
4234 Lisp_Object ostart, oend;
4236 XSETMISC (overlay, tail);
4238 ostart = OVERLAY_START (overlay);
4239 oend = OVERLAY_END (overlay);
4240 endpos = OVERLAY_POSITION (oend);
4241 if (XFASTINT (start) > endpos)
4242 break;
4243 startpos = OVERLAY_POSITION (ostart);
4244 if (insertion && (XFASTINT (start) == startpos
4245 || XFASTINT (end) == startpos))
4247 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4248 if (!NILP (prop))
4249 add_overlay_mod_hooklist (prop, overlay);
4251 if (insertion && (XFASTINT (start) == endpos
4252 || XFASTINT (end) == endpos))
4254 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4255 if (!NILP (prop))
4256 add_overlay_mod_hooklist (prop, overlay);
4258 /* Test for intersecting intervals. This does the right thing
4259 for both insertion and deletion. */
4260 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4262 prop = Foverlay_get (overlay, Qmodification_hooks);
4263 if (!NILP (prop))
4264 add_overlay_mod_hooklist (prop, overlay);
4268 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4270 int startpos, endpos;
4271 Lisp_Object ostart, oend;
4273 XSETMISC (overlay, tail);
4275 ostart = OVERLAY_START (overlay);
4276 oend = OVERLAY_END (overlay);
4277 startpos = OVERLAY_POSITION (ostart);
4278 endpos = OVERLAY_POSITION (oend);
4279 if (XFASTINT (end) < startpos)
4280 break;
4281 if (insertion && (XFASTINT (start) == startpos
4282 || XFASTINT (end) == startpos))
4284 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4285 if (!NILP (prop))
4286 add_overlay_mod_hooklist (prop, overlay);
4288 if (insertion && (XFASTINT (start) == endpos
4289 || XFASTINT (end) == endpos))
4291 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4292 if (!NILP (prop))
4293 add_overlay_mod_hooklist (prop, overlay);
4295 /* Test for intersecting intervals. This does the right thing
4296 for both insertion and deletion. */
4297 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4299 prop = Foverlay_get (overlay, Qmodification_hooks);
4300 if (!NILP (prop))
4301 add_overlay_mod_hooklist (prop, overlay);
4306 GCPRO4 (overlay, arg1, arg2, arg3);
4308 /* Call the functions recorded in last_overlay_modification_hooks.
4309 First copy the vector contents, in case some of these hooks
4310 do subsequent modification of the buffer. */
4311 int size = last_overlay_modification_hooks_used;
4312 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4313 int i;
4315 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4316 copy, size * sizeof (Lisp_Object));
4317 gcpro1.var = copy;
4318 gcpro1.nvars = size;
4320 for (i = 0; i < size;)
4322 Lisp_Object prop, overlay;
4323 prop = copy[i++];
4324 overlay = copy[i++];
4325 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4328 UNGCPRO;
4331 static void
4332 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4333 Lisp_Object list, overlay;
4334 int after;
4335 Lisp_Object arg1, arg2, arg3;
4337 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4339 GCPRO4 (list, arg1, arg2, arg3);
4341 while (CONSP (list))
4343 if (NILP (arg3))
4344 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4345 else
4346 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4347 list = XCDR (list);
4349 UNGCPRO;
4352 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4353 property is set. */
4354 void
4355 evaporate_overlays (pos)
4356 EMACS_INT pos;
4358 Lisp_Object overlay, hit_list;
4359 struct Lisp_Overlay *tail;
4361 hit_list = Qnil;
4362 if (pos <= current_buffer->overlay_center)
4363 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4365 int endpos;
4366 XSETMISC (overlay, tail);
4367 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4368 if (endpos < pos)
4369 break;
4370 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4371 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4372 hit_list = Fcons (overlay, hit_list);
4374 else
4375 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4377 int startpos;
4378 XSETMISC (overlay, tail);
4379 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4380 if (startpos > pos)
4381 break;
4382 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4383 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4384 hit_list = Fcons (overlay, hit_list);
4386 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4387 Fdelete_overlay (XCAR (hit_list));
4390 /* Somebody has tried to store a value with an unacceptable type
4391 in the slot with offset OFFSET. */
4393 void
4394 buffer_slot_type_mismatch (sym, type)
4395 Lisp_Object sym;
4396 int type;
4398 char *type_name;
4400 switch (type)
4402 case Lisp_Int:
4403 type_name = "integers";
4404 break;
4406 case Lisp_String:
4407 type_name = "strings";
4408 break;
4410 case Lisp_Symbol:
4411 type_name = "symbols";
4412 break;
4414 default:
4415 abort ();
4418 error ("Only %s should be stored in the buffer-local variable %s",
4419 type_name, SDATA (SYMBOL_NAME (sym)));
4423 /***********************************************************************
4424 Allocation with mmap
4425 ***********************************************************************/
4427 #ifdef USE_MMAP_FOR_BUFFERS
4429 #include <sys/types.h>
4430 #include <sys/mman.h>
4432 #ifndef MAP_ANON
4433 #ifdef MAP_ANONYMOUS
4434 #define MAP_ANON MAP_ANONYMOUS
4435 #else
4436 #define MAP_ANON 0
4437 #endif
4438 #endif
4440 #ifndef MAP_FAILED
4441 #define MAP_FAILED ((void *) -1)
4442 #endif
4444 #include <stdio.h>
4445 #include <errno.h>
4447 #if MAP_ANON == 0
4448 #include <fcntl.h>
4449 #endif
4451 #include "coding.h"
4454 /* Memory is allocated in regions which are mapped using mmap(2).
4455 The current implementation lets the system select mapped
4456 addresses; we're not using MAP_FIXED in general, except when
4457 trying to enlarge regions.
4459 Each mapped region starts with a mmap_region structure, the user
4460 area starts after that structure, aligned to MEM_ALIGN.
4462 +-----------------------+
4463 | struct mmap_info + |
4464 | padding |
4465 +-----------------------+
4466 | user data |
4469 +-----------------------+ */
4471 struct mmap_region
4473 /* User-specified size. */
4474 size_t nbytes_specified;
4476 /* Number of bytes mapped */
4477 size_t nbytes_mapped;
4479 /* Pointer to the location holding the address of the memory
4480 allocated with the mmap'd block. The variable actually points
4481 after this structure. */
4482 POINTER_TYPE **var;
4484 /* Next and previous in list of all mmap'd regions. */
4485 struct mmap_region *next, *prev;
4488 /* Doubly-linked list of mmap'd regions. */
4490 static struct mmap_region *mmap_regions;
4492 /* File descriptor for mmap. If we don't have anonymous mapping,
4493 /dev/zero will be opened on it. */
4495 static int mmap_fd;
4497 /* Temporary storage for mmap_set_vars, see there. */
4499 static struct mmap_region *mmap_regions_1;
4500 static int mmap_fd_1;
4502 /* Page size on this system. */
4504 static int mmap_page_size;
4506 /* 1 means mmap has been intialized. */
4508 static int mmap_initialized_p;
4510 /* Value is X rounded up to the next multiple of N. */
4512 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4514 /* Size of mmap_region structure plus padding. */
4516 #define MMAP_REGION_STRUCT_SIZE \
4517 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4519 /* Given a pointer P to the start of the user-visible part of a mapped
4520 region, return a pointer to the start of the region. */
4522 #define MMAP_REGION(P) \
4523 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4525 /* Given a pointer P to the start of a mapped region, return a pointer
4526 to the start of the user-visible part of the region. */
4528 #define MMAP_USER_AREA(P) \
4529 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4531 #define MEM_ALIGN sizeof (double)
4533 /* Predicate returning true if part of the address range [START .. END]
4534 is currently mapped. Used to prevent overwriting an existing
4535 memory mapping.
4537 Default is to conservativly assume the address range is occupied by
4538 something else. This can be overridden by system configuration
4539 files if system-specific means to determine this exists. */
4541 #ifndef MMAP_ALLOCATED_P
4542 #define MMAP_ALLOCATED_P(start, end) 1
4543 #endif
4545 /* Function prototypes. */
4547 static int mmap_free_1 P_ ((struct mmap_region *));
4548 static int mmap_enlarge P_ ((struct mmap_region *, int));
4549 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4550 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4551 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4552 static void mmap_free P_ ((POINTER_TYPE **ptr));
4553 static void mmap_init P_ ((void));
4556 /* Return a region overlapping address range START...END, or null if
4557 none. END is not including, i.e. the last byte in the range
4558 is at END - 1. */
4560 static struct mmap_region *
4561 mmap_find (start, end)
4562 POINTER_TYPE *start, *end;
4564 struct mmap_region *r;
4565 char *s = (char *) start, *e = (char *) end;
4567 for (r = mmap_regions; r; r = r->next)
4569 char *rstart = (char *) r;
4570 char *rend = rstart + r->nbytes_mapped;
4572 if (/* First byte of range, i.e. START, in this region? */
4573 (s >= rstart && s < rend)
4574 /* Last byte of range, i.e. END - 1, in this region? */
4575 || (e > rstart && e <= rend)
4576 /* First byte of this region in the range? */
4577 || (rstart >= s && rstart < e)
4578 /* Last byte of this region in the range? */
4579 || (rend > s && rend <= e))
4580 break;
4583 return r;
4587 /* Unmap a region. P is a pointer to the start of the user-araa of
4588 the region. Value is non-zero if successful. */
4590 static int
4591 mmap_free_1 (r)
4592 struct mmap_region *r;
4594 if (r->next)
4595 r->next->prev = r->prev;
4596 if (r->prev)
4597 r->prev->next = r->next;
4598 else
4599 mmap_regions = r->next;
4601 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4603 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4604 return 0;
4607 return 1;
4611 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4612 Value is non-zero if successful. */
4614 static int
4615 mmap_enlarge (r, npages)
4616 struct mmap_region *r;
4617 int npages;
4619 char *region_end = (char *) r + r->nbytes_mapped;
4620 size_t nbytes;
4621 int success = 0;
4623 if (npages < 0)
4625 /* Unmap pages at the end of the region. */
4626 nbytes = - npages * mmap_page_size;
4627 if (munmap (region_end - nbytes, nbytes) == -1)
4628 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4629 else
4631 r->nbytes_mapped -= nbytes;
4632 success = 1;
4635 else if (npages > 0)
4637 nbytes = npages * mmap_page_size;
4639 /* Try to map additional pages at the end of the region. We
4640 cannot do this if the address range is already occupied by
4641 something else because mmap deletes any previous mapping.
4642 I'm not sure this is worth doing, let's see. */
4643 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4645 POINTER_TYPE *p;
4647 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4648 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4649 if (p == MAP_FAILED)
4650 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4651 else if (p != (POINTER_TYPE *) region_end)
4653 /* Kernels are free to choose a different address. In
4654 that case, unmap what we've mapped above; we have
4655 no use for it. */
4656 if (munmap (p, nbytes) == -1)
4657 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4659 else
4661 r->nbytes_mapped += nbytes;
4662 success = 1;
4667 return success;
4671 /* Set or reset variables holding references to mapped regions. If
4672 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4673 non-zero, set all variables to the start of the user-areas
4674 of mapped regions.
4676 This function is called from Fdump_emacs to ensure that the dumped
4677 Emacs doesn't contain references to memory that won't be mapped
4678 when Emacs starts. */
4680 void
4681 mmap_set_vars (restore_p)
4682 int restore_p;
4684 struct mmap_region *r;
4686 if (restore_p)
4688 mmap_regions = mmap_regions_1;
4689 mmap_fd = mmap_fd_1;
4690 for (r = mmap_regions; r; r = r->next)
4691 *r->var = MMAP_USER_AREA (r);
4693 else
4695 for (r = mmap_regions; r; r = r->next)
4696 *r->var = NULL;
4697 mmap_regions_1 = mmap_regions;
4698 mmap_regions = NULL;
4699 mmap_fd_1 = mmap_fd;
4700 mmap_fd = -1;
4705 /* Allocate a block of storage large enough to hold NBYTES bytes of
4706 data. A pointer to the data is returned in *VAR. VAR is thus the
4707 address of some variable which will use the data area.
4709 The allocation of 0 bytes is valid.
4711 If we can't allocate the necessary memory, set *VAR to null, and
4712 return null. */
4714 static POINTER_TYPE *
4715 mmap_alloc (var, nbytes)
4716 POINTER_TYPE **var;
4717 size_t nbytes;
4719 void *p;
4720 size_t map;
4722 mmap_init ();
4724 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4725 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4726 mmap_fd, 0);
4728 if (p == MAP_FAILED)
4730 if (errno != ENOMEM)
4731 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4732 p = NULL;
4734 else
4736 struct mmap_region *r = (struct mmap_region *) p;
4738 r->nbytes_specified = nbytes;
4739 r->nbytes_mapped = map;
4740 r->var = var;
4741 r->prev = NULL;
4742 r->next = mmap_regions;
4743 if (r->next)
4744 r->next->prev = r;
4745 mmap_regions = r;
4747 p = MMAP_USER_AREA (p);
4750 return *var = p;
4754 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4755 resize it to size NBYTES. Change *VAR to reflect the new block,
4756 and return this value. If more memory cannot be allocated, then
4757 leave *VAR unchanged, and return null. */
4759 static POINTER_TYPE *
4760 mmap_realloc (var, nbytes)
4761 POINTER_TYPE **var;
4762 size_t nbytes;
4764 POINTER_TYPE *result;
4766 mmap_init ();
4768 if (*var == NULL)
4769 result = mmap_alloc (var, nbytes);
4770 else if (nbytes == 0)
4772 mmap_free (var);
4773 result = mmap_alloc (var, nbytes);
4775 else
4777 struct mmap_region *r = MMAP_REGION (*var);
4778 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4780 if (room < nbytes)
4782 /* Must enlarge. */
4783 POINTER_TYPE *old_ptr = *var;
4785 /* Try to map additional pages at the end of the region.
4786 If that fails, allocate a new region, copy data
4787 from the old region, then free it. */
4788 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4789 / mmap_page_size)))
4791 r->nbytes_specified = nbytes;
4792 *var = result = old_ptr;
4794 else if (mmap_alloc (var, nbytes))
4796 bcopy (old_ptr, *var, r->nbytes_specified);
4797 mmap_free_1 (MMAP_REGION (old_ptr));
4798 result = *var;
4799 r = MMAP_REGION (result);
4800 r->nbytes_specified = nbytes;
4802 else
4804 *var = old_ptr;
4805 result = NULL;
4808 else if (room - nbytes >= mmap_page_size)
4810 /* Shrinking by at least a page. Let's give some
4811 memory back to the system.
4813 The extra parens are to make the division happens first,
4814 on positive values, so we know it will round towards
4815 zero. */
4816 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4817 result = *var;
4818 r->nbytes_specified = nbytes;
4820 else
4822 /* Leave it alone. */
4823 result = *var;
4824 r->nbytes_specified = nbytes;
4828 return result;
4832 /* Free a block of relocatable storage whose data is pointed to by
4833 PTR. Store 0 in *PTR to show there's no block allocated. */
4835 static void
4836 mmap_free (var)
4837 POINTER_TYPE **var;
4839 mmap_init ();
4841 if (*var)
4843 mmap_free_1 (MMAP_REGION (*var));
4844 *var = NULL;
4849 /* Perform necessary intializations for the use of mmap. */
4851 static void
4852 mmap_init ()
4854 #if MAP_ANON == 0
4855 /* The value of mmap_fd is initially 0 in temacs, and -1
4856 in a dumped Emacs. */
4857 if (mmap_fd <= 0)
4859 /* No anonymous mmap -- we need the file descriptor. */
4860 mmap_fd = open ("/dev/zero", O_RDONLY);
4861 if (mmap_fd == -1)
4862 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4864 #endif /* MAP_ANON == 0 */
4866 if (mmap_initialized_p)
4867 return;
4868 mmap_initialized_p = 1;
4870 #if MAP_ANON != 0
4871 mmap_fd = -1;
4872 #endif
4874 mmap_page_size = getpagesize ();
4877 #endif /* USE_MMAP_FOR_BUFFERS */
4881 /***********************************************************************
4882 Buffer-text Allocation
4883 ***********************************************************************/
4885 #ifdef REL_ALLOC
4886 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4887 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4888 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4889 #endif /* REL_ALLOC */
4892 /* Allocate NBYTES bytes for buffer B's text buffer. */
4894 static void
4895 alloc_buffer_text (b, nbytes)
4896 struct buffer *b;
4897 size_t nbytes;
4899 POINTER_TYPE *p;
4901 BLOCK_INPUT;
4902 #if defined USE_MMAP_FOR_BUFFERS
4903 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4904 #elif defined REL_ALLOC
4905 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4906 #else
4907 p = xmalloc (nbytes);
4908 #endif
4910 if (p == NULL)
4912 UNBLOCK_INPUT;
4913 memory_full ();
4916 b->text->beg = (unsigned char *) p;
4917 UNBLOCK_INPUT;
4920 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4921 shrink it. */
4923 void
4924 enlarge_buffer_text (b, delta)
4925 struct buffer *b;
4926 int delta;
4928 POINTER_TYPE *p;
4929 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4930 + delta);
4931 BLOCK_INPUT;
4932 #if defined USE_MMAP_FOR_BUFFERS
4933 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4934 #elif defined REL_ALLOC
4935 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4936 #else
4937 p = xrealloc (b->text->beg, nbytes);
4938 #endif
4940 if (p == NULL)
4942 UNBLOCK_INPUT;
4943 memory_full ();
4946 BUF_BEG_ADDR (b) = (unsigned char *) p;
4947 UNBLOCK_INPUT;
4951 /* Free buffer B's text buffer. */
4953 static void
4954 free_buffer_text (b)
4955 struct buffer *b;
4957 BLOCK_INPUT;
4959 #if defined USE_MMAP_FOR_BUFFERS
4960 mmap_free ((POINTER_TYPE **) &b->text->beg);
4961 #elif defined REL_ALLOC
4962 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4963 #else
4964 xfree (b->text->beg);
4965 #endif
4967 BUF_BEG_ADDR (b) = NULL;
4968 UNBLOCK_INPUT;
4973 /***********************************************************************
4974 Initialization
4975 ***********************************************************************/
4977 void
4978 init_buffer_once ()
4980 int idx;
4982 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4984 /* Make sure all markable slots in buffer_defaults
4985 are initialized reasonably, so mark_buffer won't choke. */
4986 reset_buffer (&buffer_defaults);
4987 reset_buffer_local_variables (&buffer_defaults, 1);
4988 reset_buffer (&buffer_local_symbols);
4989 reset_buffer_local_variables (&buffer_local_symbols, 1);
4990 /* Prevent GC from getting confused. */
4991 buffer_defaults.text = &buffer_defaults.own_text;
4992 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4993 BUF_INTERVALS (&buffer_defaults) = 0;
4994 BUF_INTERVALS (&buffer_local_symbols) = 0;
4995 XSETPVECTYPE (&buffer_defaults, PVEC_BUFFER);
4996 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4997 XSETPVECTYPE (&buffer_local_symbols, PVEC_BUFFER);
4998 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
5000 /* Set up the default values of various buffer slots. */
5001 /* Must do these before making the first buffer! */
5003 /* real setup is done in bindings.el */
5004 buffer_defaults.mode_line_format = build_string ("%-");
5005 buffer_defaults.header_line_format = Qnil;
5006 buffer_defaults.abbrev_mode = Qnil;
5007 buffer_defaults.overwrite_mode = Qnil;
5008 buffer_defaults.case_fold_search = Qt;
5009 buffer_defaults.auto_fill_function = Qnil;
5010 buffer_defaults.selective_display = Qnil;
5011 #ifndef old
5012 buffer_defaults.selective_display_ellipses = Qt;
5013 #endif
5014 buffer_defaults.abbrev_table = Qnil;
5015 buffer_defaults.display_table = Qnil;
5016 buffer_defaults.undo_list = Qnil;
5017 buffer_defaults.mark_active = Qnil;
5018 buffer_defaults.file_format = Qnil;
5019 buffer_defaults.auto_save_file_format = Qt;
5020 buffer_defaults.overlays_before = NULL;
5021 buffer_defaults.overlays_after = NULL;
5022 buffer_defaults.overlay_center = BEG;
5024 XSETFASTINT (buffer_defaults.tab_width, 8);
5025 buffer_defaults.truncate_lines = Qnil;
5026 buffer_defaults.ctl_arrow = Qt;
5027 buffer_defaults.direction_reversed = Qnil;
5028 buffer_defaults.cursor_type = Qt;
5029 buffer_defaults.extra_line_spacing = Qnil;
5030 buffer_defaults.cursor_in_non_selected_windows = Qt;
5032 #ifdef DOS_NT
5033 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
5034 #endif
5035 buffer_defaults.enable_multibyte_characters = Qt;
5036 buffer_defaults.buffer_file_coding_system = Qnil;
5037 XSETFASTINT (buffer_defaults.fill_column, 70);
5038 XSETFASTINT (buffer_defaults.left_margin, 0);
5039 buffer_defaults.cache_long_line_scans = Qnil;
5040 buffer_defaults.file_truename = Qnil;
5041 XSETFASTINT (buffer_defaults.display_count, 0);
5042 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
5043 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
5044 buffer_defaults.left_fringe_width = Qnil;
5045 buffer_defaults.right_fringe_width = Qnil;
5046 buffer_defaults.fringes_outside_margins = Qnil;
5047 buffer_defaults.scroll_bar_width = Qnil;
5048 buffer_defaults.vertical_scroll_bar_type = Qt;
5049 buffer_defaults.indicate_empty_lines = Qnil;
5050 buffer_defaults.indicate_buffer_boundaries = Qnil;
5051 buffer_defaults.fringe_indicator_alist = Qnil;
5052 buffer_defaults.fringe_cursor_alist = Qnil;
5053 buffer_defaults.scroll_up_aggressively = Qnil;
5054 buffer_defaults.scroll_down_aggressively = Qnil;
5055 buffer_defaults.display_time = Qnil;
5057 /* Assign the local-flags to the slots that have default values.
5058 The local flag is a bit that is used in the buffer
5059 to say that it has its own local value for the slot.
5060 The local flag bits are in the local_var_flags slot of the buffer. */
5062 /* Nothing can work if this isn't true */
5063 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
5065 /* 0 means not a lisp var, -1 means always local, else mask */
5066 bzero (&buffer_local_flags, sizeof buffer_local_flags);
5067 XSETINT (buffer_local_flags.filename, -1);
5068 XSETINT (buffer_local_flags.directory, -1);
5069 XSETINT (buffer_local_flags.backed_up, -1);
5070 XSETINT (buffer_local_flags.save_length, -1);
5071 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5072 XSETINT (buffer_local_flags.read_only, -1);
5073 XSETINT (buffer_local_flags.major_mode, -1);
5074 XSETINT (buffer_local_flags.mode_name, -1);
5075 XSETINT (buffer_local_flags.undo_list, -1);
5076 XSETINT (buffer_local_flags.mark_active, -1);
5077 XSETINT (buffer_local_flags.point_before_scroll, -1);
5078 XSETINT (buffer_local_flags.file_truename, -1);
5079 XSETINT (buffer_local_flags.invisibility_spec, -1);
5080 XSETINT (buffer_local_flags.file_format, -1);
5081 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5082 XSETINT (buffer_local_flags.display_count, -1);
5083 XSETINT (buffer_local_flags.display_time, -1);
5084 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5086 idx = 1;
5087 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5088 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5089 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5090 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5091 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5092 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5093 #ifndef old
5094 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5095 #endif
5096 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5097 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5098 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5099 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5100 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5101 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5102 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5103 #ifdef DOS_NT
5104 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5105 /* Make this one a permanent local. */
5106 buffer_permanent_local_flags[idx++] = 1;
5107 #endif
5108 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5109 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5110 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5111 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5112 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5113 /* Make this one a permanent local. */
5114 buffer_permanent_local_flags[idx++] = 1;
5115 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5116 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5117 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5118 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5119 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5120 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5121 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5122 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5123 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5124 XSETFASTINT (buffer_local_flags.fringe_indicator_alist, idx); ++idx;
5125 XSETFASTINT (buffer_local_flags.fringe_cursor_alist, idx); ++idx;
5126 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5127 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5128 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5129 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5130 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5131 XSETFASTINT (buffer_local_flags.cursor_in_non_selected_windows, idx); ++idx;
5133 /* Need more room? */
5134 if (idx >= MAX_PER_BUFFER_VARS)
5135 abort ();
5136 last_per_buffer_idx = idx;
5138 Vbuffer_alist = Qnil;
5139 current_buffer = 0;
5140 all_buffers = 0;
5142 QSFundamental = build_string ("Fundamental");
5144 Qfundamental_mode = intern ("fundamental-mode");
5145 buffer_defaults.major_mode = Qfundamental_mode;
5147 Qmode_class = intern ("mode-class");
5149 Qprotected_field = intern ("protected-field");
5151 Qpermanent_local = intern ("permanent-local");
5153 Qkill_buffer_hook = intern ("kill-buffer-hook");
5154 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5156 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5158 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5160 /* super-magic invisible buffer */
5161 Vbuffer_alist = Qnil;
5163 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5165 inhibit_modification_hooks = 0;
5168 void
5169 init_buffer ()
5171 char *pwd;
5172 Lisp_Object temp;
5173 int len;
5175 #ifdef USE_MMAP_FOR_BUFFERS
5177 /* When using the ralloc implementation based on mmap(2), buffer
5178 text pointers will have been set to null in the dumped Emacs.
5179 Map new memory. */
5180 struct buffer *b;
5182 for (b = all_buffers; b; b = b->next)
5183 if (b->text->beg == NULL)
5184 enlarge_buffer_text (b, 0);
5186 #endif /* USE_MMAP_FOR_BUFFERS */
5188 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5189 if (NILP (buffer_defaults.enable_multibyte_characters))
5190 Fset_buffer_multibyte (Qnil);
5192 pwd = get_current_dir_name ();
5194 if (!pwd)
5195 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5197 #ifndef VMS
5198 /* Maybe this should really use some standard subroutine
5199 whose definition is filename syntax dependent. */
5200 len = strlen (pwd);
5201 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5203 /* Grow buffer to add directory separator and '\0'. */
5204 pwd = (char *) xrealloc (pwd, len + 2);
5205 pwd[len] = DIRECTORY_SEP;
5206 pwd[len + 1] = '\0';
5208 #endif /* not VMS */
5210 current_buffer->directory = make_unibyte_string (pwd, strlen (pwd));
5211 if (! NILP (buffer_defaults.enable_multibyte_characters))
5212 /* At this moment, we still don't know how to decode the
5213 directory name. So, we keep the bytes in multibyte form so
5214 that ENCODE_FILE correctly gets the original bytes. */
5215 current_buffer->directory
5216 = string_to_multibyte (current_buffer->directory);
5218 /* Add /: to the front of the name
5219 if it would otherwise be treated as magic. */
5220 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5221 if (! NILP (temp)
5222 /* If the default dir is just /, TEMP is non-nil
5223 because of the ange-ftp completion handler.
5224 However, it is not necessary to turn / into /:/.
5225 So avoid doing that. */
5226 && strcmp ("/", SDATA (current_buffer->directory)))
5227 current_buffer->directory
5228 = concat2 (build_string ("/:"), current_buffer->directory);
5230 temp = get_minibuffer (0);
5231 XBUFFER (temp)->directory = current_buffer->directory;
5233 free (pwd);
5236 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5237 Object stored in the current buffer. address is the address of the slot
5238 in the buffer that is current now. */
5240 /* TYPE is nil for a general Lisp variable.
5241 An integer specifies a type; then only LIsp values
5242 with that type code are allowed (except that nil is allowed too).
5243 LNAME is the LIsp-level variable name.
5244 VNAME is the name of the buffer slot.
5245 DOC is a dummy where you write the doc string as a comment. */
5246 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5247 defvar_per_buffer (lname, vname, type, 0)
5249 static void
5250 defvar_per_buffer (namestring, address, type, doc)
5251 char *namestring;
5252 Lisp_Object *address;
5253 Lisp_Object type;
5254 char *doc;
5256 Lisp_Object sym, val;
5257 int offset;
5259 sym = intern (namestring);
5260 val = allocate_misc ();
5261 offset = (char *)address - (char *)current_buffer;
5263 XMISCTYPE (val) = Lisp_Misc_Buffer_Objfwd;
5264 XBUFFER_OBJFWD (val)->offset = offset;
5265 XBUFFER_OBJFWD (val)->slottype = type;
5266 SET_SYMBOL_VALUE (sym, val);
5267 PER_BUFFER_SYMBOL (offset) = sym;
5269 if (PER_BUFFER_IDX (offset) == 0)
5270 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5271 slot of buffer_local_flags */
5272 abort ();
5276 /* initialize the buffer routines */
5277 void
5278 syms_of_buffer ()
5280 staticpro (&last_overlay_modification_hooks);
5281 last_overlay_modification_hooks
5282 = Fmake_vector (make_number (10), Qnil);
5284 staticpro (&Vbuffer_defaults);
5285 staticpro (&Vbuffer_local_symbols);
5286 staticpro (&Qfundamental_mode);
5287 staticpro (&Qmode_class);
5288 staticpro (&QSFundamental);
5289 staticpro (&Vbuffer_alist);
5290 staticpro (&Qprotected_field);
5291 staticpro (&Qpermanent_local);
5292 staticpro (&Qkill_buffer_hook);
5293 Qoverlayp = intern ("overlayp");
5294 staticpro (&Qoverlayp);
5295 Qevaporate = intern ("evaporate");
5296 staticpro (&Qevaporate);
5297 Qmodification_hooks = intern ("modification-hooks");
5298 staticpro (&Qmodification_hooks);
5299 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5300 staticpro (&Qinsert_in_front_hooks);
5301 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5302 staticpro (&Qinsert_behind_hooks);
5303 Qget_file_buffer = intern ("get-file-buffer");
5304 staticpro (&Qget_file_buffer);
5305 Qpriority = intern ("priority");
5306 staticpro (&Qpriority);
5307 Qwindow = intern ("window");
5308 staticpro (&Qwindow);
5309 Qbefore_string = intern ("before-string");
5310 staticpro (&Qbefore_string);
5311 Qafter_string = intern ("after-string");
5312 staticpro (&Qafter_string);
5313 Qfirst_change_hook = intern ("first-change-hook");
5314 staticpro (&Qfirst_change_hook);
5315 Qbefore_change_functions = intern ("before-change-functions");
5316 staticpro (&Qbefore_change_functions);
5317 Qafter_change_functions = intern ("after-change-functions");
5318 staticpro (&Qafter_change_functions);
5319 staticpro (&Qucs_set_table_for_input);
5321 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5322 staticpro (&Qkill_buffer_query_functions);
5324 Fput (Qprotected_field, Qerror_conditions,
5325 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5326 Fput (Qprotected_field, Qerror_message,
5327 build_string ("Attempt to modify a protected field"));
5329 /* All these use DEFVAR_LISP_NOPRO because the slots in
5330 buffer_defaults will all be marked via Vbuffer_defaults. */
5332 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5333 &buffer_defaults.mode_line_format,
5334 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5335 This is the same as (default-value 'mode-line-format). */);
5337 DEFVAR_LISP_NOPRO ("default-header-line-format",
5338 &buffer_defaults.header_line_format,
5339 doc: /* Default value of `header-line-format' for buffers that don't override it.
5340 This is the same as (default-value 'header-line-format). */);
5342 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5343 doc: /* Default value of `cursor-type' for buffers that don't override it.
5344 This is the same as (default-value 'cursor-type). */);
5346 DEFVAR_LISP_NOPRO ("default-line-spacing",
5347 &buffer_defaults.extra_line_spacing,
5348 doc: /* Default value of `line-spacing' for buffers that don't override it.
5349 This is the same as (default-value 'line-spacing). */);
5351 DEFVAR_LISP_NOPRO ("default-cursor-in-non-selected-windows",
5352 &buffer_defaults.cursor_in_non_selected_windows,
5353 doc: /* Default value of `cursor-in-non-selected-windows'.
5354 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5356 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5357 &buffer_defaults.abbrev_mode,
5358 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5359 This is the same as (default-value 'abbrev-mode). */);
5361 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5362 &buffer_defaults.ctl_arrow,
5363 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5364 This is the same as (default-value 'ctl-arrow). */);
5366 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5367 &buffer_defaults.direction_reversed,
5368 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5369 This is the same as (default-value 'direction-reversed). */);
5371 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5372 &buffer_defaults.enable_multibyte_characters,
5373 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5374 This is the same as (default-value 'enable-multibyte-characters). */);
5376 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5377 &buffer_defaults.buffer_file_coding_system,
5378 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5379 This is the same as (default-value 'buffer-file-coding-system). */);
5381 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5382 &buffer_defaults.truncate_lines,
5383 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5384 This is the same as (default-value 'truncate-lines). */);
5386 DEFVAR_LISP_NOPRO ("default-fill-column",
5387 &buffer_defaults.fill_column,
5388 doc: /* Default value of `fill-column' for buffers that do not override it.
5389 This is the same as (default-value 'fill-column). */);
5391 DEFVAR_LISP_NOPRO ("default-left-margin",
5392 &buffer_defaults.left_margin,
5393 doc: /* Default value of `left-margin' for buffers that do not override it.
5394 This is the same as (default-value 'left-margin). */);
5396 DEFVAR_LISP_NOPRO ("default-tab-width",
5397 &buffer_defaults.tab_width,
5398 doc: /* Default value of `tab-width' for buffers that do not override it.
5399 This is the same as (default-value 'tab-width). */);
5401 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5402 &buffer_defaults.case_fold_search,
5403 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5404 This is the same as (default-value 'case-fold-search). */);
5406 #ifdef DOS_NT
5407 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5408 &buffer_defaults.buffer_file_type,
5409 doc: /* Default file type for buffers that do not override it.
5410 This is the same as (default-value 'buffer-file-type).
5411 The file type is nil for text, t for binary. */);
5412 #endif
5414 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5415 &buffer_defaults.left_margin_cols,
5416 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5417 This is the same as (default-value 'left-margin-width). */);
5419 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5420 &buffer_defaults.right_margin_cols,
5421 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5422 This is the same as (default-value 'right-margin-width). */);
5424 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5425 &buffer_defaults.left_fringe_width,
5426 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5427 This is the same as (default-value 'left-fringe-width). */);
5429 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5430 &buffer_defaults.right_fringe_width,
5431 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5432 This is the same as (default-value 'right-fringe-width). */);
5434 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5435 &buffer_defaults.fringes_outside_margins,
5436 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5437 This is the same as (default-value 'fringes-outside-margins). */);
5439 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5440 &buffer_defaults.scroll_bar_width,
5441 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5442 This is the same as (default-value 'scroll-bar-width). */);
5444 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5445 &buffer_defaults.vertical_scroll_bar_type,
5446 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5447 This is the same as (default-value 'vertical-scroll-bar). */);
5449 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5450 &buffer_defaults.indicate_empty_lines,
5451 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5452 This is the same as (default-value 'indicate-empty-lines). */);
5454 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5455 &buffer_defaults.indicate_buffer_boundaries,
5456 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5457 This is the same as (default-value 'indicate-buffer-boundaries). */);
5459 DEFVAR_LISP_NOPRO ("default-fringe-indicator-alist",
5460 &buffer_defaults.fringe_indicator_alist,
5461 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5462 This is the same as (default-value 'fringe-indicator-alist'). */);
5464 DEFVAR_LISP_NOPRO ("default-fringe-cursor-alist",
5465 &buffer_defaults.fringe_cursor_alist,
5466 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5467 This is the same as (default-value 'fringe-cursor-alist'). */);
5469 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5470 &buffer_defaults.scroll_up_aggressively,
5471 doc: /* Default value of `scroll-up-aggressively'.
5472 This value applies in buffers that don't have their own local values.
5473 This is the same as (default-value 'scroll-up-aggressively). */);
5475 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5476 &buffer_defaults.scroll_down_aggressively,
5477 doc: /* Default value of `scroll-down-aggressively'.
5478 This value applies in buffers that don't have their own local values.
5479 This is the same as (default-value 'scroll-down-aggressively). */);
5481 DEFVAR_PER_BUFFER ("header-line-format",
5482 &current_buffer->header_line_format,
5483 Qnil,
5484 doc: /* Analogous to `mode-line-format', but controls the header line.
5485 The header line appears, optionally, at the top of a window;
5486 the mode line appears at the bottom. */);
5488 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5489 Qnil,
5490 doc: /* Template for displaying mode line for current buffer.
5491 Each buffer has its own value of this variable.
5492 Value may be nil, a string, a symbol or a list or cons cell.
5493 A value of nil means don't display a mode line.
5494 For a symbol, its value is used (but it is ignored if t or nil).
5495 A string appearing directly as the value of a symbol is processed verbatim
5496 in that the %-constructs below are not recognized.
5497 Note that unless the symbol is marked as a `risky-local-variable', all
5498 properties in any strings, as well as all :eval and :propertize forms
5499 in the value of that symbol will be ignored.
5500 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5501 is used as a mode line element. Be careful--FORM should not load any files,
5502 because that can cause an infinite recursion.
5503 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5504 with the specified properties PROPS applied.
5505 For a list whose car is a symbol, the symbol's value is taken,
5506 and if that is non-nil, the cadr of the list is processed recursively.
5507 Otherwise, the caddr of the list (if there is one) is processed.
5508 For a list whose car is a string or list, each element is processed
5509 recursively and the results are effectively concatenated.
5510 For a list whose car is an integer, the cdr of the list is processed
5511 and padded (if the number is positive) or truncated (if negative)
5512 to the width specified by that number.
5513 A string is printed verbatim in the mode line except for %-constructs:
5514 (%-constructs are allowed when the string is the entire mode-line-format
5515 or when it is found in a cons-cell or a list)
5516 %b -- print buffer name. %f -- print visited file name.
5517 %F -- print frame name.
5518 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5519 %& is like %*, but ignore read-only-ness.
5520 % means buffer is read-only and * means it is modified.
5521 For a modified read-only buffer, %* gives % and %+ gives *.
5522 %s -- print process status. %l -- print the current line number.
5523 %c -- print the current column number (this makes editing slower).
5524 To make the column number update correctly in all cases,
5525 `column-number-mode' must be non-nil.
5526 %i -- print the size of the buffer.
5527 %I -- like %i, but use k, M, G, etc., to abbreviate.
5528 %p -- print percent of buffer above top of window, or Top, Bot or All.
5529 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5530 or print Bottom or All.
5531 %n -- print Narrow if appropriate.
5532 %t -- visited file is text or binary (if OS supports this distinction).
5533 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5534 %Z -- like %z, but including the end-of-line format.
5535 %e -- print error message about full memory.
5536 %@ -- print @ or hyphen. @ means that default-directory is on a
5537 remote machine.
5538 %[ -- print one [ for each recursive editing level. %] similar.
5539 %% -- print %. %- -- print infinitely many dashes.
5540 Decimal digits after the % specify field width to which to pad. */);
5542 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5543 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5544 A value of nil means use current buffer's major mode,
5545 provided it is not marked as "special".
5547 When a mode is used by default, `find-file' switches to it
5548 before it reads the contents into the buffer and before
5549 it finishes setting up the buffer. Thus, the mode and
5550 its hooks should not expect certain variables such as
5551 `buffer-read-only' and `buffer-file-coding-system' to be set up. */);
5553 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5554 make_number (Lisp_Symbol),
5555 doc: /* Symbol for current buffer's major mode. */);
5557 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5558 Qnil,
5559 doc: /* Pretty name of current buffer's major mode (a string). */);
5561 DEFVAR_PER_BUFFER ("local-abbrev-table", &current_buffer->abbrev_table, Qnil,
5562 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5564 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5565 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5567 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5568 Qnil,
5569 doc: /* *Non-nil if searches and matches should ignore case. */);
5571 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5572 make_number (Lisp_Int),
5573 doc: /* *Column beyond which automatic line-wrapping should happen.
5574 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5576 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5577 make_number (Lisp_Int),
5578 doc: /* *Column for the default `indent-line-function' to indent to.
5579 Linefeed indents to this column in Fundamental mode. */);
5581 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5582 make_number (Lisp_Int),
5583 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5585 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5586 doc: /* *Non-nil means display control chars with uparrow.
5587 A value of nil means use backslash and octal digits.
5588 This variable does not apply to characters whose display is specified
5589 in the current display table (if there is one). */);
5591 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5592 &current_buffer->enable_multibyte_characters,
5593 Qnil,
5594 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5595 Otherwise they are regarded as unibyte. This affects the display,
5596 file I/O and the behavior of various editing commands.
5598 This variable is buffer-local but you cannot set it directly;
5599 use the function `set-buffer-multibyte' to change a buffer's representation.
5600 Changing its default value with `setq-default' is supported.
5601 See also variable `default-enable-multibyte-characters' and Info node
5602 `(elisp)Text Representations'. */);
5603 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5605 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5606 &current_buffer->buffer_file_coding_system, Qnil,
5607 doc: /* Coding system to be used for encoding the buffer contents on saving.
5608 This variable applies to saving the buffer, and also to `write-region'
5609 and other functions that use `write-region'.
5610 It does not apply to sending output to subprocesses, however.
5612 If this is nil, the buffer is saved without any code conversion
5613 unless some coding system is specified in `file-coding-system-alist'
5614 for the buffer file.
5616 If the text to be saved cannot be encoded as specified by this variable,
5617 an alternative encoding is selected by `select-safe-coding-system', which see.
5619 The variable `coding-system-for-write', if non-nil, overrides this variable.
5621 This variable is never applied to a way of decoding a file while reading it. */);
5623 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5624 Qnil,
5625 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5627 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5628 doc: /* *Non-nil means do not display continuation lines.
5629 Instead, give each line of text just one screen line.
5631 Note that this is overridden by the variable
5632 `truncate-partial-width-windows' if that variable is non-nil
5633 and this buffer is not full-frame width. */);
5635 #ifdef DOS_NT
5636 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5637 Qnil,
5638 doc: /* Non-nil if the visited file is a binary file.
5639 This variable is meaningful on MS-DOG and Windows NT.
5640 On those systems, it is automatically local in every buffer.
5641 On other systems, this variable is normally always nil. */);
5642 #endif
5644 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5645 make_number (Lisp_String),
5646 doc: /* Name of default directory of current buffer. Should end with slash.
5647 To interactively change the default directory, use command `cd'. */);
5649 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5650 Qnil,
5651 doc: /* Function called (if non-nil) to perform auto-fill.
5652 It is called after self-inserting any character specified in
5653 the `auto-fill-chars' table.
5654 NOTE: This variable is not a hook;
5655 its value may not be a list of functions. */);
5657 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5658 make_number (Lisp_String),
5659 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5661 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5662 make_number (Lisp_String),
5663 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5664 The truename of a file is calculated by `file-truename'
5665 and then abbreviated with `abbreviate-file-name'. */);
5667 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5668 &current_buffer->auto_save_file_name,
5669 make_number (Lisp_String),
5670 doc: /* Name of file for auto-saving current buffer.
5671 If it is nil, that means don't auto-save this buffer. */);
5673 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5674 doc: /* Non-nil if this buffer is read-only. */);
5676 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5677 doc: /* Non-nil if this buffer's file has been backed up.
5678 Backing up is done before the first time the file is saved. */);
5680 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5681 make_number (Lisp_Int),
5682 doc: /* Length of current buffer when last read in, saved or auto-saved.
5683 0 initially. */);
5685 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5686 Qnil,
5687 doc: /* Non-nil enables selective display.
5688 An integer N as value means display only lines
5689 that start with less than N columns of space.
5690 A value of t means that the character ^M makes itself and
5691 all the rest of the line invisible; also, when saving the buffer
5692 in a file, save the ^M as a newline. */);
5694 #ifndef old
5695 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5696 &current_buffer->selective_display_ellipses,
5697 Qnil,
5698 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5699 #endif
5701 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5702 doc: /* Non-nil if self-insertion should replace existing text.
5703 The value should be one of `overwrite-mode-textual',
5704 `overwrite-mode-binary', or nil.
5705 If it is `overwrite-mode-textual', self-insertion still
5706 inserts at the end of a line, and inserts when point is before a tab,
5707 until the tab is filled in.
5708 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5710 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5711 Qnil,
5712 doc: /* Display table that controls display of the contents of current buffer.
5714 If this variable is nil, the value of `standard-display-table' is used.
5715 Each window can have its own, overriding display table, see
5716 `set-window-display-table' and `window-display-table'.
5718 The display table is a char-table created with `make-display-table'.
5719 A char-table is an array indexed by character codes. Normal array
5720 primitives `aref' and `aset' can be used to access elements of a char-table.
5722 Each of the char-table elements control how to display the corresponding
5723 text character: the element at index C in the table says how to display
5724 the character whose code is C. Each element should be a vector of
5725 characters or nil. The value nil means display the character in the
5726 default fashion; otherwise, the characters from the vector are delivered
5727 to the screen instead of the original character.
5729 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5730 to display a capital Y instead of each X character.
5732 In addition, a char-table has six extra slots to control the display of:
5734 the end of a truncated screen line (extra-slot 0, a single character);
5735 the end of a continued line (extra-slot 1, a single character);
5736 the escape character used to display character codes in octal
5737 (extra-slot 2, a single character);
5738 the character used as an arrow for control characters (extra-slot 3,
5739 a single character);
5740 the decoration indicating the presence of invisible lines (extra-slot 4,
5741 a vector of characters);
5742 the character used to draw the border between side-by-side windows
5743 (extra-slot 5, a single character).
5745 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5747 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5748 Qnil,
5749 doc: /* *Width of left marginal area for display of a buffer.
5750 A value of nil means no marginal area. */);
5752 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5753 Qnil,
5754 doc: /* *Width of right marginal area for display of a buffer.
5755 A value of nil means no marginal area. */);
5757 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5758 Qnil,
5759 doc: /* *Width of this buffer's left fringe (in pixels).
5760 A value of 0 means no left fringe is shown in this buffer's window.
5761 A value of nil means to use the left fringe width from the window's frame. */);
5763 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5764 Qnil,
5765 doc: /* *Width of this buffer's right fringe (in pixels).
5766 A value of 0 means no right fringe is shown in this buffer's window.
5767 A value of nil means to use the right fringe width from the window's frame. */);
5769 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5770 Qnil,
5771 doc: /* *Non-nil means to display fringes outside display margins.
5772 A value of nil means to display fringes between margins and buffer text. */);
5774 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5775 Qnil,
5776 doc: /* *Width of this buffer's scroll bars in pixels.
5777 A value of nil means to use the scroll bar width from the window's frame. */);
5779 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5780 Qnil,
5781 doc: /* *Position of this buffer's vertical scroll bar.
5782 The value takes effect whenever you tell a window to display this buffer;
5783 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5785 A value of `left' or `right' means put the vertical scroll bar at that side
5786 of the window; a value of nil means don't show any vertical scroll bars.
5787 A value of t (the default) means do whatever the window's frame specifies. */);
5789 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5790 &current_buffer->indicate_empty_lines, Qnil,
5791 doc: /* *Visually indicate empty lines after the buffer end.
5792 If non-nil, a bitmap is displayed in the left fringe of a window on
5793 window-systems. */);
5795 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5796 &current_buffer->indicate_buffer_boundaries, Qnil,
5797 doc: /* *Visually indicate buffer boundaries and scrolling.
5798 If non-nil, the first and last line of the buffer are marked in the fringe
5799 of a window on window-systems with angle bitmaps, or if the window can be
5800 scrolled, the top and bottom line of the window are marked with up and down
5801 arrow bitmaps.
5803 If value is a symbol `left' or `right', both angle and arrow bitmaps
5804 are displayed in the left or right fringe, resp. Any other value
5805 that doesn't look like an alist means display the angle bitmaps in
5806 the left fringe but no arrows.
5808 You can exercise more precise control by using an alist as the
5809 value. Each alist element (INDICATOR . POSITION) specifies
5810 where to show one of the indicators. INDICATOR is one of `top',
5811 `bottom', `up', `down', or t, which specifies the default position,
5812 and POSITION is one of `left', `right', or nil, meaning do not show
5813 this indicator.
5815 For example, ((top . left) (t . right)) places the top angle bitmap in
5816 left fringe, the bottom angle bitmap in right fringe, and both arrow
5817 bitmaps in right fringe. To show just the angle bitmaps in the left
5818 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5820 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5821 &current_buffer->fringe_indicator_alist, Qnil,
5822 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5823 The value is an alist where each element (INDICATOR . BITMAPS)
5824 specifies the fringe bitmaps used to display a specific logical
5825 fringe indicator.
5827 INDICATOR specifies the logical indicator type which is one of the
5828 following symbols: `truncation' , `continuation', `overlay-arrow',
5829 `top', `bottom', `up', `down', `one-line', `empty-line', or `unknown'.
5831 BITMAPS is list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5832 the actual bitmap shown in the left or right fringe for the logical
5833 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5834 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5835 are used only for the `bottom' and `one-line' indicators when the last
5836 \(only) line in has no final newline. BITMAPS may also be a single
5837 symbol which is used in both left and right fringes. */);
5839 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5840 &current_buffer->fringe_cursor_alist, Qnil,
5841 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5842 The value is an alist where each element (CURSOR . BITMAP)
5843 specifies the fringe bitmaps used to display a specific logical
5844 cursor type in the fringe.
5846 CURSOR specifies the logical cursor type which is one of the following
5847 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5848 one is used to show a hollow cursor on narrow lines display lines
5849 where the normal hollow cursor will not fit.
5851 BITMAP is the corresponding fringe bitmap shown for the logical
5852 cursor type. */);
5854 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5855 &current_buffer->scroll_up_aggressively, Qnil,
5856 doc: /* How far to scroll windows upward.
5857 If you move point off the bottom, the window scrolls automatically.
5858 This variable controls how far it scrolls. The value nil, the default,
5859 means scroll to center point. A fraction means scroll to put point
5860 that fraction of the window's height from the bottom of the window.
5861 When the value is 0.0, point goes at the bottom line, which in the simple
5862 case that you moved off with C-f means scrolling just one line. 1.0 means
5863 point goes at the top, so that in that simple case, the window
5864 scrolls by a full window height. Meaningful values are
5865 between 0.0 and 1.0, inclusive. */);
5867 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5868 &current_buffer->scroll_down_aggressively, Qnil,
5869 doc: /* How far to scroll windows downward.
5870 If you move point off the top, the window scrolls automatically.
5871 This variable controls how far it scrolls. The value nil, the default,
5872 means scroll to center point. A fraction means scroll to put point
5873 that fraction of the window's height from the top of the window.
5874 When the value is 0.0, point goes at the top line, which in the simple
5875 case that you moved off with C-b means scrolling just one line. 1.0 means
5876 point goes at the bottom, so that in that simple case, the window
5877 scrolls by a full window height. Meaningful values are
5878 between 0.0 and 1.0, inclusive. */);
5880 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5881 "Don't ask.");
5884 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5885 doc: /* List of functions to call before each text change.
5886 Two arguments are passed to each function: the positions of
5887 the beginning and end of the range of old text to be changed.
5888 \(For an insertion, the beginning and end are at the same place.)
5889 No information is given about the length of the text after the change.
5891 Buffer changes made while executing the `before-change-functions'
5892 don't call any before-change or after-change functions.
5893 That's because these variables are temporarily set to nil.
5894 As a result, a hook function cannot straightforwardly alter the value of
5895 these variables. See the Emacs Lisp manual for a way of
5896 accomplishing an equivalent result by using other variables.
5898 If an unhandled error happens in running these functions,
5899 the variable's value remains nil. That prevents the error
5900 from happening repeatedly and making Emacs nonfunctional. */);
5901 Vbefore_change_functions = Qnil;
5903 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5904 doc: /* List of functions to call after each text change.
5905 Three arguments are passed to each function: the positions of
5906 the beginning and end of the range of changed text,
5907 and the length in bytes of the pre-change text replaced by that range.
5908 \(For an insertion, the pre-change length is zero;
5909 for a deletion, that length is the number of bytes deleted,
5910 and the post-change beginning and end are at the same place.)
5912 Buffer changes made while executing the `after-change-functions'
5913 don't call any before-change or after-change functions.
5914 That's because these variables are temporarily set to nil.
5915 As a result, a hook function cannot straightforwardly alter the value of
5916 these variables. See the Emacs Lisp manual for a way of
5917 accomplishing an equivalent result by using other variables.
5919 If an unhandled error happens in running these functions,
5920 the variable's value remains nil. That prevents the error
5921 from happening repeatedly and making Emacs nonfunctional. */);
5922 Vafter_change_functions = Qnil;
5924 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5925 doc: /* A list of functions to call before changing a buffer which is unmodified.
5926 The functions are run using the `run-hooks' function. */);
5927 Vfirst_change_hook = Qnil;
5929 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5930 doc: /* List of undo entries in current buffer.
5931 Recent changes come first; older changes follow newer.
5933 An entry (BEG . END) represents an insertion which begins at
5934 position BEG and ends at position END.
5936 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5937 from (abs POSITION). If POSITION is positive, point was at the front
5938 of the text being deleted; if negative, point was at the end.
5940 An entry (t HIGH . LOW) indicates that the buffer previously had
5941 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5942 of the visited file's modification time, as of that time. If the
5943 modification time of the most recent save is different, this entry is
5944 obsolete.
5946 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5947 was modified between BEG and END. PROPERTY is the property name,
5948 and VALUE is the old value.
5950 An entry (apply FUN-NAME . ARGS) means undo the change with
5951 \(apply FUN-NAME ARGS).
5953 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5954 in the active region. BEG and END is the range affected by this entry
5955 and DELTA is the number of bytes added or deleted in that range by
5956 this change.
5958 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5959 was adjusted in position by the offset DISTANCE (an integer).
5961 An entry of the form POSITION indicates that point was at the buffer
5962 location given by the integer. Undoing an entry of this form places
5963 point at POSITION.
5965 Entries with value `nil' mark undo boundaries. The undo command treats
5966 the changes between two undo boundaries as a single step to be undone.
5968 If the value of the variable is t, undo information is not recorded. */);
5970 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5971 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5973 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5974 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5976 Normally, the line-motion functions work by scanning the buffer for
5977 newlines. Columnar operations (like `move-to-column' and
5978 `compute-motion') also work by scanning the buffer, summing character
5979 widths as they go. This works well for ordinary text, but if the
5980 buffer's lines are very long (say, more than 500 characters), these
5981 motion functions will take longer to execute. Emacs may also take
5982 longer to update the display.
5984 If `cache-long-line-scans' is non-nil, these motion functions cache the
5985 results of their scans, and consult the cache to avoid rescanning
5986 regions of the buffer until the text is modified. The caches are most
5987 beneficial when they prevent the most searching---that is, when the
5988 buffer contains long lines and large regions of characters with the
5989 same, fixed screen width.
5991 When `cache-long-line-scans' is non-nil, processing short lines will
5992 become slightly slower (because of the overhead of consulting the
5993 cache), and the caches will use memory roughly proportional to the
5994 number of newlines and characters whose screen width varies.
5996 The caches require no explicit maintenance; their accuracy is
5997 maintained internally by the Emacs primitives. Enabling or disabling
5998 the cache should not affect the behavior of any of the motion
5999 functions; it should only affect their performance. */);
6001 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
6002 doc: /* Value of point before the last series of scroll operations, or nil. */);
6004 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
6005 doc: /* List of formats to use when saving this buffer.
6006 Formats are defined by `format-alist'. This variable is
6007 set when a file is visited. */);
6009 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6010 &current_buffer->auto_save_file_format, Qnil,
6011 doc: /* *Format in which to write auto-save files.
6012 Should be a list of symbols naming formats that are defined in `format-alist'.
6013 If it is t, which is the default, auto-save files are written in the
6014 same format as a regular save would use. */);
6016 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6017 &current_buffer->invisibility_spec, Qnil,
6018 doc: /* Invisibility spec of this buffer.
6019 The default is t, which means that text is invisible
6020 if it has a non-nil `invisible' property.
6021 If the value is a list, a text character is invisible if its `invisible'
6022 property is an element in that list (or is a list with members in common).
6023 If an element is a cons cell of the form (PROP . ELLIPSIS),
6024 then characters with property value PROP are invisible,
6025 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
6027 DEFVAR_PER_BUFFER ("buffer-display-count",
6028 &current_buffer->display_count, Qnil,
6029 doc: /* A number incremented each time this buffer is displayed in a window.
6030 The function `set-window-buffer' increments it. */);
6032 DEFVAR_PER_BUFFER ("buffer-display-time",
6033 &current_buffer->display_time, Qnil,
6034 doc: /* Time stamp updated each time this buffer is displayed in a window.
6035 The function `set-window-buffer' updates this variable
6036 to the value obtained by calling `current-time'.
6037 If the buffer has never been shown in a window, the value is nil. */);
6039 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
6040 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
6041 Non-nil also enables highlighting of the region whenever the mark is active.
6042 The variable `highlight-nonselected-windows' controls whether to highlight
6043 all windows or just the selected window.
6045 If the value is `lambda', that enables Transient Mark mode temporarily
6046 until the next buffer modification. If a command sets the value to `only',
6047 that enables Transient Mark mode for the following command only.
6048 During that following command, the value of `transient-mark-mode'
6049 is `identity'. If it is still `identity' at the end of that command,
6050 it changes to nil. */);
6051 Vtransient_mark_mode = Qnil;
6053 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
6054 doc: /* *Non-nil means disregard read-only status of buffers or characters.
6055 If the value is t, disregard `buffer-read-only' and all `read-only'
6056 text properties. If the value is a list, disregard `buffer-read-only'
6057 and disregard a `read-only' text property if the property value
6058 is a member of the list. */);
6059 Vinhibit_read_only = Qnil;
6061 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
6062 doc: /* Cursor to use when this buffer is in the selected window.
6063 Values are interpreted as follows:
6065 t use the cursor specified for the frame
6066 nil don't display a cursor
6067 box display a filled box cursor
6068 hollow display a hollow box cursor
6069 bar display a vertical bar cursor with default width
6070 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6071 hbar display a horizontal bar cursor with default height
6072 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6073 ANYTHING ELSE display a hollow box cursor
6075 When the buffer is displayed in a nonselected window,
6076 this variable has no effect; the cursor appears as a hollow box. */);
6078 DEFVAR_PER_BUFFER ("line-spacing",
6079 &current_buffer->extra_line_spacing, Qnil,
6080 doc: /* Additional space to put between lines when displaying a buffer.
6081 The space is measured in pixels, and put below lines on window systems.
6082 If value is a floating point number, it specifies the spacing relative
6083 to the default frame line height. A value of nil means add no extra space. */);
6085 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6086 &current_buffer->cursor_in_non_selected_windows, Qnil,
6087 doc: /* *Cursor type to display in non-selected windows.
6088 The value t means to use hollow box cursor. See `cursor-type' for other values. */);
6090 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
6091 doc: /* List of functions called with no args to query before killing a buffer.
6092 The buffer being killed will be current while the functions are running.
6093 If any of them returns nil, the buffer is not killed. */);
6094 Vkill_buffer_query_functions = Qnil;
6096 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook,
6097 doc: /* Normal hook run before changing the major mode of a buffer.
6098 The function `kill-all-local-variables' runs this before doing anything else. */);
6099 Vchange_major_mode_hook = Qnil;
6100 Qchange_major_mode_hook = intern ("change-major-mode-hook");
6101 staticpro (&Qchange_major_mode_hook);
6103 defsubr (&Sbuffer_live_p);
6104 defsubr (&Sbuffer_list);
6105 defsubr (&Sget_buffer);
6106 defsubr (&Sget_file_buffer);
6107 defsubr (&Sget_buffer_create);
6108 defsubr (&Smake_indirect_buffer);
6109 defsubr (&Sgenerate_new_buffer_name);
6110 defsubr (&Sbuffer_name);
6111 /*defsubr (&Sbuffer_number);*/
6112 defsubr (&Sbuffer_file_name);
6113 defsubr (&Sbuffer_base_buffer);
6114 defsubr (&Sbuffer_local_value);
6115 defsubr (&Sbuffer_local_variables);
6116 defsubr (&Sbuffer_modified_p);
6117 defsubr (&Sset_buffer_modified_p);
6118 defsubr (&Sbuffer_modified_tick);
6119 defsubr (&Sbuffer_chars_modified_tick);
6120 defsubr (&Srename_buffer);
6121 defsubr (&Sother_buffer);
6122 defsubr (&Sbuffer_enable_undo);
6123 defsubr (&Skill_buffer);
6124 defsubr (&Sset_buffer_major_mode);
6125 defsubr (&Sswitch_to_buffer);
6126 defsubr (&Spop_to_buffer);
6127 defsubr (&Scurrent_buffer);
6128 defsubr (&Sset_buffer);
6129 defsubr (&Sbarf_if_buffer_read_only);
6130 defsubr (&Sbury_buffer);
6131 defsubr (&Serase_buffer);
6132 defsubr (&Sset_buffer_multibyte);
6133 defsubr (&Skill_all_local_variables);
6135 defsubr (&Soverlayp);
6136 defsubr (&Smake_overlay);
6137 defsubr (&Sdelete_overlay);
6138 defsubr (&Smove_overlay);
6139 defsubr (&Soverlay_start);
6140 defsubr (&Soverlay_end);
6141 defsubr (&Soverlay_buffer);
6142 defsubr (&Soverlay_properties);
6143 defsubr (&Soverlays_at);
6144 defsubr (&Soverlays_in);
6145 defsubr (&Snext_overlay_change);
6146 defsubr (&Sprevious_overlay_change);
6147 defsubr (&Soverlay_recenter);
6148 defsubr (&Soverlay_lists);
6149 defsubr (&Soverlay_get);
6150 defsubr (&Soverlay_put);
6151 defsubr (&Srestore_buffer_modified_p);
6154 void
6155 keys_of_buffer ()
6157 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6158 initial_define_key (control_x_map, 'k', "kill-buffer");
6160 /* This must not be in syms_of_buffer, because Qdisabled is not
6161 initialized when that function gets called. */
6162 Fput (intern ("erase-buffer"), Qdisabled, Qt);
6165 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
6166 (do not change this comment) */