* arc-mode.el (archive-unique-fname): Make directories for nested
[emacs.git] / src / buffer.c
blob1880581c0a11f7988cffde8dc8e4e779937815b2
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, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <sys/param.h>
27 #include <errno.h>
28 #include <stdio.h>
29 #include <setjmp.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 "character.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 EXFUN (Fset_buffer, 1);
111 void set_buffer_internal P_ ((struct buffer *b));
112 void set_buffer_internal_1 P_ ((struct buffer *b));
113 static void call_overlay_mod_hooks P_ ((Lisp_Object list, Lisp_Object overlay,
114 int after, Lisp_Object arg1,
115 Lisp_Object arg2, Lisp_Object arg3));
116 static void swap_out_buffer_local_variables P_ ((struct buffer *b));
117 static void reset_buffer_local_variables P_ ((struct buffer *b, int permanent_too));
119 /* Alist of all buffer names vs the buffers. */
120 /* This used to be a variable, but is no longer,
121 to prevent lossage due to user rplac'ing this alist or its elements. */
122 Lisp_Object Vbuffer_alist;
124 /* Functions to call before and after each text change. */
125 Lisp_Object Vbefore_change_functions;
126 Lisp_Object Vafter_change_functions;
128 Lisp_Object Vtransient_mark_mode;
130 /* t means ignore all read-only text properties.
131 A list means ignore such a property if its value is a member of the list.
132 Any non-nil value means ignore buffer-read-only. */
133 Lisp_Object Vinhibit_read_only;
135 /* List of functions to call that can query about killing a buffer.
136 If any of these functions returns nil, we don't kill it. */
137 Lisp_Object Vkill_buffer_query_functions;
138 Lisp_Object Qkill_buffer_query_functions;
140 /* Hook run before changing a major mode. */
141 Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;
143 /* List of functions to call before changing an unmodified buffer. */
144 Lisp_Object Vfirst_change_hook;
146 Lisp_Object Qfirst_change_hook;
147 Lisp_Object Qbefore_change_functions;
148 Lisp_Object Qafter_change_functions;
149 Lisp_Object Qucs_set_table_for_input;
151 /* If nonzero, all modification hooks are suppressed. */
152 int inhibit_modification_hooks;
154 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
155 Lisp_Object Qpermanent_local_hook;
157 Lisp_Object Qprotected_field;
159 Lisp_Object QSFundamental; /* A string "Fundamental" */
161 Lisp_Object Qkill_buffer_hook;
163 Lisp_Object Qget_file_buffer;
165 Lisp_Object Qoverlayp;
167 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
169 Lisp_Object Qmodification_hooks;
170 Lisp_Object Qinsert_in_front_hooks;
171 Lisp_Object Qinsert_behind_hooks;
173 static void alloc_buffer_text P_ ((struct buffer *, size_t));
174 static void free_buffer_text P_ ((struct buffer *b));
175 static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
176 static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
177 static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
179 extern char * emacs_strerror P_ ((int));
181 /* For debugging; temporary. See set_buffer_internal. */
182 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
184 void
185 nsberror (spec)
186 Lisp_Object spec;
188 if (STRINGP (spec))
189 error ("No buffer named %s", SDATA (spec));
190 error ("Invalid buffer argument");
193 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
194 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
195 Value is nil if OBJECT is not a buffer or if it has been killed. */)
196 (object)
197 Lisp_Object object;
199 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
200 ? Qt : Qnil);
203 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
204 doc: /* Return a list of all existing live buffers.
205 If the optional arg FRAME is a frame, we return the buffer list
206 in the proper order for that frame: the buffers in FRAME's `buffer-list'
207 frame parameter come first, followed by the rest of the buffers. */)
208 (frame)
209 Lisp_Object frame;
211 Lisp_Object general;
212 general = Fmapcar (Qcdr, Vbuffer_alist);
214 if (FRAMEP (frame))
216 Lisp_Object framelist, prevlist, tail;
217 Lisp_Object args[3];
219 CHECK_FRAME (frame);
221 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
222 prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
224 /* Remove from GENERAL any buffer that duplicates one in
225 FRAMELIST or PREVLIST. */
226 tail = framelist;
227 while (CONSP (tail))
229 general = Fdelq (XCAR (tail), general);
230 tail = XCDR (tail);
232 tail = prevlist;
233 while (CONSP (tail))
235 general = Fdelq (XCAR (tail), general);
236 tail = XCDR (tail);
239 args[0] = framelist;
240 args[1] = general;
241 args[2] = prevlist;
242 return Fnconc (3, args);
245 return general;
248 /* Like Fassoc, but use Fstring_equal to compare
249 (which ignores text properties),
250 and don't ever QUIT. */
252 static Lisp_Object
253 assoc_ignore_text_properties (key, list)
254 register Lisp_Object key;
255 Lisp_Object list;
257 register Lisp_Object tail;
258 for (tail = list; CONSP (tail); tail = XCDR (tail))
260 register Lisp_Object elt, tem;
261 elt = XCAR (tail);
262 tem = Fstring_equal (Fcar (elt), key);
263 if (!NILP (tem))
264 return elt;
266 return Qnil;
269 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
270 doc: /* Return the buffer named BUFFER-OR-NAME.
271 BUFFER-OR-NAME must be either a string or a buffer. If BUFFER-OR-NAME
272 is a string and there is no buffer with that name, return nil. If
273 BUFFER-OR-NAME is a buffer, return it as given. */)
274 (buffer_or_name)
275 register Lisp_Object buffer_or_name;
277 if (BUFFERP (buffer_or_name))
278 return buffer_or_name;
279 CHECK_STRING (buffer_or_name);
281 return Fcdr (assoc_ignore_text_properties (buffer_or_name, Vbuffer_alist));
284 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
285 doc: /* Return the buffer visiting file FILENAME (a string).
286 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
287 If there is no such live buffer, return nil.
288 See also `find-buffer-visiting'. */)
289 (filename)
290 register Lisp_Object filename;
292 register Lisp_Object tail, buf, tem;
293 Lisp_Object handler;
295 CHECK_STRING (filename);
296 filename = Fexpand_file_name (filename, Qnil);
298 /* If the file name has special constructs in it,
299 call the corresponding file handler. */
300 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
301 if (!NILP (handler))
302 return call2 (handler, Qget_file_buffer, filename);
304 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
306 buf = Fcdr (XCAR (tail));
307 if (!BUFFERP (buf)) continue;
308 if (!STRINGP (XBUFFER (buf)->filename)) continue;
309 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
310 if (!NILP (tem))
311 return buf;
313 return Qnil;
316 Lisp_Object
317 get_truename_buffer (filename)
318 register Lisp_Object filename;
320 register Lisp_Object tail, buf, tem;
322 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
324 buf = Fcdr (XCAR (tail));
325 if (!BUFFERP (buf)) continue;
326 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
327 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
328 if (!NILP (tem))
329 return buf;
331 return Qnil;
334 /* Incremented for each buffer created, to assign the buffer number. */
335 int buffer_count;
337 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
338 doc: /* Return the buffer specified by BUFFER-OR-NAME, creating a new one if needed.
339 If BUFFER-OR-NAME is a string and a live buffer with that name exists,
340 return that buffer. If no such buffer exists, create a new buffer with
341 that name and return it. If BUFFER-OR-NAME starts with a space, the new
342 buffer does not keep undo information.
344 If BUFFER-OR-NAME is a buffer instead of a string, return it as given,
345 even if it is dead. The return value is never nil. */)
346 (buffer_or_name)
347 register Lisp_Object buffer_or_name;
349 register Lisp_Object buffer, name;
350 register struct buffer *b;
352 buffer = Fget_buffer (buffer_or_name);
353 if (!NILP (buffer))
354 return buffer;
356 if (SCHARS (buffer_or_name) == 0)
357 error ("Empty string for buffer name is not allowed");
359 b = allocate_buffer ();
361 /* An ordinary buffer uses its own struct buffer_text. */
362 b->text = &b->own_text;
363 b->base_buffer = 0;
365 BUF_GAP_SIZE (b) = 20;
366 BLOCK_INPUT;
367 /* We allocate extra 1-byte at the tail and keep it always '\0' for
368 anchoring a search. */
369 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
370 UNBLOCK_INPUT;
371 if (! BUF_BEG_ADDR (b))
372 buffer_memory_full ();
374 BUF_PT (b) = BEG;
375 BUF_GPT (b) = BEG;
376 BUF_BEGV (b) = BEG;
377 BUF_ZV (b) = BEG;
378 BUF_Z (b) = BEG;
379 BUF_PT_BYTE (b) = BEG_BYTE;
380 BUF_GPT_BYTE (b) = BEG_BYTE;
381 BUF_BEGV_BYTE (b) = BEG_BYTE;
382 BUF_ZV_BYTE (b) = BEG_BYTE;
383 BUF_Z_BYTE (b) = BEG_BYTE;
384 BUF_MODIFF (b) = 1;
385 BUF_CHARS_MODIFF (b) = 1;
386 BUF_OVERLAY_MODIFF (b) = 1;
387 BUF_SAVE_MODIFF (b) = 1;
388 BUF_INTERVALS (b) = 0;
389 BUF_UNCHANGED_MODIFIED (b) = 1;
390 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
391 BUF_END_UNCHANGED (b) = 0;
392 BUF_BEG_UNCHANGED (b) = 0;
393 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
395 b->newline_cache = 0;
396 b->width_run_cache = 0;
397 b->width_table = Qnil;
398 b->prevent_redisplay_optimizations_p = 1;
400 /* Put this on the chain of all buffers including killed ones. */
401 b->next = all_buffers;
402 all_buffers = b;
404 /* An ordinary buffer normally doesn't need markers
405 to handle BEGV and ZV. */
406 b->pt_marker = Qnil;
407 b->begv_marker = Qnil;
408 b->zv_marker = Qnil;
410 name = Fcopy_sequence (buffer_or_name);
411 STRING_SET_INTERVALS (name, NULL_INTERVAL);
412 b->name = name;
414 b->undo_list = (SREF (name, 0) != ' ') ? Qnil : Qt;
416 reset_buffer (b);
417 reset_buffer_local_variables (b, 1);
419 b->mark = Fmake_marker ();
420 BUF_MARKERS (b) = NULL;
421 b->name = name;
423 /* Put this in the alist of all live buffers. */
424 XSETBUFFER (buffer, b);
425 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buffer), Qnil));
427 /* An error in calling the function here (should someone redefine it)
428 can lead to infinite regress until you run out of stack. rms
429 says that's not worth protecting against. */
430 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
431 /* buffer is on buffer-alist, so no gcpro. */
432 call1 (Qucs_set_table_for_input, buffer);
434 return buffer;
438 /* Return a list of overlays which is a copy of the overlay list
439 LIST, but for buffer B. */
441 static struct Lisp_Overlay *
442 copy_overlays (b, list)
443 struct buffer *b;
444 struct Lisp_Overlay *list;
446 Lisp_Object buffer;
447 struct Lisp_Overlay *result = NULL, *tail = NULL;
449 XSETBUFFER (buffer, b);
451 for (; list; list = list->next)
453 Lisp_Object overlay, start, end, old_overlay;
454 EMACS_INT charpos;
456 XSETMISC (old_overlay, list);
457 charpos = marker_position (OVERLAY_START (old_overlay));
458 start = Fmake_marker ();
459 Fset_marker (start, make_number (charpos), buffer);
460 XMARKER (start)->insertion_type
461 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
463 charpos = marker_position (OVERLAY_END (old_overlay));
464 end = Fmake_marker ();
465 Fset_marker (end, make_number (charpos), buffer);
466 XMARKER (end)->insertion_type
467 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
469 overlay = allocate_misc ();
470 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
471 OVERLAY_START (overlay) = start;
472 OVERLAY_END (overlay) = end;
473 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
474 XOVERLAY (overlay)->next = NULL;
476 if (tail)
477 tail = tail->next = XOVERLAY (overlay);
478 else
479 result = tail = XOVERLAY (overlay);
482 return result;
486 /* Clone per-buffer values of buffer FROM.
488 Buffer TO gets the same per-buffer values as FROM, with the
489 following exceptions: (1) TO's name is left untouched, (2) markers
490 are copied and made to refer to TO, and (3) overlay lists are
491 copied. */
493 static void
494 clone_per_buffer_values (from, to)
495 struct buffer *from, *to;
497 Lisp_Object to_buffer;
498 int offset;
500 XSETBUFFER (to_buffer, to);
502 /* buffer-local Lisp variables start at `undo_list',
503 tho only the ones from `name' on are GC'd normally. */
504 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
505 offset < sizeof *to;
506 offset += sizeof (Lisp_Object))
508 Lisp_Object obj;
510 /* Don't touch the `name' which should be unique for every buffer. */
511 if (offset == PER_BUFFER_VAR_OFFSET (name))
512 continue;
514 obj = PER_BUFFER_VALUE (from, offset);
515 if (MARKERP (obj))
517 struct Lisp_Marker *m = XMARKER (obj);
518 obj = Fmake_marker ();
519 XMARKER (obj)->insertion_type = m->insertion_type;
520 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
523 PER_BUFFER_VALUE (to, offset) = obj;
526 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
528 to->overlays_before = copy_overlays (to, from->overlays_before);
529 to->overlays_after = copy_overlays (to, from->overlays_after);
531 /* Get (a copy of) the alist of Lisp-level local variables of FROM
532 and install that in TO. */
533 to->local_var_alist = buffer_lisp_local_variables (from);
536 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
537 2, 3,
538 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
539 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
540 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
541 NAME should be a string which is not the name of an existing buffer.
542 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
543 such as major and minor modes, in the indirect buffer.
544 CLONE nil means the indirect buffer's state is reset to default values. */)
545 (base_buffer, name, clone)
546 Lisp_Object base_buffer, name, clone;
548 Lisp_Object buf, tem;
549 struct buffer *b;
551 CHECK_STRING (name);
552 buf = Fget_buffer (name);
553 if (!NILP (buf))
554 error ("Buffer name `%s' is in use", SDATA (name));
556 tem = base_buffer;
557 base_buffer = Fget_buffer (base_buffer);
558 if (NILP (base_buffer))
559 error ("No such buffer: `%s'", SDATA (tem));
560 if (NILP (XBUFFER (base_buffer)->name))
561 error ("Base buffer has been killed");
563 if (SCHARS (name) == 0)
564 error ("Empty string for buffer name is not allowed");
566 b = allocate_buffer ();
568 b->base_buffer = (XBUFFER (base_buffer)->base_buffer
569 ? XBUFFER (base_buffer)->base_buffer
570 : XBUFFER (base_buffer));
572 /* Use the base buffer's text object. */
573 b->text = b->base_buffer->text;
575 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
576 BUF_ZV (b) = BUF_ZV (b->base_buffer);
577 BUF_PT (b) = BUF_PT (b->base_buffer);
578 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
579 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
580 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
582 b->newline_cache = 0;
583 b->width_run_cache = 0;
584 b->width_table = Qnil;
586 /* Put this on the chain of all buffers including killed ones. */
587 b->next = all_buffers;
588 all_buffers = b;
590 name = Fcopy_sequence (name);
591 STRING_SET_INTERVALS (name, NULL_INTERVAL);
592 b->name = name;
594 reset_buffer (b);
595 reset_buffer_local_variables (b, 1);
597 /* Put this in the alist of all live buffers. */
598 XSETBUFFER (buf, b);
599 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
601 b->mark = Fmake_marker ();
602 b->name = name;
604 /* The multibyte status belongs to the base buffer. */
605 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
607 /* Make sure the base buffer has markers for its narrowing. */
608 if (NILP (b->base_buffer->pt_marker))
610 b->base_buffer->pt_marker = Fmake_marker ();
611 set_marker_both (b->base_buffer->pt_marker, base_buffer,
612 BUF_PT (b->base_buffer),
613 BUF_PT_BYTE (b->base_buffer));
615 if (NILP (b->base_buffer->begv_marker))
617 b->base_buffer->begv_marker = Fmake_marker ();
618 set_marker_both (b->base_buffer->begv_marker, base_buffer,
619 BUF_BEGV (b->base_buffer),
620 BUF_BEGV_BYTE (b->base_buffer));
622 if (NILP (b->base_buffer->zv_marker))
624 b->base_buffer->zv_marker = Fmake_marker ();
625 set_marker_both (b->base_buffer->zv_marker, base_buffer,
626 BUF_ZV (b->base_buffer),
627 BUF_ZV_BYTE (b->base_buffer));
628 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
631 if (NILP (clone))
633 /* Give the indirect buffer markers for its narrowing. */
634 b->pt_marker = Fmake_marker ();
635 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
636 b->begv_marker = Fmake_marker ();
637 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
638 b->zv_marker = Fmake_marker ();
639 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
640 XMARKER (b->zv_marker)->insertion_type = 1;
642 else
644 struct buffer *old_b = current_buffer;
646 clone_per_buffer_values (b->base_buffer, b);
647 b->filename = Qnil;
648 b->file_truename = Qnil;
649 b->display_count = make_number (0);
650 b->backed_up = Qnil;
651 b->auto_save_file_name = Qnil;
652 set_buffer_internal_1 (b);
653 Fset (intern ("buffer-save-without-query"), Qnil);
654 Fset (intern ("buffer-file-number"), Qnil);
655 Fset (intern ("buffer-stale-function"), Qnil);
656 set_buffer_internal_1 (old_b);
659 return buf;
662 void
663 delete_all_overlays (b)
664 struct buffer *b;
666 Lisp_Object overlay;
668 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
669 have to empty the list, otherwise we end up with overlays that
670 think they belong to this buffer while the buffer doesn't know about
671 them any more. */
672 while (b->overlays_before)
674 XSETMISC (overlay, b->overlays_before);
675 Fdelete_overlay (overlay);
677 while (b->overlays_after)
679 XSETMISC (overlay, b->overlays_after);
680 Fdelete_overlay (overlay);
682 eassert (b->overlays_before == NULL);
683 eassert (b->overlays_after == NULL);
686 /* Reinitialize everything about a buffer except its name and contents
687 and local variables.
688 If called on an already-initialized buffer, the list of overlays
689 should be deleted before calling this function, otherwise we end up
690 with overlays that claim to belong to the buffer but the buffer
691 claims it doesn't belong to it. */
693 void
694 reset_buffer (b)
695 register struct buffer *b;
697 b->filename = Qnil;
698 b->file_truename = Qnil;
699 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
700 b->modtime = 0;
701 XSETFASTINT (b->save_length, 0);
702 b->last_window_start = 1;
703 /* It is more conservative to start out "changed" than "unchanged". */
704 b->clip_changed = 0;
705 b->prevent_redisplay_optimizations_p = 1;
706 b->backed_up = Qnil;
707 BUF_AUTOSAVE_MODIFF (b) = 0;
708 b->auto_save_failure_time = -1;
709 b->auto_save_file_name = Qnil;
710 b->read_only = Qnil;
711 b->overlays_before = NULL;
712 b->overlays_after = NULL;
713 b->overlay_center = BEG;
714 b->mark_active = Qnil;
715 b->point_before_scroll = Qnil;
716 b->file_format = Qnil;
717 b->auto_save_file_format = Qt;
718 b->last_selected_window = Qnil;
719 XSETINT (b->display_count, 0);
720 b->display_time = Qnil;
721 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
722 b->cursor_type = buffer_defaults.cursor_type;
723 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
725 b->display_error_modiff = 0;
728 /* Reset buffer B's local variables info.
729 Don't use this on a buffer that has already been in use;
730 it does not treat permanent locals consistently.
731 Instead, use Fkill_all_local_variables.
733 If PERMANENT_TOO is 1, then we reset permanent
734 buffer-local variables. If PERMANENT_TOO is 0,
735 we preserve those. */
737 static void
738 reset_buffer_local_variables (b, permanent_too)
739 register struct buffer *b;
740 int permanent_too;
742 register int offset;
743 int i;
745 /* Reset the major mode to Fundamental, together with all the
746 things that depend on the major mode.
747 default-major-mode is handled at a higher level.
748 We ignore it here. */
749 b->major_mode = Qfundamental_mode;
750 b->keymap = Qnil;
751 b->mode_name = QSFundamental;
752 b->minor_modes = Qnil;
754 /* If the standard case table has been altered and invalidated,
755 fix up its insides first. */
756 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
757 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
758 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
759 Fset_standard_case_table (Vascii_downcase_table);
761 b->downcase_table = Vascii_downcase_table;
762 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
763 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
764 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
765 b->invisibility_spec = Qt;
766 #ifndef DOS_NT
767 b->buffer_file_type = Qnil;
768 #endif
770 /* Reset all (or most) per-buffer variables to their defaults. */
771 if (permanent_too)
772 b->local_var_alist = Qnil;
773 else
775 Lisp_Object tmp, prop, last = Qnil;
776 for (tmp = b->local_var_alist; CONSP (tmp); tmp = XCDR (tmp))
777 if (CONSP (XCAR (tmp))
778 && SYMBOLP (XCAR (XCAR (tmp)))
779 && !NILP (prop = Fget (XCAR (XCAR (tmp)), Qpermanent_local)))
781 /* If permanent-local, keep it. */
782 last = tmp;
783 if (EQ (prop, Qpermanent_local_hook))
785 /* This is a partially permanent hook variable.
786 Preserve only the elements that want to be preserved. */
787 Lisp_Object list, newlist;
788 list = XCDR (XCAR (tmp));
789 if (!CONSP (list))
790 newlist = list;
791 else
792 for (newlist = Qnil; CONSP (list); list = XCDR (list))
794 Lisp_Object elt = XCAR (list);
795 /* Preserve element ELT if it's t,
796 if it is a function with a `permanent-local-hook' property,
797 or if it's not a symbol. */
798 if (! SYMBOLP (elt)
799 || EQ (elt, Qt)
800 || !NILP (Fget (elt, Qpermanent_local_hook)))
801 newlist = Fcons (elt, newlist);
803 XSETCDR (XCAR (tmp), Fnreverse (newlist));
806 /* Delete this local variable. */
807 else if (NILP (last))
808 b->local_var_alist = XCDR (tmp);
809 else
810 XSETCDR (last, XCDR (tmp));
813 for (i = 0; i < last_per_buffer_idx; ++i)
814 if (permanent_too || buffer_permanent_local_flags[i] == 0)
815 SET_PER_BUFFER_VALUE_P (b, i, 0);
817 /* For each slot that has a default value,
818 copy that into the slot. */
820 /* buffer-local Lisp variables start at `undo_list',
821 tho only the ones from `name' on are GC'd normally. */
822 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
823 offset < sizeof *b;
824 offset += sizeof (Lisp_Object))
826 int idx = PER_BUFFER_IDX (offset);
827 if ((idx > 0
828 && (permanent_too
829 || buffer_permanent_local_flags[idx] == 0))
830 /* Is -2 used anywhere? */
831 || idx == -2)
832 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
836 /* We split this away from generate-new-buffer, because rename-buffer
837 and set-visited-file-name ought to be able to use this to really
838 rename the buffer properly. */
840 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
841 1, 2, 0,
842 doc: /* Return a string that is the name of no existing buffer based on NAME.
843 If there is no live buffer named NAME, then return NAME.
844 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
845 \(starting at 2) until an unused name is found, and then return that name.
846 Optional second argument IGNORE specifies a name that is okay to use (if
847 it is in the sequence to be tried) even if a buffer with that name exists. */)
848 (name, ignore)
849 register Lisp_Object name, ignore;
851 register Lisp_Object gentemp, tem;
852 int count;
853 char number[10];
855 CHECK_STRING (name);
857 tem = Fstring_equal (name, ignore);
858 if (!NILP (tem))
859 return name;
860 tem = Fget_buffer (name);
861 if (NILP (tem))
862 return name;
864 count = 1;
865 while (1)
867 sprintf (number, "<%d>", ++count);
868 gentemp = concat2 (name, build_string (number));
869 tem = Fstring_equal (gentemp, ignore);
870 if (!NILP (tem))
871 return gentemp;
872 tem = Fget_buffer (gentemp);
873 if (NILP (tem))
874 return gentemp;
879 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
880 doc: /* Return the name of BUFFER, as a string.
881 BUFFER defaults to the current buffer.
882 Return nil if BUFFER has been killed. */)
883 (buffer)
884 register Lisp_Object buffer;
886 if (NILP (buffer))
887 return current_buffer->name;
888 CHECK_BUFFER (buffer);
889 return XBUFFER (buffer)->name;
892 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
893 doc: /* Return name of file BUFFER is visiting, or nil if none.
894 No argument or nil as argument means use the current buffer. */)
895 (buffer)
896 register Lisp_Object buffer;
898 if (NILP (buffer))
899 return current_buffer->filename;
900 CHECK_BUFFER (buffer);
901 return XBUFFER (buffer)->filename;
904 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
905 0, 1, 0,
906 doc: /* Return the base buffer of indirect buffer BUFFER.
907 If BUFFER is not indirect, return nil.
908 BUFFER defaults to the current buffer. */)
909 (buffer)
910 register Lisp_Object buffer;
912 struct buffer *base;
913 Lisp_Object base_buffer;
915 if (NILP (buffer))
916 base = current_buffer->base_buffer;
917 else
919 CHECK_BUFFER (buffer);
920 base = XBUFFER (buffer)->base_buffer;
923 if (! base)
924 return Qnil;
925 XSETBUFFER (base_buffer, base);
926 return base_buffer;
929 DEFUN ("buffer-local-value", Fbuffer_local_value,
930 Sbuffer_local_value, 2, 2, 0,
931 doc: /* Return the value of VARIABLE in BUFFER.
932 If VARIABLE does not have a buffer-local binding in BUFFER, the value
933 is the default binding of the variable. */)
934 (variable, buffer)
935 register Lisp_Object variable;
936 register Lisp_Object buffer;
938 register struct buffer *buf;
939 register Lisp_Object result;
940 struct Lisp_Symbol *sym;
942 CHECK_SYMBOL (variable);
943 CHECK_BUFFER (buffer);
944 buf = XBUFFER (buffer);
946 sym = indirect_variable (XSYMBOL (variable));
947 XSETSYMBOL (variable, sym);
949 /* Look in local_var_list */
950 result = Fassoc (variable, buf->local_var_alist);
951 if (NILP (result))
953 int offset, idx;
954 int found = 0;
956 /* Look in special slots */
957 /* buffer-local Lisp variables start at `undo_list',
958 tho only the ones from `name' on are GC'd normally. */
959 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
960 offset < sizeof (struct buffer);
961 /* sizeof EMACS_INT == sizeof Lisp_Object */
962 offset += (sizeof (EMACS_INT)))
964 idx = PER_BUFFER_IDX (offset);
965 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
966 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
967 && EQ (PER_BUFFER_SYMBOL (offset), variable))
969 result = PER_BUFFER_VALUE (buf, offset);
970 found = 1;
971 break;
975 if (!found)
976 result = Fdefault_value (variable);
978 else
980 Lisp_Object valcontents;
981 Lisp_Object current_alist_element;
983 /* What binding is loaded right now? */
984 valcontents = sym->value;
985 current_alist_element
986 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
988 /* The value of the currently loaded binding is not
989 stored in it, but rather in the realvalue slot.
990 Store that value into the binding it belongs to
991 in case that is the one we are about to use. */
993 Fsetcdr (current_alist_element,
994 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
996 /* Now get the (perhaps updated) value out of the binding. */
997 result = XCDR (result);
1000 if (!EQ (result, Qunbound))
1001 return result;
1003 xsignal1 (Qvoid_variable, variable);
1006 /* Return an alist of the Lisp-level buffer-local bindings of
1007 buffer BUF. That is, don't include the variables maintained
1008 in special slots in the buffer object. */
1010 static Lisp_Object
1011 buffer_lisp_local_variables (buf)
1012 struct buffer *buf;
1014 Lisp_Object result = Qnil;
1015 register Lisp_Object tail;
1016 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1018 Lisp_Object val, elt;
1020 elt = XCAR (tail);
1022 /* Reference each variable in the alist in buf.
1023 If inquiring about the current buffer, this gets the current values,
1024 so store them into the alist so the alist is up to date.
1025 If inquiring about some other buffer, this swaps out any values
1026 for that buffer, making the alist up to date automatically. */
1027 val = find_symbol_value (XCAR (elt));
1028 /* Use the current buffer value only if buf is the current buffer. */
1029 if (buf != current_buffer)
1030 val = XCDR (elt);
1032 /* If symbol is unbound, put just the symbol in the list. */
1033 if (EQ (val, Qunbound))
1034 result = Fcons (XCAR (elt), result);
1035 /* Otherwise, put (symbol . value) in the list. */
1036 else
1037 result = Fcons (Fcons (XCAR (elt), val), result);
1040 return result;
1043 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1044 Sbuffer_local_variables, 0, 1, 0,
1045 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1046 Most elements look like (SYMBOL . VALUE), describing one variable.
1047 For a symbol that is locally unbound, just the symbol appears in the value.
1048 Note that storing new VALUEs in these elements doesn't change the variables.
1049 No argument or nil as argument means use current buffer as BUFFER. */)
1050 (buffer)
1051 register Lisp_Object buffer;
1053 register struct buffer *buf;
1054 register Lisp_Object result;
1056 if (NILP (buffer))
1057 buf = current_buffer;
1058 else
1060 CHECK_BUFFER (buffer);
1061 buf = XBUFFER (buffer);
1064 result = buffer_lisp_local_variables (buf);
1066 /* Add on all the variables stored in special slots. */
1068 int offset, idx;
1070 /* buffer-local Lisp variables start at `undo_list',
1071 tho only the ones from `name' on are GC'd normally. */
1072 for (offset = PER_BUFFER_VAR_OFFSET (undo_list);
1073 offset < sizeof (struct buffer);
1074 /* sizeof EMACS_INT == sizeof Lisp_Object */
1075 offset += (sizeof (EMACS_INT)))
1077 idx = PER_BUFFER_IDX (offset);
1078 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1079 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1080 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1081 PER_BUFFER_VALUE (buf, offset)),
1082 result);
1086 return result;
1089 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1090 0, 1, 0,
1091 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1092 No argument or nil as argument means use current buffer as BUFFER. */)
1093 (buffer)
1094 register Lisp_Object buffer;
1096 register struct buffer *buf;
1097 if (NILP (buffer))
1098 buf = current_buffer;
1099 else
1101 CHECK_BUFFER (buffer);
1102 buf = XBUFFER (buffer);
1105 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1108 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1109 1, 1, 0,
1110 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1111 A non-nil FLAG means mark the buffer modified. */)
1112 (flag)
1113 register Lisp_Object flag;
1115 register int already;
1116 register Lisp_Object fn;
1117 Lisp_Object buffer, window;
1119 #ifdef CLASH_DETECTION
1120 /* If buffer becoming modified, lock the file.
1121 If buffer becoming unmodified, unlock the file. */
1123 fn = current_buffer->file_truename;
1124 /* Test buffer-file-name so that binding it to nil is effective. */
1125 if (!NILP (fn) && ! NILP (current_buffer->filename))
1127 already = SAVE_MODIFF < MODIFF;
1128 if (!already && !NILP (flag))
1129 lock_file (fn);
1130 else if (already && NILP (flag))
1131 unlock_file (fn);
1133 #endif /* CLASH_DETECTION */
1135 /* Here we have a problem. SAVE_MODIFF is used here to encode
1136 buffer-modified-p (as SAVE_MODIFF<MODIFF) as well as
1137 recent-auto-save-p (as SAVE_MODIFF<auto_save_modified). So if we
1138 modify SAVE_MODIFF to affect one, we may affect the other
1139 as well.
1140 E.g. if FLAG is nil we need to set SAVE_MODIFF to MODIFF, but
1141 if SAVE_MODIFF<auto_save_modified that means we risk changing
1142 recent-auto-save-p from t to nil.
1143 Vice versa, if FLAG is non-nil and SAVE_MODIFF>=auto_save_modified
1144 we risk changing recent-auto-save-p from nil to t. */
1145 SAVE_MODIFF = (NILP (flag)
1146 /* FIXME: This unavoidably sets recent-auto-save-p to nil. */
1147 ? MODIFF
1148 /* Let's try to preserve recent-auto-save-p. */
1149 : SAVE_MODIFF < MODIFF ? SAVE_MODIFF
1150 /* If SAVE_MODIFF == auto_save_modified == MODIFF,
1151 we can either decrease SAVE_MODIFF and auto_save_modified
1152 or increase MODIFF. */
1153 : MODIFF++);
1155 /* Set update_mode_lines only if buffer is displayed in some window.
1156 Packages like jit-lock or lazy-lock preserve a buffer's modified
1157 state by recording/restoring the state around blocks of code.
1158 Setting update_mode_lines makes redisplay consider all windows
1159 (on all frames). Stealth fontification of buffers not displayed
1160 would incur additional redisplay costs if we'd set
1161 update_modes_lines unconditionally.
1163 Ideally, I think there should be another mechanism for fontifying
1164 buffers without "modifying" buffers, or redisplay should be
1165 smarter about updating the `*' in mode lines. --gerd */
1166 XSETBUFFER (buffer, current_buffer);
1167 window = Fget_buffer_window (buffer, Qt);
1168 if (WINDOWP (window))
1170 ++update_mode_lines;
1171 current_buffer->prevent_redisplay_optimizations_p = 1;
1174 return flag;
1177 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1178 Srestore_buffer_modified_p, 1, 1, 0,
1179 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1180 It is not ensured that mode lines will be updated to show the modified
1181 state of the current buffer. Use with care. */)
1182 (flag)
1183 Lisp_Object flag;
1185 #ifdef CLASH_DETECTION
1186 Lisp_Object fn;
1188 /* If buffer becoming modified, lock the file.
1189 If buffer becoming unmodified, unlock the file. */
1191 fn = current_buffer->file_truename;
1192 /* Test buffer-file-name so that binding it to nil is effective. */
1193 if (!NILP (fn) && ! NILP (current_buffer->filename))
1195 int already = SAVE_MODIFF < MODIFF;
1196 if (!already && !NILP (flag))
1197 lock_file (fn);
1198 else if (already && NILP (flag))
1199 unlock_file (fn);
1201 #endif /* CLASH_DETECTION */
1203 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1204 return flag;
1207 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1208 0, 1, 0,
1209 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1210 Each buffer has a tick counter which is incremented each time the
1211 text in that buffer is changed. It wraps around occasionally.
1212 No argument or nil as argument means use current buffer as BUFFER. */)
1213 (buffer)
1214 register Lisp_Object buffer;
1216 register struct buffer *buf;
1217 if (NILP (buffer))
1218 buf = current_buffer;
1219 else
1221 CHECK_BUFFER (buffer);
1222 buf = XBUFFER (buffer);
1225 return make_number (BUF_MODIFF (buf));
1228 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1229 Sbuffer_chars_modified_tick, 0, 1, 0,
1230 doc: /* Return BUFFER's character-change tick counter.
1231 Each buffer has a character-change tick counter, which is set to the
1232 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1233 time text in that buffer is inserted or deleted. By comparing the
1234 values returned by two individual calls of `buffer-chars-modified-tick',
1235 you can tell whether a character change occurred in that buffer in
1236 between these calls. No argument or nil as argument means use current
1237 buffer as BUFFER. */)
1238 (buffer)
1239 register Lisp_Object buffer;
1241 register struct buffer *buf;
1242 if (NILP (buffer))
1243 buf = current_buffer;
1244 else
1246 CHECK_BUFFER (buffer);
1247 buf = XBUFFER (buffer);
1250 return make_number (BUF_CHARS_MODIFF (buf));
1253 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1254 "(list (read-string \"Rename buffer (to new name): \" \
1255 nil 'buffer-name-history (buffer-name (current-buffer))) \
1256 current-prefix-arg)",
1257 doc: /* Change current buffer's name to NEWNAME (a string).
1258 If second arg UNIQUE is nil or omitted, it is an error if a
1259 buffer named NEWNAME already exists.
1260 If UNIQUE is non-nil, come up with a new name using
1261 `generate-new-buffer-name'.
1262 Interactively, you can set UNIQUE with a prefix argument.
1263 We return the name we actually gave the buffer.
1264 This does not change the name of the visited file (if any). */)
1265 (newname, unique)
1266 register Lisp_Object newname, unique;
1268 register Lisp_Object tem, buf;
1270 CHECK_STRING (newname);
1272 if (SCHARS (newname) == 0)
1273 error ("Empty string is invalid as a buffer name");
1275 tem = Fget_buffer (newname);
1276 if (!NILP (tem))
1278 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1279 rename the buffer automatically so you can create another
1280 with the original name. It makes UNIQUE equivalent to
1281 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1282 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1283 return current_buffer->name;
1284 if (!NILP (unique))
1285 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1286 else
1287 error ("Buffer name `%s' is in use", SDATA (newname));
1290 current_buffer->name = newname;
1292 /* Catch redisplay's attention. Unless we do this, the mode lines for
1293 any windows displaying current_buffer will stay unchanged. */
1294 update_mode_lines++;
1296 XSETBUFFER (buf, current_buffer);
1297 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1298 if (NILP (current_buffer->filename)
1299 && !NILP (current_buffer->auto_save_file_name))
1300 call0 (intern ("rename-auto-save-file"));
1301 /* Refetch since that last call may have done GC. */
1302 return current_buffer->name;
1305 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1306 doc: /* Return most recently selected buffer other than BUFFER.
1307 Buffers not visible in windows are preferred to visible buffers,
1308 unless optional second argument VISIBLE-OK is non-nil.
1309 If the optional third argument FRAME is non-nil, use that frame's
1310 buffer list instead of the selected frame's buffer list.
1311 If no other buffer exists, the buffer `*scratch*' is returned.
1312 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1313 (buffer, visible_ok, frame)
1314 register Lisp_Object buffer, visible_ok, frame;
1316 Lisp_Object Fset_buffer_major_mode ();
1317 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1318 notsogood = Qnil;
1320 if (NILP (frame))
1321 frame = selected_frame;
1323 tail = Vbuffer_alist;
1324 pred = frame_buffer_predicate (frame);
1326 /* Consider buffers that have been seen in the selected frame
1327 before other buffers. */
1329 tem = frame_buffer_list (frame);
1330 add_ons = Qnil;
1331 while (CONSP (tem))
1333 if (BUFFERP (XCAR (tem)))
1334 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1335 tem = XCDR (tem);
1337 tail = nconc2 (Fnreverse (add_ons), tail);
1339 for (; CONSP (tail); tail = XCDR (tail))
1341 buf = Fcdr (XCAR (tail));
1342 if (EQ (buf, buffer))
1343 continue;
1344 if (NILP (buf))
1345 continue;
1346 if (NILP (XBUFFER (buf)->name))
1347 continue;
1348 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1349 continue;
1350 /* If the selected frame has a buffer_predicate,
1351 disregard buffers that don't fit the predicate. */
1352 if (!NILP (pred))
1354 tem = call1 (pred, buf);
1355 if (NILP (tem))
1356 continue;
1359 if (NILP (visible_ok))
1360 tem = Fget_buffer_window (buf, Qvisible);
1361 else
1362 tem = Qnil;
1363 if (NILP (tem))
1364 return buf;
1365 if (NILP (notsogood))
1366 notsogood = buf;
1368 if (!NILP (notsogood))
1369 return notsogood;
1370 buf = Fget_buffer (build_string ("*scratch*"));
1371 if (NILP (buf))
1373 buf = Fget_buffer_create (build_string ("*scratch*"));
1374 Fset_buffer_major_mode (buf);
1376 return buf;
1379 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1380 0, 1, "",
1381 doc: /* Start keeping undo information for buffer BUFFER.
1382 No argument or nil as argument means do this for the current buffer. */)
1383 (buffer)
1384 register Lisp_Object buffer;
1386 Lisp_Object real_buffer;
1388 if (NILP (buffer))
1389 XSETBUFFER (real_buffer, current_buffer);
1390 else
1392 real_buffer = Fget_buffer (buffer);
1393 if (NILP (real_buffer))
1394 nsberror (buffer);
1397 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1398 XBUFFER (real_buffer)->undo_list = Qnil;
1400 return Qnil;
1404 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1405 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1406 The buffer being killed will be current while the hook is running.\n\
1407 See `kill-buffer'."
1409 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 0, 1, "bKill buffer: ",
1410 doc: /* Kill buffer BUFFER-OR-NAME.
1411 The argument may be a buffer or the name of an existing buffer.
1412 Argument nil or omitted means kill the current buffer. Return t if the
1413 buffer is actually killed, nil otherwise.
1415 This function calls `replace-buffer-in-windows' for cleaning up all
1416 windows currently displaying the buffer to be killed. The functions in
1417 `kill-buffer-query-functions' are called with the buffer to be killed as
1418 the current buffer. If any of them returns nil, the buffer is not
1419 killed. The hook `kill-buffer-hook' is run before the buffer is
1420 actually killed. The buffer being killed will be current while the hook
1421 is running.
1423 Any processes that have this buffer as the `process-buffer' are killed
1424 with SIGHUP. */)
1425 (buffer_or_name)
1426 Lisp_Object buffer_or_name;
1428 Lisp_Object buffer;
1429 register struct buffer *b;
1430 register Lisp_Object tem;
1431 register struct Lisp_Marker *m;
1432 struct gcpro gcpro1;
1434 if (NILP (buffer_or_name))
1435 buffer = Fcurrent_buffer ();
1436 else
1437 buffer = Fget_buffer (buffer_or_name);
1438 if (NILP (buffer))
1439 nsberror (buffer_or_name);
1441 b = XBUFFER (buffer);
1443 /* Avoid trouble for buffer already dead. */
1444 if (NILP (b->name))
1445 return Qnil;
1447 /* Query if the buffer is still modified. */
1448 if (INTERACTIVE && !NILP (b->filename)
1449 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1451 GCPRO1 (buffer);
1452 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1453 b->name, make_number (0)));
1454 UNGCPRO;
1455 if (NILP (tem))
1456 return Qnil;
1459 /* Run hooks with the buffer to be killed the current buffer. */
1461 int count = SPECPDL_INDEX ();
1462 Lisp_Object arglist[1];
1464 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1465 set_buffer_internal (b);
1467 /* First run the query functions; if any query is answered no,
1468 don't kill the buffer. */
1469 arglist[0] = Qkill_buffer_query_functions;
1470 tem = Frun_hook_with_args_until_failure (1, arglist);
1471 if (NILP (tem))
1472 return unbind_to (count, Qnil);
1474 /* Then run the hooks. */
1475 Frun_hooks (1, &Qkill_buffer_hook);
1476 unbind_to (count, Qnil);
1479 /* We have no more questions to ask. Verify that it is valid
1480 to kill the buffer. This must be done after the questions
1481 since anything can happen within do_yes_or_no_p. */
1483 /* Don't kill the minibuffer now current. */
1484 if (EQ (buffer, XWINDOW (minibuf_window)->buffer))
1485 return Qnil;
1487 if (NILP (b->name))
1488 return Qnil;
1490 /* When we kill a base buffer, kill all its indirect buffers.
1491 We do it at this stage so nothing terrible happens if they
1492 ask questions or their hooks get errors. */
1493 if (! b->base_buffer)
1495 struct buffer *other;
1497 GCPRO1 (buffer);
1499 for (other = all_buffers; other; other = other->next)
1500 /* all_buffers contains dead buffers too;
1501 don't re-kill them. */
1502 if (other->base_buffer == b && !NILP (other->name))
1504 Lisp_Object buffer;
1505 XSETBUFFER (buffer, other);
1506 Fkill_buffer (buffer);
1509 UNGCPRO;
1512 /* Make this buffer not be current.
1513 In the process, notice if this is the sole visible buffer
1514 and give up if so. */
1515 if (b == current_buffer)
1517 tem = Fother_buffer (buffer, Qnil, Qnil);
1518 Fset_buffer (tem);
1519 if (b == current_buffer)
1520 return Qnil;
1523 /* Notice if the buffer to kill is the sole visible buffer
1524 when we're currently in the mini-buffer, and give up if so. */
1525 XSETBUFFER (tem, current_buffer);
1526 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1528 tem = Fother_buffer (buffer, Qnil, Qnil);
1529 if (EQ (buffer, tem))
1530 return Qnil;
1533 /* Now there is no question: we can kill the buffer. */
1535 #ifdef CLASH_DETECTION
1536 /* Unlock this buffer's file, if it is locked. */
1537 unlock_buffer (b);
1538 #endif /* CLASH_DETECTION */
1540 GCPRO1 (buffer);
1541 kill_buffer_processes (buffer);
1542 UNGCPRO;
1544 /* Killing buffer processes may run sentinels which may
1545 have called kill-buffer. */
1547 if (NILP (b->name))
1548 return Qnil;
1550 clear_charpos_cache (b);
1552 tem = Vinhibit_quit;
1553 Vinhibit_quit = Qt;
1554 replace_buffer_in_all_windows (buffer);
1555 Vbuffer_alist = Fdelq (Frassq (buffer, Vbuffer_alist), Vbuffer_alist);
1556 frames_discard_buffer (buffer);
1557 Vinhibit_quit = tem;
1559 /* Delete any auto-save file, if we saved it in this session.
1560 But not if the buffer is modified. */
1561 if (STRINGP (b->auto_save_file_name)
1562 && BUF_AUTOSAVE_MODIFF (b) != 0
1563 && BUF_SAVE_MODIFF (b) < BUF_AUTOSAVE_MODIFF (b)
1564 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1565 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1567 Lisp_Object tem;
1568 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1569 if (! NILP (tem))
1570 internal_delete_file (b->auto_save_file_name);
1573 if (b->base_buffer)
1575 /* Unchain all markers that belong to this indirect buffer.
1576 Don't unchain the markers that belong to the base buffer
1577 or its other indirect buffers. */
1578 for (m = BUF_MARKERS (b); m; )
1580 struct Lisp_Marker *next = m->next;
1581 if (m->buffer == b)
1582 unchain_marker (m);
1583 m = next;
1586 else
1588 /* Unchain all markers of this buffer and its indirect buffers.
1589 and leave them pointing nowhere. */
1590 for (m = BUF_MARKERS (b); m; )
1592 struct Lisp_Marker *next = m->next;
1593 m->buffer = 0;
1594 m->next = NULL;
1595 m = next;
1597 BUF_MARKERS (b) = NULL;
1598 BUF_INTERVALS (b) = NULL_INTERVAL;
1600 /* Perhaps we should explicitly free the interval tree here... */
1603 /* Reset the local variables, so that this buffer's local values
1604 won't be protected from GC. They would be protected
1605 if they happened to remain encached in their symbols.
1606 This gets rid of them for certain. */
1607 swap_out_buffer_local_variables (b);
1608 reset_buffer_local_variables (b, 1);
1610 b->name = Qnil;
1612 BLOCK_INPUT;
1613 if (! b->base_buffer)
1614 free_buffer_text (b);
1616 if (b->newline_cache)
1618 free_region_cache (b->newline_cache);
1619 b->newline_cache = 0;
1621 if (b->width_run_cache)
1623 free_region_cache (b->width_run_cache);
1624 b->width_run_cache = 0;
1626 b->width_table = Qnil;
1627 UNBLOCK_INPUT;
1628 b->undo_list = Qnil;
1630 return Qt;
1633 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1634 we do this each time BUF is selected visibly, the more recently
1635 selected buffers are always closer to the front of the list. This
1636 means that other_buffer is more likely to choose a relevant buffer. */
1638 void
1639 record_buffer (buf)
1640 Lisp_Object buf;
1642 register Lisp_Object link, prev;
1643 Lisp_Object frame;
1644 frame = selected_frame;
1646 prev = Qnil;
1647 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1649 if (EQ (XCDR (XCAR (link)), buf))
1650 break;
1651 prev = link;
1654 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1655 we cannot use Fdelq itself here because it allows quitting. */
1657 if (NILP (prev))
1658 Vbuffer_alist = XCDR (Vbuffer_alist);
1659 else
1660 XSETCDR (prev, XCDR (XCDR (prev)));
1662 XSETCDR (link, Vbuffer_alist);
1663 Vbuffer_alist = link;
1665 /* Effectively do a delq on buried_buffer_list. */
1667 prev = Qnil;
1668 for (link = XFRAME (frame)->buried_buffer_list; CONSP (link);
1669 link = XCDR (link))
1671 if (EQ (XCAR (link), buf))
1673 if (NILP (prev))
1674 XFRAME (frame)->buried_buffer_list = XCDR (link);
1675 else
1676 XSETCDR (prev, XCDR (XCDR (prev)));
1677 break;
1679 prev = link;
1682 /* Now move this buffer to the front of frame_buffer_list also. */
1684 prev = Qnil;
1685 for (link = frame_buffer_list (frame); CONSP (link);
1686 link = XCDR (link))
1688 if (EQ (XCAR (link), buf))
1689 break;
1690 prev = link;
1693 /* Effectively do delq. */
1695 if (CONSP (link))
1697 if (NILP (prev))
1698 set_frame_buffer_list (frame,
1699 XCDR (frame_buffer_list (frame)));
1700 else
1701 XSETCDR (prev, XCDR (XCDR (prev)));
1703 XSETCDR (link, frame_buffer_list (frame));
1704 set_frame_buffer_list (frame, link);
1706 else
1707 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1710 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1711 doc: /* Set an appropriate major mode for BUFFER.
1712 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1713 according to `default-major-mode'.
1714 Use this function before selecting the buffer, since it may need to inspect
1715 the current buffer's major mode. */)
1716 (buffer)
1717 Lisp_Object buffer;
1719 int count;
1720 Lisp_Object function;
1722 CHECK_BUFFER (buffer);
1724 if (STRINGP (XBUFFER (buffer)->name)
1725 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1726 function = find_symbol_value (intern ("initial-major-mode"));
1727 else
1729 function = buffer_defaults.major_mode;
1730 if (NILP (function)
1731 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1732 function = current_buffer->major_mode;
1735 if (NILP (function) || EQ (function, Qfundamental_mode))
1736 return Qnil;
1738 count = SPECPDL_INDEX ();
1740 /* To select a nonfundamental mode,
1741 select the buffer temporarily and then call the mode function. */
1743 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1745 Fset_buffer (buffer);
1746 call0 (function);
1748 return unbind_to (count, Qnil);
1751 /* Switch to buffer BUFFER in the selected window.
1752 If NORECORD is non-nil, don't call record_buffer. */
1754 Lisp_Object
1755 switch_to_buffer_1 (buffer_or_name, norecord)
1756 Lisp_Object buffer_or_name, norecord;
1758 register Lisp_Object buffer;
1760 if (NILP (buffer_or_name))
1761 buffer = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1762 else
1764 buffer = Fget_buffer (buffer_or_name);
1765 if (NILP (buffer))
1767 buffer = Fget_buffer_create (buffer_or_name);
1768 Fset_buffer_major_mode (buffer);
1771 Fset_buffer (buffer);
1772 if (NILP (norecord))
1773 record_buffer (buffer);
1775 Fset_window_buffer (EQ (selected_window, minibuf_window)
1776 ? Fnext_window (minibuf_window, Qnil, Qnil)
1777 : selected_window,
1778 buffer, Qnil);
1780 return buffer;
1783 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2,
1784 "(list (read-buffer-to-switch \"Switch to buffer: \"))",
1785 doc: /* Make BUFFER-OR-NAME current and display it in selected window.
1786 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1787 nil. Return the buffer switched to.
1789 If BUFFER-OR-NAME is a string and does not identify an existing
1790 buffer, create a new buffer with that name. Interactively, if
1791 `confirm-nonexistent-file-or-buffer' is non-nil, request
1792 confirmation before creating a new buffer. If BUFFER-OR-NAME is
1793 nil, switch to buffer returned by `other-buffer'.
1795 Optional second arg NORECORD non-nil means do not put this buffer
1796 at the front of the list of recently selected ones. This
1797 function returns the buffer it switched to as a Lisp object.
1799 If the selected window is the minibuffer window or dedicated to
1800 its buffer, use `pop-to-buffer' for displaying the buffer.
1802 WARNING: This is NOT the way to work on another buffer temporarily
1803 within a Lisp program! Use `set-buffer' instead. That avoids
1804 messing with the window-buffer correspondences. */)
1805 (buffer_or_name, norecord)
1806 Lisp_Object buffer_or_name, norecord;
1808 char *err;
1810 if (EQ (buffer_or_name, Fwindow_buffer (selected_window)))
1812 /* Basically a NOP. Avoid signalling an error in the case where
1813 the selected window is dedicated, or a minibuffer. */
1815 /* But do put this buffer at the front of the buffer list, unless
1816 that has been inhibited. Note that even if BUFFER-OR-NAME is
1817 at the front of the main buffer-list already, we still want to
1818 move it to the front of the frame's buffer list. */
1819 if (NILP (norecord))
1820 record_buffer (buffer_or_name);
1821 return Fset_buffer (buffer_or_name);
1823 else if (EQ (minibuf_window, selected_window)
1824 /* If `dedicated' is neither nil nor t, it means it's
1825 dedicatedness can be overridden by an explicit request
1826 such as a call to switch-to-buffer. */
1827 || EQ (Fwindow_dedicated_p (selected_window), Qt))
1828 /* We can't use the selected window so let `pop-to-buffer' try some
1829 other window. */
1830 return call3 (intern ("pop-to-buffer"), buffer_or_name, Qnil, norecord);
1831 else
1832 return switch_to_buffer_1 (buffer_or_name, norecord);
1835 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1836 doc: /* Return the current buffer as a Lisp object. */)
1839 register Lisp_Object buf;
1840 XSETBUFFER (buf, current_buffer);
1841 return buf;
1844 /* Set the current buffer to B.
1846 We previously set windows_or_buffers_changed here to invalidate
1847 global unchanged information in beg_unchanged and end_unchanged.
1848 This is no longer necessary because we now compute unchanged
1849 information on a buffer-basis. Every action affecting other
1850 windows than the selected one requires a select_window at some
1851 time, and that increments windows_or_buffers_changed. */
1853 void
1854 set_buffer_internal (b)
1855 register struct buffer *b;
1857 if (current_buffer != b)
1858 set_buffer_internal_1 (b);
1861 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1862 This is used by redisplay. */
1864 void
1865 set_buffer_internal_1 (b)
1866 register struct buffer *b;
1868 register struct buffer *old_buf;
1869 register Lisp_Object tail, valcontents;
1870 Lisp_Object tem;
1872 #ifdef USE_MMAP_FOR_BUFFERS
1873 if (b->text->beg == NULL)
1874 enlarge_buffer_text (b, 0);
1875 #endif /* USE_MMAP_FOR_BUFFERS */
1877 if (current_buffer == b)
1878 return;
1880 old_buf = current_buffer;
1881 current_buffer = b;
1882 last_known_column_point = -1; /* invalidate indentation cache */
1884 if (old_buf)
1886 /* Put the undo list back in the base buffer, so that it appears
1887 that an indirect buffer shares the undo list of its base. */
1888 if (old_buf->base_buffer)
1889 old_buf->base_buffer->undo_list = old_buf->undo_list;
1891 /* If the old current buffer has markers to record PT, BEGV and ZV
1892 when it is not current, update them now. */
1893 if (! NILP (old_buf->pt_marker))
1895 Lisp_Object obuf;
1896 XSETBUFFER (obuf, old_buf);
1897 set_marker_both (old_buf->pt_marker, obuf,
1898 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1900 if (! NILP (old_buf->begv_marker))
1902 Lisp_Object obuf;
1903 XSETBUFFER (obuf, old_buf);
1904 set_marker_both (old_buf->begv_marker, obuf,
1905 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1907 if (! NILP (old_buf->zv_marker))
1909 Lisp_Object obuf;
1910 XSETBUFFER (obuf, old_buf);
1911 set_marker_both (old_buf->zv_marker, obuf,
1912 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1916 /* Get the undo list from the base buffer, so that it appears
1917 that an indirect buffer shares the undo list of its base. */
1918 if (b->base_buffer)
1919 b->undo_list = b->base_buffer->undo_list;
1921 /* If the new current buffer has markers to record PT, BEGV and ZV
1922 when it is not current, fetch them now. */
1923 if (! NILP (b->pt_marker))
1925 BUF_PT (b) = marker_position (b->pt_marker);
1926 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1928 if (! NILP (b->begv_marker))
1930 BUF_BEGV (b) = marker_position (b->begv_marker);
1931 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1933 if (! NILP (b->zv_marker))
1935 BUF_ZV (b) = marker_position (b->zv_marker);
1936 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1939 /* Look down buffer's list of local Lisp variables
1940 to find and update any that forward into C variables. */
1942 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1944 if (CONSP (XCAR (tail))
1945 && SYMBOLP (XCAR (XCAR (tail)))
1946 && (valcontents = SYMBOL_VALUE (XCAR (XCAR (tail))),
1947 (BUFFER_LOCAL_VALUEP (valcontents)))
1948 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1949 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1950 /* Just reference the variable to cause it to become set for
1951 this buffer. */
1952 Fsymbol_value (XCAR (XCAR (tail)));
1955 /* Do the same with any others that were local to the previous buffer */
1957 if (old_buf)
1958 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1960 if (CONSP (tail)
1961 && SYMBOLP (XCAR (XCAR (tail)))
1962 && (valcontents = SYMBOL_VALUE (XCAR (XCAR (tail))),
1963 (BUFFER_LOCAL_VALUEP (valcontents)))
1964 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1965 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1966 /* Just reference the variable to cause it to become set for
1967 this buffer. */
1968 Fsymbol_value (XCAR (XCAR (tail)));
1972 /* Switch to buffer B temporarily for redisplay purposes.
1973 This avoids certain things that don't need to be done within redisplay. */
1975 void
1976 set_buffer_temp (b)
1977 struct buffer *b;
1979 register struct buffer *old_buf;
1981 if (current_buffer == b)
1982 return;
1984 old_buf = current_buffer;
1985 current_buffer = b;
1987 if (old_buf)
1989 /* If the old current buffer has markers to record PT, BEGV and ZV
1990 when it is not current, update them now. */
1991 if (! NILP (old_buf->pt_marker))
1993 Lisp_Object obuf;
1994 XSETBUFFER (obuf, old_buf);
1995 set_marker_both (old_buf->pt_marker, obuf,
1996 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1998 if (! NILP (old_buf->begv_marker))
2000 Lisp_Object obuf;
2001 XSETBUFFER (obuf, old_buf);
2002 set_marker_both (old_buf->begv_marker, obuf,
2003 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
2005 if (! NILP (old_buf->zv_marker))
2007 Lisp_Object obuf;
2008 XSETBUFFER (obuf, old_buf);
2009 set_marker_both (old_buf->zv_marker, obuf,
2010 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
2014 /* If the new current buffer has markers to record PT, BEGV and ZV
2015 when it is not current, fetch them now. */
2016 if (! NILP (b->pt_marker))
2018 BUF_PT (b) = marker_position (b->pt_marker);
2019 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
2021 if (! NILP (b->begv_marker))
2023 BUF_BEGV (b) = marker_position (b->begv_marker);
2024 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
2026 if (! NILP (b->zv_marker))
2028 BUF_ZV (b) = marker_position (b->zv_marker);
2029 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
2033 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
2034 doc: /* Make buffer BUFFER-OR-NAME current for editing operations.
2035 BUFFER-OR-NAME may be a buffer or the name of an existing buffer. See
2036 also `save-excursion' when you want to make a buffer current
2037 temporarily. This function does not display the buffer, so its effect
2038 ends when the current command terminates. Use `switch-to-buffer' or
2039 `pop-to-buffer' to switch buffers permanently. */)
2040 (buffer_or_name)
2041 register Lisp_Object buffer_or_name;
2043 register Lisp_Object buffer;
2044 buffer = Fget_buffer (buffer_or_name);
2045 if (NILP (buffer))
2046 nsberror (buffer_or_name);
2047 if (NILP (XBUFFER (buffer)->name))
2048 error ("Selecting deleted buffer");
2049 set_buffer_internal (XBUFFER (buffer));
2050 return buffer;
2053 /* Set the current buffer to BUFFER provided it is alive. */
2055 Lisp_Object
2056 set_buffer_if_live (buffer)
2057 Lisp_Object buffer;
2059 if (! NILP (XBUFFER (buffer)->name))
2060 Fset_buffer (buffer);
2061 return Qnil;
2064 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
2065 Sbarf_if_buffer_read_only, 0, 0, 0,
2066 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2069 if (!NILP (current_buffer->read_only)
2070 && NILP (Vinhibit_read_only))
2071 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2072 return Qnil;
2075 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
2076 doc: /* Put BUFFER-OR-NAME at the end of the list of all buffers.
2077 There it is the least likely candidate for `other-buffer' to return;
2078 thus, the least likely buffer for \\[switch-to-buffer] to select by
2079 default.
2081 The argument may be a buffer name or an actual buffer object. If
2082 BUFFER-OR-NAME is nil or omitted, bury the current buffer and remove it
2083 from the selected window if it is displayed there. If the selected
2084 window is dedicated to its buffer, delete that window if there are other
2085 windows on the same frame. If the selected window is the only window on
2086 its frame, iconify that frame. */)
2087 (buffer_or_name)
2088 register Lisp_Object buffer_or_name;
2090 Lisp_Object buffer;
2092 /* Figure out what buffer we're going to bury. */
2093 if (NILP (buffer_or_name))
2095 Lisp_Object tem;
2096 XSETBUFFER (buffer, current_buffer);
2098 tem = Fwindow_buffer (selected_window);
2099 /* If we're burying the current buffer, unshow it. */
2100 if (EQ (buffer, tem))
2102 if (NILP (Fwindow_dedicated_p (selected_window)))
2103 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
2104 else if (NILP (XWINDOW (selected_window)->parent))
2105 Ficonify_frame (Fwindow_frame (selected_window));
2106 else
2107 Fdelete_window (selected_window);
2110 else
2112 buffer = Fget_buffer (buffer_or_name);
2113 if (NILP (buffer))
2114 nsberror (buffer_or_name);
2117 /* Move buffer to the end of the buffer list. Do nothing if the
2118 buffer is killed. */
2119 if (!NILP (XBUFFER (buffer)->name))
2121 Lisp_Object aelt, link;
2123 aelt = Frassq (buffer, Vbuffer_alist);
2124 link = Fmemq (aelt, Vbuffer_alist);
2125 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2126 XSETCDR (link, Qnil);
2127 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2129 XFRAME (selected_frame)->buffer_list
2130 = Fdelq (buffer, XFRAME (selected_frame)->buffer_list);
2131 XFRAME (selected_frame)->buried_buffer_list
2132 = Fcons (buffer, Fdelq (buffer, XFRAME (selected_frame)->buried_buffer_list));
2135 return Qnil;
2138 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2139 doc: /* Delete the entire contents of the current buffer.
2140 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2141 so the buffer is truly empty after this. */)
2144 Fwiden ();
2146 del_range (BEG, Z);
2148 current_buffer->last_window_start = 1;
2149 /* Prevent warnings, or suspension of auto saving, that would happen
2150 if future size is less than past size. Use of erase-buffer
2151 implies that the future text is not really related to the past text. */
2152 XSETFASTINT (current_buffer->save_length, 0);
2153 return Qnil;
2156 void
2157 validate_region (b, e)
2158 register Lisp_Object *b, *e;
2160 CHECK_NUMBER_COERCE_MARKER (*b);
2161 CHECK_NUMBER_COERCE_MARKER (*e);
2163 if (XINT (*b) > XINT (*e))
2165 Lisp_Object tem;
2166 tem = *b; *b = *e; *e = tem;
2169 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2170 && XINT (*e) <= ZV))
2171 args_out_of_range (*b, *e);
2174 /* Advance BYTE_POS up to a character boundary
2175 and return the adjusted position. */
2177 static int
2178 advance_to_char_boundary (byte_pos)
2179 int byte_pos;
2181 int c;
2183 if (byte_pos == BEG)
2184 /* Beginning of buffer is always a character boundary. */
2185 return BEG;
2187 c = FETCH_BYTE (byte_pos);
2188 if (! CHAR_HEAD_P (c))
2190 /* We should advance BYTE_POS only when C is a constituent of a
2191 multibyte sequence. */
2192 int orig_byte_pos = byte_pos;
2196 byte_pos--;
2197 c = FETCH_BYTE (byte_pos);
2199 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2200 INC_POS (byte_pos);
2201 if (byte_pos < orig_byte_pos)
2202 byte_pos = orig_byte_pos;
2203 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2204 surely advance to the correct character boundary. If C is
2205 not, BYTE_POS was unchanged. */
2208 return byte_pos;
2211 #ifdef REL_ALLOC
2212 extern void r_alloc_reset_variable P_ ((POINTER_TYPE *, POINTER_TYPE *));
2213 #endif /* REL_ALLOC */
2215 DEFUN ("buffer-swap-text", Fbuffer_swap_text, Sbuffer_swap_text,
2216 1, 1, 0,
2217 doc: /* Swap the text between current buffer and BUFFER. */)
2218 (buffer)
2219 Lisp_Object buffer;
2221 struct buffer *other_buffer;
2222 CHECK_BUFFER (buffer);
2223 other_buffer = XBUFFER (buffer);
2225 if (NILP (other_buffer->name))
2226 error ("Cannot swap a dead buffer's text");
2228 /* Actually, it probably works just fine.
2229 * if (other_buffer == current_buffer)
2230 * error ("Cannot swap a buffer's text with itself"); */
2232 /* Actually, this may be workable as well, tho probably only if they're
2233 *both* indirect. */
2234 if (other_buffer->base_buffer
2235 || current_buffer->base_buffer)
2236 error ("Cannot swap indirect buffers's text");
2238 { /* This is probably harder to make work. */
2239 struct buffer *other;
2240 for (other = all_buffers; other; other = other->next)
2241 if (other->base_buffer == other_buffer
2242 || other->base_buffer == current_buffer)
2243 error ("One of the buffers to swap has indirect buffers");
2246 #define swapfield(field, type) \
2247 do { \
2248 type tmp##field = other_buffer->field; \
2249 other_buffer->field = current_buffer->field; \
2250 current_buffer->field = tmp##field; \
2251 } while (0)
2253 swapfield (own_text, struct buffer_text);
2254 eassert (current_buffer->text == &current_buffer->own_text);
2255 eassert (other_buffer->text == &other_buffer->own_text);
2256 #ifdef REL_ALLOC
2257 r_alloc_reset_variable ((POINTER_TYPE **) &current_buffer->own_text.beg,
2258 (POINTER_TYPE **) &other_buffer->own_text.beg);
2259 r_alloc_reset_variable ((POINTER_TYPE **) &other_buffer->own_text.beg,
2260 (POINTER_TYPE **) &current_buffer->own_text.beg);
2261 #endif /* REL_ALLOC */
2263 swapfield (pt, EMACS_INT);
2264 swapfield (pt_byte, EMACS_INT);
2265 swapfield (begv, EMACS_INT);
2266 swapfield (begv_byte, EMACS_INT);
2267 swapfield (zv, EMACS_INT);
2268 swapfield (zv_byte, EMACS_INT);
2269 eassert (!current_buffer->base_buffer);
2270 eassert (!other_buffer->base_buffer);
2271 current_buffer->clip_changed = 1; other_buffer->clip_changed = 1;
2272 swapfield (newline_cache, struct region_cache *);
2273 swapfield (width_run_cache, struct region_cache *);
2274 current_buffer->prevent_redisplay_optimizations_p = 1;
2275 other_buffer->prevent_redisplay_optimizations_p = 1;
2276 swapfield (overlays_before, struct Lisp_Overlay *);
2277 swapfield (overlays_after, struct Lisp_Overlay *);
2278 swapfield (overlay_center, EMACS_INT);
2279 swapfield (undo_list, Lisp_Object);
2280 swapfield (mark, Lisp_Object);
2281 swapfield (enable_multibyte_characters, Lisp_Object);
2282 /* FIXME: Not sure what we should do with these *_marker fields.
2283 Hopefully they're just nil anyway. */
2284 swapfield (pt_marker, Lisp_Object);
2285 swapfield (begv_marker, Lisp_Object);
2286 swapfield (zv_marker, Lisp_Object);
2287 current_buffer->point_before_scroll = Qnil;
2288 other_buffer->point_before_scroll = Qnil;
2290 current_buffer->text->modiff++; other_buffer->text->modiff++;
2291 current_buffer->text->chars_modiff++; other_buffer->text->chars_modiff++;
2292 current_buffer->text->overlay_modiff++; other_buffer->text->overlay_modiff++;
2293 current_buffer->text->beg_unchanged = current_buffer->text->gpt;
2294 current_buffer->text->end_unchanged = current_buffer->text->gpt;
2295 other_buffer->text->beg_unchanged = other_buffer->text->gpt;
2296 other_buffer->text->end_unchanged = other_buffer->text->gpt;
2298 struct Lisp_Marker *m;
2299 for (m = BUF_MARKERS (current_buffer); m; m = m->next)
2300 if (m->buffer == other_buffer)
2301 m->buffer = current_buffer;
2302 else
2303 /* Since there's no indirect buffer in sight, markers on
2304 BUF_MARKERS(buf) should either be for `buf' or dead. */
2305 eassert (!m->buffer);
2306 for (m = BUF_MARKERS (other_buffer); m; m = m->next)
2307 if (m->buffer == current_buffer)
2308 m->buffer = other_buffer;
2309 else
2310 /* Since there's no indirect buffer in sight, markers on
2311 BUF_MARKERS(buf) should either be for `buf' or dead. */
2312 eassert (!m->buffer);
2314 { /* Some of the C code expects that w->buffer == w->pointm->buffer.
2315 So since we just swapped the markers between the two buffers, we need
2316 to undo the effect of this swap for window markers. */
2317 Lisp_Object w = Fselected_window (), ws = Qnil;
2318 Lisp_Object buf1, buf2;
2319 XSETBUFFER (buf1, current_buffer); XSETBUFFER (buf2, other_buffer);
2321 while (NILP (Fmemq (w, ws)))
2323 ws = Fcons (w, ws);
2324 if (MARKERP (XWINDOW (w)->pointm)
2325 && (EQ (XWINDOW (w)->buffer, buf1)
2326 || EQ (XWINDOW (w)->buffer, buf2)))
2327 Fset_marker (XWINDOW (w)->pointm,
2328 make_number (BUF_BEGV (XBUFFER (XWINDOW (w)->buffer))),
2329 XWINDOW (w)->buffer);
2330 w = Fnext_window (w, Qt, Qt);
2334 if (current_buffer->text->intervals)
2335 (eassert (EQ (current_buffer->text->intervals->up.obj, buffer)),
2336 XSETBUFFER (current_buffer->text->intervals->up.obj, current_buffer));
2337 if (other_buffer->text->intervals)
2338 (eassert (EQ (other_buffer->text->intervals->up.obj, Fcurrent_buffer ())),
2339 XSETBUFFER (other_buffer->text->intervals->up.obj, other_buffer));
2341 return Qnil;
2344 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2345 1, 1, 0,
2346 doc: /* Set the multibyte flag of the current buffer to FLAG.
2347 If FLAG is t, this makes the buffer a multibyte buffer.
2348 If FLAG is nil, this makes the buffer a single-byte buffer.
2349 In these cases, the buffer contents remain unchanged as a sequence of
2350 bytes but the contents viewed as characters do change.
2351 If FLAG is `to', this makes the buffer a multibyte buffer by changing
2352 all eight-bit bytes to eight-bit characters.
2353 If the multibyte flag was really changed, undo information of the
2354 current buffer is cleared. */)
2355 (flag)
2356 Lisp_Object flag;
2358 struct Lisp_Marker *tail, *markers;
2359 struct buffer *other;
2360 int begv, zv;
2361 int narrowed = (BEG != BEGV || Z != ZV);
2362 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2363 Lisp_Object old_undo = current_buffer->undo_list;
2364 struct gcpro gcpro1;
2366 if (current_buffer->base_buffer)
2367 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2369 /* Do nothing if nothing actually changes. */
2370 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2371 return flag;
2373 GCPRO1 (old_undo);
2375 /* Don't record these buffer changes. We will put a special undo entry
2376 instead. */
2377 current_buffer->undo_list = Qt;
2379 /* If the cached position is for this buffer, clear it out. */
2380 clear_charpos_cache (current_buffer);
2382 if (NILP (flag))
2383 begv = BEGV_BYTE, zv = ZV_BYTE;
2384 else
2385 begv = BEGV, zv = ZV;
2387 if (narrowed)
2388 Fwiden ();
2390 if (NILP (flag))
2392 int pos, stop;
2393 unsigned char *p;
2395 /* Do this first, so it can use CHAR_TO_BYTE
2396 to calculate the old correspondences. */
2397 set_intervals_multibyte (0);
2399 current_buffer->enable_multibyte_characters = Qnil;
2401 Z = Z_BYTE;
2402 BEGV = BEGV_BYTE;
2403 ZV = ZV_BYTE;
2404 GPT = GPT_BYTE;
2405 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2408 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2409 tail->charpos = tail->bytepos;
2411 /* Convert multibyte form of 8-bit characters to unibyte. */
2412 pos = BEG;
2413 stop = GPT;
2414 p = BEG_ADDR;
2415 while (1)
2417 int c, bytes;
2419 if (pos == stop)
2421 if (pos == Z)
2422 break;
2423 p = GAP_END_ADDR;
2424 stop = Z;
2426 if (ASCII_BYTE_P (*p))
2427 p++, pos++;
2428 else if (CHAR_BYTE8_HEAD_P (*p))
2430 c = STRING_CHAR_AND_LENGTH (p, bytes);
2431 /* Delete all bytes for this 8-bit character but the
2432 last one, and change the last one to the charcter
2433 code. */
2434 bytes--;
2435 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2436 p = GAP_END_ADDR;
2437 *p++ = c;
2438 pos++;
2439 if (begv > pos)
2440 begv -= bytes;
2441 if (zv > pos)
2442 zv -= bytes;
2443 stop = Z;
2445 else
2447 bytes = BYTES_BY_CHAR_HEAD (*p);
2448 p += bytes, pos += bytes;
2451 if (narrowed)
2452 Fnarrow_to_region (make_number (begv), make_number (zv));
2454 else
2456 int pt = PT;
2457 int pos, stop;
2458 unsigned char *p, *pend;
2460 /* Be sure not to have a multibyte sequence striding over the GAP.
2461 Ex: We change this: "...abc\302 _GAP_ \241def..."
2462 to: "...abc _GAP_ \302\241def..." */
2464 if (EQ (flag, Qt)
2465 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2466 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2468 unsigned char *p = GPT_ADDR - 1;
2470 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2471 if (BASE_LEADING_CODE_P (*p))
2473 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2475 move_gap_both (new_gpt, new_gpt);
2479 /* Make the buffer contents valid as multibyte by converting
2480 8-bit characters to multibyte form. */
2481 pos = BEG;
2482 stop = GPT;
2483 p = BEG_ADDR;
2484 pend = GPT_ADDR;
2485 while (1)
2487 int bytes;
2489 if (pos == stop)
2491 if (pos == Z)
2492 break;
2493 p = GAP_END_ADDR;
2494 pend = Z_ADDR;
2495 stop = Z;
2498 if (ASCII_BYTE_P (*p))
2499 p++, pos++;
2500 else if (EQ (flag, Qt) && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2501 p += bytes, pos += bytes;
2502 else
2504 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2505 int c;
2507 c = BYTE8_TO_CHAR (*p);
2508 bytes = CHAR_STRING (c, tmp);
2509 *p = tmp[0];
2510 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2511 bytes--;
2512 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2513 /* Now the gap is after the just inserted data. */
2514 pos = GPT;
2515 p = GAP_END_ADDR;
2516 if (pos <= begv)
2517 begv += bytes;
2518 if (pos <= zv)
2519 zv += bytes;
2520 if (pos <= pt)
2521 pt += bytes;
2522 pend = Z_ADDR;
2523 stop = Z;
2527 if (pt != PT)
2528 TEMP_SET_PT (pt);
2530 if (narrowed)
2531 Fnarrow_to_region (make_number (begv), make_number (zv));
2533 /* Do this first, so that chars_in_text asks the right question.
2534 set_intervals_multibyte needs it too. */
2535 current_buffer->enable_multibyte_characters = Qt;
2537 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2538 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2540 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2542 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2543 if (BEGV_BYTE > GPT_BYTE)
2544 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2545 else
2546 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2548 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2549 if (ZV_BYTE > GPT_BYTE)
2550 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2551 else
2552 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2555 int pt_byte = advance_to_char_boundary (PT_BYTE);
2556 int pt;
2558 if (pt_byte > GPT_BYTE)
2559 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2560 else
2561 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2562 TEMP_SET_PT_BOTH (pt, pt_byte);
2565 tail = markers = BUF_MARKERS (current_buffer);
2567 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2568 getting confused by the markers that have not yet been updated.
2569 It is also a signal that it should never create a marker. */
2570 BUF_MARKERS (current_buffer) = NULL;
2572 for (; tail; tail = tail->next)
2574 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2575 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2578 /* Make sure no markers were put on the chain
2579 while the chain value was incorrect. */
2580 if (BUF_MARKERS (current_buffer))
2581 abort ();
2583 BUF_MARKERS (current_buffer) = markers;
2585 /* Do this last, so it can calculate the new correspondences
2586 between chars and bytes. */
2587 set_intervals_multibyte (1);
2590 if (!EQ (old_undo, Qt))
2592 /* Represent all the above changes by a special undo entry. */
2593 extern Lisp_Object Qapply;
2594 current_buffer->undo_list = Fcons (list3 (Qapply,
2595 intern ("set-buffer-multibyte"),
2596 NILP (flag) ? Qt : Qnil),
2597 old_undo);
2600 UNGCPRO;
2602 /* Changing the multibyteness of a buffer means that all windows
2603 showing that buffer must be updated thoroughly. */
2604 current_buffer->prevent_redisplay_optimizations_p = 1;
2605 ++windows_or_buffers_changed;
2607 /* Copy this buffer's new multibyte status
2608 into all of its indirect buffers. */
2609 for (other = all_buffers; other; other = other->next)
2610 if (other->base_buffer == current_buffer && !NILP (other->name))
2612 other->enable_multibyte_characters
2613 = current_buffer->enable_multibyte_characters;
2614 other->prevent_redisplay_optimizations_p = 1;
2617 /* Restore the modifiedness of the buffer. */
2618 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2619 Fset_buffer_modified_p (Qnil);
2621 #ifdef subprocesses
2622 /* Update coding systems of this buffer's process (if any). */
2624 Lisp_Object process;
2626 process = Fget_buffer_process (Fcurrent_buffer ());
2627 if (PROCESSP (process))
2628 setup_process_coding_systems (process);
2630 #endif /* subprocesses */
2632 return flag;
2635 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2636 0, 0, 0,
2637 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2638 Most local variable bindings are eliminated so that the default values
2639 become effective once more. Also, the syntax table is set from
2640 `standard-syntax-table', the local keymap is set to nil,
2641 and the abbrev table from `fundamental-mode-abbrev-table'.
2642 This function also forces redisplay of the mode line.
2644 Every function to select a new major mode starts by
2645 calling this function.
2647 As a special exception, local variables whose names have
2648 a non-nil `permanent-local' property are not eliminated by this function.
2650 The first thing this function does is run
2651 the normal hook `change-major-mode-hook'. */)
2654 if (!NILP (Vrun_hooks))
2655 call1 (Vrun_hooks, Qchange_major_mode_hook);
2657 /* Make sure none of the bindings in local_var_alist
2658 remain swapped in, in their symbols. */
2660 swap_out_buffer_local_variables (current_buffer);
2662 /* Actually eliminate all local bindings of this buffer. */
2664 reset_buffer_local_variables (current_buffer, 0);
2666 /* Force mode-line redisplay. Useful here because all major mode
2667 commands call this function. */
2668 update_mode_lines++;
2670 return Qnil;
2673 /* Make sure no local variables remain set up with buffer B
2674 for their current values. */
2676 static void
2677 swap_out_buffer_local_variables (b)
2678 struct buffer *b;
2680 Lisp_Object oalist, alist, sym, buffer;
2682 XSETBUFFER (buffer, b);
2683 oalist = b->local_var_alist;
2685 for (alist = oalist; CONSP (alist); alist = XCDR (alist))
2687 if (CONSP (XCAR (alist))
2688 && (sym = XCAR (XCAR (alist)), SYMBOLP (sym))
2689 /* Need not do anything if some other buffer's binding is
2690 now encached. */
2691 && EQ (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer,
2692 buffer))
2694 /* Symbol is set up for this buffer's old local value:
2695 swap it out! */
2696 swap_in_global_binding (sym);
2701 /* Find all the overlays in the current buffer that contain position POS.
2702 Return the number found, and store them in a vector in *VEC_PTR.
2703 Store in *LEN_PTR the size allocated for the vector.
2704 Store in *NEXT_PTR the next position after POS where an overlay starts,
2705 or ZV if there are no more overlays between POS and ZV.
2706 Store in *PREV_PTR the previous position before POS where an overlay ends,
2707 or where an overlay starts which ends at or after POS;
2708 or BEGV if there are no such overlays from BEGV to POS.
2709 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2711 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2712 when this function is called.
2714 If EXTEND is non-zero, we make the vector bigger if necessary.
2715 If EXTEND is zero, we never extend the vector,
2716 and we store only as many overlays as will fit.
2717 But we still return the total number of overlays.
2719 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2720 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2721 default (BEGV or ZV). */
2724 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2725 EMACS_INT pos;
2726 int extend;
2727 Lisp_Object **vec_ptr;
2728 int *len_ptr;
2729 EMACS_INT *next_ptr;
2730 EMACS_INT *prev_ptr;
2731 int change_req;
2733 Lisp_Object overlay, start, end;
2734 struct Lisp_Overlay *tail;
2735 int idx = 0;
2736 int len = *len_ptr;
2737 Lisp_Object *vec = *vec_ptr;
2738 int next = ZV;
2739 int prev = BEGV;
2740 int inhibit_storing = 0;
2742 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2744 int startpos, endpos;
2746 XSETMISC (overlay, tail);
2748 start = OVERLAY_START (overlay);
2749 end = OVERLAY_END (overlay);
2750 endpos = OVERLAY_POSITION (end);
2751 if (endpos < pos)
2753 if (prev < endpos)
2754 prev = endpos;
2755 break;
2757 startpos = OVERLAY_POSITION (start);
2758 /* This one ends at or after POS
2759 so its start counts for PREV_PTR if it's before POS. */
2760 if (prev < startpos && startpos < pos)
2761 prev = startpos;
2762 if (endpos == pos)
2763 continue;
2764 if (startpos <= pos)
2766 if (idx == len)
2768 /* The supplied vector is full.
2769 Either make it bigger, or don't store any more in it. */
2770 if (extend)
2772 /* Make it work with an initial len == 0. */
2773 len *= 2;
2774 if (len == 0)
2775 len = 4;
2776 *len_ptr = len;
2777 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2778 *vec_ptr = vec;
2780 else
2781 inhibit_storing = 1;
2784 if (!inhibit_storing)
2785 vec[idx] = overlay;
2786 /* Keep counting overlays even if we can't return them all. */
2787 idx++;
2789 else if (startpos < next)
2790 next = startpos;
2793 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2795 int startpos, endpos;
2797 XSETMISC (overlay, tail);
2799 start = OVERLAY_START (overlay);
2800 end = OVERLAY_END (overlay);
2801 startpos = OVERLAY_POSITION (start);
2802 if (pos < startpos)
2804 if (startpos < next)
2805 next = startpos;
2806 break;
2808 endpos = OVERLAY_POSITION (end);
2809 if (pos < endpos)
2811 if (idx == len)
2813 if (extend)
2815 /* Make it work with an initial len == 0. */
2816 len *= 2;
2817 if (len == 0)
2818 len = 4;
2819 *len_ptr = len;
2820 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2821 *vec_ptr = vec;
2823 else
2824 inhibit_storing = 1;
2827 if (!inhibit_storing)
2828 vec[idx] = overlay;
2829 idx++;
2831 if (startpos < pos && startpos > prev)
2832 prev = startpos;
2834 else if (endpos < pos && endpos > prev)
2835 prev = endpos;
2836 else if (endpos == pos && startpos > prev
2837 && (!change_req || startpos < pos))
2838 prev = startpos;
2841 if (next_ptr)
2842 *next_ptr = next;
2843 if (prev_ptr)
2844 *prev_ptr = prev;
2845 return idx;
2848 /* Find all the overlays in the current buffer that overlap the range
2849 BEG-END, or are empty at BEG, or are empty at END provided END
2850 denotes the position at the end of the current buffer.
2852 Return the number found, and store them in a vector in *VEC_PTR.
2853 Store in *LEN_PTR the size allocated for the vector.
2854 Store in *NEXT_PTR the next position after POS where an overlay starts,
2855 or ZV if there are no more overlays.
2856 Store in *PREV_PTR the previous position before POS where an overlay ends,
2857 or BEGV if there are no previous overlays.
2858 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2860 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2861 when this function is called.
2863 If EXTEND is non-zero, we make the vector bigger if necessary.
2864 If EXTEND is zero, we never extend the vector,
2865 and we store only as many overlays as will fit.
2866 But we still return the total number of overlays. */
2868 static int
2869 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2870 int beg, end;
2871 int extend;
2872 Lisp_Object **vec_ptr;
2873 int *len_ptr;
2874 int *next_ptr;
2875 int *prev_ptr;
2877 Lisp_Object overlay, ostart, oend;
2878 struct Lisp_Overlay *tail;
2879 int idx = 0;
2880 int len = *len_ptr;
2881 Lisp_Object *vec = *vec_ptr;
2882 int next = ZV;
2883 int prev = BEGV;
2884 int inhibit_storing = 0;
2885 int end_is_Z = end == Z;
2887 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2889 int startpos, endpos;
2891 XSETMISC (overlay, tail);
2893 ostart = OVERLAY_START (overlay);
2894 oend = OVERLAY_END (overlay);
2895 endpos = OVERLAY_POSITION (oend);
2896 if (endpos < beg)
2898 if (prev < endpos)
2899 prev = endpos;
2900 break;
2902 startpos = OVERLAY_POSITION (ostart);
2903 /* Count an interval if it overlaps the range, is empty at the
2904 start of the range, or is empty at END provided END denotes the
2905 end of the buffer. */
2906 if ((beg < endpos && startpos < end)
2907 || (startpos == endpos
2908 && (beg == endpos || (end_is_Z && endpos == end))))
2910 if (idx == len)
2912 /* The supplied vector is full.
2913 Either make it bigger, or don't store any more in it. */
2914 if (extend)
2916 /* Make it work with an initial len == 0. */
2917 len *= 2;
2918 if (len == 0)
2919 len = 4;
2920 *len_ptr = len;
2921 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2922 *vec_ptr = vec;
2924 else
2925 inhibit_storing = 1;
2928 if (!inhibit_storing)
2929 vec[idx] = overlay;
2930 /* Keep counting overlays even if we can't return them all. */
2931 idx++;
2933 else if (startpos < next)
2934 next = startpos;
2937 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2939 int startpos, endpos;
2941 XSETMISC (overlay, tail);
2943 ostart = OVERLAY_START (overlay);
2944 oend = OVERLAY_END (overlay);
2945 startpos = OVERLAY_POSITION (ostart);
2946 if (end < startpos)
2948 if (startpos < next)
2949 next = startpos;
2950 break;
2952 endpos = OVERLAY_POSITION (oend);
2953 /* Count an interval if it overlaps the range, is empty at the
2954 start of the range, or is empty at END provided END denotes the
2955 end of the buffer. */
2956 if ((beg < endpos && startpos < end)
2957 || (startpos == endpos
2958 && (beg == endpos || (end_is_Z && endpos == end))))
2960 if (idx == len)
2962 if (extend)
2964 /* Make it work with an initial len == 0. */
2965 len *= 2;
2966 if (len == 0)
2967 len = 4;
2968 *len_ptr = len;
2969 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2970 *vec_ptr = vec;
2972 else
2973 inhibit_storing = 1;
2976 if (!inhibit_storing)
2977 vec[idx] = overlay;
2978 idx++;
2980 else if (endpos < beg && endpos > prev)
2981 prev = endpos;
2984 if (next_ptr)
2985 *next_ptr = next;
2986 if (prev_ptr)
2987 *prev_ptr = prev;
2988 return idx;
2992 /* Return non-zero if there exists an overlay with a non-nil
2993 `mouse-face' property overlapping OVERLAY. */
2996 mouse_face_overlay_overlaps (overlay)
2997 Lisp_Object overlay;
2999 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
3000 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
3001 int n, i, size;
3002 Lisp_Object *v, tem;
3004 size = 10;
3005 v = (Lisp_Object *) alloca (size * sizeof *v);
3006 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
3007 if (n > size)
3009 v = (Lisp_Object *) alloca (n * sizeof *v);
3010 overlays_in (start, end, 0, &v, &n, NULL, NULL);
3013 for (i = 0; i < n; ++i)
3014 if (!EQ (v[i], overlay)
3015 && (tem = Foverlay_get (overlay, Qmouse_face),
3016 !NILP (tem)))
3017 break;
3019 return i < n;
3024 /* Fast function to just test if we're at an overlay boundary. */
3026 overlay_touches_p (pos)
3027 int pos;
3029 Lisp_Object overlay;
3030 struct Lisp_Overlay *tail;
3032 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
3034 int endpos;
3036 XSETMISC (overlay ,tail);
3037 if (!OVERLAYP (overlay))
3038 abort ();
3040 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3041 if (endpos < pos)
3042 break;
3043 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
3044 return 1;
3047 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
3049 int startpos;
3051 XSETMISC (overlay, tail);
3052 if (!OVERLAYP (overlay))
3053 abort ();
3055 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3056 if (pos < startpos)
3057 break;
3058 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
3059 return 1;
3061 return 0;
3064 struct sortvec
3066 Lisp_Object overlay;
3067 int beg, end;
3068 int priority;
3071 static int
3072 compare_overlays (v1, v2)
3073 const void *v1, *v2;
3075 const struct sortvec *s1 = (const struct sortvec *) v1;
3076 const struct sortvec *s2 = (const struct sortvec *) v2;
3077 if (s1->priority != s2->priority)
3078 return s1->priority - s2->priority;
3079 if (s1->beg != s2->beg)
3080 return s1->beg - s2->beg;
3081 if (s1->end != s2->end)
3082 return s2->end - s1->end;
3083 return 0;
3086 /* Sort an array of overlays by priority. The array is modified in place.
3087 The return value is the new size; this may be smaller than the original
3088 size if some of the overlays were invalid or were window-specific. */
3090 sort_overlays (overlay_vec, noverlays, w)
3091 Lisp_Object *overlay_vec;
3092 int noverlays;
3093 struct window *w;
3095 int i, j;
3096 struct sortvec *sortvec;
3097 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
3099 /* Put the valid and relevant overlays into sortvec. */
3101 for (i = 0, j = 0; i < noverlays; i++)
3103 Lisp_Object tem;
3104 Lisp_Object overlay;
3106 overlay = overlay_vec[i];
3107 if (OVERLAY_VALID (overlay)
3108 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
3109 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
3111 /* If we're interested in a specific window, then ignore
3112 overlays that are limited to some other window. */
3113 if (w)
3115 Lisp_Object window;
3117 window = Foverlay_get (overlay, Qwindow);
3118 if (WINDOWP (window) && XWINDOW (window) != w)
3119 continue;
3122 /* This overlay is good and counts: put it into sortvec. */
3123 sortvec[j].overlay = overlay;
3124 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3125 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
3126 tem = Foverlay_get (overlay, Qpriority);
3127 if (INTEGERP (tem))
3128 sortvec[j].priority = XINT (tem);
3129 else
3130 sortvec[j].priority = 0;
3131 j++;
3134 noverlays = j;
3136 /* Sort the overlays into the proper order: increasing priority. */
3138 if (noverlays > 1)
3139 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
3141 for (i = 0; i < noverlays; i++)
3142 overlay_vec[i] = sortvec[i].overlay;
3143 return (noverlays);
3146 struct sortstr
3148 Lisp_Object string, string2;
3149 int size;
3150 int priority;
3153 struct sortstrlist
3155 struct sortstr *buf; /* An array that expands as needed; never freed. */
3156 int size; /* Allocated length of that array. */
3157 int used; /* How much of the array is currently in use. */
3158 int bytes; /* Total length of the strings in buf. */
3161 /* Buffers for storing information about the overlays touching a given
3162 position. These could be automatic variables in overlay_strings, but
3163 it's more efficient to hold onto the memory instead of repeatedly
3164 allocating and freeing it. */
3165 static struct sortstrlist overlay_heads, overlay_tails;
3166 static unsigned char *overlay_str_buf;
3168 /* Allocated length of overlay_str_buf. */
3169 static int overlay_str_len;
3171 /* A comparison function suitable for passing to qsort. */
3172 static int
3173 cmp_for_strings (as1, as2)
3174 char *as1, *as2;
3176 struct sortstr *s1 = (struct sortstr *)as1;
3177 struct sortstr *s2 = (struct sortstr *)as2;
3178 if (s1->size != s2->size)
3179 return s2->size - s1->size;
3180 if (s1->priority != s2->priority)
3181 return s1->priority - s2->priority;
3182 return 0;
3185 static void
3186 record_overlay_string (ssl, str, str2, pri, size)
3187 struct sortstrlist *ssl;
3188 Lisp_Object str, str2, pri;
3189 int size;
3191 int nbytes;
3193 if (ssl->used == ssl->size)
3195 if (ssl->buf)
3196 ssl->size *= 2;
3197 else
3198 ssl->size = 5;
3199 ssl->buf = ((struct sortstr *)
3200 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
3202 ssl->buf[ssl->used].string = str;
3203 ssl->buf[ssl->used].string2 = str2;
3204 ssl->buf[ssl->used].size = size;
3205 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3206 ssl->used++;
3208 if (NILP (current_buffer->enable_multibyte_characters))
3209 nbytes = SCHARS (str);
3210 else if (! STRING_MULTIBYTE (str))
3211 nbytes = count_size_as_multibyte (SDATA (str),
3212 SBYTES (str));
3213 else
3214 nbytes = SBYTES (str);
3216 ssl->bytes += nbytes;
3218 if (STRINGP (str2))
3220 if (NILP (current_buffer->enable_multibyte_characters))
3221 nbytes = SCHARS (str2);
3222 else if (! STRING_MULTIBYTE (str2))
3223 nbytes = count_size_as_multibyte (SDATA (str2),
3224 SBYTES (str2));
3225 else
3226 nbytes = SBYTES (str2);
3228 ssl->bytes += nbytes;
3232 /* Return the concatenation of the strings associated with overlays that
3233 begin or end at POS, ignoring overlays that are specific to a window
3234 other than W. The strings are concatenated in the appropriate order:
3235 shorter overlays nest inside longer ones, and higher priority inside
3236 lower. Normally all of the after-strings come first, but zero-sized
3237 overlays have their after-strings ride along with the before-strings
3238 because it would look strange to print them inside-out.
3240 Returns the string length, and stores the contents indirectly through
3241 PSTR, if that variable is non-null. The string may be overwritten by
3242 subsequent calls. */
3245 overlay_strings (pos, w, pstr)
3246 EMACS_INT pos;
3247 struct window *w;
3248 unsigned char **pstr;
3250 Lisp_Object overlay, window, str;
3251 struct Lisp_Overlay *ov;
3252 int startpos, endpos;
3253 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3255 overlay_heads.used = overlay_heads.bytes = 0;
3256 overlay_tails.used = overlay_tails.bytes = 0;
3257 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3259 XSETMISC (overlay, ov);
3260 eassert (OVERLAYP (overlay));
3262 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3263 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3264 if (endpos < pos)
3265 break;
3266 if (endpos != pos && startpos != pos)
3267 continue;
3268 window = Foverlay_get (overlay, Qwindow);
3269 if (WINDOWP (window) && XWINDOW (window) != w)
3270 continue;
3271 if (startpos == pos
3272 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3273 record_overlay_string (&overlay_heads, str,
3274 (startpos == endpos
3275 ? Foverlay_get (overlay, Qafter_string)
3276 : Qnil),
3277 Foverlay_get (overlay, Qpriority),
3278 endpos - startpos);
3279 else if (endpos == pos
3280 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3281 record_overlay_string (&overlay_tails, str, Qnil,
3282 Foverlay_get (overlay, Qpriority),
3283 endpos - startpos);
3285 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3287 XSETMISC (overlay, ov);
3288 eassert (OVERLAYP (overlay));
3290 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3291 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3292 if (startpos > pos)
3293 break;
3294 if (endpos != pos && startpos != pos)
3295 continue;
3296 window = Foverlay_get (overlay, Qwindow);
3297 if (WINDOWP (window) && XWINDOW (window) != w)
3298 continue;
3299 if (startpos == pos
3300 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3301 record_overlay_string (&overlay_heads, str,
3302 (startpos == endpos
3303 ? Foverlay_get (overlay, Qafter_string)
3304 : Qnil),
3305 Foverlay_get (overlay, Qpriority),
3306 endpos - startpos);
3307 else if (endpos == pos
3308 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3309 record_overlay_string (&overlay_tails, str, Qnil,
3310 Foverlay_get (overlay, Qpriority),
3311 endpos - startpos);
3313 if (overlay_tails.used > 1)
3314 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3315 cmp_for_strings);
3316 if (overlay_heads.used > 1)
3317 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3318 cmp_for_strings);
3319 if (overlay_heads.bytes || overlay_tails.bytes)
3321 Lisp_Object tem;
3322 int i;
3323 unsigned char *p;
3324 int total = overlay_heads.bytes + overlay_tails.bytes;
3326 if (total > overlay_str_len)
3328 overlay_str_len = total;
3329 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3330 total);
3332 p = overlay_str_buf;
3333 for (i = overlay_tails.used; --i >= 0;)
3335 int nbytes;
3336 tem = overlay_tails.buf[i].string;
3337 nbytes = copy_text (SDATA (tem), p,
3338 SBYTES (tem),
3339 STRING_MULTIBYTE (tem), multibyte);
3340 p += nbytes;
3342 for (i = 0; i < overlay_heads.used; ++i)
3344 int nbytes;
3345 tem = overlay_heads.buf[i].string;
3346 nbytes = copy_text (SDATA (tem), p,
3347 SBYTES (tem),
3348 STRING_MULTIBYTE (tem), multibyte);
3349 p += nbytes;
3350 tem = overlay_heads.buf[i].string2;
3351 if (STRINGP (tem))
3353 nbytes = copy_text (SDATA (tem), p,
3354 SBYTES (tem),
3355 STRING_MULTIBYTE (tem), multibyte);
3356 p += nbytes;
3359 if (p != overlay_str_buf + total)
3360 abort ();
3361 if (pstr)
3362 *pstr = overlay_str_buf;
3363 return total;
3365 return 0;
3368 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3370 void
3371 recenter_overlay_lists (buf, pos)
3372 struct buffer *buf;
3373 EMACS_INT pos;
3375 Lisp_Object overlay, beg, end;
3376 struct Lisp_Overlay *prev, *tail, *next;
3378 /* See if anything in overlays_before should move to overlays_after. */
3380 /* We don't strictly need prev in this loop; it should always be nil.
3381 But we use it for symmetry and in case that should cease to be true
3382 with some future change. */
3383 prev = NULL;
3384 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3386 next = tail->next;
3387 XSETMISC (overlay, tail);
3389 /* If the overlay is not valid, get rid of it. */
3390 if (!OVERLAY_VALID (overlay))
3391 #if 1
3392 abort ();
3393 #else
3395 /* Splice the cons cell TAIL out of overlays_before. */
3396 if (!NILP (prev))
3397 XCDR (prev) = next;
3398 else
3399 buf->overlays_before = next;
3400 tail = prev;
3401 continue;
3403 #endif
3405 beg = OVERLAY_START (overlay);
3406 end = OVERLAY_END (overlay);
3408 if (OVERLAY_POSITION (end) > pos)
3410 /* OVERLAY needs to be moved. */
3411 int where = OVERLAY_POSITION (beg);
3412 struct Lisp_Overlay *other, *other_prev;
3414 /* Splice the cons cell TAIL out of overlays_before. */
3415 if (prev)
3416 prev->next = next;
3417 else
3418 buf->overlays_before = next;
3420 /* Search thru overlays_after for where to put it. */
3421 other_prev = NULL;
3422 for (other = buf->overlays_after; other;
3423 other_prev = other, other = other->next)
3425 Lisp_Object otherbeg, otheroverlay;
3427 XSETMISC (otheroverlay, other);
3428 eassert (OVERLAY_VALID (otheroverlay));
3430 otherbeg = OVERLAY_START (otheroverlay);
3431 if (OVERLAY_POSITION (otherbeg) >= where)
3432 break;
3435 /* Add TAIL to overlays_after before OTHER. */
3436 tail->next = other;
3437 if (other_prev)
3438 other_prev->next = tail;
3439 else
3440 buf->overlays_after = tail;
3441 tail = prev;
3443 else
3444 /* We've reached the things that should stay in overlays_before.
3445 All the rest of overlays_before must end even earlier,
3446 so stop now. */
3447 break;
3450 /* See if anything in overlays_after should be in overlays_before. */
3451 prev = NULL;
3452 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3454 next = tail->next;
3455 XSETMISC (overlay, tail);
3457 /* If the overlay is not valid, get rid of it. */
3458 if (!OVERLAY_VALID (overlay))
3459 #if 1
3460 abort ();
3461 #else
3463 /* Splice the cons cell TAIL out of overlays_after. */
3464 if (!NILP (prev))
3465 XCDR (prev) = next;
3466 else
3467 buf->overlays_after = next;
3468 tail = prev;
3469 continue;
3471 #endif
3473 beg = OVERLAY_START (overlay);
3474 end = OVERLAY_END (overlay);
3476 /* Stop looking, when we know that nothing further
3477 can possibly end before POS. */
3478 if (OVERLAY_POSITION (beg) > pos)
3479 break;
3481 if (OVERLAY_POSITION (end) <= pos)
3483 /* OVERLAY needs to be moved. */
3484 int where = OVERLAY_POSITION (end);
3485 struct Lisp_Overlay *other, *other_prev;
3487 /* Splice the cons cell TAIL out of overlays_after. */
3488 if (prev)
3489 prev->next = next;
3490 else
3491 buf->overlays_after = next;
3493 /* Search thru overlays_before for where to put it. */
3494 other_prev = NULL;
3495 for (other = buf->overlays_before; other;
3496 other_prev = other, other = other->next)
3498 Lisp_Object otherend, otheroverlay;
3500 XSETMISC (otheroverlay, other);
3501 eassert (OVERLAY_VALID (otheroverlay));
3503 otherend = OVERLAY_END (otheroverlay);
3504 if (OVERLAY_POSITION (otherend) <= where)
3505 break;
3508 /* Add TAIL to overlays_before before OTHER. */
3509 tail->next = other;
3510 if (other_prev)
3511 other_prev->next = tail;
3512 else
3513 buf->overlays_before = tail;
3514 tail = prev;
3518 buf->overlay_center = pos;
3521 void
3522 adjust_overlays_for_insert (pos, length)
3523 EMACS_INT pos;
3524 EMACS_INT length;
3526 /* After an insertion, the lists are still sorted properly,
3527 but we may need to update the value of the overlay center. */
3528 if (current_buffer->overlay_center >= pos)
3529 current_buffer->overlay_center += length;
3532 void
3533 adjust_overlays_for_delete (pos, length)
3534 EMACS_INT pos;
3535 EMACS_INT length;
3537 if (current_buffer->overlay_center < pos)
3538 /* The deletion was to our right. No change needed; the before- and
3539 after-lists are still consistent. */
3541 else if (current_buffer->overlay_center > pos + length)
3542 /* The deletion was to our left. We need to adjust the center value
3543 to account for the change in position, but the lists are consistent
3544 given the new value. */
3545 current_buffer->overlay_center -= length;
3546 else
3547 /* We're right in the middle. There might be things on the after-list
3548 that now belong on the before-list. Recentering will move them,
3549 and also update the center point. */
3550 recenter_overlay_lists (current_buffer, pos);
3553 /* Fix up overlays that were garbled as a result of permuting markers
3554 in the range START through END. Any overlay with at least one
3555 endpoint in this range will need to be unlinked from the overlay
3556 list and reinserted in its proper place.
3557 Such an overlay might even have negative size at this point.
3558 If so, we'll make the overlay empty. */
3559 void
3560 fix_start_end_in_overlays (start, end)
3561 register int start, end;
3563 Lisp_Object overlay;
3564 struct Lisp_Overlay *before_list, *after_list;
3565 /* These are either nil, indicating that before_list or after_list
3566 should be assigned, or the cons cell the cdr of which should be
3567 assigned. */
3568 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3569 /* 'Parent', likewise, indicates a cons cell or
3570 current_buffer->overlays_before or overlays_after, depending
3571 which loop we're in. */
3572 struct Lisp_Overlay *tail, *parent;
3573 int startpos, endpos;
3575 /* This algorithm shifts links around instead of consing and GCing.
3576 The loop invariant is that before_list (resp. after_list) is a
3577 well-formed list except that its last element, the CDR of beforep
3578 (resp. afterp) if beforep (afterp) isn't nil or before_list
3579 (after_list) if it is, is still uninitialized. So it's not a bug
3580 that before_list isn't initialized, although it may look
3581 strange. */
3582 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3584 XSETMISC (overlay, tail);
3586 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3587 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3589 /* If the overlay is backwards, make it empty. */
3590 if (endpos < startpos)
3592 startpos = endpos;
3593 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3594 Qnil);
3597 if (endpos < start)
3598 break;
3600 if (endpos < end
3601 || (startpos >= start && startpos < end))
3603 /* Add it to the end of the wrong list. Later on,
3604 recenter_overlay_lists will move it to the right place. */
3605 if (endpos < current_buffer->overlay_center)
3607 if (!afterp)
3608 after_list = tail;
3609 else
3610 afterp->next = tail;
3611 afterp = tail;
3613 else
3615 if (!beforep)
3616 before_list = tail;
3617 else
3618 beforep->next = tail;
3619 beforep = tail;
3621 if (!parent)
3622 current_buffer->overlays_before = tail->next;
3623 else
3624 parent->next = tail->next;
3625 tail = tail->next;
3627 else
3628 parent = tail, tail = parent->next;
3630 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3632 XSETMISC (overlay, tail);
3634 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3635 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3637 /* If the overlay is backwards, make it empty. */
3638 if (endpos < startpos)
3640 startpos = endpos;
3641 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3642 Qnil);
3645 if (startpos >= end)
3646 break;
3648 if (startpos >= start
3649 || (endpos >= start && endpos < end))
3651 if (endpos < current_buffer->overlay_center)
3653 if (!afterp)
3654 after_list = tail;
3655 else
3656 afterp->next = tail;
3657 afterp = tail;
3659 else
3661 if (!beforep)
3662 before_list = tail;
3663 else
3664 beforep->next = tail;
3665 beforep = tail;
3667 if (!parent)
3668 current_buffer->overlays_after = tail->next;
3669 else
3670 parent->next = tail->next;
3671 tail = tail->next;
3673 else
3674 parent = tail, tail = parent->next;
3677 /* Splice the constructed (wrong) lists into the buffer's lists,
3678 and let the recenter function make it sane again. */
3679 if (beforep)
3681 beforep->next = current_buffer->overlays_before;
3682 current_buffer->overlays_before = before_list;
3684 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3686 if (afterp)
3688 afterp->next = current_buffer->overlays_after;
3689 current_buffer->overlays_after = after_list;
3691 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3694 /* We have two types of overlay: the one whose ending marker is
3695 after-insertion-marker (this is the usual case) and the one whose
3696 ending marker is before-insertion-marker. When `overlays_before'
3697 contains overlays of the latter type and the former type in this
3698 order and both overlays end at inserting position, inserting a text
3699 increases only the ending marker of the latter type, which results
3700 in incorrect ordering of `overlays_before'.
3702 This function fixes ordering of overlays in the slot
3703 `overlays_before' of the buffer *BP. Before the insertion, `point'
3704 was at PREV, and now is at POS. */
3706 void
3707 fix_overlays_before (bp, prev, pos)
3708 struct buffer *bp;
3709 EMACS_INT prev, pos;
3711 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3712 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3713 Lisp_Object tem;
3714 EMACS_INT end;
3716 /* After the insertion, the several overlays may be in incorrect
3717 order. The possibility is that, in the list `overlays_before',
3718 an overlay which ends at POS appears after an overlay which ends
3719 at PREV. Since POS is greater than PREV, we must fix the
3720 ordering of these overlays, by moving overlays ends at POS before
3721 the overlays ends at PREV. */
3723 /* At first, find a place where disordered overlays should be linked
3724 in. It is where an overlay which end before POS exists. (i.e. an
3725 overlay whose ending marker is after-insertion-marker if disorder
3726 exists). */
3727 while (tail
3728 && (XSETMISC (tem, tail),
3729 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3731 parent = tail;
3732 tail = tail->next;
3735 /* If we don't find such an overlay,
3736 or the found one ends before PREV,
3737 or the found one is the last one in the list,
3738 we don't have to fix anything. */
3739 if (!tail || end < prev || !tail->next)
3740 return;
3742 right_pair = parent;
3743 parent = tail;
3744 tail = tail->next;
3746 /* Now, end position of overlays in the list TAIL should be before
3747 or equal to PREV. In the loop, an overlay which ends at POS is
3748 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3749 we found an overlay which ends before PREV, the remaining
3750 overlays are in correct order. */
3751 while (tail)
3753 XSETMISC (tem, tail);
3754 end = OVERLAY_POSITION (OVERLAY_END (tem));
3756 if (end == pos)
3757 { /* This overlay is disordered. */
3758 struct Lisp_Overlay *found = tail;
3760 /* Unlink the found overlay. */
3761 tail = found->next;
3762 parent->next = tail;
3763 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3764 and link it into the right place. */
3765 if (!right_pair)
3767 found->next = bp->overlays_before;
3768 bp->overlays_before = found;
3770 else
3772 found->next = right_pair->next;
3773 right_pair->next = found;
3776 else if (end == prev)
3778 parent = tail;
3779 tail = tail->next;
3781 else /* No more disordered overlay. */
3782 break;
3786 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3787 doc: /* Return t if OBJECT is an overlay. */)
3788 (object)
3789 Lisp_Object object;
3791 return (OVERLAYP (object) ? Qt : Qnil);
3794 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3795 doc: /* Create a new overlay with range BEG to END in BUFFER.
3796 If omitted, BUFFER defaults to the current buffer.
3797 BEG and END may be integers or markers.
3798 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3799 for the front of the overlay advance when text is inserted there
3800 \(which means the text *is not* included in the overlay).
3801 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3802 for the rear of the overlay advance when text is inserted there
3803 \(which means the text *is* included in the overlay). */)
3804 (beg, end, buffer, front_advance, rear_advance)
3805 Lisp_Object beg, end, buffer;
3806 Lisp_Object front_advance, rear_advance;
3808 Lisp_Object overlay;
3809 struct buffer *b;
3811 if (NILP (buffer))
3812 XSETBUFFER (buffer, current_buffer);
3813 else
3814 CHECK_BUFFER (buffer);
3815 if (MARKERP (beg)
3816 && ! EQ (Fmarker_buffer (beg), buffer))
3817 error ("Marker points into wrong buffer");
3818 if (MARKERP (end)
3819 && ! EQ (Fmarker_buffer (end), buffer))
3820 error ("Marker points into wrong buffer");
3822 CHECK_NUMBER_COERCE_MARKER (beg);
3823 CHECK_NUMBER_COERCE_MARKER (end);
3825 if (XINT (beg) > XINT (end))
3827 Lisp_Object temp;
3828 temp = beg; beg = end; end = temp;
3831 b = XBUFFER (buffer);
3833 beg = Fset_marker (Fmake_marker (), beg, buffer);
3834 end = Fset_marker (Fmake_marker (), end, buffer);
3836 if (!NILP (front_advance))
3837 XMARKER (beg)->insertion_type = 1;
3838 if (!NILP (rear_advance))
3839 XMARKER (end)->insertion_type = 1;
3841 overlay = allocate_misc ();
3842 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3843 XOVERLAY (overlay)->start = beg;
3844 XOVERLAY (overlay)->end = end;
3845 XOVERLAY (overlay)->plist = Qnil;
3846 XOVERLAY (overlay)->next = NULL;
3848 /* Put the new overlay on the wrong list. */
3849 end = OVERLAY_END (overlay);
3850 if (OVERLAY_POSITION (end) < b->overlay_center)
3852 if (b->overlays_after)
3853 XOVERLAY (overlay)->next = b->overlays_after;
3854 b->overlays_after = XOVERLAY (overlay);
3856 else
3858 if (b->overlays_before)
3859 XOVERLAY (overlay)->next = b->overlays_before;
3860 b->overlays_before = XOVERLAY (overlay);
3863 /* This puts it in the right list, and in the right order. */
3864 recenter_overlay_lists (b, b->overlay_center);
3866 /* We don't need to redisplay the region covered by the overlay, because
3867 the overlay has no properties at the moment. */
3869 return overlay;
3872 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3874 static void
3875 modify_overlay (buf, start, end)
3876 struct buffer *buf;
3877 EMACS_INT start, end;
3879 if (start > end)
3881 int temp = start;
3882 start = end;
3883 end = temp;
3886 BUF_COMPUTE_UNCHANGED (buf, start, end);
3888 /* If this is a buffer not in the selected window,
3889 we must do other windows. */
3890 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3891 windows_or_buffers_changed = 1;
3892 /* If multiple windows show this buffer, we must do other windows. */
3893 else if (buffer_shared > 1)
3894 windows_or_buffers_changed = 1;
3895 /* If we modify an overlay at the end of the buffer, we cannot
3896 be sure that window end is still valid. */
3897 else if (end >= ZV && start <= ZV)
3898 windows_or_buffers_changed = 1;
3900 ++BUF_OVERLAY_MODIFF (buf);
3904 Lisp_Object Fdelete_overlay ();
3906 static struct Lisp_Overlay *
3907 unchain_overlay (list, overlay)
3908 struct Lisp_Overlay *list, *overlay;
3910 struct Lisp_Overlay *tmp, *prev;
3911 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3912 if (tmp == overlay)
3914 if (prev)
3915 prev->next = tmp->next;
3916 else
3917 list = tmp->next;
3918 overlay->next = NULL;
3919 break;
3921 return list;
3924 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3925 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3926 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3927 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3928 buffer. */)
3929 (overlay, beg, end, buffer)
3930 Lisp_Object overlay, beg, end, buffer;
3932 struct buffer *b, *ob;
3933 Lisp_Object obuffer;
3934 int count = SPECPDL_INDEX ();
3936 CHECK_OVERLAY (overlay);
3937 if (NILP (buffer))
3938 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3939 if (NILP (buffer))
3940 XSETBUFFER (buffer, current_buffer);
3941 CHECK_BUFFER (buffer);
3943 if (MARKERP (beg)
3944 && ! EQ (Fmarker_buffer (beg), buffer))
3945 error ("Marker points into wrong buffer");
3946 if (MARKERP (end)
3947 && ! EQ (Fmarker_buffer (end), buffer))
3948 error ("Marker points into wrong buffer");
3950 CHECK_NUMBER_COERCE_MARKER (beg);
3951 CHECK_NUMBER_COERCE_MARKER (end);
3953 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3954 return Fdelete_overlay (overlay);
3956 if (XINT (beg) > XINT (end))
3958 Lisp_Object temp;
3959 temp = beg; beg = end; end = temp;
3962 specbind (Qinhibit_quit, Qt);
3964 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3965 b = XBUFFER (buffer);
3966 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3968 /* If the overlay has changed buffers, do a thorough redisplay. */
3969 if (!EQ (buffer, obuffer))
3971 /* Redisplay where the overlay was. */
3972 if (!NILP (obuffer))
3974 int o_beg;
3975 int o_end;
3977 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3978 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3980 modify_overlay (ob, o_beg, o_end);
3983 /* Redisplay where the overlay is going to be. */
3984 modify_overlay (b, XINT (beg), XINT (end));
3986 else
3987 /* Redisplay the area the overlay has just left, or just enclosed. */
3989 int o_beg, o_end;
3991 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3992 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3994 if (o_beg == XINT (beg))
3995 modify_overlay (b, o_end, XINT (end));
3996 else if (o_end == XINT (end))
3997 modify_overlay (b, o_beg, XINT (beg));
3998 else
4000 if (XINT (beg) < o_beg) o_beg = XINT (beg);
4001 if (XINT (end) > o_end) o_end = XINT (end);
4002 modify_overlay (b, o_beg, o_end);
4006 if (!NILP (obuffer))
4008 ob->overlays_before
4009 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
4010 ob->overlays_after
4011 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
4012 eassert (XOVERLAY (overlay)->next == NULL);
4015 Fset_marker (OVERLAY_START (overlay), beg, buffer);
4016 Fset_marker (OVERLAY_END (overlay), end, buffer);
4018 /* Put the overlay on the wrong list. */
4019 end = OVERLAY_END (overlay);
4020 if (OVERLAY_POSITION (end) < b->overlay_center)
4022 XOVERLAY (overlay)->next = b->overlays_after;
4023 b->overlays_after = XOVERLAY (overlay);
4025 else
4027 XOVERLAY (overlay)->next = b->overlays_before;
4028 b->overlays_before = XOVERLAY (overlay);
4031 /* This puts it in the right list, and in the right order. */
4032 recenter_overlay_lists (b, b->overlay_center);
4034 return unbind_to (count, overlay);
4037 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
4038 doc: /* Delete the overlay OVERLAY from its buffer. */)
4039 (overlay)
4040 Lisp_Object overlay;
4042 Lisp_Object buffer;
4043 struct buffer *b;
4044 int count = SPECPDL_INDEX ();
4046 CHECK_OVERLAY (overlay);
4048 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4049 if (NILP (buffer))
4050 return Qnil;
4052 b = XBUFFER (buffer);
4053 specbind (Qinhibit_quit, Qt);
4055 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
4056 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
4057 eassert (XOVERLAY (overlay)->next == NULL);
4058 modify_overlay (b,
4059 marker_position (OVERLAY_START (overlay)),
4060 marker_position (OVERLAY_END (overlay)));
4061 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
4062 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
4064 /* When deleting an overlay with before or after strings, turn off
4065 display optimizations for the affected buffer, on the basis that
4066 these strings may contain newlines. This is easier to do than to
4067 check for that situation during redisplay. */
4068 if (!windows_or_buffers_changed
4069 && (!NILP (Foverlay_get (overlay, Qbefore_string))
4070 || !NILP (Foverlay_get (overlay, Qafter_string))))
4071 b->prevent_redisplay_optimizations_p = 1;
4073 return unbind_to (count, Qnil);
4076 /* Overlay dissection functions. */
4078 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
4079 doc: /* Return the position at which OVERLAY starts. */)
4080 (overlay)
4081 Lisp_Object overlay;
4083 CHECK_OVERLAY (overlay);
4085 return (Fmarker_position (OVERLAY_START (overlay)));
4088 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
4089 doc: /* Return the position at which OVERLAY ends. */)
4090 (overlay)
4091 Lisp_Object overlay;
4093 CHECK_OVERLAY (overlay);
4095 return (Fmarker_position (OVERLAY_END (overlay)));
4098 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
4099 doc: /* Return the buffer OVERLAY belongs to.
4100 Return nil if OVERLAY has been deleted. */)
4101 (overlay)
4102 Lisp_Object overlay;
4104 CHECK_OVERLAY (overlay);
4106 return Fmarker_buffer (OVERLAY_START (overlay));
4109 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
4110 doc: /* Return a list of the properties on OVERLAY.
4111 This is a copy of OVERLAY's plist; modifying its conses has no effect on
4112 OVERLAY. */)
4113 (overlay)
4114 Lisp_Object overlay;
4116 CHECK_OVERLAY (overlay);
4118 return Fcopy_sequence (XOVERLAY (overlay)->plist);
4122 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
4123 doc: /* Return a list of the overlays that contain the character at POS. */)
4124 (pos)
4125 Lisp_Object pos;
4127 int noverlays;
4128 Lisp_Object *overlay_vec;
4129 int len;
4130 Lisp_Object result;
4132 CHECK_NUMBER_COERCE_MARKER (pos);
4134 len = 10;
4135 /* We can't use alloca here because overlays_at can call xrealloc. */
4136 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4138 /* Put all the overlays we want in a vector in overlay_vec.
4139 Store the length in len. */
4140 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4141 (EMACS_INT *) 0, (EMACS_INT *) 0, 0);
4143 /* Make a list of them all. */
4144 result = Flist (noverlays, overlay_vec);
4146 xfree (overlay_vec);
4147 return result;
4150 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
4151 doc: /* Return a list of the overlays that overlap the region BEG ... END.
4152 Overlap means that at least one character is contained within the overlay
4153 and also contained within the specified region.
4154 Empty overlays are included in the result if they are located at BEG,
4155 between BEG and END, or at END provided END denotes the position at the
4156 end of the buffer. */)
4157 (beg, end)
4158 Lisp_Object beg, end;
4160 int noverlays;
4161 Lisp_Object *overlay_vec;
4162 int len;
4163 Lisp_Object result;
4165 CHECK_NUMBER_COERCE_MARKER (beg);
4166 CHECK_NUMBER_COERCE_MARKER (end);
4168 len = 10;
4169 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4171 /* Put all the overlays we want in a vector in overlay_vec.
4172 Store the length in len. */
4173 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
4174 (int *) 0, (int *) 0);
4176 /* Make a list of them all. */
4177 result = Flist (noverlays, overlay_vec);
4179 xfree (overlay_vec);
4180 return result;
4183 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
4184 1, 1, 0,
4185 doc: /* Return the next position after POS where an overlay starts or ends.
4186 If there are no overlay boundaries from POS to (point-max),
4187 the value is (point-max). */)
4188 (pos)
4189 Lisp_Object pos;
4191 int noverlays;
4192 EMACS_INT endpos;
4193 Lisp_Object *overlay_vec;
4194 int len;
4195 int i;
4197 CHECK_NUMBER_COERCE_MARKER (pos);
4199 len = 10;
4200 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4202 /* Put all the overlays we want in a vector in overlay_vec.
4203 Store the length in len.
4204 endpos gets the position where the next overlay starts. */
4205 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4206 &endpos, (EMACS_INT *) 0, 1);
4208 /* If any of these overlays ends before endpos,
4209 use its ending point instead. */
4210 for (i = 0; i < noverlays; i++)
4212 Lisp_Object oend;
4213 EMACS_INT oendpos;
4215 oend = OVERLAY_END (overlay_vec[i]);
4216 oendpos = OVERLAY_POSITION (oend);
4217 if (oendpos < endpos)
4218 endpos = oendpos;
4221 xfree (overlay_vec);
4222 return make_number (endpos);
4225 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
4226 Sprevious_overlay_change, 1, 1, 0,
4227 doc: /* Return the previous position before POS where an overlay starts or ends.
4228 If there are no overlay boundaries from (point-min) to POS,
4229 the value is (point-min). */)
4230 (pos)
4231 Lisp_Object pos;
4233 int noverlays;
4234 EMACS_INT prevpos;
4235 Lisp_Object *overlay_vec;
4236 int len;
4238 CHECK_NUMBER_COERCE_MARKER (pos);
4240 /* At beginning of buffer, we know the answer;
4241 avoid bug subtracting 1 below. */
4242 if (XINT (pos) == BEGV)
4243 return pos;
4245 len = 10;
4246 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4248 /* Put all the overlays we want in a vector in overlay_vec.
4249 Store the length in len.
4250 prevpos gets the position of the previous change. */
4251 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4252 (EMACS_INT *) 0, &prevpos, 1);
4254 xfree (overlay_vec);
4255 return make_number (prevpos);
4258 /* These functions are for debugging overlays. */
4260 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4261 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4262 The car has all the overlays before the overlay center;
4263 the cdr has all the overlays after the overlay center.
4264 Recentering overlays moves overlays between these lists.
4265 The lists you get are copies, so that changing them has no effect.
4266 However, the overlays you get are the real objects that the buffer uses. */)
4269 struct Lisp_Overlay *ol;
4270 Lisp_Object before = Qnil, after = Qnil, tmp;
4271 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4273 XSETMISC (tmp, ol);
4274 before = Fcons (tmp, before);
4276 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4278 XSETMISC (tmp, ol);
4279 after = Fcons (tmp, after);
4281 return Fcons (Fnreverse (before), Fnreverse (after));
4284 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4285 doc: /* Recenter the overlays of the current buffer around position POS.
4286 That makes overlay lookup faster for positions near POS (but perhaps slower
4287 for positions far away from POS). */)
4288 (pos)
4289 Lisp_Object pos;
4291 CHECK_NUMBER_COERCE_MARKER (pos);
4293 recenter_overlay_lists (current_buffer, XINT (pos));
4294 return Qnil;
4297 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4298 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4299 (overlay, prop)
4300 Lisp_Object overlay, prop;
4302 CHECK_OVERLAY (overlay);
4303 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4306 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4307 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4308 (overlay, prop, value)
4309 Lisp_Object overlay, prop, value;
4311 Lisp_Object tail, buffer;
4312 int changed;
4314 CHECK_OVERLAY (overlay);
4316 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4318 for (tail = XOVERLAY (overlay)->plist;
4319 CONSP (tail) && CONSP (XCDR (tail));
4320 tail = XCDR (XCDR (tail)))
4321 if (EQ (XCAR (tail), prop))
4323 changed = !EQ (XCAR (XCDR (tail)), value);
4324 XSETCAR (XCDR (tail), value);
4325 goto found;
4327 /* It wasn't in the list, so add it to the front. */
4328 changed = !NILP (value);
4329 XOVERLAY (overlay)->plist
4330 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4331 found:
4332 if (! NILP (buffer))
4334 if (changed)
4335 modify_overlay (XBUFFER (buffer),
4336 marker_position (OVERLAY_START (overlay)),
4337 marker_position (OVERLAY_END (overlay)));
4338 if (EQ (prop, Qevaporate) && ! NILP (value)
4339 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4340 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4341 Fdelete_overlay (overlay);
4344 return value;
4347 /* Subroutine of report_overlay_modification. */
4349 /* Lisp vector holding overlay hook functions to call.
4350 Vector elements come in pairs.
4351 Each even-index element is a list of hook functions.
4352 The following odd-index element is the overlay they came from.
4354 Before the buffer change, we fill in this vector
4355 as we call overlay hook functions.
4356 After the buffer change, we get the functions to call from this vector.
4357 This way we always call the same functions before and after the change. */
4358 static Lisp_Object last_overlay_modification_hooks;
4360 /* Number of elements actually used in last_overlay_modification_hooks. */
4361 static int last_overlay_modification_hooks_used;
4363 /* Add one functionlist/overlay pair
4364 to the end of last_overlay_modification_hooks. */
4366 static void
4367 add_overlay_mod_hooklist (functionlist, overlay)
4368 Lisp_Object functionlist, overlay;
4370 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4372 if (last_overlay_modification_hooks_used == oldsize)
4373 last_overlay_modification_hooks = larger_vector
4374 (last_overlay_modification_hooks, oldsize * 2, Qnil);
4375 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4376 functionlist); last_overlay_modification_hooks_used++;
4377 ASET (last_overlay_modification_hooks, last_overlay_modification_hooks_used,
4378 overlay); last_overlay_modification_hooks_used++;
4381 /* Run the modification-hooks of overlays that include
4382 any part of the text in START to END.
4383 If this change is an insertion, also
4384 run the insert-before-hooks of overlay starting at END,
4385 and the insert-after-hooks of overlay ending at START.
4387 This is called both before and after the modification.
4388 AFTER is nonzero when we call after the modification.
4390 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4391 When AFTER is nonzero, they are the start position,
4392 the position after the inserted new text,
4393 and the length of deleted or replaced old text. */
4395 void
4396 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4397 Lisp_Object start, end;
4398 int after;
4399 Lisp_Object arg1, arg2, arg3;
4401 Lisp_Object prop, overlay;
4402 struct Lisp_Overlay *tail;
4403 /* 1 if this change is an insertion. */
4404 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4405 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4407 overlay = Qnil;
4408 tail = NULL;
4410 /* We used to run the functions as soon as we found them and only register
4411 them in last_overlay_modification_hooks for the purpose of the `after'
4412 case. But running elisp code as we traverse the list of overlays is
4413 painful because the list can be modified by the elisp code so we had to
4414 copy at several places. We now simply do a read-only traversal that
4415 only collects the functions to run and we run them afterwards. It's
4416 simpler, especially since all the code was already there. -stef */
4418 if (!after)
4420 /* We are being called before a change.
4421 Scan the overlays to find the functions to call. */
4422 last_overlay_modification_hooks_used = 0;
4423 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4425 int startpos, endpos;
4426 Lisp_Object ostart, oend;
4428 XSETMISC (overlay, tail);
4430 ostart = OVERLAY_START (overlay);
4431 oend = OVERLAY_END (overlay);
4432 endpos = OVERLAY_POSITION (oend);
4433 if (XFASTINT (start) > endpos)
4434 break;
4435 startpos = OVERLAY_POSITION (ostart);
4436 if (insertion && (XFASTINT (start) == startpos
4437 || XFASTINT (end) == startpos))
4439 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4440 if (!NILP (prop))
4441 add_overlay_mod_hooklist (prop, overlay);
4443 if (insertion && (XFASTINT (start) == endpos
4444 || XFASTINT (end) == endpos))
4446 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4447 if (!NILP (prop))
4448 add_overlay_mod_hooklist (prop, overlay);
4450 /* Test for intersecting intervals. This does the right thing
4451 for both insertion and deletion. */
4452 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4454 prop = Foverlay_get (overlay, Qmodification_hooks);
4455 if (!NILP (prop))
4456 add_overlay_mod_hooklist (prop, overlay);
4460 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4462 int startpos, endpos;
4463 Lisp_Object ostart, oend;
4465 XSETMISC (overlay, tail);
4467 ostart = OVERLAY_START (overlay);
4468 oend = OVERLAY_END (overlay);
4469 startpos = OVERLAY_POSITION (ostart);
4470 endpos = OVERLAY_POSITION (oend);
4471 if (XFASTINT (end) < startpos)
4472 break;
4473 if (insertion && (XFASTINT (start) == startpos
4474 || XFASTINT (end) == startpos))
4476 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4477 if (!NILP (prop))
4478 add_overlay_mod_hooklist (prop, overlay);
4480 if (insertion && (XFASTINT (start) == endpos
4481 || XFASTINT (end) == endpos))
4483 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4484 if (!NILP (prop))
4485 add_overlay_mod_hooklist (prop, overlay);
4487 /* Test for intersecting intervals. This does the right thing
4488 for both insertion and deletion. */
4489 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4491 prop = Foverlay_get (overlay, Qmodification_hooks);
4492 if (!NILP (prop))
4493 add_overlay_mod_hooklist (prop, overlay);
4498 GCPRO4 (overlay, arg1, arg2, arg3);
4500 /* Call the functions recorded in last_overlay_modification_hooks.
4501 First copy the vector contents, in case some of these hooks
4502 do subsequent modification of the buffer. */
4503 int size = last_overlay_modification_hooks_used;
4504 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4505 int i;
4507 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4508 copy, size * sizeof (Lisp_Object));
4509 gcpro1.var = copy;
4510 gcpro1.nvars = size;
4512 for (i = 0; i < size;)
4514 Lisp_Object prop, overlay;
4515 prop = copy[i++];
4516 overlay = copy[i++];
4517 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4520 UNGCPRO;
4523 static void
4524 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4525 Lisp_Object list, overlay;
4526 int after;
4527 Lisp_Object arg1, arg2, arg3;
4529 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4531 GCPRO4 (list, arg1, arg2, arg3);
4533 while (CONSP (list))
4535 if (NILP (arg3))
4536 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4537 else
4538 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4539 list = XCDR (list);
4541 UNGCPRO;
4544 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4545 property is set. */
4546 void
4547 evaporate_overlays (pos)
4548 EMACS_INT pos;
4550 Lisp_Object overlay, hit_list;
4551 struct Lisp_Overlay *tail;
4553 hit_list = Qnil;
4554 if (pos <= current_buffer->overlay_center)
4555 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4557 int endpos;
4558 XSETMISC (overlay, tail);
4559 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4560 if (endpos < pos)
4561 break;
4562 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4563 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4564 hit_list = Fcons (overlay, hit_list);
4566 else
4567 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4569 int startpos;
4570 XSETMISC (overlay, tail);
4571 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4572 if (startpos > pos)
4573 break;
4574 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4575 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4576 hit_list = Fcons (overlay, hit_list);
4578 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4579 Fdelete_overlay (XCAR (hit_list));
4582 /* Somebody has tried to store a value with an unacceptable type
4583 in the slot with offset OFFSET. */
4585 void
4586 buffer_slot_type_mismatch (newval, type)
4587 Lisp_Object newval;
4588 int type;
4590 Lisp_Object predicate;
4592 switch (type)
4594 case_Lisp_Int: predicate = Qintegerp; break;
4595 case Lisp_String: predicate = Qstringp; break;
4596 case Lisp_Symbol: predicate = Qsymbolp; break;
4597 default: abort ();
4600 wrong_type_argument (predicate, newval);
4604 /***********************************************************************
4605 Allocation with mmap
4606 ***********************************************************************/
4608 #ifdef USE_MMAP_FOR_BUFFERS
4610 #include <sys/types.h>
4611 #include <sys/mman.h>
4613 #ifndef MAP_ANON
4614 #ifdef MAP_ANONYMOUS
4615 #define MAP_ANON MAP_ANONYMOUS
4616 #else
4617 #define MAP_ANON 0
4618 #endif
4619 #endif
4621 #ifndef MAP_FAILED
4622 #define MAP_FAILED ((void *) -1)
4623 #endif
4625 #include <stdio.h>
4626 #include <errno.h>
4628 #if MAP_ANON == 0
4629 #include <fcntl.h>
4630 #endif
4632 #include "coding.h"
4635 /* Memory is allocated in regions which are mapped using mmap(2).
4636 The current implementation lets the system select mapped
4637 addresses; we're not using MAP_FIXED in general, except when
4638 trying to enlarge regions.
4640 Each mapped region starts with a mmap_region structure, the user
4641 area starts after that structure, aligned to MEM_ALIGN.
4643 +-----------------------+
4644 | struct mmap_info + |
4645 | padding |
4646 +-----------------------+
4647 | user data |
4650 +-----------------------+ */
4652 struct mmap_region
4654 /* User-specified size. */
4655 size_t nbytes_specified;
4657 /* Number of bytes mapped */
4658 size_t nbytes_mapped;
4660 /* Pointer to the location holding the address of the memory
4661 allocated with the mmap'd block. The variable actually points
4662 after this structure. */
4663 POINTER_TYPE **var;
4665 /* Next and previous in list of all mmap'd regions. */
4666 struct mmap_region *next, *prev;
4669 /* Doubly-linked list of mmap'd regions. */
4671 static struct mmap_region *mmap_regions;
4673 /* File descriptor for mmap. If we don't have anonymous mapping,
4674 /dev/zero will be opened on it. */
4676 static int mmap_fd;
4678 /* Temporary storage for mmap_set_vars, see there. */
4680 static struct mmap_region *mmap_regions_1;
4681 static int mmap_fd_1;
4683 /* Page size on this system. */
4685 static int mmap_page_size;
4687 /* 1 means mmap has been intialized. */
4689 static int mmap_initialized_p;
4691 /* Value is X rounded up to the next multiple of N. */
4693 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4695 /* Size of mmap_region structure plus padding. */
4697 #define MMAP_REGION_STRUCT_SIZE \
4698 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4700 /* Given a pointer P to the start of the user-visible part of a mapped
4701 region, return a pointer to the start of the region. */
4703 #define MMAP_REGION(P) \
4704 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4706 /* Given a pointer P to the start of a mapped region, return a pointer
4707 to the start of the user-visible part of the region. */
4709 #define MMAP_USER_AREA(P) \
4710 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4712 #define MEM_ALIGN sizeof (double)
4714 /* Predicate returning true if part of the address range [START .. END]
4715 is currently mapped. Used to prevent overwriting an existing
4716 memory mapping.
4718 Default is to conservativly assume the address range is occupied by
4719 something else. This can be overridden by system configuration
4720 files if system-specific means to determine this exists. */
4722 #ifndef MMAP_ALLOCATED_P
4723 #define MMAP_ALLOCATED_P(start, end) 1
4724 #endif
4726 /* Function prototypes. */
4728 static int mmap_free_1 P_ ((struct mmap_region *));
4729 static int mmap_enlarge P_ ((struct mmap_region *, int));
4730 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4731 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4732 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4733 static void mmap_free P_ ((POINTER_TYPE **ptr));
4734 static void mmap_init P_ ((void));
4737 /* Return a region overlapping address range START...END, or null if
4738 none. END is not including, i.e. the last byte in the range
4739 is at END - 1. */
4741 static struct mmap_region *
4742 mmap_find (start, end)
4743 POINTER_TYPE *start, *end;
4745 struct mmap_region *r;
4746 char *s = (char *) start, *e = (char *) end;
4748 for (r = mmap_regions; r; r = r->next)
4750 char *rstart = (char *) r;
4751 char *rend = rstart + r->nbytes_mapped;
4753 if (/* First byte of range, i.e. START, in this region? */
4754 (s >= rstart && s < rend)
4755 /* Last byte of range, i.e. END - 1, in this region? */
4756 || (e > rstart && e <= rend)
4757 /* First byte of this region in the range? */
4758 || (rstart >= s && rstart < e)
4759 /* Last byte of this region in the range? */
4760 || (rend > s && rend <= e))
4761 break;
4764 return r;
4768 /* Unmap a region. P is a pointer to the start of the user-araa of
4769 the region. Value is non-zero if successful. */
4771 static int
4772 mmap_free_1 (r)
4773 struct mmap_region *r;
4775 if (r->next)
4776 r->next->prev = r->prev;
4777 if (r->prev)
4778 r->prev->next = r->next;
4779 else
4780 mmap_regions = r->next;
4782 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4784 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4785 return 0;
4788 return 1;
4792 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4793 Value is non-zero if successful. */
4795 static int
4796 mmap_enlarge (r, npages)
4797 struct mmap_region *r;
4798 int npages;
4800 char *region_end = (char *) r + r->nbytes_mapped;
4801 size_t nbytes;
4802 int success = 0;
4804 if (npages < 0)
4806 /* Unmap pages at the end of the region. */
4807 nbytes = - npages * mmap_page_size;
4808 if (munmap (region_end - nbytes, nbytes) == -1)
4809 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4810 else
4812 r->nbytes_mapped -= nbytes;
4813 success = 1;
4816 else if (npages > 0)
4818 nbytes = npages * mmap_page_size;
4820 /* Try to map additional pages at the end of the region. We
4821 cannot do this if the address range is already occupied by
4822 something else because mmap deletes any previous mapping.
4823 I'm not sure this is worth doing, let's see. */
4824 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4826 POINTER_TYPE *p;
4828 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4829 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4830 if (p == MAP_FAILED)
4831 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4832 else if (p != (POINTER_TYPE *) region_end)
4834 /* Kernels are free to choose a different address. In
4835 that case, unmap what we've mapped above; we have
4836 no use for it. */
4837 if (munmap (p, nbytes) == -1)
4838 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4840 else
4842 r->nbytes_mapped += nbytes;
4843 success = 1;
4848 return success;
4852 /* Set or reset variables holding references to mapped regions. If
4853 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4854 non-zero, set all variables to the start of the user-areas
4855 of mapped regions.
4857 This function is called from Fdump_emacs to ensure that the dumped
4858 Emacs doesn't contain references to memory that won't be mapped
4859 when Emacs starts. */
4861 void
4862 mmap_set_vars (restore_p)
4863 int restore_p;
4865 struct mmap_region *r;
4867 if (restore_p)
4869 mmap_regions = mmap_regions_1;
4870 mmap_fd = mmap_fd_1;
4871 for (r = mmap_regions; r; r = r->next)
4872 *r->var = MMAP_USER_AREA (r);
4874 else
4876 for (r = mmap_regions; r; r = r->next)
4877 *r->var = NULL;
4878 mmap_regions_1 = mmap_regions;
4879 mmap_regions = NULL;
4880 mmap_fd_1 = mmap_fd;
4881 mmap_fd = -1;
4886 /* Allocate a block of storage large enough to hold NBYTES bytes of
4887 data. A pointer to the data is returned in *VAR. VAR is thus the
4888 address of some variable which will use the data area.
4890 The allocation of 0 bytes is valid.
4892 If we can't allocate the necessary memory, set *VAR to null, and
4893 return null. */
4895 static POINTER_TYPE *
4896 mmap_alloc (var, nbytes)
4897 POINTER_TYPE **var;
4898 size_t nbytes;
4900 void *p;
4901 size_t map;
4903 mmap_init ();
4905 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4906 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4907 mmap_fd, 0);
4909 if (p == MAP_FAILED)
4911 if (errno != ENOMEM)
4912 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4913 p = NULL;
4915 else
4917 struct mmap_region *r = (struct mmap_region *) p;
4919 r->nbytes_specified = nbytes;
4920 r->nbytes_mapped = map;
4921 r->var = var;
4922 r->prev = NULL;
4923 r->next = mmap_regions;
4924 if (r->next)
4925 r->next->prev = r;
4926 mmap_regions = r;
4928 p = MMAP_USER_AREA (p);
4931 return *var = p;
4935 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4936 resize it to size NBYTES. Change *VAR to reflect the new block,
4937 and return this value. If more memory cannot be allocated, then
4938 leave *VAR unchanged, and return null. */
4940 static POINTER_TYPE *
4941 mmap_realloc (var, nbytes)
4942 POINTER_TYPE **var;
4943 size_t nbytes;
4945 POINTER_TYPE *result;
4947 mmap_init ();
4949 if (*var == NULL)
4950 result = mmap_alloc (var, nbytes);
4951 else if (nbytes == 0)
4953 mmap_free (var);
4954 result = mmap_alloc (var, nbytes);
4956 else
4958 struct mmap_region *r = MMAP_REGION (*var);
4959 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4961 if (room < nbytes)
4963 /* Must enlarge. */
4964 POINTER_TYPE *old_ptr = *var;
4966 /* Try to map additional pages at the end of the region.
4967 If that fails, allocate a new region, copy data
4968 from the old region, then free it. */
4969 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4970 / mmap_page_size)))
4972 r->nbytes_specified = nbytes;
4973 *var = result = old_ptr;
4975 else if (mmap_alloc (var, nbytes))
4977 bcopy (old_ptr, *var, r->nbytes_specified);
4978 mmap_free_1 (MMAP_REGION (old_ptr));
4979 result = *var;
4980 r = MMAP_REGION (result);
4981 r->nbytes_specified = nbytes;
4983 else
4985 *var = old_ptr;
4986 result = NULL;
4989 else if (room - nbytes >= mmap_page_size)
4991 /* Shrinking by at least a page. Let's give some
4992 memory back to the system.
4994 The extra parens are to make the division happens first,
4995 on positive values, so we know it will round towards
4996 zero. */
4997 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4998 result = *var;
4999 r->nbytes_specified = nbytes;
5001 else
5003 /* Leave it alone. */
5004 result = *var;
5005 r->nbytes_specified = nbytes;
5009 return result;
5013 /* Free a block of relocatable storage whose data is pointed to by
5014 PTR. Store 0 in *PTR to show there's no block allocated. */
5016 static void
5017 mmap_free (var)
5018 POINTER_TYPE **var;
5020 mmap_init ();
5022 if (*var)
5024 mmap_free_1 (MMAP_REGION (*var));
5025 *var = NULL;
5030 /* Perform necessary intializations for the use of mmap. */
5032 static void
5033 mmap_init ()
5035 #if MAP_ANON == 0
5036 /* The value of mmap_fd is initially 0 in temacs, and -1
5037 in a dumped Emacs. */
5038 if (mmap_fd <= 0)
5040 /* No anonymous mmap -- we need the file descriptor. */
5041 mmap_fd = open ("/dev/zero", O_RDONLY);
5042 if (mmap_fd == -1)
5043 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
5045 #endif /* MAP_ANON == 0 */
5047 if (mmap_initialized_p)
5048 return;
5049 mmap_initialized_p = 1;
5051 #if MAP_ANON != 0
5052 mmap_fd = -1;
5053 #endif
5055 mmap_page_size = getpagesize ();
5058 #endif /* USE_MMAP_FOR_BUFFERS */
5062 /***********************************************************************
5063 Buffer-text Allocation
5064 ***********************************************************************/
5066 #ifdef REL_ALLOC
5067 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
5068 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
5069 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
5070 #endif /* REL_ALLOC */
5073 /* Allocate NBYTES bytes for buffer B's text buffer. */
5075 static void
5076 alloc_buffer_text (b, nbytes)
5077 struct buffer *b;
5078 size_t nbytes;
5080 POINTER_TYPE *p;
5082 BLOCK_INPUT;
5083 #if defined USE_MMAP_FOR_BUFFERS
5084 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
5085 #elif defined REL_ALLOC
5086 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
5087 #else
5088 p = xmalloc (nbytes);
5089 #endif
5091 if (p == NULL)
5093 UNBLOCK_INPUT;
5094 memory_full ();
5097 b->text->beg = (unsigned char *) p;
5098 UNBLOCK_INPUT;
5101 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
5102 shrink it. */
5104 void
5105 enlarge_buffer_text (struct buffer *b, EMACS_INT delta)
5107 POINTER_TYPE *p;
5108 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
5109 + delta);
5110 BLOCK_INPUT;
5111 #if defined USE_MMAP_FOR_BUFFERS
5112 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
5113 #elif defined REL_ALLOC
5114 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
5115 #else
5116 p = xrealloc (b->text->beg, nbytes);
5117 #endif
5119 if (p == NULL)
5121 UNBLOCK_INPUT;
5122 memory_full ();
5125 BUF_BEG_ADDR (b) = (unsigned char *) p;
5126 UNBLOCK_INPUT;
5130 /* Free buffer B's text buffer. */
5132 static void
5133 free_buffer_text (b)
5134 struct buffer *b;
5136 BLOCK_INPUT;
5138 #if defined USE_MMAP_FOR_BUFFERS
5139 mmap_free ((POINTER_TYPE **) &b->text->beg);
5140 #elif defined REL_ALLOC
5141 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
5142 #else
5143 xfree (b->text->beg);
5144 #endif
5146 BUF_BEG_ADDR (b) = NULL;
5147 UNBLOCK_INPUT;
5152 /***********************************************************************
5153 Initialization
5154 ***********************************************************************/
5156 void
5157 init_buffer_once ()
5159 int idx;
5161 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
5163 /* Make sure all markable slots in buffer_defaults
5164 are initialized reasonably, so mark_buffer won't choke. */
5165 reset_buffer (&buffer_defaults);
5166 reset_buffer_local_variables (&buffer_defaults, 1);
5167 reset_buffer (&buffer_local_symbols);
5168 reset_buffer_local_variables (&buffer_local_symbols, 1);
5169 /* Prevent GC from getting confused. */
5170 buffer_defaults.text = &buffer_defaults.own_text;
5171 buffer_local_symbols.text = &buffer_local_symbols.own_text;
5172 BUF_INTERVALS (&buffer_defaults) = 0;
5173 BUF_INTERVALS (&buffer_local_symbols) = 0;
5174 XSETPVECTYPE (&buffer_defaults, PVEC_BUFFER);
5175 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
5176 XSETPVECTYPE (&buffer_local_symbols, PVEC_BUFFER);
5177 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
5179 /* Set up the default values of various buffer slots. */
5180 /* Must do these before making the first buffer! */
5182 /* real setup is done in bindings.el */
5183 buffer_defaults.mode_line_format = make_pure_c_string ("%-");
5184 buffer_defaults.header_line_format = Qnil;
5185 buffer_defaults.abbrev_mode = Qnil;
5186 buffer_defaults.overwrite_mode = Qnil;
5187 buffer_defaults.case_fold_search = Qt;
5188 buffer_defaults.auto_fill_function = Qnil;
5189 buffer_defaults.selective_display = Qnil;
5190 #ifndef old
5191 buffer_defaults.selective_display_ellipses = Qt;
5192 #endif
5193 buffer_defaults.abbrev_table = Qnil;
5194 buffer_defaults.display_table = Qnil;
5195 buffer_defaults.undo_list = Qnil;
5196 buffer_defaults.mark_active = Qnil;
5197 buffer_defaults.file_format = Qnil;
5198 buffer_defaults.auto_save_file_format = Qt;
5199 buffer_defaults.overlays_before = NULL;
5200 buffer_defaults.overlays_after = NULL;
5201 buffer_defaults.overlay_center = BEG;
5203 XSETFASTINT (buffer_defaults.tab_width, 8);
5204 buffer_defaults.truncate_lines = Qnil;
5205 buffer_defaults.word_wrap = Qnil;
5206 buffer_defaults.ctl_arrow = Qt;
5207 buffer_defaults.direction_reversed = Qnil;
5208 buffer_defaults.cursor_type = Qt;
5209 buffer_defaults.extra_line_spacing = Qnil;
5210 buffer_defaults.cursor_in_non_selected_windows = Qt;
5212 #ifdef DOS_NT
5213 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
5214 #endif
5215 buffer_defaults.enable_multibyte_characters = Qt;
5216 buffer_defaults.buffer_file_coding_system = Qnil;
5217 XSETFASTINT (buffer_defaults.fill_column, 70);
5218 XSETFASTINT (buffer_defaults.left_margin, 0);
5219 buffer_defaults.cache_long_line_scans = Qnil;
5220 buffer_defaults.file_truename = Qnil;
5221 XSETFASTINT (buffer_defaults.display_count, 0);
5222 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
5223 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
5224 buffer_defaults.left_fringe_width = Qnil;
5225 buffer_defaults.right_fringe_width = Qnil;
5226 buffer_defaults.fringes_outside_margins = Qnil;
5227 buffer_defaults.scroll_bar_width = Qnil;
5228 buffer_defaults.vertical_scroll_bar_type = Qt;
5229 buffer_defaults.indicate_empty_lines = Qnil;
5230 buffer_defaults.indicate_buffer_boundaries = Qnil;
5231 buffer_defaults.fringe_indicator_alist = Qnil;
5232 buffer_defaults.fringe_cursor_alist = Qnil;
5233 buffer_defaults.scroll_up_aggressively = Qnil;
5234 buffer_defaults.scroll_down_aggressively = Qnil;
5235 buffer_defaults.display_time = Qnil;
5237 /* Assign the local-flags to the slots that have default values.
5238 The local flag is a bit that is used in the buffer
5239 to say that it has its own local value for the slot.
5240 The local flag bits are in the local_var_flags slot of the buffer. */
5242 /* Nothing can work if this isn't true */
5243 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
5245 /* 0 means not a lisp var, -1 means always local, else mask */
5246 bzero (&buffer_local_flags, sizeof buffer_local_flags);
5247 XSETINT (buffer_local_flags.filename, -1);
5248 XSETINT (buffer_local_flags.directory, -1);
5249 XSETINT (buffer_local_flags.backed_up, -1);
5250 XSETINT (buffer_local_flags.save_length, -1);
5251 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5252 XSETINT (buffer_local_flags.read_only, -1);
5253 XSETINT (buffer_local_flags.major_mode, -1);
5254 XSETINT (buffer_local_flags.mode_name, -1);
5255 XSETINT (buffer_local_flags.undo_list, -1);
5256 XSETINT (buffer_local_flags.mark_active, -1);
5257 XSETINT (buffer_local_flags.point_before_scroll, -1);
5258 XSETINT (buffer_local_flags.file_truename, -1);
5259 XSETINT (buffer_local_flags.invisibility_spec, -1);
5260 XSETINT (buffer_local_flags.file_format, -1);
5261 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5262 XSETINT (buffer_local_flags.display_count, -1);
5263 XSETINT (buffer_local_flags.display_time, -1);
5264 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5266 idx = 1;
5267 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5268 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5269 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5270 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5271 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5272 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5273 #ifndef old
5274 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5275 #endif
5276 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5277 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5278 XSETFASTINT (buffer_local_flags.word_wrap, idx); ++idx;
5279 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5280 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5281 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5282 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5283 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5284 #ifdef DOS_NT
5285 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5286 /* Make this one a permanent local. */
5287 buffer_permanent_local_flags[idx++] = 1;
5288 #endif
5289 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5290 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5291 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5292 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5293 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5294 /* Make this one a permanent local. */
5295 buffer_permanent_local_flags[idx++] = 1;
5296 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5297 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5298 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5299 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5300 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5301 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5302 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5303 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5304 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5305 XSETFASTINT (buffer_local_flags.fringe_indicator_alist, idx); ++idx;
5306 XSETFASTINT (buffer_local_flags.fringe_cursor_alist, idx); ++idx;
5307 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5308 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5309 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5310 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5311 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5312 XSETFASTINT (buffer_local_flags.cursor_in_non_selected_windows, idx); ++idx;
5314 /* Need more room? */
5315 if (idx >= MAX_PER_BUFFER_VARS)
5316 abort ();
5317 last_per_buffer_idx = idx;
5319 Vbuffer_alist = Qnil;
5320 current_buffer = 0;
5321 all_buffers = 0;
5323 QSFundamental = make_pure_c_string ("Fundamental");
5325 Qfundamental_mode = intern_c_string ("fundamental-mode");
5326 buffer_defaults.major_mode = Qfundamental_mode;
5328 Qmode_class = intern_c_string ("mode-class");
5330 Qprotected_field = intern_c_string ("protected-field");
5332 Qpermanent_local = intern_c_string ("permanent-local");
5334 Qkill_buffer_hook = intern_c_string ("kill-buffer-hook");
5335 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5337 Qucs_set_table_for_input = intern_c_string ("ucs-set-table-for-input");
5339 /* super-magic invisible buffer */
5340 Vprin1_to_string_buffer = Fget_buffer_create (make_pure_c_string (" prin1"));
5341 Vbuffer_alist = Qnil;
5343 Fset_buffer (Fget_buffer_create (make_pure_c_string ("*scratch*")));
5345 inhibit_modification_hooks = 0;
5348 void
5349 init_buffer ()
5351 char *pwd;
5352 Lisp_Object temp;
5353 int len;
5355 #ifdef USE_MMAP_FOR_BUFFERS
5357 /* When using the ralloc implementation based on mmap(2), buffer
5358 text pointers will have been set to null in the dumped Emacs.
5359 Map new memory. */
5360 struct buffer *b;
5362 for (b = all_buffers; b; b = b->next)
5363 if (b->text->beg == NULL)
5364 enlarge_buffer_text (b, 0);
5366 #endif /* USE_MMAP_FOR_BUFFERS */
5368 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5369 if (NILP (buffer_defaults.enable_multibyte_characters))
5370 Fset_buffer_multibyte (Qnil);
5372 pwd = get_current_dir_name ();
5374 if (!pwd)
5375 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5377 /* Maybe this should really use some standard subroutine
5378 whose definition is filename syntax dependent. */
5379 len = strlen (pwd);
5380 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5382 /* Grow buffer to add directory separator and '\0'. */
5383 pwd = (char *) realloc (pwd, len + 2);
5384 if (!pwd)
5385 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5386 pwd[len] = DIRECTORY_SEP;
5387 pwd[len + 1] = '\0';
5390 current_buffer->directory = make_unibyte_string (pwd, strlen (pwd));
5391 if (! NILP (buffer_defaults.enable_multibyte_characters))
5392 /* At this moment, we still don't know how to decode the
5393 directory name. So, we keep the bytes in multibyte form so
5394 that ENCODE_FILE correctly gets the original bytes. */
5395 current_buffer->directory
5396 = string_to_multibyte (current_buffer->directory);
5398 /* Add /: to the front of the name
5399 if it would otherwise be treated as magic. */
5400 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5401 if (! NILP (temp)
5402 /* If the default dir is just /, TEMP is non-nil
5403 because of the ange-ftp completion handler.
5404 However, it is not necessary to turn / into /:/.
5405 So avoid doing that. */
5406 && strcmp ("/", SDATA (current_buffer->directory)))
5407 current_buffer->directory
5408 = concat2 (build_string ("/:"), current_buffer->directory);
5410 temp = get_minibuffer (0);
5411 XBUFFER (temp)->directory = current_buffer->directory;
5413 free (pwd);
5416 /* Similar to defvar_lisp but define a variable whose value is the Lisp
5417 Object stored in the current buffer. address is the address of the slot
5418 in the buffer that is current now. */
5420 /* TYPE is nil for a general Lisp variable.
5421 An integer specifies a type; then only LIsp values
5422 with that type code are allowed (except that nil is allowed too).
5423 LNAME is the LIsp-level variable name.
5424 VNAME is the name of the buffer slot.
5425 DOC is a dummy where you write the doc string as a comment. */
5426 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
5427 defvar_per_buffer (lname, vname, type, 0)
5429 static void
5430 defvar_per_buffer (namestring, address, type, doc)
5431 char *namestring;
5432 Lisp_Object *address;
5433 Lisp_Object type;
5434 char *doc;
5436 Lisp_Object sym, val;
5437 int offset;
5439 sym = intern (namestring);
5440 val = allocate_misc ();
5441 offset = (char *)address - (char *)current_buffer;
5443 XMISCTYPE (val) = Lisp_Misc_Buffer_Objfwd;
5444 XBUFFER_OBJFWD (val)->offset = offset;
5445 XBUFFER_OBJFWD (val)->slottype = type;
5446 SET_SYMBOL_VALUE (sym, val);
5447 PER_BUFFER_SYMBOL (offset) = sym;
5449 if (PER_BUFFER_IDX (offset) == 0)
5450 /* Did a DEFVAR_PER_BUFFER without initializing the corresponding
5451 slot of buffer_local_flags */
5452 abort ();
5456 /* initialize the buffer routines */
5457 void
5458 syms_of_buffer ()
5460 staticpro (&last_overlay_modification_hooks);
5461 last_overlay_modification_hooks
5462 = Fmake_vector (make_number (10), Qnil);
5464 staticpro (&Vbuffer_defaults);
5465 staticpro (&Vbuffer_local_symbols);
5466 staticpro (&Qfundamental_mode);
5467 staticpro (&Qmode_class);
5468 staticpro (&QSFundamental);
5469 staticpro (&Vbuffer_alist);
5470 staticpro (&Qprotected_field);
5471 staticpro (&Qpermanent_local);
5472 Qpermanent_local_hook = intern_c_string ("permanent-local-hook");
5473 staticpro (&Qpermanent_local_hook);
5474 staticpro (&Qkill_buffer_hook);
5475 Qoverlayp = intern_c_string ("overlayp");
5476 staticpro (&Qoverlayp);
5477 Qevaporate = intern_c_string ("evaporate");
5478 staticpro (&Qevaporate);
5479 Qmodification_hooks = intern_c_string ("modification-hooks");
5480 staticpro (&Qmodification_hooks);
5481 Qinsert_in_front_hooks = intern_c_string ("insert-in-front-hooks");
5482 staticpro (&Qinsert_in_front_hooks);
5483 Qinsert_behind_hooks = intern_c_string ("insert-behind-hooks");
5484 staticpro (&Qinsert_behind_hooks);
5485 Qget_file_buffer = intern_c_string ("get-file-buffer");
5486 staticpro (&Qget_file_buffer);
5487 Qpriority = intern_c_string ("priority");
5488 staticpro (&Qpriority);
5489 Qwindow = intern_c_string ("window");
5490 staticpro (&Qwindow);
5491 Qbefore_string = intern_c_string ("before-string");
5492 staticpro (&Qbefore_string);
5493 Qafter_string = intern_c_string ("after-string");
5494 staticpro (&Qafter_string);
5495 Qfirst_change_hook = intern_c_string ("first-change-hook");
5496 staticpro (&Qfirst_change_hook);
5497 Qbefore_change_functions = intern_c_string ("before-change-functions");
5498 staticpro (&Qbefore_change_functions);
5499 Qafter_change_functions = intern_c_string ("after-change-functions");
5500 staticpro (&Qafter_change_functions);
5501 /* The next one is initialized in init_buffer_once. */
5502 staticpro (&Qucs_set_table_for_input);
5504 Qkill_buffer_query_functions = intern_c_string ("kill-buffer-query-functions");
5505 staticpro (&Qkill_buffer_query_functions);
5507 Fput (Qprotected_field, Qerror_conditions,
5508 pure_cons (Qprotected_field, pure_cons (Qerror, Qnil)));
5509 Fput (Qprotected_field, Qerror_message,
5510 make_pure_c_string ("Attempt to modify a protected field"));
5512 /* All these use DEFVAR_LISP_NOPRO because the slots in
5513 buffer_defaults will all be marked via Vbuffer_defaults. */
5515 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5516 &buffer_defaults.mode_line_format,
5517 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5518 This is the same as (default-value 'mode-line-format). */);
5520 DEFVAR_LISP_NOPRO ("default-header-line-format",
5521 &buffer_defaults.header_line_format,
5522 doc: /* Default value of `header-line-format' for buffers that don't override it.
5523 This is the same as (default-value 'header-line-format). */);
5525 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5526 doc: /* Default value of `cursor-type' for buffers that don't override it.
5527 This is the same as (default-value 'cursor-type). */);
5529 DEFVAR_LISP_NOPRO ("default-line-spacing",
5530 &buffer_defaults.extra_line_spacing,
5531 doc: /* Default value of `line-spacing' for buffers that don't override it.
5532 This is the same as (default-value 'line-spacing). */);
5534 DEFVAR_LISP_NOPRO ("default-cursor-in-non-selected-windows",
5535 &buffer_defaults.cursor_in_non_selected_windows,
5536 doc: /* Default value of `cursor-in-non-selected-windows'.
5537 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5539 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5540 &buffer_defaults.abbrev_mode,
5541 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5542 This is the same as (default-value 'abbrev-mode). */);
5544 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5545 &buffer_defaults.ctl_arrow,
5546 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5547 This is the same as (default-value 'ctl-arrow). */);
5549 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5550 &buffer_defaults.direction_reversed,
5551 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5552 This is the same as (default-value 'direction-reversed). */);
5554 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5555 &buffer_defaults.enable_multibyte_characters,
5556 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5557 This is the same as (default-value 'enable-multibyte-characters). */);
5559 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5560 &buffer_defaults.buffer_file_coding_system,
5561 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5562 This is the same as (default-value 'buffer-file-coding-system). */);
5564 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5565 &buffer_defaults.truncate_lines,
5566 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5567 This is the same as (default-value 'truncate-lines). */);
5569 DEFVAR_LISP_NOPRO ("default-fill-column",
5570 &buffer_defaults.fill_column,
5571 doc: /* Default value of `fill-column' for buffers that do not override it.
5572 This is the same as (default-value 'fill-column). */);
5574 DEFVAR_LISP_NOPRO ("default-left-margin",
5575 &buffer_defaults.left_margin,
5576 doc: /* Default value of `left-margin' for buffers that do not override it.
5577 This is the same as (default-value 'left-margin). */);
5579 DEFVAR_LISP_NOPRO ("default-tab-width",
5580 &buffer_defaults.tab_width,
5581 doc: /* Default value of `tab-width' for buffers that do not override it.
5582 This is the same as (default-value 'tab-width). */);
5584 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5585 &buffer_defaults.case_fold_search,
5586 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5587 This is the same as (default-value 'case-fold-search). */);
5589 #ifdef DOS_NT
5590 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5591 &buffer_defaults.buffer_file_type,
5592 doc: /* Default file type for buffers that do not override it.
5593 This is the same as (default-value 'buffer-file-type).
5594 The file type is nil for text, t for binary. */);
5595 #endif
5597 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5598 &buffer_defaults.left_margin_cols,
5599 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5600 This is the same as (default-value 'left-margin-width). */);
5602 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5603 &buffer_defaults.right_margin_cols,
5604 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5605 This is the same as (default-value 'right-margin-width). */);
5607 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5608 &buffer_defaults.left_fringe_width,
5609 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5610 This is the same as (default-value 'left-fringe-width). */);
5612 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5613 &buffer_defaults.right_fringe_width,
5614 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5615 This is the same as (default-value 'right-fringe-width). */);
5617 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5618 &buffer_defaults.fringes_outside_margins,
5619 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5620 This is the same as (default-value 'fringes-outside-margins). */);
5622 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5623 &buffer_defaults.scroll_bar_width,
5624 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5625 This is the same as (default-value 'scroll-bar-width). */);
5627 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5628 &buffer_defaults.vertical_scroll_bar_type,
5629 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5630 This is the same as (default-value 'vertical-scroll-bar). */);
5632 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5633 &buffer_defaults.indicate_empty_lines,
5634 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5635 This is the same as (default-value 'indicate-empty-lines). */);
5637 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5638 &buffer_defaults.indicate_buffer_boundaries,
5639 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5640 This is the same as (default-value 'indicate-buffer-boundaries). */);
5642 DEFVAR_LISP_NOPRO ("default-fringe-indicator-alist",
5643 &buffer_defaults.fringe_indicator_alist,
5644 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5645 This is the same as (default-value 'fringe-indicator-alist'). */);
5647 DEFVAR_LISP_NOPRO ("default-fringe-cursor-alist",
5648 &buffer_defaults.fringe_cursor_alist,
5649 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5650 This is the same as (default-value 'fringe-cursor-alist'). */);
5652 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5653 &buffer_defaults.scroll_up_aggressively,
5654 doc: /* Default value of `scroll-up-aggressively'.
5655 This value applies in buffers that don't have their own local values.
5656 This is the same as (default-value 'scroll-up-aggressively). */);
5658 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5659 &buffer_defaults.scroll_down_aggressively,
5660 doc: /* Default value of `scroll-down-aggressively'.
5661 This value applies in buffers that don't have their own local values.
5662 This is the same as (default-value 'scroll-down-aggressively). */);
5664 DEFVAR_PER_BUFFER ("header-line-format",
5665 &current_buffer->header_line_format,
5666 Qnil,
5667 doc: /* Analogous to `mode-line-format', but controls the header line.
5668 The header line appears, optionally, at the top of a window;
5669 the mode line appears at the bottom. */);
5671 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5672 Qnil,
5673 doc: /* Template for displaying mode line for current buffer.
5674 Each buffer has its own value of this variable.
5675 Value may be nil, a string, a symbol or a list or cons cell.
5676 A value of nil means don't display a mode line.
5677 For a symbol, its value is used (but it is ignored if t or nil).
5678 A string appearing directly as the value of a symbol is processed verbatim
5679 in that the %-constructs below are not recognized.
5680 Note that unless the symbol is marked as a `risky-local-variable', all
5681 properties in any strings, as well as all :eval and :propertize forms
5682 in the value of that symbol will be ignored.
5683 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5684 is used as a mode line element. Be careful--FORM should not load any files,
5685 because that can cause an infinite recursion.
5686 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5687 with the specified properties PROPS applied.
5688 For a list whose car is a symbol, the symbol's value is taken,
5689 and if that is non-nil, the cadr of the list is processed recursively.
5690 Otherwise, the caddr of the list (if there is one) is processed.
5691 For a list whose car is a string or list, each element is processed
5692 recursively and the results are effectively concatenated.
5693 For a list whose car is an integer, the cdr of the list is processed
5694 and padded (if the number is positive) or truncated (if negative)
5695 to the width specified by that number.
5696 A string is printed verbatim in the mode line except for %-constructs:
5697 (%-constructs are allowed when the string is the entire mode-line-format
5698 or when it is found in a cons-cell or a list)
5699 %b -- print buffer name. %f -- print visited file name.
5700 %F -- print frame name.
5701 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5702 %& is like %*, but ignore read-only-ness.
5703 % means buffer is read-only and * means it is modified.
5704 For a modified read-only buffer, %* gives % and %+ gives *.
5705 %s -- print process status. %l -- print the current line number.
5706 %c -- print the current column number (this makes editing slower).
5707 To make the column number update correctly in all cases,
5708 `column-number-mode' must be non-nil.
5709 %i -- print the size of the buffer.
5710 %I -- like %i, but use k, M, G, etc., to abbreviate.
5711 %p -- print percent of buffer above top of window, or Top, Bot or All.
5712 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5713 or print Bottom or All.
5714 %n -- print Narrow if appropriate.
5715 %t -- visited file is text or binary (if OS supports this distinction).
5716 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5717 %Z -- like %z, but including the end-of-line format.
5718 %e -- print error message about full memory.
5719 %@ -- print @ or hyphen. @ means that default-directory is on a
5720 remote machine.
5721 %[ -- print one [ for each recursive editing level. %] similar.
5722 %% -- print %. %- -- print infinitely many dashes.
5723 Decimal digits after the % specify field width to which to pad. */);
5725 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5726 doc: /* *Value of `major-mode' for new buffers. */);
5728 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5729 make_number (Lisp_Symbol),
5730 doc: /* Symbol for current buffer's major mode.
5731 The default value (normally `fundamental-mode') affects new buffers.
5732 A value of nil means to use the current buffer's major mode, provided
5733 it is not marked as "special".
5735 When a mode is used by default, `find-file' switches to it before it
5736 reads the contents into the buffer and before it finishes setting up
5737 the buffer. Thus, the mode and its hooks should not expect certain
5738 variables such as `buffer-read-only' and `buffer-file-coding-system'
5739 to be set up. */);
5741 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5742 Qnil,
5743 doc: /* Pretty name of current buffer's major mode.
5744 Usually a string, but can use any of the constructs for `mode-line-format',
5745 which see.
5746 Format with `format-mode-line' to produce a string value. */);
5748 DEFVAR_PER_BUFFER ("local-abbrev-table", &current_buffer->abbrev_table, Qnil,
5749 doc: /* Local (mode-specific) abbrev table of current buffer. */);
5751 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5752 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5754 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5755 Qnil,
5756 doc: /* *Non-nil if searches and matches should ignore case. */);
5758 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5759 make_number (LISP_INT_TAG),
5760 doc: /* *Column beyond which automatic line-wrapping should happen.
5761 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5763 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5764 make_number (LISP_INT_TAG),
5765 doc: /* *Column for the default `indent-line-function' to indent to.
5766 Linefeed indents to this column in Fundamental mode. */);
5768 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5769 make_number (LISP_INT_TAG),
5770 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5772 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5773 doc: /* *Non-nil means display control chars with uparrow.
5774 A value of nil means use backslash and octal digits.
5775 This variable does not apply to characters whose display is specified
5776 in the current display table (if there is one). */);
5778 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5779 &current_buffer->enable_multibyte_characters,
5780 Qnil,
5781 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5782 Otherwise they are regarded as unibyte. This affects the display,
5783 file I/O and the behavior of various editing commands.
5785 This variable is buffer-local but you cannot set it directly;
5786 use the function `set-buffer-multibyte' to change a buffer's representation.
5787 Changing its default value with `setq-default' is supported.
5788 See also variable `default-enable-multibyte-characters' and Info node
5789 `(elisp)Text Representations'. */);
5790 XSYMBOL (intern_c_string ("enable-multibyte-characters"))->constant = 1;
5792 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5793 &current_buffer->buffer_file_coding_system, Qnil,
5794 doc: /* Coding system to be used for encoding the buffer contents on saving.
5795 This variable applies to saving the buffer, and also to `write-region'
5796 and other functions that use `write-region'.
5797 It does not apply to sending output to subprocesses, however.
5799 If this is nil, the buffer is saved without any code conversion
5800 unless some coding system is specified in `file-coding-system-alist'
5801 for the buffer file.
5803 If the text to be saved cannot be encoded as specified by this variable,
5804 an alternative encoding is selected by `select-safe-coding-system', which see.
5806 The variable `coding-system-for-write', if non-nil, overrides this variable.
5808 This variable is never applied to a way of decoding a file while reading it. */);
5810 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5811 Qnil,
5812 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5814 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5815 doc: /* *Non-nil means do not display continuation lines.
5816 Instead, give each line of text just one screen line.
5818 Note that this is overridden by the variable
5819 `truncate-partial-width-windows' if that variable is non-nil
5820 and this buffer is not full-frame width. */);
5822 DEFVAR_PER_BUFFER ("word-wrap", &current_buffer->word_wrap, Qnil,
5823 doc: /* *Non-nil means to use word-wrapping for continuation lines.
5824 When word-wrapping is on, continuation lines are wrapped at the space
5825 or tab character nearest to the right window edge.
5826 If nil, continuation lines are wrapped at the right screen edge.
5828 This variable has no effect if long lines are truncated (see
5829 `truncate-lines' and `truncate-partial-width-windows'). If you use
5830 word-wrapping, you might want to reduce the value of
5831 `truncate-partial-width-windows', since wrapping can make text readable
5832 in narrower windows. */);
5834 #ifdef DOS_NT
5835 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5836 Qnil,
5837 doc: /* Non-nil if the visited file is a binary file.
5838 This variable is meaningful on MS-DOG and Windows NT.
5839 On those systems, it is automatically local in every buffer.
5840 On other systems, this variable is normally always nil. */);
5841 #endif
5843 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5844 make_number (Lisp_String),
5845 doc: /* Name of default directory of current buffer. Should end with slash.
5846 To interactively change the default directory, use command `cd'. */);
5848 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5849 Qnil,
5850 doc: /* Function called (if non-nil) to perform auto-fill.
5851 It is called after self-inserting any character specified in
5852 the `auto-fill-chars' table.
5853 NOTE: This variable is not a hook;
5854 its value may not be a list of functions. */);
5856 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5857 make_number (Lisp_String),
5858 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5860 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5861 make_number (Lisp_String),
5862 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5863 The truename of a file is calculated by `file-truename'
5864 and then abbreviated with `abbreviate-file-name'. */);
5866 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5867 &current_buffer->auto_save_file_name,
5868 make_number (Lisp_String),
5869 doc: /* Name of file for auto-saving current buffer.
5870 If it is nil, that means don't auto-save this buffer. */);
5872 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5873 doc: /* Non-nil if this buffer is read-only. */);
5875 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5876 doc: /* Non-nil if this buffer's file has been backed up.
5877 Backing up is done before the first time the file is saved. */);
5879 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5880 make_number (LISP_INT_TAG),
5881 doc: /* Length of current buffer when last read in, saved or auto-saved.
5882 0 initially.
5883 -1 means auto-saving turned off until next real save.
5885 If you set this to -2, that means don't turn off auto-saving in this buffer
5886 if its text size shrinks. If you use `buffer-swap-text' on a buffer,
5887 you probably should set this to -2 in that buffer. */);
5889 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5890 Qnil,
5891 doc: /* Non-nil enables selective display.
5892 An integer N as value means display only lines
5893 that start with less than N columns of space.
5894 A value of t means that the character ^M makes itself and
5895 all the rest of the line invisible; also, when saving the buffer
5896 in a file, save the ^M as a newline. */);
5898 #ifndef old
5899 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5900 &current_buffer->selective_display_ellipses,
5901 Qnil,
5902 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5903 #endif
5905 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5906 doc: /* Non-nil if self-insertion should replace existing text.
5907 The value should be one of `overwrite-mode-textual',
5908 `overwrite-mode-binary', or nil.
5909 If it is `overwrite-mode-textual', self-insertion still
5910 inserts at the end of a line, and inserts when point is before a tab,
5911 until the tab is filled in.
5912 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5914 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5915 Qnil,
5916 doc: /* Display table that controls display of the contents of current buffer.
5918 If this variable is nil, the value of `standard-display-table' is used.
5919 Each window can have its own, overriding display table, see
5920 `set-window-display-table' and `window-display-table'.
5922 The display table is a char-table created with `make-display-table'.
5923 A char-table is an array indexed by character codes. Normal array
5924 primitives `aref' and `aset' can be used to access elements of a char-table.
5926 Each of the char-table elements control how to display the corresponding
5927 text character: the element at index C in the table says how to display
5928 the character whose code is C. Each element should be a vector of
5929 characters or nil. The value nil means display the character in the
5930 default fashion; otherwise, the characters from the vector are delivered
5931 to the screen instead of the original character.
5933 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5934 to display a capital Y instead of each X character.
5936 In addition, a char-table has six extra slots to control the display of:
5938 the end of a truncated screen line (extra-slot 0, a single character);
5939 the end of a continued line (extra-slot 1, a single character);
5940 the escape character used to display character codes in octal
5941 (extra-slot 2, a single character);
5942 the character used as an arrow for control characters (extra-slot 3,
5943 a single character);
5944 the decoration indicating the presence of invisible lines (extra-slot 4,
5945 a vector of characters);
5946 the character used to draw the border between side-by-side windows
5947 (extra-slot 5, a single character).
5949 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5951 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5952 Qnil,
5953 doc: /* *Width of left marginal area for display of a buffer.
5954 A value of nil means no marginal area. */);
5956 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5957 Qnil,
5958 doc: /* *Width of right marginal area for display of a buffer.
5959 A value of nil means no marginal area. */);
5961 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5962 Qnil,
5963 doc: /* *Width of this buffer's left fringe (in pixels).
5964 A value of 0 means no left fringe is shown in this buffer's window.
5965 A value of nil means to use the left fringe width from the window's frame. */);
5967 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5968 Qnil,
5969 doc: /* *Width of this buffer's right fringe (in pixels).
5970 A value of 0 means no right fringe is shown in this buffer's window.
5971 A value of nil means to use the right fringe width from the window's frame. */);
5973 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5974 Qnil,
5975 doc: /* *Non-nil means to display fringes outside display margins.
5976 A value of nil means to display fringes between margins and buffer text. */);
5978 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5979 Qnil,
5980 doc: /* *Width of this buffer's scroll bars in pixels.
5981 A value of nil means to use the scroll bar width from the window's frame. */);
5983 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5984 Qnil,
5985 doc: /* *Position of this buffer's vertical scroll bar.
5986 The value takes effect whenever you tell a window to display this buffer;
5987 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5989 A value of `left' or `right' means put the vertical scroll bar at that side
5990 of the window; a value of nil means don't show any vertical scroll bars.
5991 A value of t (the default) means do whatever the window's frame specifies. */);
5993 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5994 &current_buffer->indicate_empty_lines, Qnil,
5995 doc: /* *Visually indicate empty lines after the buffer end.
5996 If non-nil, a bitmap is displayed in the left fringe of a window on
5997 window-systems. */);
5999 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
6000 &current_buffer->indicate_buffer_boundaries, Qnil,
6001 doc: /* *Visually indicate buffer boundaries and scrolling.
6002 If non-nil, the first and last line of the buffer are marked in the fringe
6003 of a window on window-systems with angle bitmaps, or if the window can be
6004 scrolled, the top and bottom line of the window are marked with up and down
6005 arrow bitmaps.
6007 If value is a symbol `left' or `right', both angle and arrow bitmaps
6008 are displayed in the left or right fringe, resp. Any other value
6009 that doesn't look like an alist means display the angle bitmaps in
6010 the left fringe but no arrows.
6012 You can exercise more precise control by using an alist as the
6013 value. Each alist element (INDICATOR . POSITION) specifies
6014 where to show one of the indicators. INDICATOR is one of `top',
6015 `bottom', `up', `down', or t, which specifies the default position,
6016 and POSITION is one of `left', `right', or nil, meaning do not show
6017 this indicator.
6019 For example, ((top . left) (t . right)) places the top angle bitmap in
6020 left fringe, the bottom angle bitmap in right fringe, and both arrow
6021 bitmaps in right fringe. To show just the angle bitmaps in the left
6022 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
6024 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
6025 &current_buffer->fringe_indicator_alist, Qnil,
6026 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
6027 The value is an alist where each element (INDICATOR . BITMAPS)
6028 specifies the fringe bitmaps used to display a specific logical
6029 fringe indicator.
6031 INDICATOR specifies the logical indicator type which is one of the
6032 following symbols: `truncation' , `continuation', `overlay-arrow',
6033 `top', `bottom', `up', `down', `one-line', `empty-line', or `unknown'.
6035 BITMAPS is list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
6036 the actual bitmap shown in the left or right fringe for the logical
6037 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
6038 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
6039 are used only for the `bottom' and `one-line' indicators when the last
6040 \(only) line in has no final newline. BITMAPS may also be a single
6041 symbol which is used in both left and right fringes. */);
6043 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
6044 &current_buffer->fringe_cursor_alist, Qnil,
6045 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
6046 The value is an alist where each element (CURSOR . BITMAP)
6047 specifies the fringe bitmaps used to display a specific logical
6048 cursor type in the fringe.
6050 CURSOR specifies the logical cursor type which is one of the following
6051 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
6052 one is used to show a hollow cursor on narrow lines display lines
6053 where the normal hollow cursor will not fit.
6055 BITMAP is the corresponding fringe bitmap shown for the logical
6056 cursor type. */);
6058 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
6059 &current_buffer->scroll_up_aggressively, Qnil,
6060 doc: /* How far to scroll windows upward.
6061 If you move point off the bottom, the window scrolls automatically.
6062 This variable controls how far it scrolls. The value nil, the default,
6063 means scroll to center point. A fraction means scroll to put point
6064 that fraction of the window's height from the bottom of the window.
6065 When the value is 0.0, point goes at the bottom line, which in the
6066 simple case that you moved off with C-f means scrolling just one line.
6067 1.0 means point goes at the top, so that in that simple case, the
6068 window scrolls by a full window height. Meaningful values are
6069 between 0.0 and 1.0, inclusive. */);
6071 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
6072 &current_buffer->scroll_down_aggressively, Qnil,
6073 doc: /* How far to scroll windows downward.
6074 If you move point off the top, the window scrolls automatically.
6075 This variable controls how far it scrolls. The value nil, the default,
6076 means scroll to center point. A fraction means scroll to put point
6077 that fraction of the window's height from the top of the window.
6078 When the value is 0.0, point goes at the top line, which in the
6079 simple case that you moved off with C-b means scrolling just one line.
6080 1.0 means point goes at the bottom, so that in that simple case, the
6081 window scrolls by a full window height. Meaningful values are
6082 between 0.0 and 1.0, inclusive. */);
6084 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
6085 "Don't ask.");
6088 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
6089 doc: /* List of functions to call before each text change.
6090 Two arguments are passed to each function: the positions of
6091 the beginning and end of the range of old text to be changed.
6092 \(For an insertion, the beginning and end are at the same place.)
6093 No information is given about the length of the text after the change.
6095 Buffer changes made while executing the `before-change-functions'
6096 don't call any before-change or after-change functions.
6097 That's because these variables are temporarily set to nil.
6098 As a result, a hook function cannot straightforwardly alter the
6099 value of these variables. See the Emacs Lisp manual for a way of
6100 accomplishing an equivalent result by using other variables.
6102 If an unhandled error happens in running these functions,
6103 the variable's value remains nil. That prevents the error
6104 from happening repeatedly and making Emacs nonfunctional. */);
6105 Vbefore_change_functions = Qnil;
6107 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
6108 doc: /* List of functions to call after each text change.
6109 Three arguments are passed to each function: the positions of
6110 the beginning and end of the range of changed text,
6111 and the length in bytes of the pre-change text replaced by that range.
6112 \(For an insertion, the pre-change length is zero;
6113 for a deletion, that length is the number of bytes deleted,
6114 and the post-change beginning and end are at the same place.)
6116 Buffer changes made while executing the `after-change-functions'
6117 don't call any before-change or after-change functions.
6118 That's because these variables are temporarily set to nil.
6119 As a result, a hook function cannot straightforwardly alter the
6120 value of these variables. See the Emacs Lisp manual for a way of
6121 accomplishing an equivalent result by using other variables.
6123 If an unhandled error happens in running these functions,
6124 the variable's value remains nil. That prevents the error
6125 from happening repeatedly and making Emacs nonfunctional. */);
6126 Vafter_change_functions = Qnil;
6128 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
6129 doc: /* A list of functions to call before changing a buffer which is unmodified.
6130 The functions are run using the `run-hooks' function. */);
6131 Vfirst_change_hook = Qnil;
6133 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
6134 doc: /* List of undo entries in current buffer.
6135 Recent changes come first; older changes follow newer.
6137 An entry (BEG . END) represents an insertion which begins at
6138 position BEG and ends at position END.
6140 An entry (TEXT . POSITION) represents the deletion of the string TEXT
6141 from (abs POSITION). If POSITION is positive, point was at the front
6142 of the text being deleted; if negative, point was at the end.
6144 An entry (t HIGH . LOW) indicates that the buffer previously had
6145 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
6146 of the visited file's modification time, as of that time. If the
6147 modification time of the most recent save is different, this entry is
6148 obsolete.
6150 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
6151 was modified between BEG and END. PROPERTY is the property name,
6152 and VALUE is the old value.
6154 An entry (apply FUN-NAME . ARGS) means undo the change with
6155 \(apply FUN-NAME ARGS).
6157 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
6158 in the active region. BEG and END is the range affected by this entry
6159 and DELTA is the number of bytes added or deleted in that range by
6160 this change.
6162 An entry (MARKER . DISTANCE) indicates that the marker MARKER
6163 was adjusted in position by the offset DISTANCE (an integer).
6165 An entry of the form POSITION indicates that point was at the buffer
6166 location given by the integer. Undoing an entry of this form places
6167 point at POSITION.
6169 Entries with value `nil' mark undo boundaries. The undo command treats
6170 the changes between two undo boundaries as a single step to be undone.
6172 If the value of the variable is t, undo information is not recorded. */);
6174 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
6175 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
6177 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
6178 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
6180 Normally, the line-motion functions work by scanning the buffer for
6181 newlines. Columnar operations (like `move-to-column' and
6182 `compute-motion') also work by scanning the buffer, summing character
6183 widths as they go. This works well for ordinary text, but if the
6184 buffer's lines are very long (say, more than 500 characters), these
6185 motion functions will take longer to execute. Emacs may also take
6186 longer to update the display.
6188 If `cache-long-line-scans' is non-nil, these motion functions cache the
6189 results of their scans, and consult the cache to avoid rescanning
6190 regions of the buffer until the text is modified. The caches are most
6191 beneficial when they prevent the most searching---that is, when the
6192 buffer contains long lines and large regions of characters with the
6193 same, fixed screen width.
6195 When `cache-long-line-scans' is non-nil, processing short lines will
6196 become slightly slower (because of the overhead of consulting the
6197 cache), and the caches will use memory roughly proportional to the
6198 number of newlines and characters whose screen width varies.
6200 The caches require no explicit maintenance; their accuracy is
6201 maintained internally by the Emacs primitives. Enabling or disabling
6202 the cache should not affect the behavior of any of the motion
6203 functions; it should only affect their performance. */);
6205 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
6206 doc: /* Value of point before the last series of scroll operations, or nil. */);
6208 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
6209 doc: /* List of formats to use when saving this buffer.
6210 Formats are defined by `format-alist'. This variable is
6211 set when a file is visited. */);
6213 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6214 &current_buffer->auto_save_file_format, Qnil,
6215 doc: /* *Format in which to write auto-save files.
6216 Should be a list of symbols naming formats that are defined in `format-alist'.
6217 If it is t, which is the default, auto-save files are written in the
6218 same format as a regular save would use. */);
6220 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6221 &current_buffer->invisibility_spec, Qnil,
6222 doc: /* Invisibility spec of this buffer.
6223 The default is t, which means that text is invisible
6224 if it has a non-nil `invisible' property.
6225 If the value is a list, a text character is invisible if its `invisible'
6226 property is an element in that list (or is a list with members in common).
6227 If an element is a cons cell of the form (PROP . ELLIPSIS),
6228 then characters with property value PROP are invisible,
6229 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
6231 DEFVAR_PER_BUFFER ("buffer-display-count",
6232 &current_buffer->display_count, Qnil,
6233 doc: /* A number incremented each time this buffer is displayed in a window.
6234 The function `set-window-buffer' increments it. */);
6236 DEFVAR_PER_BUFFER ("buffer-display-time",
6237 &current_buffer->display_time, Qnil,
6238 doc: /* Time stamp updated each time this buffer is displayed in a window.
6239 The function `set-window-buffer' updates this variable
6240 to the value obtained by calling `current-time'.
6241 If the buffer has never been shown in a window, the value is nil. */);
6243 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
6244 doc: /* */);
6245 Vtransient_mark_mode = Qnil;
6246 /* The docstring is in simple.el. If we put it here, it would be
6247 overwritten when transient-mark-mode is defined using
6248 define-minor-mode. */
6250 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
6251 doc: /* *Non-nil means disregard read-only status of buffers or characters.
6252 If the value is t, disregard `buffer-read-only' and all `read-only'
6253 text properties. If the value is a list, disregard `buffer-read-only'
6254 and disregard a `read-only' text property if the property value
6255 is a member of the list. */);
6256 Vinhibit_read_only = Qnil;
6258 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
6259 doc: /* Cursor to use when this buffer is in the selected window.
6260 Values are interpreted as follows:
6262 t use the cursor specified for the frame
6263 nil don't display a cursor
6264 box display a filled box cursor
6265 hollow display a hollow box cursor
6266 bar display a vertical bar cursor with default width
6267 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6268 hbar display a horizontal bar cursor with default height
6269 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6270 ANYTHING ELSE display a hollow box cursor
6272 When the buffer is displayed in a non-selected window, the
6273 cursor's appearance is instead controlled by the variable
6274 `cursor-in-non-selected-windows'. */);
6276 DEFVAR_PER_BUFFER ("line-spacing",
6277 &current_buffer->extra_line_spacing, Qnil,
6278 doc: /* Additional space to put between lines when displaying a buffer.
6279 The space is measured in pixels, and put below lines on graphic displays,
6280 see `display-graphic-p'.
6281 If value is a floating point number, it specifies the spacing relative
6282 to the default frame line height. A value of nil means add no extra space. */);
6284 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6285 &current_buffer->cursor_in_non_selected_windows, Qnil,
6286 doc: /* *Cursor type to display in non-selected windows.
6287 The value t means to use hollow box cursor. See `cursor-type' for other values. */);
6289 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
6290 doc: /* List of functions called with no args to query before killing a buffer.
6291 The buffer being killed will be current while the functions are running.
6292 If any of them returns nil, the buffer is not killed. */);
6293 Vkill_buffer_query_functions = Qnil;
6295 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook,
6296 doc: /* Normal hook run before changing the major mode of a buffer.
6297 The function `kill-all-local-variables' runs this before doing anything else. */);
6298 Vchange_major_mode_hook = Qnil;
6299 Qchange_major_mode_hook = intern_c_string ("change-major-mode-hook");
6300 staticpro (&Qchange_major_mode_hook);
6302 defsubr (&Sbuffer_live_p);
6303 defsubr (&Sbuffer_list);
6304 defsubr (&Sget_buffer);
6305 defsubr (&Sget_file_buffer);
6306 defsubr (&Sget_buffer_create);
6307 defsubr (&Smake_indirect_buffer);
6308 defsubr (&Sgenerate_new_buffer_name);
6309 defsubr (&Sbuffer_name);
6310 /*defsubr (&Sbuffer_number);*/
6311 defsubr (&Sbuffer_file_name);
6312 defsubr (&Sbuffer_base_buffer);
6313 defsubr (&Sbuffer_local_value);
6314 defsubr (&Sbuffer_local_variables);
6315 defsubr (&Sbuffer_modified_p);
6316 defsubr (&Sset_buffer_modified_p);
6317 defsubr (&Sbuffer_modified_tick);
6318 defsubr (&Sbuffer_chars_modified_tick);
6319 defsubr (&Srename_buffer);
6320 defsubr (&Sother_buffer);
6321 defsubr (&Sbuffer_enable_undo);
6322 defsubr (&Skill_buffer);
6323 defsubr (&Sset_buffer_major_mode);
6324 defsubr (&Sswitch_to_buffer);
6325 defsubr (&Scurrent_buffer);
6326 defsubr (&Sset_buffer);
6327 defsubr (&Sbarf_if_buffer_read_only);
6328 defsubr (&Sbury_buffer);
6329 defsubr (&Serase_buffer);
6330 defsubr (&Sbuffer_swap_text);
6331 defsubr (&Sset_buffer_multibyte);
6332 defsubr (&Skill_all_local_variables);
6334 defsubr (&Soverlayp);
6335 defsubr (&Smake_overlay);
6336 defsubr (&Sdelete_overlay);
6337 defsubr (&Smove_overlay);
6338 defsubr (&Soverlay_start);
6339 defsubr (&Soverlay_end);
6340 defsubr (&Soverlay_buffer);
6341 defsubr (&Soverlay_properties);
6342 defsubr (&Soverlays_at);
6343 defsubr (&Soverlays_in);
6344 defsubr (&Snext_overlay_change);
6345 defsubr (&Sprevious_overlay_change);
6346 defsubr (&Soverlay_recenter);
6347 defsubr (&Soverlay_lists);
6348 defsubr (&Soverlay_get);
6349 defsubr (&Soverlay_put);
6350 defsubr (&Srestore_buffer_modified_p);
6353 void
6354 keys_of_buffer ()
6356 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6357 initial_define_key (control_x_map, 'k', "kill-buffer");
6359 /* This must not be in syms_of_buffer, because Qdisabled is not
6360 initialized when that function gets called. */
6361 Fput (intern_c_string ("erase-buffer"), Qdisabled, Qt);
6364 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
6365 (do not change this comment) */