(syms_of_xdisp): Make fontification-functions buffer-local.
[emacs.git] / src / buffer.c
blob77731c42771b13a1a29589075a2f7b106a1c8636
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985,86,87,88,89,93,94,95,97,98, 1999, 2000
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
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>
30 #ifndef USE_CRT_DLL
31 extern int errno;
32 #endif
34 #ifndef MAXPATHLEN
35 /* in 4.1, param.h fails to define this. */
36 #define MAXPATHLEN 1024
37 #endif /* not MAXPATHLEN */
39 #ifdef HAVE_UNISTD_H
40 #include <unistd.h>
41 #endif
42 #include "lisp.h"
43 #include "intervals.h"
44 #include "window.h"
45 #include "commands.h"
46 #include "buffer.h"
47 #include "charset.h"
48 #include "region-cache.h"
49 #include "indent.h"
50 #include "blockinput.h"
51 #include "keyboard.h"
52 #include "frame.h"
54 struct buffer *current_buffer; /* the current buffer */
56 /* First buffer in chain of all buffers (in reverse order of creation).
57 Threaded through ->next. */
59 struct buffer *all_buffers;
61 /* This structure holds the default values of the buffer-local variables
62 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
63 The default value occupies the same slot in this structure
64 as an individual buffer's value occupies in that buffer.
65 Setting the default value also goes through the alist of buffers
66 and stores into each buffer that does not say it has a local value. */
68 struct buffer buffer_defaults;
70 /* A Lisp_Object pointer to the above, used for staticpro */
72 static Lisp_Object Vbuffer_defaults;
74 /* This structure marks which slots in a buffer have corresponding
75 default values in buffer_defaults.
76 Each such slot has a nonzero value in this structure.
77 The value has only one nonzero bit.
79 When a buffer has its own local value for a slot,
80 the entry for that slot (found in the same slot in this structure)
81 is turned on in the buffer's local_flags array.
83 If a slot in this structure is -1, then even though there may
84 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
85 and the corresponding slot in buffer_defaults is not used.
87 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
88 but there is a default value which is copied into each buffer.
90 If a slot in this structure is negative, then even though there may
91 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
92 and the corresponding slot in buffer_defaults is not used.
94 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
95 zero, that is a bug */
97 struct buffer buffer_local_flags;
99 /* This structure holds the names of symbols whose values may be
100 buffer-local. It is indexed and accessed in the same way as the above. */
102 struct buffer buffer_local_symbols;
103 /* A Lisp_Object pointer to the above, used for staticpro */
104 static Lisp_Object Vbuffer_local_symbols;
106 /* This structure holds the required types for the values in the
107 buffer-local slots. If a slot contains Qnil, then the
108 corresponding buffer slot may contain a value of any type. If a
109 slot contains an integer, then prospective values' tags must be
110 equal to that integer (except nil is always allowed).
111 When a tag does not match, the function
112 buffer_slot_type_mismatch will signal an error.
114 If a slot here contains -1, the corresponding variable is read-only. */
115 struct buffer buffer_local_types;
117 /* Flags indicating which built-in buffer-local variables
118 are permanent locals. */
119 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
121 /* Number of per-buffer variables used. */
123 int last_per_buffer_idx;
125 Lisp_Object Fset_buffer ();
126 void set_buffer_internal ();
127 void set_buffer_internal_1 ();
128 static void call_overlay_mod_hooks ();
129 static void swap_out_buffer_local_variables ();
130 static void reset_buffer_local_variables ();
132 /* Alist of all buffer names vs the buffers. */
133 /* This used to be a variable, but is no longer,
134 to prevent lossage due to user rplac'ing this alist or its elements. */
135 Lisp_Object Vbuffer_alist;
137 /* Functions to call before and after each text change. */
138 Lisp_Object Vbefore_change_functions;
139 Lisp_Object Vafter_change_functions;
141 Lisp_Object Vtransient_mark_mode;
143 /* t means ignore all read-only text properties.
144 A list means ignore such a property if its value is a member of the list.
145 Any non-nil value means ignore buffer-read-only. */
146 Lisp_Object Vinhibit_read_only;
148 /* List of functions to call that can query about killing a buffer.
149 If any of these functions returns nil, we don't kill it. */
150 Lisp_Object Vkill_buffer_query_functions;
152 /* List of functions to call before changing an unmodified buffer. */
153 Lisp_Object Vfirst_change_hook;
155 Lisp_Object Qfirst_change_hook;
156 Lisp_Object Qbefore_change_functions;
157 Lisp_Object Qafter_change_functions;
159 /* If nonzero, all modification hooks are suppressed. */
160 int inhibit_modification_hooks;
162 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
164 Lisp_Object Qprotected_field;
166 Lisp_Object QSFundamental; /* A string "Fundamental" */
168 Lisp_Object Qkill_buffer_hook;
170 Lisp_Object Qget_file_buffer;
172 Lisp_Object Qoverlayp;
174 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
176 Lisp_Object Qmodification_hooks;
177 Lisp_Object Qinsert_in_front_hooks;
178 Lisp_Object Qinsert_behind_hooks;
180 static void alloc_buffer_text P_ ((struct buffer *, size_t));
181 static void free_buffer_text P_ ((struct buffer *b));
184 /* For debugging; temporary. See set_buffer_internal. */
185 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
187 void
188 nsberror (spec)
189 Lisp_Object spec;
191 if (STRINGP (spec))
192 error ("No buffer named %s", XSTRING (spec)->data);
193 error ("Invalid buffer argument");
196 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
197 "Return non-nil if OBJECT is a buffer which has not been killed.\n\
198 Value is nil if OBJECT is not a buffer or if it has been killed.")
199 (object)
200 Lisp_Object object;
202 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
203 ? Qt : Qnil);
206 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
207 "Return a list of all existing live buffers.\n\
208 If the optional arg FRAME is a frame, we return that frame's buffer list.")
209 (frame)
210 Lisp_Object frame;
212 Lisp_Object framelist, general;
213 general = Fmapcar (Qcdr, Vbuffer_alist);
215 if (FRAMEP (frame))
217 Lisp_Object tail;
219 CHECK_FRAME (frame, 1);
221 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
223 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
224 tail = framelist;
225 while (! NILP (tail))
227 general = Fdelq (XCAR (tail), general);
228 tail = XCDR (tail);
230 return nconc2 (framelist, general);
233 return general;
236 /* Like Fassoc, but use Fstring_equal to compare
237 (which ignores text properties),
238 and don't ever QUIT. */
240 static Lisp_Object
241 assoc_ignore_text_properties (key, list)
242 register Lisp_Object key;
243 Lisp_Object list;
245 register Lisp_Object tail;
246 for (tail = list; !NILP (tail); tail = Fcdr (tail))
248 register Lisp_Object elt, tem;
249 elt = Fcar (tail);
250 tem = Fstring_equal (Fcar (elt), key);
251 if (!NILP (tem))
252 return elt;
254 return Qnil;
257 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
258 "Return the buffer named NAME (a string).\n\
259 If there is no live buffer named NAME, return nil.\n\
260 NAME may also be a buffer; if so, the value is that buffer.")
261 (name)
262 register Lisp_Object name;
264 if (BUFFERP (name))
265 return name;
266 CHECK_STRING (name, 0);
268 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
271 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
272 "Return the buffer visiting file FILENAME (a string).\n\
273 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
274 If there is no such live buffer, return nil.\n\
275 See also `find-buffer-visiting'.")
276 (filename)
277 register Lisp_Object filename;
279 register Lisp_Object tail, buf, tem;
280 Lisp_Object handler;
282 CHECK_STRING (filename, 0);
283 filename = Fexpand_file_name (filename, Qnil);
285 /* If the file name has special constructs in it,
286 call the corresponding file handler. */
287 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
288 if (!NILP (handler))
289 return call2 (handler, Qget_file_buffer, filename);
291 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
293 buf = Fcdr (XCAR (tail));
294 if (!BUFFERP (buf)) continue;
295 if (!STRINGP (XBUFFER (buf)->filename)) continue;
296 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
297 if (!NILP (tem))
298 return buf;
300 return Qnil;
303 Lisp_Object
304 get_truename_buffer (filename)
305 register Lisp_Object filename;
307 register Lisp_Object tail, buf, tem;
309 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
311 buf = Fcdr (XCAR (tail));
312 if (!BUFFERP (buf)) continue;
313 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
314 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
315 if (!NILP (tem))
316 return buf;
318 return Qnil;
321 /* Incremented for each buffer created, to assign the buffer number. */
322 int buffer_count;
324 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
325 "Return the buffer named NAME, or create such a buffer and return it.\n\
326 A new buffer is created if there is no live buffer named NAME.\n\
327 If NAME starts with a space, the new buffer does not keep undo information.\n\
328 If NAME is a buffer instead of a string, then it is the value returned.\n\
329 The value is never nil.")
330 (name)
331 register Lisp_Object name;
333 register Lisp_Object buf;
334 register struct buffer *b;
336 buf = Fget_buffer (name);
337 if (!NILP (buf))
338 return buf;
340 if (XSTRING (name)->size == 0)
341 error ("Empty string for buffer name is not allowed");
343 b = (struct buffer *) allocate_buffer ();
345 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
347 /* An ordinary buffer uses its own struct buffer_text. */
348 b->text = &b->own_text;
349 b->base_buffer = 0;
351 BUF_GAP_SIZE (b) = 20;
352 BLOCK_INPUT;
353 /* We allocate extra 1-byte at the tail and keep it always '\0' for
354 anchoring a search. */
355 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
356 UNBLOCK_INPUT;
357 if (! BUF_BEG_ADDR (b))
358 buffer_memory_full ();
360 BUF_PT (b) = 1;
361 BUF_GPT (b) = 1;
362 BUF_BEGV (b) = 1;
363 BUF_ZV (b) = 1;
364 BUF_Z (b) = 1;
365 BUF_PT_BYTE (b) = 1;
366 BUF_GPT_BYTE (b) = 1;
367 BUF_BEGV_BYTE (b) = 1;
368 BUF_ZV_BYTE (b) = 1;
369 BUF_Z_BYTE (b) = 1;
370 BUF_MODIFF (b) = 1;
371 BUF_OVERLAY_MODIFF (b) = 1;
372 BUF_SAVE_MODIFF (b) = 1;
373 BUF_INTERVALS (b) = 0;
374 BUF_UNCHANGED_MODIFIED (b) = 1;
375 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
376 BUF_END_UNCHANGED (b) = 0;
377 BUF_BEG_UNCHANGED (b) = 0;
378 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
380 b->newline_cache = 0;
381 b->width_run_cache = 0;
382 b->width_table = Qnil;
383 b->prevent_redisplay_optimizations_p = 1;
385 /* Put this on the chain of all buffers including killed ones. */
386 b->next = all_buffers;
387 all_buffers = b;
389 /* An ordinary buffer normally doesn't need markers
390 to handle BEGV and ZV. */
391 b->pt_marker = Qnil;
392 b->begv_marker = Qnil;
393 b->zv_marker = Qnil;
395 name = Fcopy_sequence (name);
396 XSTRING (name)->intervals = NULL_INTERVAL;
397 b->name = name;
399 if (XSTRING (name)->data[0] != ' ')
400 b->undo_list = Qnil;
401 else
402 b->undo_list = Qt;
404 reset_buffer (b);
405 reset_buffer_local_variables (b, 1);
407 /* Put this in the alist of all live buffers. */
408 XSETBUFFER (buf, b);
409 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
411 b->mark = Fmake_marker ();
412 BUF_MARKERS (b) = Qnil;
413 b->name = name;
414 return buf;
418 /* Clone per-buffer values of buffer FROM.
420 Buffer TO gets the same per-buffer values as FROM, with the
421 following exceptions: (1) TO's name is left untouched, (2) markers
422 are copied and made to refer to TO, and (3) overlay lists are
423 copied. */
425 static void
426 clone_per_buffer_values (from, to)
427 struct buffer *from, *to;
429 Lisp_Object to_buffer;
430 int offset;
432 XSETBUFFER (to_buffer, to);
434 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
435 offset < sizeof *to;
436 offset += sizeof (Lisp_Object))
438 Lisp_Object obj;
440 obj = PER_BUFFER_VALUE (from, offset);
441 if (MARKERP (obj))
443 struct Lisp_Marker *m = XMARKER (obj);
444 obj = Fmake_marker ();
445 XMARKER (obj)->insertion_type = m->insertion_type;
446 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
449 PER_BUFFER_VALUE (to, offset) = obj;
452 to->overlays_after = Fcopy_sequence (from->overlays_after);
453 to->overlays_before = Fcopy_sequence (to->overlays_before);
454 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
458 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
459 2, 3,
460 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
461 "Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.\n\
462 BASE-BUFFER should be an existing buffer (or buffer name).\n\
463 NAME should be a string which is not the name of an existing buffer.\n\
464 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,\n\
465 such as major and minor modes, in the indirect buffer.\n\
466 CLONE nil means the indirect buffer's state is reset to default values.")
467 (base_buffer, name, clone)
468 Lisp_Object base_buffer, name, clone;
470 Lisp_Object buf;
471 struct buffer *b;
473 buf = Fget_buffer (name);
474 if (!NILP (buf))
475 error ("Buffer name `%s' is in use", XSTRING (name)->data);
477 base_buffer = Fget_buffer (base_buffer);
478 if (NILP (base_buffer))
479 error ("No such buffer: `%s'", XSTRING (name)->data);
481 if (XSTRING (name)->size == 0)
482 error ("Empty string for buffer name is not allowed");
484 b = (struct buffer *) allocate_buffer ();
485 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
487 if (XBUFFER (base_buffer)->base_buffer)
488 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
489 else
490 b->base_buffer = XBUFFER (base_buffer);
492 /* Use the base buffer's text object. */
493 b->text = b->base_buffer->text;
495 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
496 BUF_ZV (b) = BUF_ZV (b->base_buffer);
497 BUF_PT (b) = BUF_PT (b->base_buffer);
498 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
499 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
500 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
502 b->newline_cache = 0;
503 b->width_run_cache = 0;
504 b->width_table = Qnil;
506 /* Put this on the chain of all buffers including killed ones. */
507 b->next = all_buffers;
508 all_buffers = b;
510 name = Fcopy_sequence (name);
511 XSTRING (name)->intervals = NULL_INTERVAL;
512 b->name = name;
514 reset_buffer (b);
515 reset_buffer_local_variables (b, 1);
517 /* Put this in the alist of all live buffers. */
518 XSETBUFFER (buf, b);
519 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
521 b->mark = Fmake_marker ();
522 b->name = name;
524 /* The multibyte status belongs to the base buffer. */
525 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
527 /* Make sure the base buffer has markers for its narrowing. */
528 if (NILP (b->base_buffer->pt_marker))
530 b->base_buffer->pt_marker = Fmake_marker ();
531 set_marker_both (b->base_buffer->pt_marker, base_buffer,
532 BUF_PT (b->base_buffer),
533 BUF_PT_BYTE (b->base_buffer));
535 if (NILP (b->base_buffer->begv_marker))
537 b->base_buffer->begv_marker = Fmake_marker ();
538 set_marker_both (b->base_buffer->begv_marker, base_buffer,
539 BUF_BEGV (b->base_buffer),
540 BUF_BEGV_BYTE (b->base_buffer));
542 if (NILP (b->base_buffer->zv_marker))
544 b->base_buffer->zv_marker = Fmake_marker ();
545 set_marker_both (b->base_buffer->zv_marker, base_buffer,
546 BUF_ZV (b->base_buffer),
547 BUF_ZV_BYTE (b->base_buffer));
548 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
551 if (NILP (clone))
553 /* Give the indirect buffer markers for its narrowing. */
554 b->pt_marker = Fmake_marker ();
555 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
556 b->begv_marker = Fmake_marker ();
557 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
558 b->zv_marker = Fmake_marker ();
559 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
560 XMARKER (b->zv_marker)->insertion_type = 1;
562 else
563 clone_per_buffer_values (b->base_buffer, b);
565 return buf;
568 /* Reinitialize everything about a buffer except its name and contents
569 and local variables. */
571 void
572 reset_buffer (b)
573 register struct buffer *b;
575 b->filename = Qnil;
576 b->file_truename = Qnil;
577 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
578 b->modtime = 0;
579 XSETFASTINT (b->save_length, 0);
580 b->last_window_start = 1;
581 /* It is more conservative to start out "changed" than "unchanged". */
582 b->clip_changed = 0;
583 b->prevent_redisplay_optimizations_p = 1;
584 b->backed_up = Qnil;
585 b->auto_save_modified = 0;
586 b->auto_save_failure_time = -1;
587 b->auto_save_file_name = Qnil;
588 b->read_only = Qnil;
589 b->overlays_before = Qnil;
590 b->overlays_after = Qnil;
591 XSETFASTINT (b->overlay_center, 1);
592 b->mark_active = Qnil;
593 b->point_before_scroll = Qnil;
594 b->file_format = Qnil;
595 b->last_selected_window = Qnil;
596 XSETINT (b->display_count, 0);
597 b->display_time = Qnil;
598 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
599 b->cursor_type = buffer_defaults.cursor_type;
600 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
603 /* Reset buffer B's local variables info.
604 Don't use this on a buffer that has already been in use;
605 it does not treat permanent locals consistently.
606 Instead, use Fkill_all_local_variables.
608 If PERMANENT_TOO is 1, then we reset permanent built-in
609 buffer-local variables. If PERMANENT_TOO is 0,
610 we preserve those. */
612 static void
613 reset_buffer_local_variables (b, permanent_too)
614 register struct buffer *b;
615 int permanent_too;
617 register int offset;
618 int i;
620 /* Reset the major mode to Fundamental, together with all the
621 things that depend on the major mode.
622 default-major-mode is handled at a higher level.
623 We ignore it here. */
624 b->major_mode = Qfundamental_mode;
625 b->keymap = Qnil;
626 b->abbrev_table = Vfundamental_mode_abbrev_table;
627 b->mode_name = QSFundamental;
628 b->minor_modes = Qnil;
630 /* If the standard case table has been altered and invalidated,
631 fix up its insides first. */
632 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
633 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
634 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
635 Fset_standard_case_table (Vascii_downcase_table);
637 b->downcase_table = Vascii_downcase_table;
638 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
639 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
640 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
641 b->invisibility_spec = Qt;
642 #ifndef DOS_NT
643 b->buffer_file_type = Qnil;
644 #endif
646 #if 0
647 b->sort_table = XSTRING (Vascii_sort_table);
648 b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
649 #endif /* 0 */
651 /* Reset all (or most) per-buffer variables to their defaults. */
652 b->local_var_alist = Qnil;
653 for (i = 0; i < last_per_buffer_idx; ++i)
654 if (permanent_too || buffer_permanent_local_flags[i] == 0)
655 SET_PER_BUFFER_VALUE_P (b, i, 0);
657 /* For each slot that has a default value,
658 copy that into the slot. */
660 for (offset = PER_BUFFER_VAR_OFFSET (name);
661 offset < sizeof *b;
662 offset += sizeof (Lisp_Object))
664 int idx = PER_BUFFER_IDX (offset);
665 if ((idx > 0
666 && (permanent_too
667 || buffer_permanent_local_flags[idx] == 0))
668 /* Is -2 used anywhere? */
669 || idx == -2)
670 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
674 /* We split this away from generate-new-buffer, because rename-buffer
675 and set-visited-file-name ought to be able to use this to really
676 rename the buffer properly. */
678 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
679 1, 2, 0,
680 "Return a string that is the name of no existing buffer based on NAME.\n\
681 If there is no live buffer named NAME, then return NAME.\n\
682 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
683 until an unused name is found, and then return that name.\n\
684 Optional second argument IGNORE specifies a name that is okay to use\n\
685 \(if it is in the sequence to be tried)\n\
686 even if a buffer with that name exists.")
687 (name, ignore)
688 register Lisp_Object name, ignore;
690 register Lisp_Object gentemp, tem;
691 int count;
692 char number[10];
694 CHECK_STRING (name, 0);
696 tem = Fget_buffer (name);
697 if (NILP (tem))
698 return name;
700 count = 1;
701 while (1)
703 sprintf (number, "<%d>", ++count);
704 gentemp = concat2 (name, build_string (number));
705 tem = Fstring_equal (gentemp, ignore);
706 if (!NILP (tem))
707 return gentemp;
708 tem = Fget_buffer (gentemp);
709 if (NILP (tem))
710 return gentemp;
715 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
716 "Return the name of BUFFER, as a string.\n\
717 With no argument or nil as argument, return the name of the current buffer.")
718 (buffer)
719 register Lisp_Object buffer;
721 if (NILP (buffer))
722 return current_buffer->name;
723 CHECK_BUFFER (buffer, 0);
724 return XBUFFER (buffer)->name;
727 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
728 "Return name of file BUFFER is visiting, or nil if none.\n\
729 No argument or nil as argument means use the current buffer.")
730 (buffer)
731 register Lisp_Object buffer;
733 if (NILP (buffer))
734 return current_buffer->filename;
735 CHECK_BUFFER (buffer, 0);
736 return XBUFFER (buffer)->filename;
739 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
740 0, 1, 0,
741 "Return the base buffer of indirect buffer BUFFER.\n\
742 If BUFFER is not indirect, return nil.")
743 (buffer)
744 register Lisp_Object buffer;
746 struct buffer *base;
747 Lisp_Object base_buffer;
749 if (NILP (buffer))
750 base = current_buffer->base_buffer;
751 else
753 CHECK_BUFFER (buffer, 0);
754 base = XBUFFER (buffer)->base_buffer;
757 if (! base)
758 return Qnil;
759 XSETBUFFER (base_buffer, base);
760 return base_buffer;
763 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
764 Sbuffer_local_variables, 0, 1, 0,
765 "Return an alist of variables that are buffer-local in BUFFER.\n\
766 Most elements look like (SYMBOL . VALUE), describing one variable.\n\
767 For a symbol that is locally unbound, just the symbol appears in the value.\n\
768 Note that storing new VALUEs in these elements doesn't change the variables.\n\
769 No argument or nil as argument means use current buffer as BUFFER.")
770 (buffer)
771 register Lisp_Object buffer;
773 register struct buffer *buf;
774 register Lisp_Object result;
776 if (NILP (buffer))
777 buf = current_buffer;
778 else
780 CHECK_BUFFER (buffer, 0);
781 buf = XBUFFER (buffer);
784 result = Qnil;
787 register Lisp_Object tail;
788 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
790 Lisp_Object val, elt;
792 elt = XCAR (tail);
794 /* Reference each variable in the alist in buf.
795 If inquiring about the current buffer, this gets the current values,
796 so store them into the alist so the alist is up to date.
797 If inquiring about some other buffer, this swaps out any values
798 for that buffer, making the alist up to date automatically. */
799 val = find_symbol_value (XCAR (elt));
800 /* Use the current buffer value only if buf is the current buffer. */
801 if (buf != current_buffer)
802 val = XCDR (elt);
804 /* If symbol is unbound, put just the symbol in the list. */
805 if (EQ (val, Qunbound))
806 result = Fcons (XCAR (elt), result);
807 /* Otherwise, put (symbol . value) in the list. */
808 else
809 result = Fcons (Fcons (XCAR (elt), val), result);
813 /* Add on all the variables stored in special slots. */
815 int offset, idx;
817 for (offset = PER_BUFFER_VAR_OFFSET (name);
818 offset < sizeof (struct buffer);
819 /* sizeof EMACS_INT == sizeof Lisp_Object */
820 offset += (sizeof (EMACS_INT)))
822 idx = PER_BUFFER_IDX (offset);
823 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
824 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
825 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
826 PER_BUFFER_VALUE (buf, offset)),
827 result);
831 return result;
835 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
836 0, 1, 0,
837 "Return t if BUFFER was modified since its file was last read or saved.\n\
838 No argument or nil as argument means use current buffer as BUFFER.")
839 (buffer)
840 register Lisp_Object buffer;
842 register struct buffer *buf;
843 if (NILP (buffer))
844 buf = current_buffer;
845 else
847 CHECK_BUFFER (buffer, 0);
848 buf = XBUFFER (buffer);
851 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
854 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
855 1, 1, 0,
856 "Mark current buffer as modified or unmodified according to FLAG.\n\
857 A non-nil FLAG means mark the buffer modified.")
858 (flag)
859 register Lisp_Object flag;
861 register int already;
862 register Lisp_Object fn;
863 Lisp_Object buffer, window;
865 #ifdef CLASH_DETECTION
866 /* If buffer becoming modified, lock the file.
867 If buffer becoming unmodified, unlock the file. */
869 fn = current_buffer->file_truename;
870 /* Test buffer-file-name so that binding it to nil is effective. */
871 if (!NILP (fn) && ! NILP (current_buffer->filename))
873 already = SAVE_MODIFF < MODIFF;
874 if (!already && !NILP (flag))
875 lock_file (fn);
876 else if (already && NILP (flag))
877 unlock_file (fn);
879 #endif /* CLASH_DETECTION */
881 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
883 /* Set update_mode_lines only if buffer is displayed in some window.
884 Packages like jit-lock or lazy-lock preserve a buffer's modified
885 state by recording/restoring the state around blocks of code.
886 Setting update_mode_lines makes redisplay consider all windows
887 (on all frames). Stealth fontification of buffers not displayed
888 would incur additional redisplay costs if we'd set
889 update_modes_lines unconditionally.
891 Ideally, I think there should be another mechanism for fontifying
892 buffers without "modifying" buffers, or redisplay should be
893 smarter about updating the `*' in mode lines. --gerd */
894 XSETBUFFER (buffer, current_buffer);
895 window = Fget_buffer_window (buffer, Qt);
896 if (WINDOWP (window))
897 update_mode_lines++;
899 return flag;
902 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
903 Srestore_buffer_modified_p, 1, 1, 0,
904 "Like `set-buffer-modified-p', with a differences concerning redisplay.\n\
905 It is not ensured that mode lines will be updated to show the modified\n\
906 state of the current buffer. Use with care.")
907 (flag)
908 Lisp_Object flag;
910 #ifdef CLASH_DETECTION
911 Lisp_Object fn;
913 /* If buffer becoming modified, lock the file.
914 If buffer becoming unmodified, unlock the file. */
916 fn = current_buffer->file_truename;
917 /* Test buffer-file-name so that binding it to nil is effective. */
918 if (!NILP (fn) && ! NILP (current_buffer->filename))
920 int already = SAVE_MODIFF < MODIFF;
921 if (!already && !NILP (flag))
922 lock_file (fn);
923 else if (already && NILP (flag))
924 unlock_file (fn);
926 #endif /* CLASH_DETECTION */
928 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
929 return flag;
932 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
933 0, 1, 0,
934 "Return BUFFER's tick counter, incremented for each change in text.\n\
935 Each buffer has a tick counter which is incremented each time the text in\n\
936 that buffer is changed. It wraps around occasionally.\n\
937 No argument or nil as argument means use current buffer as BUFFER.")
938 (buffer)
939 register Lisp_Object buffer;
941 register struct buffer *buf;
942 if (NILP (buffer))
943 buf = current_buffer;
944 else
946 CHECK_BUFFER (buffer, 0);
947 buf = XBUFFER (buffer);
950 return make_number (BUF_MODIFF (buf));
953 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
954 "sRename buffer (to new name): \nP",
955 "Change current buffer's name to NEWNAME (a string).\n\
956 If second arg UNIQUE is nil or omitted, it is an error if a\n\
957 buffer named NEWNAME already exists.\n\
958 If UNIQUE is non-nil, come up with a new name using\n\
959 `generate-new-buffer-name'.\n\
960 Interactively, you can set UNIQUE with a prefix argument.\n\
961 We return the name we actually gave the buffer.\n\
962 This does not change the name of the visited file (if any).")
963 (newname, unique)
964 register Lisp_Object newname, unique;
966 register Lisp_Object tem, buf;
968 CHECK_STRING (newname, 0);
970 if (XSTRING (newname)->size == 0)
971 error ("Empty string is invalid as a buffer name");
973 tem = Fget_buffer (newname);
974 if (!NILP (tem))
976 /* Don't short-circuit if UNIQUE is t. That is a useful way to
977 rename the buffer automatically so you can create another
978 with the original name. It makes UNIQUE equivalent to
979 (rename-buffer (generate-new-buffer-name NEWNAME)). */
980 if (NILP (unique) && XBUFFER (tem) == current_buffer)
981 return current_buffer->name;
982 if (!NILP (unique))
983 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
984 else
985 error ("Buffer name `%s' is in use", XSTRING (newname)->data);
988 current_buffer->name = newname;
990 /* Catch redisplay's attention. Unless we do this, the mode lines for
991 any windows displaying current_buffer will stay unchanged. */
992 update_mode_lines++;
994 XSETBUFFER (buf, current_buffer);
995 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
996 if (NILP (current_buffer->filename)
997 && !NILP (current_buffer->auto_save_file_name))
998 call0 (intern ("rename-auto-save-file"));
999 /* Refetch since that last call may have done GC. */
1000 return current_buffer->name;
1003 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1004 "Return most recently selected buffer other than BUFFER.\n\
1005 Buffers not visible in windows are preferred to visible buffers,\n\
1006 unless optional second argument VISIBLE-OK is non-nil.\n\
1007 If the optional third argument FRAME is non-nil, use that frame's\n\
1008 buffer list instead of the selected frame's buffer list.\n\
1009 If no other buffer exists, the buffer `*scratch*' is returned.\n\
1010 If BUFFER is omitted or nil, some interesting buffer is returned.")
1011 (buffer, visible_ok, frame)
1012 register Lisp_Object buffer, visible_ok, frame;
1014 Lisp_Object Fset_buffer_major_mode ();
1015 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1016 notsogood = Qnil;
1018 if (NILP (frame))
1019 frame = selected_frame;
1021 tail = Vbuffer_alist;
1022 pred = frame_buffer_predicate (frame);
1024 /* Consider buffers that have been seen in the selected frame
1025 before other buffers. */
1027 tem = frame_buffer_list (frame);
1028 add_ons = Qnil;
1029 while (CONSP (tem))
1031 if (BUFFERP (XCAR (tem)))
1032 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1033 tem = XCDR (tem);
1035 tail = nconc2 (Fnreverse (add_ons), tail);
1037 for (; !NILP (tail); tail = Fcdr (tail))
1039 buf = Fcdr (Fcar (tail));
1040 if (EQ (buf, buffer))
1041 continue;
1042 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
1043 continue;
1044 /* If the selected frame has a buffer_predicate,
1045 disregard buffers that don't fit the predicate. */
1046 if (!NILP (pred))
1048 tem = call1 (pred, buf);
1049 if (NILP (tem))
1050 continue;
1053 if (NILP (visible_ok))
1054 tem = Fget_buffer_window (buf, Qvisible);
1055 else
1056 tem = Qnil;
1057 if (NILP (tem))
1058 return buf;
1059 if (NILP (notsogood))
1060 notsogood = buf;
1062 if (!NILP (notsogood))
1063 return notsogood;
1064 buf = Fget_buffer (build_string ("*scratch*"));
1065 if (NILP (buf))
1067 buf = Fget_buffer_create (build_string ("*scratch*"));
1068 Fset_buffer_major_mode (buf);
1070 return buf;
1073 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
1074 0, 1, "",
1075 "Make BUFFER stop keeping undo information.\n\
1076 No argument or nil as argument means do this for the current buffer.")
1077 (buffer)
1078 register Lisp_Object buffer;
1080 Lisp_Object real_buffer;
1082 if (NILP (buffer))
1083 XSETBUFFER (real_buffer, current_buffer);
1084 else
1086 real_buffer = Fget_buffer (buffer);
1087 if (NILP (real_buffer))
1088 nsberror (buffer);
1091 XBUFFER (real_buffer)->undo_list = Qt;
1093 return Qnil;
1096 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1097 0, 1, "",
1098 "Start keeping undo information for buffer BUFFER.\n\
1099 No argument or nil as argument means do this for the current buffer.")
1100 (buffer)
1101 register Lisp_Object buffer;
1103 Lisp_Object real_buffer;
1105 if (NILP (buffer))
1106 XSETBUFFER (real_buffer, current_buffer);
1107 else
1109 real_buffer = Fget_buffer (buffer);
1110 if (NILP (real_buffer))
1111 nsberror (buffer);
1114 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1115 XBUFFER (real_buffer)->undo_list = Qnil;
1117 return Qnil;
1121 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1122 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1123 The buffer being killed will be current while the hook is running.\n\
1124 See `kill-buffer'."
1126 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1127 "Kill the buffer BUFFER.\n\
1128 The argument may be a buffer or may be the name of a buffer.\n\
1129 An argument of nil means kill the current buffer.\n\n\
1130 Value is t if the buffer is actually killed, nil if user says no.\n\n\
1131 The value of `kill-buffer-hook' (which may be local to that buffer),\n\
1132 if not void, is a list of functions to be called, with no arguments,\n\
1133 before the buffer is actually killed. The buffer to be killed is current\n\
1134 when the hook functions are called.\n\n\
1135 Any processes that have this buffer as the `process-buffer' are killed\n\
1136 with SIGHUP.")
1137 (buffer)
1138 Lisp_Object buffer;
1140 Lisp_Object buf;
1141 register struct buffer *b;
1142 register Lisp_Object tem;
1143 register struct Lisp_Marker *m;
1144 struct gcpro gcpro1;
1146 if (NILP (buffer))
1147 buf = Fcurrent_buffer ();
1148 else
1149 buf = Fget_buffer (buffer);
1150 if (NILP (buf))
1151 nsberror (buffer);
1153 b = XBUFFER (buf);
1155 /* Avoid trouble for buffer already dead. */
1156 if (NILP (b->name))
1157 return Qnil;
1159 /* Query if the buffer is still modified. */
1160 if (INTERACTIVE && !NILP (b->filename)
1161 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1163 GCPRO1 (buf);
1164 tem = do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
1165 XSTRING (b->name)->data));
1166 UNGCPRO;
1167 if (NILP (tem))
1168 return Qnil;
1171 /* Run hooks with the buffer to be killed the current buffer. */
1173 int count = specpdl_ptr - specpdl;
1174 Lisp_Object list;
1176 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1177 set_buffer_internal (b);
1179 /* First run the query functions; if any query is answered no,
1180 don't kill the buffer. */
1181 for (list = Vkill_buffer_query_functions; !NILP (list); list = Fcdr (list))
1183 tem = call0 (Fcar (list));
1184 if (NILP (tem))
1185 return unbind_to (count, Qnil);
1188 /* Then run the hooks. */
1189 if (!NILP (Vrun_hooks))
1190 call1 (Vrun_hooks, Qkill_buffer_hook);
1191 unbind_to (count, Qnil);
1194 /* We have no more questions to ask. Verify that it is valid
1195 to kill the buffer. This must be done after the questions
1196 since anything can happen within do_yes_or_no_p. */
1198 /* Don't kill the minibuffer now current. */
1199 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1200 return Qnil;
1202 if (NILP (b->name))
1203 return Qnil;
1205 /* When we kill a base buffer, kill all its indirect buffers.
1206 We do it at this stage so nothing terrible happens if they
1207 ask questions or their hooks get errors. */
1208 if (! b->base_buffer)
1210 struct buffer *other;
1212 GCPRO1 (buf);
1214 for (other = all_buffers; other; other = other->next)
1215 /* all_buffers contains dead buffers too;
1216 don't re-kill them. */
1217 if (other->base_buffer == b && !NILP (other->name))
1219 Lisp_Object buf;
1220 XSETBUFFER (buf, other);
1221 Fkill_buffer (buf);
1224 UNGCPRO;
1227 /* Make this buffer not be current.
1228 In the process, notice if this is the sole visible buffer
1229 and give up if so. */
1230 if (b == current_buffer)
1232 tem = Fother_buffer (buf, Qnil, Qnil);
1233 Fset_buffer (tem);
1234 if (b == current_buffer)
1235 return Qnil;
1238 /* Notice if the buffer to kill is the sole visible buffer
1239 when we're currently in the mini-buffer, and give up if so. */
1240 XSETBUFFER (tem, current_buffer);
1241 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1243 tem = Fother_buffer (buf, Qnil, Qnil);
1244 Fset_buffer (tem);
1245 if (EQ (buf, tem))
1246 return Qnil;
1249 /* Now there is no question: we can kill the buffer. */
1251 #ifdef CLASH_DETECTION
1252 /* Unlock this buffer's file, if it is locked. */
1253 unlock_buffer (b);
1254 #endif /* CLASH_DETECTION */
1256 kill_buffer_processes (buf);
1258 tem = Vinhibit_quit;
1259 Vinhibit_quit = Qt;
1260 replace_buffer_in_all_windows (buf);
1261 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1262 frames_discard_buffer (buf);
1263 Vinhibit_quit = tem;
1265 /* Delete any auto-save file, if we saved it in this session. */
1266 if (STRINGP (b->auto_save_file_name)
1267 && b->auto_save_modified != 0
1268 && BUF_SAVE_MODIFF (b) < b->auto_save_modified)
1270 Lisp_Object tem;
1271 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1272 if (! NILP (tem))
1273 internal_delete_file (b->auto_save_file_name);
1276 if (b->base_buffer)
1278 /* Unchain all markers that belong to this indirect buffer.
1279 Don't unchain the markers that belong to the base buffer
1280 or its other indirect buffers. */
1281 for (tem = BUF_MARKERS (b); !NILP (tem); )
1283 Lisp_Object next;
1284 m = XMARKER (tem);
1285 next = m->chain;
1286 if (m->buffer == b)
1287 unchain_marker (tem);
1288 tem = next;
1291 else
1293 /* Unchain all markers of this buffer and its indirect buffers.
1294 and leave them pointing nowhere. */
1295 for (tem = BUF_MARKERS (b); !NILP (tem); )
1297 m = XMARKER (tem);
1298 m->buffer = 0;
1299 tem = m->chain;
1300 m->chain = Qnil;
1302 BUF_MARKERS (b) = Qnil;
1303 BUF_INTERVALS (b) = NULL_INTERVAL;
1305 /* Perhaps we should explicitly free the interval tree here... */
1308 /* Reset the local variables, so that this buffer's local values
1309 won't be protected from GC. They would be protected
1310 if they happened to remain encached in their symbols.
1311 This gets rid of them for certain. */
1312 swap_out_buffer_local_variables (b);
1313 reset_buffer_local_variables (b, 1);
1315 b->name = Qnil;
1317 BLOCK_INPUT;
1318 if (! b->base_buffer)
1319 free_buffer_text (b);
1321 if (b->newline_cache)
1323 free_region_cache (b->newline_cache);
1324 b->newline_cache = 0;
1326 if (b->width_run_cache)
1328 free_region_cache (b->width_run_cache);
1329 b->width_run_cache = 0;
1331 b->width_table = Qnil;
1332 UNBLOCK_INPUT;
1333 b->undo_list = Qnil;
1335 return Qt;
1338 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1339 we do this each time BUF is selected visibly, the more recently
1340 selected buffers are always closer to the front of the list. This
1341 means that other_buffer is more likely to choose a relevant buffer. */
1343 void
1344 record_buffer (buf)
1345 Lisp_Object buf;
1347 register Lisp_Object link, prev;
1348 Lisp_Object frame;
1349 frame = selected_frame;
1351 prev = Qnil;
1352 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1354 if (EQ (XCDR (XCAR (link)), buf))
1355 break;
1356 prev = link;
1359 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1360 we cannot use Fdelq itself here because it allows quitting. */
1362 if (NILP (prev))
1363 Vbuffer_alist = XCDR (Vbuffer_alist);
1364 else
1365 XCDR (prev) = XCDR (XCDR (prev));
1367 XCDR (link) = Vbuffer_alist;
1368 Vbuffer_alist = link;
1370 /* Now move this buffer to the front of frame_buffer_list also. */
1372 prev = Qnil;
1373 for (link = frame_buffer_list (frame); CONSP (link);
1374 link = XCDR (link))
1376 if (EQ (XCAR (link), buf))
1377 break;
1378 prev = link;
1381 /* Effectively do delq. */
1383 if (CONSP (link))
1385 if (NILP (prev))
1386 set_frame_buffer_list (frame,
1387 XCDR (frame_buffer_list (frame)));
1388 else
1389 XCDR (prev) = XCDR (XCDR (prev));
1391 XCDR (link) = frame_buffer_list (frame);
1392 set_frame_buffer_list (frame, link);
1394 else
1395 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1398 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1399 "Set an appropriate major mode for BUFFER, according to `default-major-mode'.\n\
1400 Use this function before selecting the buffer, since it may need to inspect\n\
1401 the current buffer's major mode.")
1402 (buffer)
1403 Lisp_Object buffer;
1405 int count;
1406 Lisp_Object function;
1408 function = buffer_defaults.major_mode;
1409 if (NILP (function) && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1410 function = current_buffer->major_mode;
1412 if (NILP (function) || EQ (function, Qfundamental_mode))
1413 return Qnil;
1415 count = specpdl_ptr - specpdl;
1417 /* To select a nonfundamental mode,
1418 select the buffer temporarily and then call the mode function. */
1420 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1422 Fset_buffer (buffer);
1423 call0 (function);
1425 return unbind_to (count, Qnil);
1428 /* If switching buffers in WINDOW would be an error, return
1429 a C string saying what the error would be. */
1431 char *
1432 no_switch_window (window)
1433 Lisp_Object window;
1435 Lisp_Object tem;
1436 if (EQ (minibuf_window, window))
1437 return "Cannot switch buffers in minibuffer window";
1438 tem = Fwindow_dedicated_p (window);
1439 if (!NILP (tem))
1440 return "Cannot switch buffers in a dedicated window";
1441 return NULL;
1444 /* Switch to buffer BUFFER in the selected window.
1445 If NORECORD is non-nil, don't call record_buffer. */
1447 Lisp_Object
1448 switch_to_buffer_1 (buffer, norecord)
1449 Lisp_Object buffer, norecord;
1451 register Lisp_Object buf;
1453 if (NILP (buffer))
1454 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1455 else
1457 buf = Fget_buffer (buffer);
1458 if (NILP (buf))
1460 buf = Fget_buffer_create (buffer);
1461 Fset_buffer_major_mode (buf);
1464 Fset_buffer (buf);
1465 if (NILP (norecord))
1466 record_buffer (buf);
1468 Fset_window_buffer (EQ (selected_window, minibuf_window)
1469 ? Fnext_window (minibuf_window, Qnil, Qnil)
1470 : selected_window,
1471 buf);
1473 return buf;
1476 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1477 "Select buffer BUFFER in the current window.\n\
1478 BUFFER may be a buffer or a buffer name.\n\
1479 Optional second arg NORECORD non-nil means\n\
1480 do not put this buffer at the front of the list of recently selected ones.\n\
1482 WARNING: This is NOT the way to work on another buffer temporarily\n\
1483 within a Lisp program! Use `set-buffer' instead. That avoids messing with\n\
1484 the window-buffer correspondences.")
1485 (buffer, norecord)
1486 Lisp_Object buffer, norecord;
1488 char *err;
1490 err = no_switch_window (selected_window);
1491 if (err) error (err);
1493 return switch_to_buffer_1 (buffer, norecord);
1496 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1497 "Select buffer BUFFER in some window, preferably a different one.\n\
1498 If BUFFER is nil, then some other buffer is chosen.\n\
1499 If `pop-up-windows' is non-nil, windows can be split to do this.\n\
1500 If optional second arg OTHER-WINDOW is non-nil, insist on finding another\n\
1501 window even if BUFFER is already visible in the selected window.\n\
1502 This uses the function `display-buffer' as a subroutine; see the documentation\n\
1503 of `display-buffer' for additional customization information.\n\
1505 Optional third arg NORECORD non-nil means\n\
1506 do not put this buffer at the front of the list of recently selected ones.")
1507 (buffer, other_window, norecord)
1508 Lisp_Object buffer, other_window, norecord;
1510 register Lisp_Object buf;
1511 if (NILP (buffer))
1512 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1513 else
1515 buf = Fget_buffer (buffer);
1516 if (NILP (buf))
1518 buf = Fget_buffer_create (buffer);
1519 Fset_buffer_major_mode (buf);
1522 Fset_buffer (buf);
1523 if (NILP (norecord))
1524 record_buffer (buf);
1525 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil));
1526 return buf;
1529 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1530 "Return the current buffer as a Lisp object.")
1533 register Lisp_Object buf;
1534 XSETBUFFER (buf, current_buffer);
1535 return buf;
1538 /* Set the current buffer to B.
1540 We previously set windows_or_buffers_changed here to invalidate
1541 global unchanged information in beg_unchanged and end_unchanged.
1542 This is no longer necessary because we now compute unchanged
1543 information on a buffer-basis. Every action affecting other
1544 windows than the selected one requires a select_window at some
1545 time, and that increments windows_or_buffers_changed. */
1547 void
1548 set_buffer_internal (b)
1549 register struct buffer *b;
1551 if (current_buffer != b)
1552 set_buffer_internal_1 (b);
1555 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1556 This is used by redisplay. */
1558 void
1559 set_buffer_internal_1 (b)
1560 register struct buffer *b;
1562 register struct buffer *old_buf;
1563 register Lisp_Object tail, valcontents;
1564 Lisp_Object tem;
1566 #ifdef USE_MMAP_FOR_BUFFERS
1567 if (b->text->beg == NULL)
1568 enlarge_buffer_text (b, 0);
1569 #endif /* USE_MMAP_FOR_BUFFERS */
1571 if (current_buffer == b)
1572 return;
1574 old_buf = current_buffer;
1575 current_buffer = b;
1576 last_known_column_point = -1; /* invalidate indentation cache */
1578 if (old_buf)
1580 /* Put the undo list back in the base buffer, so that it appears
1581 that an indirect buffer shares the undo list of its base. */
1582 if (old_buf->base_buffer)
1583 old_buf->base_buffer->undo_list = old_buf->undo_list;
1585 /* If the old current buffer has markers to record PT, BEGV and ZV
1586 when it is not current, update them now. */
1587 if (! NILP (old_buf->pt_marker))
1589 Lisp_Object obuf;
1590 XSETBUFFER (obuf, old_buf);
1591 set_marker_both (old_buf->pt_marker, obuf,
1592 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1594 if (! NILP (old_buf->begv_marker))
1596 Lisp_Object obuf;
1597 XSETBUFFER (obuf, old_buf);
1598 set_marker_both (old_buf->begv_marker, obuf,
1599 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1601 if (! NILP (old_buf->zv_marker))
1603 Lisp_Object obuf;
1604 XSETBUFFER (obuf, old_buf);
1605 set_marker_both (old_buf->zv_marker, obuf,
1606 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1610 /* Get the undo list from the base buffer, so that it appears
1611 that an indirect buffer shares the undo list of its base. */
1612 if (b->base_buffer)
1613 b->undo_list = b->base_buffer->undo_list;
1615 /* If the new current buffer has markers to record PT, BEGV and ZV
1616 when it is not current, fetch them now. */
1617 if (! NILP (b->pt_marker))
1619 BUF_PT (b) = marker_position (b->pt_marker);
1620 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1622 if (! NILP (b->begv_marker))
1624 BUF_BEGV (b) = marker_position (b->begv_marker);
1625 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1627 if (! NILP (b->zv_marker))
1629 BUF_ZV (b) = marker_position (b->zv_marker);
1630 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1633 /* Look down buffer's list of local Lisp variables
1634 to find and update any that forward into C variables. */
1636 for (tail = b->local_var_alist; !NILP (tail); tail = XCDR (tail))
1638 valcontents = XSYMBOL (XCAR (XCAR (tail)))->value;
1639 if ((BUFFER_LOCAL_VALUEP (valcontents)
1640 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1641 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1642 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1643 /* Just reference the variable
1644 to cause it to become set for this buffer. */
1645 Fsymbol_value (XCAR (XCAR (tail)));
1648 /* Do the same with any others that were local to the previous buffer */
1650 if (old_buf)
1651 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCDR (tail))
1653 valcontents = XSYMBOL (XCAR (XCAR (tail)))->value;
1654 if ((BUFFER_LOCAL_VALUEP (valcontents)
1655 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1656 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1657 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1658 /* Just reference the variable
1659 to cause it to become set for this buffer. */
1660 Fsymbol_value (XCAR (XCAR (tail)));
1664 /* Switch to buffer B temporarily for redisplay purposes.
1665 This avoids certain things that don't need to be done within redisplay. */
1667 void
1668 set_buffer_temp (b)
1669 struct buffer *b;
1671 register struct buffer *old_buf;
1673 if (current_buffer == b)
1674 return;
1676 old_buf = current_buffer;
1677 current_buffer = b;
1679 if (old_buf)
1681 /* If the old current buffer has markers to record PT, BEGV and ZV
1682 when it is not current, update them now. */
1683 if (! NILP (old_buf->pt_marker))
1685 Lisp_Object obuf;
1686 XSETBUFFER (obuf, old_buf);
1687 set_marker_both (old_buf->pt_marker, obuf,
1688 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1690 if (! NILP (old_buf->begv_marker))
1692 Lisp_Object obuf;
1693 XSETBUFFER (obuf, old_buf);
1694 set_marker_both (old_buf->begv_marker, obuf,
1695 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1697 if (! NILP (old_buf->zv_marker))
1699 Lisp_Object obuf;
1700 XSETBUFFER (obuf, old_buf);
1701 set_marker_both (old_buf->zv_marker, obuf,
1702 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1706 /* If the new current buffer has markers to record PT, BEGV and ZV
1707 when it is not current, fetch them now. */
1708 if (! NILP (b->pt_marker))
1710 BUF_PT (b) = marker_position (b->pt_marker);
1711 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1713 if (! NILP (b->begv_marker))
1715 BUF_BEGV (b) = marker_position (b->begv_marker);
1716 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1718 if (! NILP (b->zv_marker))
1720 BUF_ZV (b) = marker_position (b->zv_marker);
1721 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1725 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1726 "Make the buffer BUFFER current for editing operations.\n\
1727 BUFFER may be a buffer or the name of an existing buffer.\n\
1728 See also `save-excursion' when you want to make a buffer current temporarily.\n\
1729 This function does not display the buffer, so its effect ends\n\
1730 when the current command terminates.\n\
1731 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.")
1732 (buffer)
1733 register Lisp_Object buffer;
1735 register Lisp_Object buf;
1736 buf = Fget_buffer (buffer);
1737 if (NILP (buf))
1738 nsberror (buffer);
1739 if (NILP (XBUFFER (buf)->name))
1740 error ("Selecting deleted buffer");
1741 set_buffer_internal (XBUFFER (buf));
1742 return buf;
1745 /* Set the current buffer to BUFFER provided it is alive. */
1747 Lisp_Object
1748 set_buffer_if_live (buffer)
1749 Lisp_Object buffer;
1751 if (! NILP (XBUFFER (buffer)->name))
1752 Fset_buffer (buffer);
1753 return Qnil;
1756 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1757 Sbarf_if_buffer_read_only, 0, 0, 0,
1758 "Signal a `buffer-read-only' error if the current buffer is read-only.")
1761 if (!NILP (current_buffer->read_only)
1762 && NILP (Vinhibit_read_only))
1763 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1764 return Qnil;
1767 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1768 "Put BUFFER at the end of the list of all buffers.\n\
1769 There it is the least likely candidate for `other-buffer' to return;\n\
1770 thus, the least likely buffer for \\[switch-to-buffer] to select by default.\n\
1771 If BUFFER is nil or omitted, bury the current buffer.\n\
1772 Also, if BUFFER is nil or omitted, remove the current buffer from the\n\
1773 selected window if it is displayed there.")
1774 (buffer)
1775 register Lisp_Object buffer;
1777 /* Figure out what buffer we're going to bury. */
1778 if (NILP (buffer))
1780 XSETBUFFER (buffer, current_buffer);
1782 /* If we're burying the current buffer, unshow it. */
1783 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1785 else
1787 Lisp_Object buf1;
1789 buf1 = Fget_buffer (buffer);
1790 if (NILP (buf1))
1791 nsberror (buffer);
1792 buffer = buf1;
1795 /* Move buffer to the end of the buffer list. Do nothing if the
1796 buffer is killed. */
1797 if (!NILP (XBUFFER (buffer)->name))
1799 Lisp_Object aelt, link;
1801 aelt = Frassq (buffer, Vbuffer_alist);
1802 link = Fmemq (aelt, Vbuffer_alist);
1803 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1804 XCDR (link) = Qnil;
1805 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1807 frames_bury_buffer (buffer);
1810 return Qnil;
1813 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1814 "Delete the entire contents of the current buffer.\n\
1815 Any narrowing restriction in effect (see `narrow-to-region') is removed,\n\
1816 so the buffer is truly empty after this.")
1819 Fwiden ();
1821 del_range (BEG, Z);
1823 current_buffer->last_window_start = 1;
1824 /* Prevent warnings, or suspension of auto saving, that would happen
1825 if future size is less than past size. Use of erase-buffer
1826 implies that the future text is not really related to the past text. */
1827 XSETFASTINT (current_buffer->save_length, 0);
1828 return Qnil;
1831 void
1832 validate_region (b, e)
1833 register Lisp_Object *b, *e;
1835 CHECK_NUMBER_COERCE_MARKER (*b, 0);
1836 CHECK_NUMBER_COERCE_MARKER (*e, 1);
1838 if (XINT (*b) > XINT (*e))
1840 Lisp_Object tem;
1841 tem = *b; *b = *e; *e = tem;
1844 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1845 && XINT (*e) <= ZV))
1846 args_out_of_range (*b, *e);
1849 /* Advance BYTE_POS up to a character boundary
1850 and return the adjusted position. */
1852 static int
1853 advance_to_char_boundary (byte_pos)
1854 int byte_pos;
1856 int c;
1858 if (byte_pos == BEG)
1859 /* Beginning of buffer is always a character boundary. */
1860 return 1;
1862 c = FETCH_BYTE (byte_pos);
1863 if (! CHAR_HEAD_P (c))
1865 /* We should advance BYTE_POS only when C is a constituent of a
1866 multibyte sequence. */
1867 int orig_byte_pos = byte_pos;
1871 byte_pos--;
1872 c = FETCH_BYTE (byte_pos);
1874 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
1875 INC_POS (byte_pos);
1876 if (byte_pos < orig_byte_pos)
1877 byte_pos = orig_byte_pos;
1878 /* If C is a constituent of a multibyte sequence, BYTE_POS was
1879 surely advance to the correct character boundary. If C is
1880 not, BYTE_POS was unchanged. */
1883 return byte_pos;
1886 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
1887 1, 1, 0,
1888 "Set the multibyte flag of the current buffer to FLAG.\n\
1889 If FLAG is t, this makes the buffer a multibyte buffer.\n\
1890 If FLAG is nil, this makes the buffer a single-byte buffer.\n\
1891 The buffer contents remain unchanged as a sequence of bytes\n\
1892 but the contents viewed as characters do change.")
1893 (flag)
1894 Lisp_Object flag;
1896 Lisp_Object tail, markers;
1897 struct buffer *other;
1898 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
1899 int begv = BEGV, zv = ZV;
1900 int narrowed = (BEG != begv || Z != zv);
1901 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
1903 if (current_buffer->base_buffer)
1904 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
1906 /* Do nothing if nothing actually changes. */
1907 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
1908 return flag;
1910 /* It would be better to update the list,
1911 but this is good enough for now. */
1912 if (undo_enabled_p)
1913 current_buffer->undo_list = Qt;
1915 /* If the cached position is for this buffer, clear it out. */
1916 clear_charpos_cache (current_buffer);
1918 if (narrowed)
1919 Fwiden ();
1921 if (NILP (flag))
1923 int pos, stop;
1924 unsigned char *p;
1926 /* Do this first, so it can use CHAR_TO_BYTE
1927 to calculate the old correspondences. */
1928 set_intervals_multibyte (0);
1930 current_buffer->enable_multibyte_characters = Qnil;
1932 Z = Z_BYTE;
1933 BEGV = BEGV_BYTE;
1934 ZV = ZV_BYTE;
1935 GPT = GPT_BYTE;
1936 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
1938 tail = BUF_MARKERS (current_buffer);
1939 while (! NILP (tail))
1941 XMARKER (tail)->charpos = XMARKER (tail)->bytepos;
1942 tail = XMARKER (tail)->chain;
1945 /* Convert multibyte form of 8-bit characters to unibyte. */
1946 pos = BEG;
1947 stop = GPT;
1948 p = BEG_ADDR;
1949 while (1)
1951 int c, bytes;
1953 if (pos == stop)
1955 if (pos == Z)
1956 break;
1957 p = GAP_END_ADDR;
1958 stop = Z;
1960 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
1961 p += bytes, pos += bytes;
1962 else
1964 c = STRING_CHAR (p, stop - pos);
1965 /* Delete all bytes for this 8-bit character but the
1966 last one, and change the last one to the charcter
1967 code. */
1968 bytes--;
1969 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
1970 p = GAP_END_ADDR;
1971 *p++ = c;
1972 pos++;
1973 if (begv > pos)
1974 begv -= bytes;
1975 if (zv > pos)
1976 zv -= bytes;
1977 stop = Z;
1980 if (narrowed)
1981 Fnarrow_to_region (make_number (begv), make_number (zv));
1983 else
1985 int pt = PT;
1986 int pos, stop;
1987 unsigned char *p;
1989 /* Be sure not to have a multibyte sequence striding over the GAP.
1990 Ex: We change this: "...abc\201 _GAP_ \241def..."
1991 to: "...abc _GAP_ \201\241def..." */
1993 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
1994 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
1996 unsigned char *p = GPT_ADDR - 1;
1998 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
1999 if (BASE_LEADING_CODE_P (*p))
2001 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2003 move_gap_both (new_gpt, new_gpt);
2007 /* Make the buffer contents valid as multibyte by converting
2008 8-bit characters to multibyte form. */
2009 pos = BEG;
2010 stop = GPT;
2011 p = BEG_ADDR;
2012 while (1)
2014 int bytes;
2016 if (pos == stop)
2018 if (pos == Z)
2019 break;
2020 p = GAP_END_ADDR;
2021 stop = Z;
2024 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2025 p += bytes, pos += bytes;
2026 else
2028 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2030 bytes = CHAR_STRING (*p, tmp);
2031 *p = tmp[0];
2032 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2033 bytes--;
2034 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2035 /* Now the gap is after the just inserted data. */
2036 pos = GPT;
2037 p = GAP_END_ADDR;
2038 if (pos <= begv)
2039 begv += bytes;
2040 if (pos <= zv)
2041 zv += bytes;
2042 if (pos <= pt)
2043 pt += bytes;
2044 stop = Z;
2048 if (pt != PT)
2049 TEMP_SET_PT (pt);
2051 if (narrowed)
2052 Fnarrow_to_region (make_number (begv), make_number (zv));
2054 /* Do this first, so that chars_in_text asks the right question.
2055 set_intervals_multibyte needs it too. */
2056 current_buffer->enable_multibyte_characters = Qt;
2058 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2059 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2061 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2063 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2064 if (BEGV_BYTE > GPT_BYTE)
2065 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2066 else
2067 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2069 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2070 if (ZV_BYTE > GPT_BYTE)
2071 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2072 else
2073 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2076 int pt_byte = advance_to_char_boundary (PT_BYTE);
2077 int pt;
2079 if (pt_byte > GPT_BYTE)
2080 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2081 else
2082 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2083 TEMP_SET_PT_BOTH (pt, pt_byte);
2086 tail = markers = BUF_MARKERS (current_buffer);
2088 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2089 getting confused by the markers that have not yet been updated.
2090 It is also a signal that it should never create a marker. */
2091 BUF_MARKERS (current_buffer) = Qnil;
2093 while (! NILP (tail))
2095 XMARKER (tail)->bytepos
2096 = advance_to_char_boundary (XMARKER (tail)->bytepos);
2097 XMARKER (tail)->charpos = BYTE_TO_CHAR (XMARKER (tail)->bytepos);
2099 tail = XMARKER (tail)->chain;
2102 /* Make sure no markers were put on the chain
2103 while the chain value was incorrect. */
2104 if (! EQ (BUF_MARKERS (current_buffer), Qnil))
2105 abort ();
2107 BUF_MARKERS (current_buffer) = markers;
2109 /* Do this last, so it can calculate the new correspondences
2110 between chars and bytes. */
2111 set_intervals_multibyte (1);
2114 if (undo_enabled_p)
2115 current_buffer->undo_list = Qnil;
2117 /* Changing the multibyteness of a buffer means that all windows
2118 showing that buffer must be updated thoroughly. */
2119 current_buffer->prevent_redisplay_optimizations_p = 1;
2120 ++windows_or_buffers_changed;
2122 /* Copy this buffer's new multibyte status
2123 into all of its indirect buffers. */
2124 for (other = all_buffers; other; other = other->next)
2125 if (other->base_buffer == current_buffer && !NILP (other->name))
2127 other->enable_multibyte_characters
2128 = current_buffer->enable_multibyte_characters;
2129 other->prevent_redisplay_optimizations_p = 1;
2132 /* Restore the modifiedness of the buffer. */
2133 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2134 Fset_buffer_modified_p (Qnil);
2136 return flag;
2139 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2140 0, 0, 0,
2141 "Switch to Fundamental mode by killing current buffer's local variables.\n\
2142 Most local variable bindings are eliminated so that the default values\n\
2143 become effective once more. Also, the syntax table is set from\n\
2144 `standard-syntax-table', the local keymap is set to nil,\n\
2145 and the abbrev table from `fundamental-mode-abbrev-table'.\n\
2146 This function also forces redisplay of the mode line.\n\
2148 Every function to select a new major mode starts by\n\
2149 calling this function.\n\n\
2150 As a special exception, local variables whose names have\n\
2151 a non-nil `permanent-local' property are not eliminated by this function.\n\
2153 The first thing this function does is run\n\
2154 the normal hook `change-major-mode-hook'.")
2157 register Lisp_Object alist, sym, tem;
2158 Lisp_Object oalist;
2160 if (!NILP (Vrun_hooks))
2161 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2162 oalist = current_buffer->local_var_alist;
2164 /* Make sure none of the bindings in oalist
2165 remain swapped in, in their symbols. */
2167 swap_out_buffer_local_variables (current_buffer);
2169 /* Actually eliminate all local bindings of this buffer. */
2171 reset_buffer_local_variables (current_buffer, 0);
2173 /* Redisplay mode lines; we are changing major mode. */
2175 update_mode_lines++;
2177 /* Any which are supposed to be permanent,
2178 make local again, with the same values they had. */
2180 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2182 sym = XCAR (XCAR (alist));
2183 tem = Fget (sym, Qpermanent_local);
2184 if (! NILP (tem))
2186 Fmake_local_variable (sym);
2187 Fset (sym, XCDR (XCAR (alist)));
2191 /* Force mode-line redisplay. Useful here because all major mode
2192 commands call this function. */
2193 update_mode_lines++;
2195 return Qnil;
2198 /* Make sure no local variables remain set up with buffer B
2199 for their current values. */
2201 static void
2202 swap_out_buffer_local_variables (b)
2203 struct buffer *b;
2205 Lisp_Object oalist, alist, sym, tem, buffer;
2207 XSETBUFFER (buffer, b);
2208 oalist = b->local_var_alist;
2210 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2212 sym = XCAR (XCAR (alist));
2214 /* Need not do anything if some other buffer's binding is now encached. */
2215 tem = XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->buffer;
2216 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2218 /* Symbol is set up for this buffer's old local value.
2219 Set it up for the current buffer with the default value. */
2221 tem = XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->cdr;
2222 /* Store the symbol's current value into the alist entry
2223 it is currently set up for. This is so that, if the
2224 local is marked permanent, and we make it local again
2225 later in Fkill_all_local_variables, we don't lose the value. */
2226 XCDR (XCAR (tem))
2227 = do_symval_forwarding (XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->realvalue);
2228 /* Switch to the symbol's default-value alist entry. */
2229 XCAR (tem) = tem;
2230 /* Mark it as current for buffer B. */
2231 XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->buffer = buffer;
2232 /* Store the current value into any forwarding in the symbol. */
2233 store_symval_forwarding (sym,
2234 XBUFFER_LOCAL_VALUE (XSYMBOL (sym)->value)->realvalue,
2235 XCDR (tem));
2240 /* Find all the overlays in the current buffer that contain position POS.
2241 Return the number found, and store them in a vector in *VEC_PTR.
2242 Store in *LEN_PTR the size allocated for the vector.
2243 Store in *NEXT_PTR the next position after POS where an overlay starts,
2244 or ZV if there are no more overlays.
2245 Store in *PREV_PTR the previous position before POS where an overlay ends,
2246 or where an overlay starts which ends at or after POS;
2247 or BEGV if there are no such overlays.
2248 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2250 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2251 when this function is called.
2253 If EXTEND is non-zero, we make the vector bigger if necessary.
2254 If EXTEND is zero, we never extend the vector,
2255 and we store only as many overlays as will fit.
2256 But we still return the total number of overlays.
2258 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2259 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2260 default (BEGV or ZV). */
2263 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2264 int pos;
2265 int extend;
2266 Lisp_Object **vec_ptr;
2267 int *len_ptr;
2268 int *next_ptr;
2269 int *prev_ptr;
2270 int change_req;
2272 Lisp_Object tail, overlay, start, end;
2273 int idx = 0;
2274 int len = *len_ptr;
2275 Lisp_Object *vec = *vec_ptr;
2276 int next = ZV;
2277 int prev = BEGV;
2278 int inhibit_storing = 0;
2280 for (tail = current_buffer->overlays_before;
2281 GC_CONSP (tail);
2282 tail = XCDR (tail))
2284 int startpos, endpos;
2286 overlay = XCAR (tail);
2288 start = OVERLAY_START (overlay);
2289 end = OVERLAY_END (overlay);
2290 endpos = OVERLAY_POSITION (end);
2291 if (endpos < pos)
2293 if (prev < endpos)
2294 prev = endpos;
2295 break;
2297 startpos = OVERLAY_POSITION (start);
2298 /* This one ends at or after POS
2299 so its start counts for PREV_PTR if it's before POS. */
2300 if (prev < startpos && startpos < pos)
2301 prev = startpos;
2302 if (endpos == pos)
2303 continue;
2304 if (startpos <= pos)
2306 if (idx == len)
2308 /* The supplied vector is full.
2309 Either make it bigger, or don't store any more in it. */
2310 if (extend)
2312 /* Make it work with an initial len == 0. */
2313 len *= 2;
2314 if (len == 0)
2315 len = 4;
2316 *len_ptr = len;
2317 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2318 *vec_ptr = vec;
2320 else
2321 inhibit_storing = 1;
2324 if (!inhibit_storing)
2325 vec[idx] = overlay;
2326 /* Keep counting overlays even if we can't return them all. */
2327 idx++;
2329 else if (startpos < next)
2330 next = startpos;
2333 for (tail = current_buffer->overlays_after;
2334 GC_CONSP (tail);
2335 tail = XCDR (tail))
2337 int startpos, endpos;
2339 overlay = XCAR (tail);
2341 start = OVERLAY_START (overlay);
2342 end = OVERLAY_END (overlay);
2343 startpos = OVERLAY_POSITION (start);
2344 if (pos < startpos)
2346 if (startpos < next)
2347 next = startpos;
2348 break;
2350 endpos = OVERLAY_POSITION (end);
2351 if (pos < endpos)
2353 if (idx == len)
2355 if (extend)
2357 *len_ptr = len *= 2;
2358 if (len == 0)
2359 len = *len_ptr = 4;
2360 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2361 *vec_ptr = vec;
2363 else
2364 inhibit_storing = 1;
2367 if (!inhibit_storing)
2368 vec[idx] = overlay;
2369 idx++;
2371 if (startpos < pos && startpos > prev)
2372 prev = startpos;
2374 else if (endpos < pos && endpos > prev)
2375 prev = endpos;
2376 else if (endpos == pos && startpos > prev
2377 && (!change_req || startpos < pos))
2378 prev = startpos;
2381 if (next_ptr)
2382 *next_ptr = next;
2383 if (prev_ptr)
2384 *prev_ptr = prev;
2385 return idx;
2388 /* Find all the overlays in the current buffer that overlap the range BEG-END
2389 or are empty at BEG.
2391 Return the number found, and store them in a vector in *VEC_PTR.
2392 Store in *LEN_PTR the size allocated for the vector.
2393 Store in *NEXT_PTR the next position after POS where an overlay starts,
2394 or ZV if there are no more overlays.
2395 Store in *PREV_PTR the previous position before POS where an overlay ends,
2396 or BEGV if there are no previous overlays.
2397 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2399 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2400 when this function is called.
2402 If EXTEND is non-zero, we make the vector bigger if necessary.
2403 If EXTEND is zero, we never extend the vector,
2404 and we store only as many overlays as will fit.
2405 But we still return the total number of overlays. */
2408 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2409 int beg, end;
2410 int extend;
2411 Lisp_Object **vec_ptr;
2412 int *len_ptr;
2413 int *next_ptr;
2414 int *prev_ptr;
2416 Lisp_Object tail, overlay, ostart, oend;
2417 int idx = 0;
2418 int len = *len_ptr;
2419 Lisp_Object *vec = *vec_ptr;
2420 int next = ZV;
2421 int prev = BEGV;
2422 int inhibit_storing = 0;
2424 for (tail = current_buffer->overlays_before;
2425 GC_CONSP (tail);
2426 tail = XCDR (tail))
2428 int startpos, endpos;
2430 overlay = XCAR (tail);
2432 ostart = OVERLAY_START (overlay);
2433 oend = OVERLAY_END (overlay);
2434 endpos = OVERLAY_POSITION (oend);
2435 if (endpos < beg)
2437 if (prev < endpos)
2438 prev = endpos;
2439 break;
2441 startpos = OVERLAY_POSITION (ostart);
2442 /* Count an interval if it either overlaps the range
2443 or is empty at the start of the range. */
2444 if ((beg < endpos && startpos < end)
2445 || (startpos == endpos && beg == endpos))
2447 if (idx == len)
2449 /* The supplied vector is full.
2450 Either make it bigger, or don't store any more in it. */
2451 if (extend)
2453 *len_ptr = len *= 2;
2454 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2455 *vec_ptr = vec;
2457 else
2458 inhibit_storing = 1;
2461 if (!inhibit_storing)
2462 vec[idx] = overlay;
2463 /* Keep counting overlays even if we can't return them all. */
2464 idx++;
2466 else if (startpos < next)
2467 next = startpos;
2470 for (tail = current_buffer->overlays_after;
2471 GC_CONSP (tail);
2472 tail = XCDR (tail))
2474 int startpos, endpos;
2476 overlay = XCAR (tail);
2478 ostart = OVERLAY_START (overlay);
2479 oend = OVERLAY_END (overlay);
2480 startpos = OVERLAY_POSITION (ostart);
2481 if (end < startpos)
2483 if (startpos < next)
2484 next = startpos;
2485 break;
2487 endpos = OVERLAY_POSITION (oend);
2488 /* Count an interval if it either overlaps the range
2489 or is empty at the start of the range. */
2490 if ((beg < endpos && startpos < end)
2491 || (startpos == endpos && beg == endpos))
2493 if (idx == len)
2495 if (extend)
2497 *len_ptr = len *= 2;
2498 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2499 *vec_ptr = vec;
2501 else
2502 inhibit_storing = 1;
2505 if (!inhibit_storing)
2506 vec[idx] = overlay;
2507 idx++;
2509 else if (endpos < beg && endpos > prev)
2510 prev = endpos;
2513 if (next_ptr)
2514 *next_ptr = next;
2515 if (prev_ptr)
2516 *prev_ptr = prev;
2517 return idx;
2520 /* Fast function to just test if we're at an overlay boundary. */
2522 overlay_touches_p (pos)
2523 int pos;
2525 Lisp_Object tail, overlay;
2527 for (tail = current_buffer->overlays_before; GC_CONSP (tail);
2528 tail = XCDR (tail))
2530 int endpos;
2532 overlay = XCAR (tail);
2533 if (!GC_OVERLAYP (overlay))
2534 abort ();
2536 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2537 if (endpos < pos)
2538 break;
2539 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2540 return 1;
2543 for (tail = current_buffer->overlays_after; GC_CONSP (tail);
2544 tail = XCDR (tail))
2546 int startpos;
2548 overlay = XCAR (tail);
2549 if (!GC_OVERLAYP (overlay))
2550 abort ();
2552 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2553 if (pos < startpos)
2554 break;
2555 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2556 return 1;
2558 return 0;
2561 struct sortvec
2563 Lisp_Object overlay;
2564 int beg, end;
2565 int priority;
2568 static int
2569 compare_overlays (v1, v2)
2570 const void *v1, *v2;
2572 const struct sortvec *s1 = (const struct sortvec *) v1;
2573 const struct sortvec *s2 = (const struct sortvec *) v2;
2574 if (s1->priority != s2->priority)
2575 return s1->priority - s2->priority;
2576 if (s1->beg != s2->beg)
2577 return s1->beg - s2->beg;
2578 if (s1->end != s2->end)
2579 return s2->end - s1->end;
2580 return 0;
2583 /* Sort an array of overlays by priority. The array is modified in place.
2584 The return value is the new size; this may be smaller than the original
2585 size if some of the overlays were invalid or were window-specific. */
2587 sort_overlays (overlay_vec, noverlays, w)
2588 Lisp_Object *overlay_vec;
2589 int noverlays;
2590 struct window *w;
2592 int i, j;
2593 struct sortvec *sortvec;
2594 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2596 /* Put the valid and relevant overlays into sortvec. */
2598 for (i = 0, j = 0; i < noverlays; i++)
2600 Lisp_Object tem;
2601 Lisp_Object overlay;
2603 overlay = overlay_vec[i];
2604 if (OVERLAY_VALID (overlay)
2605 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2606 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2608 /* If we're interested in a specific window, then ignore
2609 overlays that are limited to some other window. */
2610 if (w)
2612 Lisp_Object window;
2614 window = Foverlay_get (overlay, Qwindow);
2615 if (WINDOWP (window) && XWINDOW (window) != w)
2616 continue;
2619 /* This overlay is good and counts: put it into sortvec. */
2620 sortvec[j].overlay = overlay;
2621 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2622 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2623 tem = Foverlay_get (overlay, Qpriority);
2624 if (INTEGERP (tem))
2625 sortvec[j].priority = XINT (tem);
2626 else
2627 sortvec[j].priority = 0;
2628 j++;
2631 noverlays = j;
2633 /* Sort the overlays into the proper order: increasing priority. */
2635 if (noverlays > 1)
2636 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2638 for (i = 0; i < noverlays; i++)
2639 overlay_vec[i] = sortvec[i].overlay;
2640 return (noverlays);
2643 struct sortstr
2645 Lisp_Object string, string2;
2646 int size;
2647 int priority;
2650 struct sortstrlist
2652 struct sortstr *buf; /* An array that expands as needed; never freed. */
2653 int size; /* Allocated length of that array. */
2654 int used; /* How much of the array is currently in use. */
2655 int bytes; /* Total length of the strings in buf. */
2658 /* Buffers for storing information about the overlays touching a given
2659 position. These could be automatic variables in overlay_strings, but
2660 it's more efficient to hold onto the memory instead of repeatedly
2661 allocating and freeing it. */
2662 static struct sortstrlist overlay_heads, overlay_tails;
2663 static unsigned char *overlay_str_buf;
2665 /* Allocated length of overlay_str_buf. */
2666 static int overlay_str_len;
2668 /* A comparison function suitable for passing to qsort. */
2669 static int
2670 cmp_for_strings (as1, as2)
2671 char *as1, *as2;
2673 struct sortstr *s1 = (struct sortstr *)as1;
2674 struct sortstr *s2 = (struct sortstr *)as2;
2675 if (s1->size != s2->size)
2676 return s2->size - s1->size;
2677 if (s1->priority != s2->priority)
2678 return s1->priority - s2->priority;
2679 return 0;
2682 static void
2683 record_overlay_string (ssl, str, str2, pri, size)
2684 struct sortstrlist *ssl;
2685 Lisp_Object str, str2, pri;
2686 int size;
2688 int nbytes;
2690 if (ssl->used == ssl->size)
2692 if (ssl->buf)
2693 ssl->size *= 2;
2694 else
2695 ssl->size = 5;
2696 ssl->buf = ((struct sortstr *)
2697 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2699 ssl->buf[ssl->used].string = str;
2700 ssl->buf[ssl->used].string2 = str2;
2701 ssl->buf[ssl->used].size = size;
2702 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2703 ssl->used++;
2705 if (NILP (current_buffer->enable_multibyte_characters))
2706 nbytes = XSTRING (str)->size;
2707 else if (! STRING_MULTIBYTE (str))
2708 nbytes = count_size_as_multibyte (XSTRING (str)->data,
2709 STRING_BYTES (XSTRING (str)));
2710 else
2711 nbytes = STRING_BYTES (XSTRING (str));
2713 ssl->bytes += nbytes;
2715 if (STRINGP (str2))
2717 if (NILP (current_buffer->enable_multibyte_characters))
2718 nbytes = XSTRING (str2)->size;
2719 else if (! STRING_MULTIBYTE (str2))
2720 nbytes = count_size_as_multibyte (XSTRING (str2)->data,
2721 STRING_BYTES (XSTRING (str2)));
2722 else
2723 nbytes = STRING_BYTES (XSTRING (str2));
2725 ssl->bytes += nbytes;
2729 /* Return the concatenation of the strings associated with overlays that
2730 begin or end at POS, ignoring overlays that are specific to a window
2731 other than W. The strings are concatenated in the appropriate order:
2732 shorter overlays nest inside longer ones, and higher priority inside
2733 lower. Normally all of the after-strings come first, but zero-sized
2734 overlays have their after-strings ride along with the before-strings
2735 because it would look strange to print them inside-out.
2737 Returns the string length, and stores the contents indirectly through
2738 PSTR, if that variable is non-null. The string may be overwritten by
2739 subsequent calls. */
2742 overlay_strings (pos, w, pstr)
2743 int pos;
2744 struct window *w;
2745 unsigned char **pstr;
2747 Lisp_Object ov, overlay, window, str;
2748 int startpos, endpos;
2749 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
2751 overlay_heads.used = overlay_heads.bytes = 0;
2752 overlay_tails.used = overlay_tails.bytes = 0;
2753 for (ov = current_buffer->overlays_before; CONSP (ov); ov = XCDR (ov))
2755 overlay = XCAR (ov);
2756 if (!OVERLAYP (overlay))
2757 abort ();
2759 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2760 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2761 if (endpos < pos)
2762 break;
2763 if (endpos != pos && startpos != pos)
2764 continue;
2765 window = Foverlay_get (overlay, Qwindow);
2766 if (WINDOWP (window) && XWINDOW (window) != w)
2767 continue;
2768 if (startpos == pos
2769 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2770 record_overlay_string (&overlay_heads, str,
2771 (startpos == endpos
2772 ? Foverlay_get (overlay, Qafter_string)
2773 : Qnil),
2774 Foverlay_get (overlay, Qpriority),
2775 endpos - startpos);
2776 else if (endpos == pos
2777 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2778 record_overlay_string (&overlay_tails, str, Qnil,
2779 Foverlay_get (overlay, Qpriority),
2780 endpos - startpos);
2782 for (ov = current_buffer->overlays_after; CONSP (ov); ov = XCDR (ov))
2784 overlay = XCAR (ov);
2785 if (!OVERLAYP (overlay))
2786 abort ();
2788 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2789 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2790 if (startpos > pos)
2791 break;
2792 if (endpos != pos && startpos != pos)
2793 continue;
2794 window = Foverlay_get (overlay, Qwindow);
2795 if (WINDOWP (window) && XWINDOW (window) != w)
2796 continue;
2797 if (startpos == pos
2798 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2799 record_overlay_string (&overlay_heads, str,
2800 (startpos == endpos
2801 ? Foverlay_get (overlay, Qafter_string)
2802 : Qnil),
2803 Foverlay_get (overlay, Qpriority),
2804 endpos - startpos);
2805 else if (endpos == pos
2806 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2807 record_overlay_string (&overlay_tails, str, Qnil,
2808 Foverlay_get (overlay, Qpriority),
2809 endpos - startpos);
2811 if (overlay_tails.used > 1)
2812 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
2813 cmp_for_strings);
2814 if (overlay_heads.used > 1)
2815 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
2816 cmp_for_strings);
2817 if (overlay_heads.bytes || overlay_tails.bytes)
2819 Lisp_Object tem;
2820 int i;
2821 unsigned char *p;
2822 int total = overlay_heads.bytes + overlay_tails.bytes;
2824 if (total > overlay_str_len)
2826 overlay_str_len = total;
2827 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
2828 total);
2830 p = overlay_str_buf;
2831 for (i = overlay_tails.used; --i >= 0;)
2833 int nbytes;
2834 tem = overlay_tails.buf[i].string;
2835 nbytes = copy_text (XSTRING (tem)->data, p,
2836 STRING_BYTES (XSTRING (tem)),
2837 STRING_MULTIBYTE (tem), multibyte);
2838 p += nbytes;
2840 for (i = 0; i < overlay_heads.used; ++i)
2842 int nbytes;
2843 tem = overlay_heads.buf[i].string;
2844 nbytes = copy_text (XSTRING (tem)->data, p,
2845 STRING_BYTES (XSTRING (tem)),
2846 STRING_MULTIBYTE (tem), multibyte);
2847 p += nbytes;
2848 tem = overlay_heads.buf[i].string2;
2849 if (STRINGP (tem))
2851 nbytes = copy_text (XSTRING (tem)->data, p,
2852 STRING_BYTES (XSTRING (tem)),
2853 STRING_MULTIBYTE (tem), multibyte);
2854 p += nbytes;
2857 if (p != overlay_str_buf + total)
2858 abort ();
2859 if (pstr)
2860 *pstr = overlay_str_buf;
2861 return total;
2863 return 0;
2866 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
2868 void
2869 recenter_overlay_lists (buf, pos)
2870 struct buffer *buf;
2871 int pos;
2873 Lisp_Object overlay, tail, next, prev, beg, end;
2875 /* See if anything in overlays_before should move to overlays_after. */
2877 /* We don't strictly need prev in this loop; it should always be nil.
2878 But we use it for symmetry and in case that should cease to be true
2879 with some future change. */
2880 prev = Qnil;
2881 for (tail = buf->overlays_before;
2882 CONSP (tail);
2883 prev = tail, tail = next)
2885 next = XCDR (tail);
2886 overlay = XCAR (tail);
2888 /* If the overlay is not valid, get rid of it. */
2889 if (!OVERLAY_VALID (overlay))
2890 #if 1
2891 abort ();
2892 #else
2894 /* Splice the cons cell TAIL out of overlays_before. */
2895 if (!NILP (prev))
2896 XCDR (prev) = next;
2897 else
2898 buf->overlays_before = next;
2899 tail = prev;
2900 continue;
2902 #endif
2904 beg = OVERLAY_START (overlay);
2905 end = OVERLAY_END (overlay);
2907 if (OVERLAY_POSITION (end) > pos)
2909 /* OVERLAY needs to be moved. */
2910 int where = OVERLAY_POSITION (beg);
2911 Lisp_Object other, other_prev;
2913 /* Splice the cons cell TAIL out of overlays_before. */
2914 if (!NILP (prev))
2915 XCDR (prev) = next;
2916 else
2917 buf->overlays_before = next;
2919 /* Search thru overlays_after for where to put it. */
2920 other_prev = Qnil;
2921 for (other = buf->overlays_after;
2922 CONSP (other);
2923 other_prev = other, other = XCDR (other))
2925 Lisp_Object otherbeg, otheroverlay;
2927 otheroverlay = XCAR (other);
2928 if (! OVERLAY_VALID (otheroverlay))
2929 abort ();
2931 otherbeg = OVERLAY_START (otheroverlay);
2932 if (OVERLAY_POSITION (otherbeg) >= where)
2933 break;
2936 /* Add TAIL to overlays_after before OTHER. */
2937 XCDR (tail) = other;
2938 if (!NILP (other_prev))
2939 XCDR (other_prev) = tail;
2940 else
2941 buf->overlays_after = tail;
2942 tail = prev;
2944 else
2945 /* We've reached the things that should stay in overlays_before.
2946 All the rest of overlays_before must end even earlier,
2947 so stop now. */
2948 break;
2951 /* See if anything in overlays_after should be in overlays_before. */
2952 prev = Qnil;
2953 for (tail = buf->overlays_after;
2954 CONSP (tail);
2955 prev = tail, tail = next)
2957 next = XCDR (tail);
2958 overlay = XCAR (tail);
2960 /* If the overlay is not valid, get rid of it. */
2961 if (!OVERLAY_VALID (overlay))
2962 #if 1
2963 abort ();
2964 #else
2966 /* Splice the cons cell TAIL out of overlays_after. */
2967 if (!NILP (prev))
2968 XCDR (prev) = next;
2969 else
2970 buf->overlays_after = next;
2971 tail = prev;
2972 continue;
2974 #endif
2976 beg = OVERLAY_START (overlay);
2977 end = OVERLAY_END (overlay);
2979 /* Stop looking, when we know that nothing further
2980 can possibly end before POS. */
2981 if (OVERLAY_POSITION (beg) > pos)
2982 break;
2984 if (OVERLAY_POSITION (end) <= pos)
2986 /* OVERLAY needs to be moved. */
2987 int where = OVERLAY_POSITION (end);
2988 Lisp_Object other, other_prev;
2990 /* Splice the cons cell TAIL out of overlays_after. */
2991 if (!NILP (prev))
2992 XCDR (prev) = next;
2993 else
2994 buf->overlays_after = next;
2996 /* Search thru overlays_before for where to put it. */
2997 other_prev = Qnil;
2998 for (other = buf->overlays_before;
2999 CONSP (other);
3000 other_prev = other, other = XCDR (other))
3002 Lisp_Object otherend, otheroverlay;
3004 otheroverlay = XCAR (other);
3005 if (! OVERLAY_VALID (otheroverlay))
3006 abort ();
3008 otherend = OVERLAY_END (otheroverlay);
3009 if (OVERLAY_POSITION (otherend) <= where)
3010 break;
3013 /* Add TAIL to overlays_before before OTHER. */
3014 XCDR (tail) = other;
3015 if (!NILP (other_prev))
3016 XCDR (other_prev) = tail;
3017 else
3018 buf->overlays_before = tail;
3019 tail = prev;
3023 XSETFASTINT (buf->overlay_center, pos);
3026 void
3027 adjust_overlays_for_insert (pos, length)
3028 int pos;
3029 int length;
3031 /* After an insertion, the lists are still sorted properly,
3032 but we may need to update the value of the overlay center. */
3033 if (XFASTINT (current_buffer->overlay_center) >= pos)
3034 XSETFASTINT (current_buffer->overlay_center,
3035 XFASTINT (current_buffer->overlay_center) + length);
3038 void
3039 adjust_overlays_for_delete (pos, length)
3040 int pos;
3041 int length;
3043 if (XFASTINT (current_buffer->overlay_center) < pos)
3044 /* The deletion was to our right. No change needed; the before- and
3045 after-lists are still consistent. */
3047 else if (XFASTINT (current_buffer->overlay_center) > pos + length)
3048 /* The deletion was to our left. We need to adjust the center value
3049 to account for the change in position, but the lists are consistent
3050 given the new value. */
3051 XSETFASTINT (current_buffer->overlay_center,
3052 XFASTINT (current_buffer->overlay_center) - length);
3053 else
3054 /* We're right in the middle. There might be things on the after-list
3055 that now belong on the before-list. Recentering will move them,
3056 and also update the center point. */
3057 recenter_overlay_lists (current_buffer, pos);
3060 /* Fix up overlays that were garbled as a result of permuting markers
3061 in the range START through END. Any overlay with at least one
3062 endpoint in this range will need to be unlinked from the overlay
3063 list and reinserted in its proper place.
3064 Such an overlay might even have negative size at this point.
3065 If so, we'll reverse the endpoints. Can you think of anything
3066 better to do in this situation? */
3067 void
3068 fix_overlays_in_range (start, end)
3069 register int start, end;
3071 Lisp_Object overlay;
3072 Lisp_Object before_list, after_list;
3073 Lisp_Object *ptail, *pbefore = &before_list, *pafter = &after_list;
3074 int startpos, endpos;
3076 /* This algorithm shifts links around instead of consing and GCing.
3077 The loop invariant is that before_list (resp. after_list) is a
3078 well-formed list except that its last element, the one that
3079 *pbefore (resp. *pafter) points to, is still uninitialized.
3080 So it's not a bug that before_list isn't initialized, although
3081 it may look strange. */
3082 for (ptail = &current_buffer->overlays_before; CONSP (*ptail);)
3084 overlay = XCAR (*ptail);
3085 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3086 if (endpos < start)
3087 break;
3088 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3089 if (endpos < end
3090 || (startpos >= start && startpos < end))
3092 /* If the overlay is backwards, fix that now. */
3093 if (startpos > endpos)
3095 int tem;
3096 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3097 Qnil);
3098 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3099 Qnil);
3100 tem = startpos; startpos = endpos; endpos = tem;
3102 /* Add it to the end of the wrong list. Later on,
3103 recenter_overlay_lists will move it to the right place. */
3104 if (endpos < XINT (current_buffer->overlay_center))
3106 *pafter = *ptail;
3107 pafter = &XCDR (*ptail);
3109 else
3111 *pbefore = *ptail;
3112 pbefore = &XCDR (*ptail);
3114 *ptail = XCDR (*ptail);
3116 else
3117 ptail = &XCDR (*ptail);
3119 for (ptail = &current_buffer->overlays_after; CONSP (*ptail);)
3121 overlay = XCAR (*ptail);
3122 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3123 if (startpos >= end)
3124 break;
3125 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3126 if (startpos >= start
3127 || (endpos >= start && endpos < end))
3129 if (startpos > endpos)
3131 int tem;
3132 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3133 Qnil);
3134 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3135 Qnil);
3136 tem = startpos; startpos = endpos; endpos = tem;
3138 if (endpos < XINT (current_buffer->overlay_center))
3140 *pafter = *ptail;
3141 pafter = &XCDR (*ptail);
3143 else
3145 *pbefore = *ptail;
3146 pbefore = &XCDR (*ptail);
3148 *ptail = XCDR (*ptail);
3150 else
3151 ptail = &XCDR (*ptail);
3154 /* Splice the constructed (wrong) lists into the buffer's lists,
3155 and let the recenter function make it sane again. */
3156 *pbefore = current_buffer->overlays_before;
3157 current_buffer->overlays_before = before_list;
3158 recenter_overlay_lists (current_buffer,
3159 XINT (current_buffer->overlay_center));
3161 *pafter = current_buffer->overlays_after;
3162 current_buffer->overlays_after = after_list;
3163 recenter_overlay_lists (current_buffer,
3164 XINT (current_buffer->overlay_center));
3167 /* We have two types of overlay: the one whose ending marker is
3168 after-insertion-marker (this is the usual case) and the one whose
3169 ending marker is before-insertion-marker. When `overlays_before'
3170 contains overlays of the latter type and the former type in this
3171 order and both overlays end at inserting position, inserting a text
3172 increases only the ending marker of the latter type, which results
3173 in incorrect ordering of `overlays_before'.
3175 This function fixes ordering of overlays in the slot
3176 `overlays_before' of the buffer *BP. Before the insertion, `point'
3177 was at PREV, and now is at POS. */
3179 void
3180 fix_overlays_before (bp, prev, pos)
3181 struct buffer *bp;
3182 int prev, pos;
3184 Lisp_Object *tailp = &bp->overlays_before;
3185 Lisp_Object *right_place;
3186 int end;
3188 /* After the insertion, the several overlays may be in incorrect
3189 order. The possibility is that, in the list `overlays_before',
3190 an overlay which ends at POS appears after an overlay which ends
3191 at PREV. Since POS is greater than PREV, we must fix the
3192 ordering of these overlays, by moving overlays ends at POS before
3193 the overlays ends at PREV. */
3195 /* At first, find a place where disordered overlays should be linked
3196 in. It is where an overlay which end before POS exists. (i.e. an
3197 overlay whose ending marker is after-insertion-marker if disorder
3198 exists). */
3199 while (!NILP (*tailp)
3200 && ((end = OVERLAY_POSITION (OVERLAY_END (XCAR (*tailp))))
3201 >= pos))
3202 tailp = &XCDR (*tailp);
3204 /* If we don't find such an overlay,
3205 or the found one ends before PREV,
3206 or the found one is the last one in the list,
3207 we don't have to fix anything. */
3208 if (NILP (*tailp)
3209 || end < prev
3210 || NILP (XCDR (*tailp)))
3211 return;
3213 right_place = tailp;
3214 tailp = &XCDR (*tailp);
3216 /* Now, end position of overlays in the list *TAILP should be before
3217 or equal to PREV. In the loop, an overlay which ends at POS is
3218 moved ahead to the place pointed by RIGHT_PLACE. If we found an
3219 overlay which ends before PREV, the remaining overlays are in
3220 correct order. */
3221 while (!NILP (*tailp))
3223 end = OVERLAY_POSITION (OVERLAY_END (XCAR (*tailp)));
3225 if (end == pos)
3226 { /* This overlay is disordered. */
3227 Lisp_Object found = *tailp;
3229 /* Unlink the found overlay. */
3230 *tailp = XCDR (found);
3231 /* Move an overlay at RIGHT_PLACE to the next of the found one. */
3232 XCDR (found) = *right_place;
3233 /* Link it into the right place. */
3234 *right_place = found;
3236 else if (end == prev)
3237 tailp = &XCDR (*tailp);
3238 else /* No more disordered overlay. */
3239 break;
3243 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3244 "Return t if OBJECT is an overlay.")
3245 (object)
3246 Lisp_Object object;
3248 return (OVERLAYP (object) ? Qt : Qnil);
3251 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3252 "Create a new overlay with range BEG to END in BUFFER.\n\
3253 If omitted, BUFFER defaults to the current buffer.\n\
3254 BEG and END may be integers or markers.\n\
3255 The fourth arg FRONT-ADVANCE, if non-nil, makes the\n\
3256 front delimiter advance when text is inserted there.\n\
3257 The fifth arg REAR-ADVANCE, if non-nil, makes the\n\
3258 rear delimiter advance when text is inserted there.")
3259 (beg, end, buffer, front_advance, rear_advance)
3260 Lisp_Object beg, end, buffer;
3261 Lisp_Object front_advance, rear_advance;
3263 Lisp_Object overlay;
3264 struct buffer *b;
3266 if (NILP (buffer))
3267 XSETBUFFER (buffer, current_buffer);
3268 else
3269 CHECK_BUFFER (buffer, 2);
3270 if (MARKERP (beg)
3271 && ! EQ (Fmarker_buffer (beg), buffer))
3272 error ("Marker points into wrong buffer");
3273 if (MARKERP (end)
3274 && ! EQ (Fmarker_buffer (end), buffer))
3275 error ("Marker points into wrong buffer");
3277 CHECK_NUMBER_COERCE_MARKER (beg, 1);
3278 CHECK_NUMBER_COERCE_MARKER (end, 1);
3280 if (XINT (beg) > XINT (end))
3282 Lisp_Object temp;
3283 temp = beg; beg = end; end = temp;
3286 b = XBUFFER (buffer);
3288 beg = Fset_marker (Fmake_marker (), beg, buffer);
3289 end = Fset_marker (Fmake_marker (), end, buffer);
3291 if (!NILP (front_advance))
3292 XMARKER (beg)->insertion_type = 1;
3293 if (!NILP (rear_advance))
3294 XMARKER (end)->insertion_type = 1;
3296 overlay = allocate_misc ();
3297 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3298 XOVERLAY (overlay)->start = beg;
3299 XOVERLAY (overlay)->end = end;
3300 XOVERLAY (overlay)->plist = Qnil;
3302 /* Put the new overlay on the wrong list. */
3303 end = OVERLAY_END (overlay);
3304 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3305 b->overlays_after = Fcons (overlay, b->overlays_after);
3306 else
3307 b->overlays_before = Fcons (overlay, b->overlays_before);
3309 /* This puts it in the right list, and in the right order. */
3310 recenter_overlay_lists (b, XINT (b->overlay_center));
3312 /* We don't need to redisplay the region covered by the overlay, because
3313 the overlay has no properties at the moment. */
3315 return overlay;
3318 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3320 static void
3321 modify_overlay (buf, start, end)
3322 struct buffer *buf;
3323 int start, end;
3325 if (start == end)
3326 return;
3328 if (start > end)
3330 int temp = start;
3331 start = end; end = temp;
3334 BUF_COMPUTE_UNCHANGED (buf, start, end);
3336 /* If this is a buffer not in the selected window,
3337 we must do other windows. */
3338 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3339 windows_or_buffers_changed = 1;
3340 /* If multiple windows show this buffer, we must do other windows. */
3341 else if (buffer_shared > 1)
3342 windows_or_buffers_changed = 1;
3344 ++BUF_OVERLAY_MODIFF (buf);
3347 \f\f
3348 Lisp_Object Fdelete_overlay ();
3350 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3351 "Set the endpoints of OVERLAY to BEG and END in BUFFER.\n\
3352 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.\n\
3353 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current\n\
3354 buffer.")
3355 (overlay, beg, end, buffer)
3356 Lisp_Object overlay, beg, end, buffer;
3358 struct buffer *b, *ob;
3359 Lisp_Object obuffer;
3360 int count = specpdl_ptr - specpdl;
3362 CHECK_OVERLAY (overlay, 0);
3363 if (NILP (buffer))
3364 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3365 if (NILP (buffer))
3366 XSETBUFFER (buffer, current_buffer);
3367 CHECK_BUFFER (buffer, 3);
3369 if (MARKERP (beg)
3370 && ! EQ (Fmarker_buffer (beg), buffer))
3371 error ("Marker points into wrong buffer");
3372 if (MARKERP (end)
3373 && ! EQ (Fmarker_buffer (end), buffer))
3374 error ("Marker points into wrong buffer");
3376 CHECK_NUMBER_COERCE_MARKER (beg, 1);
3377 CHECK_NUMBER_COERCE_MARKER (end, 1);
3379 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3380 return Fdelete_overlay (overlay);
3382 if (XINT (beg) > XINT (end))
3384 Lisp_Object temp;
3385 temp = beg; beg = end; end = temp;
3388 specbind (Qinhibit_quit, Qt);
3390 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3391 b = XBUFFER (buffer);
3392 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3394 /* If the overlay has changed buffers, do a thorough redisplay. */
3395 if (!EQ (buffer, obuffer))
3397 /* Redisplay where the overlay was. */
3398 if (!NILP (obuffer))
3400 int o_beg;
3401 int o_end;
3403 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3404 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3406 modify_overlay (ob, o_beg, o_end);
3409 /* Redisplay where the overlay is going to be. */
3410 modify_overlay (b, XINT (beg), XINT (end));
3412 else
3413 /* Redisplay the area the overlay has just left, or just enclosed. */
3415 int o_beg, o_end;
3417 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3418 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3420 if (o_beg == XINT (beg))
3421 modify_overlay (b, o_end, XINT (end));
3422 else if (o_end == XINT (end))
3423 modify_overlay (b, o_beg, XINT (beg));
3424 else
3426 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3427 if (XINT (end) > o_end) o_end = XINT (end);
3428 modify_overlay (b, o_beg, o_end);
3432 if (!NILP (obuffer))
3434 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
3435 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
3438 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3439 Fset_marker (OVERLAY_END (overlay), end, buffer);
3441 /* Put the overlay on the wrong list. */
3442 end = OVERLAY_END (overlay);
3443 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3444 b->overlays_after = Fcons (overlay, b->overlays_after);
3445 else
3446 b->overlays_before = Fcons (overlay, b->overlays_before);
3448 /* This puts it in the right list, and in the right order. */
3449 recenter_overlay_lists (b, XINT (b->overlay_center));
3451 return unbind_to (count, overlay);
3454 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3455 "Delete the overlay OVERLAY from its buffer.")
3456 (overlay)
3457 Lisp_Object overlay;
3459 Lisp_Object buffer;
3460 struct buffer *b;
3461 int count = specpdl_ptr - specpdl;
3463 CHECK_OVERLAY (overlay, 0);
3465 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3466 if (NILP (buffer))
3467 return Qnil;
3469 b = XBUFFER (buffer);
3471 specbind (Qinhibit_quit, Qt);
3473 b->overlays_before = Fdelq (overlay, b->overlays_before);
3474 b->overlays_after = Fdelq (overlay, b->overlays_after);
3476 modify_overlay (b,
3477 marker_position (OVERLAY_START (overlay)),
3478 marker_position (OVERLAY_END (overlay)));
3480 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3481 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3483 return unbind_to (count, Qnil);
3486 /* Overlay dissection functions. */
3488 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3489 "Return the position at which OVERLAY starts.")
3490 (overlay)
3491 Lisp_Object overlay;
3493 CHECK_OVERLAY (overlay, 0);
3495 return (Fmarker_position (OVERLAY_START (overlay)));
3498 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3499 "Return the position at which OVERLAY ends.")
3500 (overlay)
3501 Lisp_Object overlay;
3503 CHECK_OVERLAY (overlay, 0);
3505 return (Fmarker_position (OVERLAY_END (overlay)));
3508 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3509 "Return the buffer OVERLAY belongs to.")
3510 (overlay)
3511 Lisp_Object overlay;
3513 CHECK_OVERLAY (overlay, 0);
3515 return Fmarker_buffer (OVERLAY_START (overlay));
3518 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3519 "Return a list of the properties on OVERLAY.\n\
3520 This is a copy of OVERLAY's plist; modifying its conses has no effect on\n\
3521 OVERLAY.")
3522 (overlay)
3523 Lisp_Object overlay;
3525 CHECK_OVERLAY (overlay, 0);
3527 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3531 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3532 "Return a list of the overlays that contain position POS.")
3533 (pos)
3534 Lisp_Object pos;
3536 int noverlays;
3537 Lisp_Object *overlay_vec;
3538 int len;
3539 Lisp_Object result;
3541 CHECK_NUMBER_COERCE_MARKER (pos, 0);
3543 len = 10;
3544 /* We can't use alloca here because overlays_at can call xrealloc. */
3545 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3547 /* Put all the overlays we want in a vector in overlay_vec.
3548 Store the length in len. */
3549 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3550 (int *) 0, (int *) 0, 0);
3552 /* Make a list of them all. */
3553 result = Flist (noverlays, overlay_vec);
3555 xfree (overlay_vec);
3556 return result;
3559 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3560 "Return a list of the overlays that overlap the region BEG ... END.\n\
3561 Overlap means that at least one character is contained within the overlay\n\
3562 and also contained within the specified region.\n\
3563 Empty overlays are included in the result if they are located at BEG\n\
3564 or between BEG and END.")
3565 (beg, end)
3566 Lisp_Object beg, end;
3568 int noverlays;
3569 Lisp_Object *overlay_vec;
3570 int len;
3571 Lisp_Object result;
3573 CHECK_NUMBER_COERCE_MARKER (beg, 0);
3574 CHECK_NUMBER_COERCE_MARKER (end, 0);
3576 len = 10;
3577 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3579 /* Put all the overlays we want in a vector in overlay_vec.
3580 Store the length in len. */
3581 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3582 (int *) 0, (int *) 0);
3584 /* Make a list of them all. */
3585 result = Flist (noverlays, overlay_vec);
3587 xfree (overlay_vec);
3588 return result;
3591 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3592 1, 1, 0,
3593 "Return the next position after POS where an overlay starts or ends.\n\
3594 If there are no more overlay boundaries after POS, return (point-max).")
3595 (pos)
3596 Lisp_Object pos;
3598 int noverlays;
3599 int endpos;
3600 Lisp_Object *overlay_vec;
3601 int len;
3602 int i;
3604 CHECK_NUMBER_COERCE_MARKER (pos, 0);
3606 len = 10;
3607 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3609 /* Put all the overlays we want in a vector in overlay_vec.
3610 Store the length in len.
3611 endpos gets the position where the next overlay starts. */
3612 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3613 &endpos, (int *) 0, 1);
3615 /* If any of these overlays ends before endpos,
3616 use its ending point instead. */
3617 for (i = 0; i < noverlays; i++)
3619 Lisp_Object oend;
3620 int oendpos;
3622 oend = OVERLAY_END (overlay_vec[i]);
3623 oendpos = OVERLAY_POSITION (oend);
3624 if (oendpos < endpos)
3625 endpos = oendpos;
3628 xfree (overlay_vec);
3629 return make_number (endpos);
3632 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3633 Sprevious_overlay_change, 1, 1, 0,
3634 "Return the previous position before POS where an overlay starts or ends.\n\
3635 If there are no more overlay boundaries before POS, return (point-min).")
3636 (pos)
3637 Lisp_Object pos;
3639 int noverlays;
3640 int prevpos;
3641 Lisp_Object *overlay_vec;
3642 int len;
3644 CHECK_NUMBER_COERCE_MARKER (pos, 0);
3646 /* At beginning of buffer, we know the answer;
3647 avoid bug subtracting 1 below. */
3648 if (XINT (pos) == BEGV)
3649 return pos;
3651 len = 10;
3652 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3654 /* Put all the overlays we want in a vector in overlay_vec.
3655 Store the length in len.
3656 prevpos gets the position of the previous change. */
3657 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3658 (int *) 0, &prevpos, 1);
3660 xfree (overlay_vec);
3661 return make_number (prevpos);
3664 /* These functions are for debugging overlays. */
3666 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3667 "Return a pair of lists giving all the overlays of the current buffer.\n\
3668 The car has all the overlays before the overlay center;\n\
3669 the cdr has all the overlays after the overlay center.\n\
3670 Recentering overlays moves overlays between these lists.\n\
3671 The lists you get are copies, so that changing them has no effect.\n\
3672 However, the overlays you get are the real objects that the buffer uses.")
3675 Lisp_Object before, after;
3676 before = current_buffer->overlays_before;
3677 if (CONSP (before))
3678 before = Fcopy_sequence (before);
3679 after = current_buffer->overlays_after;
3680 if (CONSP (after))
3681 after = Fcopy_sequence (after);
3683 return Fcons (before, after);
3686 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
3687 "Recenter the overlays of the current buffer around position POS.")
3688 (pos)
3689 Lisp_Object pos;
3691 CHECK_NUMBER_COERCE_MARKER (pos, 0);
3693 recenter_overlay_lists (current_buffer, XINT (pos));
3694 return Qnil;
3697 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
3698 "Get the property of overlay OVERLAY with property name PROP.")
3699 (overlay, prop)
3700 Lisp_Object overlay, prop;
3702 Lisp_Object plist, fallback;
3704 CHECK_OVERLAY (overlay, 0);
3706 fallback = Qnil;
3708 for (plist = XOVERLAY (overlay)->plist;
3709 CONSP (plist) && CONSP (XCDR (plist));
3710 plist = XCDR (XCDR (plist)))
3712 if (EQ (XCAR (plist), prop))
3713 return XCAR (XCDR (plist));
3714 else if (EQ (XCAR (plist), Qcategory))
3716 Lisp_Object tem;
3717 tem = Fcar (Fcdr (plist));
3718 if (SYMBOLP (tem))
3719 fallback = Fget (tem, prop);
3723 return fallback;
3726 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
3727 "Set one property of overlay OVERLAY: give property PROP value VALUE.")
3728 (overlay, prop, value)
3729 Lisp_Object overlay, prop, value;
3731 Lisp_Object tail, buffer;
3732 int changed;
3734 CHECK_OVERLAY (overlay, 0);
3736 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3738 for (tail = XOVERLAY (overlay)->plist;
3739 CONSP (tail) && CONSP (XCDR (tail));
3740 tail = XCDR (XCDR (tail)))
3741 if (EQ (XCAR (tail), prop))
3743 changed = !EQ (XCAR (XCDR (tail)), value);
3744 XCAR (XCDR (tail)) = value;
3745 goto found;
3747 /* It wasn't in the list, so add it to the front. */
3748 changed = !NILP (value);
3749 XOVERLAY (overlay)->plist
3750 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
3751 found:
3752 if (! NILP (buffer))
3754 if (changed)
3755 modify_overlay (XBUFFER (buffer),
3756 marker_position (OVERLAY_START (overlay)),
3757 marker_position (OVERLAY_END (overlay)));
3758 if (EQ (prop, Qevaporate) && ! NILP (value)
3759 && (OVERLAY_POSITION (OVERLAY_START (overlay))
3760 == OVERLAY_POSITION (OVERLAY_END (overlay))))
3761 Fdelete_overlay (overlay);
3763 return value;
3766 /* Subroutine of report_overlay_modification. */
3768 /* Lisp vector holding overlay hook functions to call.
3769 Vector elements come in pairs.
3770 Each even-index element is a list of hook functions.
3771 The following odd-index element is the overlay they came from.
3773 Before the buffer change, we fill in this vector
3774 as we call overlay hook functions.
3775 After the buffer change, we get the functions to call from this vector.
3776 This way we always call the same functions before and after the change. */
3777 static Lisp_Object last_overlay_modification_hooks;
3779 /* Number of elements actually used in last_overlay_modification_hooks. */
3780 static int last_overlay_modification_hooks_used;
3782 /* Add one functionlist/overlay pair
3783 to the end of last_overlay_modification_hooks. */
3785 static void
3786 add_overlay_mod_hooklist (functionlist, overlay)
3787 Lisp_Object functionlist, overlay;
3789 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
3791 if (last_overlay_modification_hooks_used == oldsize)
3793 Lisp_Object old;
3794 old = last_overlay_modification_hooks;
3795 last_overlay_modification_hooks
3796 = Fmake_vector (make_number (oldsize * 2), Qnil);
3797 bcopy (XVECTOR (old)->contents,
3798 XVECTOR (last_overlay_modification_hooks)->contents,
3799 sizeof (Lisp_Object) * oldsize);
3801 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = functionlist;
3802 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = overlay;
3805 /* Run the modification-hooks of overlays that include
3806 any part of the text in START to END.
3807 If this change is an insertion, also
3808 run the insert-before-hooks of overlay starting at END,
3809 and the insert-after-hooks of overlay ending at START.
3811 This is called both before and after the modification.
3812 AFTER is nonzero when we call after the modification.
3814 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
3815 When AFTER is nonzero, they are the start position,
3816 the position after the inserted new text,
3817 and the length of deleted or replaced old text. */
3819 void
3820 report_overlay_modification (start, end, after, arg1, arg2, arg3)
3821 Lisp_Object start, end;
3822 int after;
3823 Lisp_Object arg1, arg2, arg3;
3825 Lisp_Object prop, overlay, tail;
3826 /* 1 if this change is an insertion. */
3827 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
3828 int tail_copied;
3829 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3831 overlay = Qnil;
3832 tail = Qnil;
3833 GCPRO5 (overlay, tail, arg1, arg2, arg3);
3835 if (after)
3837 /* Call the functions recorded in last_overlay_modification_hooks
3838 rather than scanning the overlays again.
3839 First copy the vector contents, in case some of these hooks
3840 do subsequent modification of the buffer. */
3841 int size = last_overlay_modification_hooks_used;
3842 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
3843 int i;
3845 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
3846 copy, size * sizeof (Lisp_Object));
3847 gcpro1.var = copy;
3848 gcpro1.nvars = size;
3850 for (i = 0; i < size;)
3852 Lisp_Object prop, overlay;
3853 prop = copy[i++];
3854 overlay = copy[i++];
3855 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3857 UNGCPRO;
3858 return;
3861 /* We are being called before a change.
3862 Scan the overlays to find the functions to call. */
3863 last_overlay_modification_hooks_used = 0;
3864 tail_copied = 0;
3865 for (tail = current_buffer->overlays_before;
3866 CONSP (tail);
3867 tail = XCDR (tail))
3869 int startpos, endpos;
3870 Lisp_Object ostart, oend;
3872 overlay = XCAR (tail);
3874 ostart = OVERLAY_START (overlay);
3875 oend = OVERLAY_END (overlay);
3876 endpos = OVERLAY_POSITION (oend);
3877 if (XFASTINT (start) > endpos)
3878 break;
3879 startpos = OVERLAY_POSITION (ostart);
3880 if (insertion && (XFASTINT (start) == startpos
3881 || XFASTINT (end) == startpos))
3883 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
3884 if (!NILP (prop))
3886 /* Copy TAIL in case the hook recenters the overlay lists. */
3887 if (!tail_copied)
3888 tail = Fcopy_sequence (tail);
3889 tail_copied = 1;
3890 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3893 if (insertion && (XFASTINT (start) == endpos
3894 || XFASTINT (end) == endpos))
3896 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
3897 if (!NILP (prop))
3899 if (!tail_copied)
3900 tail = Fcopy_sequence (tail);
3901 tail_copied = 1;
3902 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3905 /* Test for intersecting intervals. This does the right thing
3906 for both insertion and deletion. */
3907 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
3909 prop = Foverlay_get (overlay, Qmodification_hooks);
3910 if (!NILP (prop))
3912 if (!tail_copied)
3913 tail = Fcopy_sequence (tail);
3914 tail_copied = 1;
3915 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3920 tail_copied = 0;
3921 for (tail = current_buffer->overlays_after;
3922 CONSP (tail);
3923 tail = XCDR (tail))
3925 int startpos, endpos;
3926 Lisp_Object ostart, oend;
3928 overlay = XCAR (tail);
3930 ostart = OVERLAY_START (overlay);
3931 oend = OVERLAY_END (overlay);
3932 startpos = OVERLAY_POSITION (ostart);
3933 endpos = OVERLAY_POSITION (oend);
3934 if (XFASTINT (end) < startpos)
3935 break;
3936 if (insertion && (XFASTINT (start) == startpos
3937 || XFASTINT (end) == startpos))
3939 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
3940 if (!NILP (prop))
3942 if (!tail_copied)
3943 tail = Fcopy_sequence (tail);
3944 tail_copied = 1;
3945 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3948 if (insertion && (XFASTINT (start) == endpos
3949 || XFASTINT (end) == endpos))
3951 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
3952 if (!NILP (prop))
3954 if (!tail_copied)
3955 tail = Fcopy_sequence (tail);
3956 tail_copied = 1;
3957 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3960 /* Test for intersecting intervals. This does the right thing
3961 for both insertion and deletion. */
3962 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
3964 prop = Foverlay_get (overlay, Qmodification_hooks);
3965 if (!NILP (prop))
3967 if (!tail_copied)
3968 tail = Fcopy_sequence (tail);
3969 tail_copied = 1;
3970 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
3975 UNGCPRO;
3978 static void
3979 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
3980 Lisp_Object list, overlay;
3981 int after;
3982 Lisp_Object arg1, arg2, arg3;
3984 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3986 GCPRO4 (list, arg1, arg2, arg3);
3987 if (! after)
3988 add_overlay_mod_hooklist (list, overlay);
3990 while (!NILP (list))
3992 if (NILP (arg3))
3993 call4 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2);
3994 else
3995 call5 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
3996 list = Fcdr (list);
3998 UNGCPRO;
4001 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4002 property is set. */
4003 void
4004 evaporate_overlays (pos)
4005 int pos;
4007 Lisp_Object tail, overlay, hit_list;
4009 hit_list = Qnil;
4010 if (pos <= XFASTINT (current_buffer->overlay_center))
4011 for (tail = current_buffer->overlays_before; CONSP (tail);
4012 tail = XCDR (tail))
4014 int endpos;
4015 overlay = XCAR (tail);
4016 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4017 if (endpos < pos)
4018 break;
4019 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4020 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4021 hit_list = Fcons (overlay, hit_list);
4023 else
4024 for (tail = current_buffer->overlays_after; CONSP (tail);
4025 tail = XCDR (tail))
4027 int startpos;
4028 overlay = XCAR (tail);
4029 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4030 if (startpos > pos)
4031 break;
4032 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4033 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4034 hit_list = Fcons (overlay, hit_list);
4036 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4037 Fdelete_overlay (XCAR (hit_list));
4040 /* Somebody has tried to store a value with an unacceptable type
4041 in the slot with offset OFFSET. */
4043 void
4044 buffer_slot_type_mismatch (offset)
4045 int offset;
4047 Lisp_Object sym;
4048 char *type_name;
4050 switch (XINT (PER_BUFFER_TYPE (offset)))
4052 case Lisp_Int:
4053 type_name = "integers";
4054 break;
4056 case Lisp_String:
4057 type_name = "strings";
4058 break;
4060 case Lisp_Symbol:
4061 type_name = "symbols";
4062 break;
4064 default:
4065 abort ();
4068 sym = PER_BUFFER_SYMBOL (offset);
4069 error ("Only %s should be stored in the buffer-local variable %s",
4070 type_name, XSYMBOL (sym)->name->data);
4074 /***********************************************************************
4075 Allocation with mmap
4076 ***********************************************************************/
4078 #ifdef USE_MMAP_FOR_BUFFERS
4080 #include <sys/types.h>
4081 #include <sys/mman.h>
4083 #ifndef MAP_ANON
4084 #ifdef MAP_ANONYMOUS
4085 #define MAP_ANON MAP_ANONYMOUS
4086 #else
4087 #define MAP_ANON 0
4088 #endif
4089 #endif
4091 #ifndef MAP_FAILED
4092 #define MAP_FAILED ((void *) -1)
4093 #endif
4095 #include <stdio.h>
4096 #include <errno.h>
4098 #if MAP_ANON == 0
4099 #include <fcntl.h>
4100 #endif
4102 #include "coding.h"
4105 /* Memory is allocated in regions which are mapped using mmap(2).
4106 The current implementation lets the system select mapped
4107 addresses; we're not using MAP_FIXED in general, except when
4108 trying to enlarge regions.
4110 Each mapped region starts with a mmap_region structure, the user
4111 area starts after that structure, aligned to MEM_ALIGN.
4113 +-----------------------+
4114 | struct mmap_info + |
4115 | padding |
4116 +-----------------------+
4117 | user data |
4120 +-----------------------+ */
4122 struct mmap_region
4124 /* User-specified size. */
4125 size_t nbytes_specified;
4127 /* Number of bytes mapped */
4128 size_t nbytes_mapped;
4130 /* Pointer to the location holding the address of the memory
4131 allocated with the mmap'd block. The variable actually points
4132 after this structure. */
4133 POINTER_TYPE **var;
4135 /* Next and previous in list of all mmap'd regions. */
4136 struct mmap_region *next, *prev;
4139 /* Doubly-linked list of mmap'd regions. */
4141 static struct mmap_region *mmap_regions;
4143 /* File descriptor for mmap. If we don't have anonymous mapping,
4144 /dev/zero will be opened on it. */
4146 static int mmap_fd;
4148 /* Temporary storage for mmap_set_vars, see there. */
4150 static struct mmap_region *mmap_regions_1;
4151 static int mmap_fd_1;
4153 /* Page size on this system. */
4155 static int mmap_page_size;
4157 /* 1 means mmap has been intialized. */
4159 static int mmap_initialized_p;
4161 /* Value is X rounded up to the next multiple of N. */
4163 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4165 /* Size of mmap_region structure plus padding. */
4167 #define MMAP_REGION_STRUCT_SIZE \
4168 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4170 /* Given a pointer P to the start of the user-visible part of a mapped
4171 region, return a pointer to the start of the region. */
4173 #define MMAP_REGION(P) \
4174 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4176 /* Given a pointer P to the start of a mapped region, return a pointer
4177 to the start of the user-visible part of the region. */
4179 #define MMAP_USER_AREA(P) \
4180 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4182 #define MEM_ALIGN sizeof (double)
4184 /* Function prototypes. */
4186 static int mmap_free_1 P_ ((struct mmap_region *));
4187 static int mmap_enlarge P_ ((struct mmap_region *, int));
4188 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4189 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4190 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4191 static void mmap_free P_ ((POINTER_TYPE **ptr));
4192 static void mmap_init P_ ((void));
4195 /* Return a region overlapping address range START...END, or null if
4196 none. END is not including, i.e. the last byte in the range
4197 is at END - 1. */
4199 static struct mmap_region *
4200 mmap_find (start, end)
4201 POINTER_TYPE *start, *end;
4203 struct mmap_region *r;
4204 char *s = (char *) start, *e = (char *) end;
4206 for (r = mmap_regions; r; r = r->next)
4208 char *rstart = (char *) r;
4209 char *rend = rstart + r->nbytes_mapped;
4211 if (/* First byte of range, i.e. START, in this region? */
4212 (s >= rstart && s < rend)
4213 /* Last byte of range, i.e. END - 1, in this region? */
4214 || (e > rstart && e <= rend)
4215 /* First byte of this region in the range? */
4216 || (rstart >= s && rstart < e)
4217 /* Last byte of this region in the range? */
4218 || (rend > s && rend <= e))
4219 break;
4222 return r;
4226 /* Unmap a region. P is a pointer to the start of the user-araa of
4227 the region. Value is non-zero if successful. */
4229 static int
4230 mmap_free_1 (r)
4231 struct mmap_region *r;
4233 if (r->next)
4234 r->next->prev = r->prev;
4235 if (r->prev)
4236 r->prev->next = r->next;
4237 else
4238 mmap_regions = r->next;
4240 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4242 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4243 return 0;
4246 return 1;
4250 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4251 Value is non-zero if successful. */
4253 static int
4254 mmap_enlarge (r, npages)
4255 struct mmap_region *r;
4256 int npages;
4258 char *region_end = (char *) r + r->nbytes_mapped;
4259 size_t nbytes;
4260 int success = 0;
4262 if (npages < 0)
4264 /* Unmap pages at the end of the region. */
4265 nbytes = - npages * mmap_page_size;
4266 if (munmap (region_end - nbytes, nbytes) == -1)
4267 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4268 else
4270 r->nbytes_mapped -= nbytes;
4271 success = 1;
4274 else if (npages > 0)
4276 struct mmap_region *r2;
4278 nbytes = npages * mmap_page_size;
4280 /* Try to map additional pages at the end of the region. We
4281 cannot do this if the address range is already occupied by
4282 something else because mmap deletes any previous mapping.
4283 I'm not sure this is worth doing, let's see. */
4284 r2 = mmap_find (region_end, region_end + nbytes);
4285 if (r2 == NULL)
4287 POINTER_TYPE *p;
4289 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4290 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4291 if (p == MAP_FAILED)
4292 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4293 else if (p != (POINTER_TYPE *) region_end)
4295 /* Kernels are free to choose a different address. In
4296 that case, unmap what we've mapped above; we have
4297 no use for it. */
4298 if (munmap (p, nbytes) == -1)
4299 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4301 else
4303 r->nbytes_mapped += nbytes;
4304 success = 1;
4309 return success;
4313 /* Set or reset variables holding references to mapped regions. If
4314 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4315 non-zero, set all variables to the start of the user-areas
4316 of mapped regions.
4318 This function is called from Fdump_emacs to ensure that the dumped
4319 Emacs doesn't contain references to memory that won't be mapped
4320 when Emacs starts. */
4322 void
4323 mmap_set_vars (restore_p)
4324 int restore_p;
4326 struct mmap_region *r;
4328 if (restore_p)
4330 mmap_regions = mmap_regions_1;
4331 mmap_fd = mmap_fd_1;
4332 for (r = mmap_regions; r; r = r->next)
4333 *r->var = MMAP_USER_AREA (r);
4335 else
4337 for (r = mmap_regions; r; r = r->next)
4338 *r->var = NULL;
4339 mmap_regions_1 = mmap_regions;
4340 mmap_regions = NULL;
4341 mmap_fd_1 = mmap_fd;
4342 mmap_fd = -1;
4347 /* Allocate a block of storage large enough to hold NBYTES bytes of
4348 data. A pointer to the data is returned in *VAR. VAR is thus the
4349 address of some variable which will use the data area.
4351 The allocation of 0 bytes is valid.
4353 If we can't allocate the necessary memory, set *VAR to null, and
4354 return null. */
4356 static POINTER_TYPE *
4357 mmap_alloc (var, nbytes)
4358 POINTER_TYPE **var;
4359 size_t nbytes;
4361 void *p;
4362 size_t map;
4364 mmap_init ();
4366 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4367 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4368 mmap_fd, 0);
4370 if (p == MAP_FAILED)
4372 if (errno != ENOMEM)
4373 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4374 p = NULL;
4376 else
4378 struct mmap_region *r = (struct mmap_region *) p;
4380 r->nbytes_specified = nbytes;
4381 r->nbytes_mapped = map;
4382 r->var = var;
4383 r->prev = NULL;
4384 r->next = mmap_regions;
4385 if (r->next)
4386 r->next->prev = r;
4387 mmap_regions = r;
4389 p = MMAP_USER_AREA (p);
4392 return *var = p;
4396 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4397 resize it to size NBYTES. Change *VAR to reflect the new block,
4398 and return this value. If more memory cannot be allocated, then
4399 leave *VAR unchanged, and return null. */
4401 static POINTER_TYPE *
4402 mmap_realloc (var, nbytes)
4403 POINTER_TYPE **var;
4404 size_t nbytes;
4406 POINTER_TYPE *result;
4408 mmap_init ();
4410 if (*var == NULL)
4411 result = mmap_alloc (var, nbytes);
4412 else if (nbytes == 0)
4414 mmap_free (var);
4415 result = mmap_alloc (var, nbytes);
4417 else
4419 struct mmap_region *r = MMAP_REGION (*var);
4420 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4422 if (room < nbytes)
4424 /* Must enlarge. */
4425 POINTER_TYPE *old_ptr = *var;
4427 /* Try to map additional pages at the end of the region.
4428 If that fails, allocate a new region, copy data
4429 from the old region, then free it. */
4430 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4431 / mmap_page_size)))
4433 r->nbytes_specified = nbytes;
4434 *var = result = old_ptr;
4436 else if (mmap_alloc (var, nbytes))
4438 bcopy (old_ptr, *var, r->nbytes_specified);
4439 mmap_free_1 (MMAP_REGION (old_ptr));
4440 result = *var;
4441 r = MMAP_REGION (result);
4442 r->nbytes_specified = nbytes;
4444 else
4446 *var = old_ptr;
4447 result = NULL;
4450 else if (room - nbytes >= mmap_page_size)
4452 /* Shrinking by at least a page. Let's give some
4453 memory back to the system. */
4454 mmap_enlarge (r, - (room - nbytes) / mmap_page_size);
4455 result = *var;
4456 r->nbytes_specified = nbytes;
4458 else
4460 /* Leave it alone. */
4461 result = *var;
4462 r->nbytes_specified = nbytes;
4466 return result;
4470 /* Free a block of relocatable storage whose data is pointed to by
4471 PTR. Store 0 in *PTR to show there's no block allocated. */
4473 static void
4474 mmap_free (var)
4475 POINTER_TYPE **var;
4477 mmap_init ();
4479 if (*var)
4481 mmap_free_1 (MMAP_REGION (*var));
4482 *var = NULL;
4487 /* Perform necessary intializations for the use of mmap. */
4489 static void
4490 mmap_init ()
4492 #if MAP_ANON == 0
4493 /* The value of mmap_fd is initially 0 in temacs, and -1
4494 in a dumped Emacs. */
4495 if (mmap_fd <= 0)
4497 /* No anonymous mmap -- we need the file descriptor. */
4498 mmap_fd = open ("/dev/zero", O_RDONLY);
4499 if (mmap_fd == -1)
4500 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4502 #endif /* MAP_ANON == 0 */
4504 if (mmap_initialized_p)
4505 return;
4506 mmap_initialized_p = 1;
4508 #if MAP_ANON != 0
4509 mmap_fd = -1;
4510 #endif
4512 mmap_page_size = getpagesize ();
4515 #endif /* USE_MMAP_FOR_BUFFERS */
4519 /***********************************************************************
4520 Buffer-text Allocation
4521 ***********************************************************************/
4523 #ifdef REL_ALLOC
4524 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4525 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4526 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4527 #endif /* REL_ALLOC */
4530 /* Allocate NBYTES bytes for buffer B's text buffer. */
4532 static void
4533 alloc_buffer_text (b, nbytes)
4534 struct buffer *b;
4535 size_t nbytes;
4537 POINTER_TYPE *p;
4539 BLOCK_INPUT;
4540 #if defined USE_MMAP_FOR_BUFFERS
4541 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4542 #elif defined REL_ALLOC
4543 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4544 #else
4545 p = xmalloc (nbytes);
4546 #endif
4548 if (p == NULL)
4550 UNBLOCK_INPUT;
4551 memory_full ();
4554 b->text->beg = (unsigned char *) p;
4555 UNBLOCK_INPUT;
4558 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4559 shrink it. */
4561 void
4562 enlarge_buffer_text (b, delta)
4563 struct buffer *b;
4564 int delta;
4566 POINTER_TYPE *p;
4567 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4568 + delta);
4569 BLOCK_INPUT;
4570 #if defined USE_MMAP_FOR_BUFFERS
4571 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4572 #elif defined REL_ALLOC
4573 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4574 #else
4575 p = xrealloc (b->text->beg, nbytes);
4576 #endif
4578 if (p == NULL)
4580 UNBLOCK_INPUT;
4581 memory_full ();
4584 BUF_BEG_ADDR (b) = (unsigned char *) p;
4585 UNBLOCK_INPUT;
4589 /* Free buffer B's text buffer. */
4591 static void
4592 free_buffer_text (b)
4593 struct buffer *b;
4595 BLOCK_INPUT;
4597 #if defined USE_MMAP_FOR_BUFFERS
4598 mmap_free ((POINTER_TYPE **) &b->text->beg);
4599 #elif defined REL_ALLOC
4600 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4601 #else
4602 xfree (b->text->beg);
4603 #endif
4605 BUF_BEG_ADDR (b) = NULL;
4606 UNBLOCK_INPUT;
4611 /***********************************************************************
4612 Initialization
4613 ***********************************************************************/
4615 void
4616 init_buffer_once ()
4618 int idx;
4620 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4622 /* Make sure all markable slots in buffer_defaults
4623 are initialized reasonably, so mark_buffer won't choke. */
4624 reset_buffer (&buffer_defaults);
4625 reset_buffer_local_variables (&buffer_defaults, 1);
4626 reset_buffer (&buffer_local_symbols);
4627 reset_buffer_local_variables (&buffer_local_symbols, 1);
4628 /* Prevent GC from getting confused. */
4629 buffer_defaults.text = &buffer_defaults.own_text;
4630 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4631 BUF_INTERVALS (&buffer_defaults) = 0;
4632 BUF_INTERVALS (&buffer_local_symbols) = 0;
4633 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4634 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4636 /* Set up the default values of various buffer slots. */
4637 /* Must do these before making the first buffer! */
4639 /* real setup is done in bindings.el */
4640 buffer_defaults.mode_line_format = build_string ("%-");
4641 buffer_defaults.header_line_format = Qnil;
4642 buffer_defaults.abbrev_mode = Qnil;
4643 buffer_defaults.overwrite_mode = Qnil;
4644 buffer_defaults.case_fold_search = Qt;
4645 buffer_defaults.auto_fill_function = Qnil;
4646 buffer_defaults.selective_display = Qnil;
4647 #ifndef old
4648 buffer_defaults.selective_display_ellipses = Qt;
4649 #endif
4650 buffer_defaults.abbrev_table = Qnil;
4651 buffer_defaults.display_table = Qnil;
4652 buffer_defaults.undo_list = Qnil;
4653 buffer_defaults.mark_active = Qnil;
4654 buffer_defaults.file_format = Qnil;
4655 buffer_defaults.overlays_before = Qnil;
4656 buffer_defaults.overlays_after = Qnil;
4657 XSETFASTINT (buffer_defaults.overlay_center, BEG);
4659 XSETFASTINT (buffer_defaults.tab_width, 8);
4660 buffer_defaults.truncate_lines = Qnil;
4661 buffer_defaults.ctl_arrow = Qt;
4662 buffer_defaults.direction_reversed = Qnil;
4663 buffer_defaults.cursor_type = Qt;
4664 buffer_defaults.extra_line_spacing = Qnil;
4666 #ifdef DOS_NT
4667 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4668 #endif
4669 buffer_defaults.enable_multibyte_characters = Qt;
4670 buffer_defaults.buffer_file_coding_system = Qnil;
4671 XSETFASTINT (buffer_defaults.fill_column, 70);
4672 XSETFASTINT (buffer_defaults.left_margin, 0);
4673 buffer_defaults.cache_long_line_scans = Qnil;
4674 buffer_defaults.file_truename = Qnil;
4675 XSETFASTINT (buffer_defaults.display_count, 0);
4676 buffer_defaults.indicate_empty_lines = Qnil;
4677 buffer_defaults.scroll_up_aggressively = Qnil;
4678 buffer_defaults.scroll_down_aggressively = Qnil;
4679 buffer_defaults.display_time = Qnil;
4681 /* Assign the local-flags to the slots that have default values.
4682 The local flag is a bit that is used in the buffer
4683 to say that it has its own local value for the slot.
4684 The local flag bits are in the local_var_flags slot of the buffer. */
4686 /* Nothing can work if this isn't true */
4687 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4689 /* 0 means not a lisp var, -1 means always local, else mask */
4690 bzero (&buffer_local_flags, sizeof buffer_local_flags);
4691 XSETINT (buffer_local_flags.filename, -1);
4692 XSETINT (buffer_local_flags.directory, -1);
4693 XSETINT (buffer_local_flags.backed_up, -1);
4694 XSETINT (buffer_local_flags.save_length, -1);
4695 XSETINT (buffer_local_flags.auto_save_file_name, -1);
4696 XSETINT (buffer_local_flags.read_only, -1);
4697 XSETINT (buffer_local_flags.major_mode, -1);
4698 XSETINT (buffer_local_flags.mode_name, -1);
4699 XSETINT (buffer_local_flags.undo_list, -1);
4700 XSETINT (buffer_local_flags.mark_active, -1);
4701 XSETINT (buffer_local_flags.point_before_scroll, -1);
4702 XSETINT (buffer_local_flags.file_truename, -1);
4703 XSETINT (buffer_local_flags.invisibility_spec, -1);
4704 XSETINT (buffer_local_flags.file_format, -1);
4705 XSETINT (buffer_local_flags.display_count, -1);
4706 XSETINT (buffer_local_flags.display_time, -1);
4707 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
4709 idx = 1;
4710 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
4711 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
4712 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
4713 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
4714 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
4715 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
4716 #ifndef old
4717 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
4718 #endif
4719 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
4720 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
4721 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
4722 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
4723 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
4724 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
4725 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
4726 #ifdef DOS_NT
4727 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
4728 /* Make this one a permanent local. */
4729 buffer_permanent_local_flags[idx++] = 1;
4730 #endif
4731 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
4732 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
4733 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
4734 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
4735 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
4736 /* Make this one a permanent local. */
4737 buffer_permanent_local_flags[idx++] = 1;
4738 XSETFASTINT (buffer_local_flags.left_margin_width, idx); ++idx;
4739 XSETFASTINT (buffer_local_flags.right_margin_width, idx); ++idx;
4740 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
4741 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
4742 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
4743 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
4744 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
4745 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
4747 /* Need more room? */
4748 if (idx >= MAX_PER_BUFFER_VARS)
4749 abort ();
4750 last_per_buffer_idx = idx;
4752 Vbuffer_alist = Qnil;
4753 current_buffer = 0;
4754 all_buffers = 0;
4756 QSFundamental = build_string ("Fundamental");
4758 Qfundamental_mode = intern ("fundamental-mode");
4759 buffer_defaults.major_mode = Qfundamental_mode;
4761 Qmode_class = intern ("mode-class");
4763 Qprotected_field = intern ("protected-field");
4765 Qpermanent_local = intern ("permanent-local");
4767 Qkill_buffer_hook = intern ("kill-buffer-hook");
4769 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
4771 /* super-magic invisible buffer */
4772 Vbuffer_alist = Qnil;
4774 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
4776 inhibit_modification_hooks = 0;
4779 void
4780 init_buffer ()
4782 char buf[MAXPATHLEN + 1];
4783 char *pwd;
4784 struct stat dotstat, pwdstat;
4785 Lisp_Object temp;
4786 int rc;
4788 #ifdef USE_MMAP_FOR_BUFFERS
4790 /* When using the ralloc implementation based on mmap(2), buffer
4791 text pointers will have been set to null in the dumped Emacs.
4792 Map new memory. */
4793 struct buffer *b;
4795 for (b = all_buffers; b; b = b->next)
4796 if (b->text->beg == NULL)
4797 enlarge_buffer_text (b, 0);
4799 #endif /* USE_MMAP_FOR_BUFFERS */
4801 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
4802 if (NILP (buffer_defaults.enable_multibyte_characters))
4803 Fset_buffer_multibyte (Qnil);
4805 /* If PWD is accurate, use it instead of calling getwd. This is faster
4806 when PWD is right, and may avoid a fatal error. */
4807 if ((pwd = getenv ("PWD")) != 0
4808 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
4809 && stat (pwd, &pwdstat) == 0
4810 && stat (".", &dotstat) == 0
4811 && dotstat.st_ino == pwdstat.st_ino
4812 && dotstat.st_dev == pwdstat.st_dev
4813 && strlen (pwd) < MAXPATHLEN)
4814 strcpy (buf, pwd);
4815 #ifdef HAVE_GETCWD
4816 else if (getcwd (buf, MAXPATHLEN+1) == 0)
4817 fatal ("`getcwd' failed: %s\n", strerror (errno));
4818 #else
4819 else if (getwd (buf) == 0)
4820 fatal ("`getwd' failed: %s\n", buf);
4821 #endif
4823 #ifndef VMS
4824 /* Maybe this should really use some standard subroutine
4825 whose definition is filename syntax dependent. */
4826 rc = strlen (buf);
4827 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
4829 buf[rc] = DIRECTORY_SEP;
4830 buf[rc + 1] = '\0';
4832 #endif /* not VMS */
4834 current_buffer->directory = build_string (buf);
4836 /* Add /: to the front of the name
4837 if it would otherwise be treated as magic. */
4838 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
4839 if (! NILP (temp)
4840 /* If the default dir is just /, TEMP is non-nil
4841 because of the ange-ftp completion handler.
4842 However, it is not necessary to turn / into /:/.
4843 So avoid doing that. */
4844 && strcmp ("/", XSTRING (current_buffer->directory)->data))
4845 current_buffer->directory
4846 = concat2 (build_string ("/:"), current_buffer->directory);
4848 temp = get_minibuffer (0);
4849 XBUFFER (temp)->directory = current_buffer->directory;
4852 /* initialize the buffer routines */
4853 void
4854 syms_of_buffer ()
4856 staticpro (&last_overlay_modification_hooks);
4857 last_overlay_modification_hooks
4858 = Fmake_vector (make_number (10), Qnil);
4860 staticpro (&Vbuffer_defaults);
4861 staticpro (&Vbuffer_local_symbols);
4862 staticpro (&Qfundamental_mode);
4863 staticpro (&Qmode_class);
4864 staticpro (&QSFundamental);
4865 staticpro (&Vbuffer_alist);
4866 staticpro (&Qprotected_field);
4867 staticpro (&Qpermanent_local);
4868 staticpro (&Qkill_buffer_hook);
4869 Qoverlayp = intern ("overlayp");
4870 staticpro (&Qoverlayp);
4871 Qevaporate = intern ("evaporate");
4872 staticpro (&Qevaporate);
4873 Qmodification_hooks = intern ("modification-hooks");
4874 staticpro (&Qmodification_hooks);
4875 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
4876 staticpro (&Qinsert_in_front_hooks);
4877 Qinsert_behind_hooks = intern ("insert-behind-hooks");
4878 staticpro (&Qinsert_behind_hooks);
4879 Qget_file_buffer = intern ("get-file-buffer");
4880 staticpro (&Qget_file_buffer);
4881 Qpriority = intern ("priority");
4882 staticpro (&Qpriority);
4883 Qwindow = intern ("window");
4884 staticpro (&Qwindow);
4885 Qbefore_string = intern ("before-string");
4886 staticpro (&Qbefore_string);
4887 Qafter_string = intern ("after-string");
4888 staticpro (&Qafter_string);
4889 Qfirst_change_hook = intern ("first-change-hook");
4890 staticpro (&Qfirst_change_hook);
4891 Qbefore_change_functions = intern ("before-change-functions");
4892 staticpro (&Qbefore_change_functions);
4893 Qafter_change_functions = intern ("after-change-functions");
4894 staticpro (&Qafter_change_functions);
4896 Fput (Qprotected_field, Qerror_conditions,
4897 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
4898 Fput (Qprotected_field, Qerror_message,
4899 build_string ("Attempt to modify a protected field"));
4901 /* All these use DEFVAR_LISP_NOPRO because the slots in
4902 buffer_defaults will all be marked via Vbuffer_defaults. */
4904 DEFVAR_LISP_NOPRO ("default-mode-line-format",
4905 &buffer_defaults.mode_line_format,
4906 "Default value of `mode-line-format' for buffers that don't override it.\n\
4907 This is the same as (default-value 'mode-line-format).");
4909 DEFVAR_LISP_NOPRO ("default-header-line-format",
4910 &buffer_defaults.header_line_format,
4911 "Default value of `header-line-format' for buffers that don't override it.\n\
4912 This is the same as (default-value 'header-line-format).");
4914 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
4915 "Default value of `cursor-type' for buffers that don't override it.\n\
4916 This is the same as (default-value 'cursor-type).");
4918 DEFVAR_LISP_NOPRO ("default-line-spacing",
4919 &buffer_defaults.extra_line_spacing,
4920 "Default value of `line-spacing' for buffers that don't override it.\n\
4921 This is the same as (default-value 'line-spacing).");
4923 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
4924 &buffer_defaults.abbrev_mode,
4925 "Default value of `abbrev-mode' for buffers that do not override it.\n\
4926 This is the same as (default-value 'abbrev-mode).");
4928 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
4929 &buffer_defaults.ctl_arrow,
4930 "Default value of `ctl-arrow' for buffers that do not override it.\n\
4931 This is the same as (default-value 'ctl-arrow).");
4933 DEFVAR_LISP_NOPRO ("default-direction-reversed",
4934 &buffer_defaults.direction_reversed,
4935 "Default value of `direction_reversed' for buffers that do not override it.\n\
4936 This is the same as (default-value 'direction-reversed).");
4938 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
4939 &buffer_defaults.enable_multibyte_characters,
4940 "*Default value of `enable-multibyte-characters' for buffers not overriding it.\n\
4941 This is the same as (default-value 'enable-multibyte-characters).");
4943 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
4944 &buffer_defaults.buffer_file_coding_system,
4945 "Default value of `buffer-file-coding-system' for buffers not overriding it.\n\
4946 This is the same as (default-value 'buffer-file-coding-system).");
4948 DEFVAR_LISP_NOPRO ("default-truncate-lines",
4949 &buffer_defaults.truncate_lines,
4950 "Default value of `truncate-lines' for buffers that do not override it.\n\
4951 This is the same as (default-value 'truncate-lines).");
4953 DEFVAR_LISP_NOPRO ("default-fill-column",
4954 &buffer_defaults.fill_column,
4955 "Default value of `fill-column' for buffers that do not override it.\n\
4956 This is the same as (default-value 'fill-column).");
4958 DEFVAR_LISP_NOPRO ("default-left-margin",
4959 &buffer_defaults.left_margin,
4960 "Default value of `left-margin' for buffers that do not override it.\n\
4961 This is the same as (default-value 'left-margin).");
4963 DEFVAR_LISP_NOPRO ("default-tab-width",
4964 &buffer_defaults.tab_width,
4965 "Default value of `tab-width' for buffers that do not override it.\n\
4966 This is the same as (default-value 'tab-width).");
4968 DEFVAR_LISP_NOPRO ("default-case-fold-search",
4969 &buffer_defaults.case_fold_search,
4970 "Default value of `case-fold-search' for buffers that don't override it.\n\
4971 This is the same as (default-value 'case-fold-search).");
4973 #ifdef DOS_NT
4974 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
4975 &buffer_defaults.buffer_file_type,
4976 "Default file type for buffers that do not override it.\n\
4977 This is the same as (default-value 'buffer-file-type).\n\
4978 The file type is nil for text, t for binary.");
4979 #endif
4981 DEFVAR_LISP_NOPRO ("default-left-margin-width",
4982 &buffer_defaults.left_margin_width,
4983 "Default value of `left-margin-width' for buffers that don't override it.\n\
4984 This is the same as (default-value 'left-margin-width).");
4986 DEFVAR_LISP_NOPRO ("default-right-margin-width",
4987 &buffer_defaults.right_margin_width,
4988 "Default value of `right_margin_width' for buffers that don't override it.\n\
4989 This is the same as (default-value 'right-margin-width).");
4991 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
4992 &buffer_defaults.indicate_empty_lines,
4993 "Default value of `indicate-empty-lines' for buffers that don't override it.\n\
4994 This is the same as (default-value 'indicate-empty-lines).");
4996 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
4997 &buffer_defaults.scroll_up_aggressively,
4998 "Default value of `scroll-up-aggressively' for buffers that\n\
4999 don't override it. This is the same as (default-value\n\
5000 'scroll-up-aggressively).");
5002 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5003 &buffer_defaults.scroll_down_aggressively,
5004 "Default value of `scroll-down-aggressively' for buffers that\n\
5005 don't override it. This is the same as (default-value\n\
5006 'scroll-down-aggressively).");
5008 DEFVAR_PER_BUFFER ("header-line-format",
5009 &current_buffer->header_line_format,
5010 Qnil,
5011 "Analogous to `mode-line-format', but for a mode line displayed\n\
5012 at the top of windows.");
5014 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5015 Qnil, 0);
5017 /* This doc string is too long for cpp; cpp dies if it isn't in a comment.
5018 But make-docfile finds it!
5019 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5020 Qnil,
5021 "Template for displaying mode line for current buffer.\n\
5022 Each buffer has its own value of this variable.\n\
5023 Value may be nil, a string, a symbol or a list or cons cell.\n\
5024 A value of nil means don't display a mode line.\n\
5025 For a symbol, its value is used (but it is ignored if t or nil).\n\
5026 A string appearing directly as the value of a symbol is processed verbatim\n\
5027 in that the %-constructs below are not recognized.\n\
5028 For a list of the form `(:eval FORM)', FORM is evaluated and the result\n\
5029 is used as a mode line element.\n\
5030 For a list whose car is a symbol, the symbol's value is taken,\n\
5031 and if that is non-nil, the cadr of the list is processed recursively.\n\
5032 Otherwise, the caddr of the list (if there is one) is processed.\n\
5033 For a list whose car is a string or list, each element is processed\n\
5034 recursively and the results are effectively concatenated.\n\
5035 For a list whose car is an integer, the cdr of the list is processed\n\
5036 and padded (if the number is positive) or truncated (if negative)\n\
5037 to the width specified by that number.\n\
5038 A string is printed verbatim in the mode line except for %-constructs:\n\
5039 (%-constructs are allowed when the string is the entire mode-line-format\n\
5040 or when it is found in a cons-cell or a list)\n\
5041 %b -- print buffer name. %f -- print visited file name.\n\
5042 %F -- print frame name.\n\
5043 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.\n\
5044 %& is like %*, but ignore read-only-ness.\n\
5045 % means buffer is read-only and * means it is modified.\n\
5046 For a modified read-only buffer, %* gives % and %+ gives *.\n\
5047 %s -- print process status. %l -- print the current line number.\n\
5048 %c -- print the current column number (this makes editing slower).\n\
5049 To make the column number update correctly in all cases,\n\
5050 `column-number-mode' must be non-nil.\n\
5051 %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
5052 %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
5053 or print Bottom or All.\n\
5054 %m -- print the mode name.\n\
5055 %n -- print Narrow if appropriate.\n\
5056 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.\n\
5057 %Z -- like %z, but including the end-of-line format.\n\
5058 %[ -- print one [ for each recursive editing level. %] similar.\n\
5059 %% -- print %. %- -- print infinitely many dashes.\n\
5060 Decimal digits after the % specify field width to which to pad.");
5063 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5064 "*Major mode for new buffers. Defaults to `fundamental-mode'.\n\
5065 nil here means use current buffer's major mode.");
5067 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5068 make_number (Lisp_Symbol),
5069 "Symbol for current buffer's major mode.");
5071 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5072 make_number (Lisp_String),
5073 "Pretty name of current buffer's major mode (a string).");
5075 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5076 "Non-nil turns on automatic expansion of abbrevs as they are inserted.\n\
5077 Automatically becomes buffer-local when set in any fashion.");
5079 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5080 Qnil,
5081 "*Non-nil if searches and matches should ignore case.\n\
5082 Automatically becomes buffer-local when set in any fashion.");
5084 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5085 make_number (Lisp_Int),
5086 "*Column beyond which automatic line-wrapping should happen.\n\
5087 Automatically becomes buffer-local when set in any fashion.");
5089 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5090 make_number (Lisp_Int),
5091 "*Column for the default indent-line-function to indent to.\n\
5092 Linefeed indents to this column in Fundamental mode.\n\
5093 Automatically becomes buffer-local when set in any fashion.");
5095 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5096 make_number (Lisp_Int),
5097 "*Distance between tab stops (for display of tab characters), in columns.\n\
5098 Automatically becomes buffer-local when set in any fashion.");
5100 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5101 "*Non-nil means display control chars with uparrow.\n\
5102 A value of nil means use backslash and octal digits.\n\
5103 Automatically becomes buffer-local when set in any fashion.\n\
5104 This variable does not apply to characters whose display is specified\n\
5105 in the current display table (if there is one).");
5107 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5108 &current_buffer->enable_multibyte_characters,
5109 make_number (-1),
5110 "Non-nil means the buffer contents are regarded as multi-byte characters.\n\
5111 Otherwise they are regarded as unibyte. This affects the display,\n\
5112 file I/O and the behavior of various editing commands.\n\
5114 This variable is buffer-local but you cannot set it directly;\n\
5115 use the function `set-buffer-multibyte' to change a buffer's representation.\n\
5116 Changing its default value with `setq-default' is supported.\n\
5117 See also variable `default-enable-multibyte-characters' and Info node\n\
5118 `(elisp)Text Representations'.");
5120 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5121 &current_buffer->buffer_file_coding_system, Qnil,
5122 "Coding system to be used for encoding the buffer contents on saving.\n\
5123 This variable applies to saving the buffer, and also to `write-region'\n\
5124 and other functions that use `write-region'.\n\
5125 It does not apply to sending output to subprocesses, however.\n\
5127 If this is nil, the buffer is saved without any code conversion\n\
5128 unless some coding system is specified in `file-coding-system-alist'\n\
5129 for the buffer file.\n\
5131 The variable `coding-system-for-write', if non-nil, overrides this variable.\n\
5133 This variable is never applied to a way of decoding\n\
5134 a file while reading it.");
5136 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5137 Qnil,
5138 "*Non-nil means lines in the buffer are displayed right to left.");
5140 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5141 "*Non-nil means do not display continuation lines;\n\
5142 give each line of text one screen line.\n\
5143 Automatically becomes buffer-local when set in any fashion.\n\
5145 Note that this is overridden by the variable\n\
5146 `truncate-partial-width-windows' if that variable is non-nil\n\
5147 and this buffer is not full-frame width.");
5149 #ifdef DOS_NT
5150 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5151 Qnil,
5152 "Non-nil if the visited file is a binary file.\n\
5153 This variable is meaningful on MS-DOG and Windows NT.\n\
5154 On those systems, it is automatically local in every buffer.\n\
5155 On other systems, this variable is normally always nil.");
5156 #endif
5158 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5159 make_number (Lisp_String),
5160 "Name of default directory of current buffer. Should end with slash.\n\
5161 Each buffer has its own value of this variable.");
5163 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5164 Qnil,
5165 "Function called (if non-nil) to perform auto-fill.\n\
5166 It is called after self-inserting any character specified in\n\
5167 the `auto-fill-chars' table.\n\
5168 Each buffer has its own value of this variable.\n\
5169 NOTE: This variable is not a hook;\n\
5170 its value may not be a list of functions.");
5172 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5173 make_number (Lisp_String),
5174 "Name of file visited in current buffer, or nil if not visiting a file.\n\
5175 Each buffer has its own value of this variable.");
5177 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5178 make_number (Lisp_String),
5179 "Abbreviated truename of file visited in current buffer, or nil if none.\n\
5180 The truename of a file is calculated by `file-truename'\n\
5181 and then abbreviated with `abbreviate-file-name'.\n\
5182 Each buffer has its own value of this variable.");
5184 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5185 &current_buffer->auto_save_file_name,
5186 make_number (Lisp_String),
5187 "Name of file for auto-saving current buffer,\n\
5188 or nil if buffer should not be auto-saved.\n\
5189 Each buffer has its own value of this variable.");
5191 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5192 "Non-nil if this buffer is read-only.\n\
5193 Each buffer has its own value of this variable.");
5195 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5196 "Non-nil if this buffer's file has been backed up.\n\
5197 Backing up is done before the first time the file is saved.\n\
5198 Each buffer has its own value of this variable.");
5200 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5201 make_number (Lisp_Int),
5202 "Length of current buffer when last read in, saved or auto-saved.\n\
5203 0 initially.\n\
5204 Each buffer has its own value of this variable.");
5206 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5207 Qnil,
5208 "Non-nil enables selective display:\n\
5209 Integer N as value means display only lines\n\
5210 that start with less than n columns of space.\n\
5211 A value of t means, after a ^M, all the rest of the line is invisible.\n\
5212 Then ^M's in the file are written into files as newlines.\n\n\
5213 Automatically becomes buffer-local when set in any fashion.");
5215 #ifndef old
5216 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5217 &current_buffer->selective_display_ellipses,
5218 Qnil,
5219 "t means display ... on previous line when a line is invisible.\n\
5220 Automatically becomes buffer-local when set in any fashion.");
5221 #endif
5223 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5224 "Non-nil if self-insertion should replace existing text.\n\
5225 The value should be one of `overwrite-mode-textual',\n\
5226 `overwrite-mode-binary', or nil.\n\
5227 If it is `overwrite-mode-textual', self-insertion still\n\
5228 inserts at the end of a line, and inserts when point is before a tab,\n\
5229 until the tab is filled in.\n\
5230 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.\n\
5231 Automatically becomes buffer-local when set in any fashion.");
5233 #if 0 /* The doc string is too long for some compilers,
5234 but make-docfile can find it in this comment. */
5235 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5236 Qnil,
5237 "Display table that controls display of the contents of current buffer.\n\
5238 Automatically becomes buffer-local when set in any fashion.\n\
5239 The display table is a char-table created with `make-display-table'.\n\
5240 The ordinary char-table elements control how to display each possible text\n\
5241 character. Each value should be a vector of characters or nil;\n\
5242 nil means display the character in the default fashion.\n\
5243 There are six extra slots to control the display of\n\
5244 the end of a truncated screen line (extra-slot 0, a single character);\n\
5245 the end of a continued line (extra-slot 1, a single character);\n\
5246 the escape character used to display character codes in octal\n\
5247 (extra-slot 2, a single character);\n\
5248 the character used as an arrow for control characters (extra-slot 3,\n\
5249 a single character);\n\
5250 the decoration indicating the presence of invisible lines (extra-slot 4,\n\
5251 a vector of characters);\n\
5252 the character used to draw the border between side-by-side windows\n\
5253 (extra-slot 5, a single character).\n\
5254 See also the functions `display-table-slot' and `set-display-table-slot'.\n\
5255 If this variable is nil, the value of `standard-display-table' is used.\n\
5256 Each window can have its own, overriding display table.");
5257 #endif
5258 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5259 Qnil, 0);
5261 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_width,
5262 Qnil,
5263 "*Width of left marginal area for display of a buffer.\n\
5264 Automatically becomes buffer-local when set in any fashion.\n\
5265 A value of nil means no marginal area.");
5267 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_width,
5268 Qnil,
5269 "*Width of right marginal area for display of a buffer.\n\
5270 Automatically becomes buffer-local when set in any fashion.\n\
5271 A value of nil means no marginal area.");
5273 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5274 &current_buffer->indicate_empty_lines, Qnil,
5275 "*Visually indicate empty lines after the buffer end.\n\
5276 If non-nil, a bitmap is displayed in the left fringe of a window on\n\
5277 window-systems.\n\
5278 Automatically becomes buffer-local when set in any fashion.\n");
5280 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5281 &current_buffer->scroll_up_aggressively, Qnil,
5282 "*If a number, scroll display up aggressively.\n\
5283 If scrolling a window because point is above the window start, choose\n\
5284 a new window start so that point ends up that fraction of the window's\n\
5285 height from the top of the window.\n\
5286 Automatically becomes buffer-local when set in any fashion.");
5288 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5289 &current_buffer->scroll_down_aggressively, Qnil,
5290 "*If a number, scroll display down aggressively.\n\
5291 If scrolling a window because point is below the window end, choose\n\
5292 a new window start so that point ends up that fraction of the window's\n\
5293 height from the bottom of the window.\n\
5294 Automatically becomes buffer-local when set in any fashion.");
5296 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5297 "Don't ask.");
5300 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5301 "List of functions to call before each text change.\n\
5302 Two arguments are passed to each function: the positions of\n\
5303 the beginning and end of the range of old text to be changed.\n\
5304 \(For an insertion, the beginning and end are at the same place.)\n\
5305 No information is given about the length of the text after the change.\n\
5307 Buffer changes made while executing the `before-change-functions'\n\
5308 don't call any before-change or after-change functions.\n\
5309 That's because these variables are temporarily set to nil.\n\
5310 As a result, a hook function cannot straightforwardly alter the value of\n\
5311 these variables. See the Emacs Lisp manual for a way of\n\
5312 accomplishing an equivalent result by using other variables.\n\
5314 If an unhandled error happens in running these functions,\n\
5315 the variable's value remains nil. That prevents the error\n\
5316 from happening repeatedly and making Emacs nonfunctional.");
5317 Vbefore_change_functions = Qnil;
5319 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5320 "List of function to call after each text change.\n\
5321 Three arguments are passed to each function: the positions of\n\
5322 the beginning and end of the range of changed text,\n\
5323 and the length in bytes of the pre-change text replaced by that range.\n\
5324 \(For an insertion, the pre-change length is zero;\n\
5325 for a deletion, that length is the number of bytes deleted,\n\
5326 and the post-change beginning and end are at the same place.)\n\
5328 Buffer changes made while executing the `after-change-functions'\n\
5329 don't call any before-change or after-change functions.\n\
5330 That's because these variables are temporarily set to nil.\n\
5331 As a result, a hook function cannot straightforwardly alter the value of\n\
5332 these variables. See the Emacs Lisp manual for a way of\n\
5333 accomplishing an equivalent result by using other variables.\n\
5335 If an unhandled error happens in running these functions,\n\
5336 the variable's value remains nil. That prevents the error\n\
5337 from happening repeatedly and making Emacs nonfunctional.");
5338 Vafter_change_functions = Qnil;
5340 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5341 "A list of functions to call before changing a buffer which is unmodified.\n\
5342 The functions are run using the `run-hooks' function.");
5343 Vfirst_change_hook = Qnil;
5345 #if 0 /* The doc string is too long for some compilers,
5346 but make-docfile can find it in this comment. */
5347 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5348 "List of undo entries in current buffer.\n\
5349 This variable is always local in all buffers.\n\
5350 Recent changes come first; older changes follow newer.\n\
5352 An entry (BEG . END) represents an insertion which begins at\n\
5353 position BEG and ends at position END.\n\
5355 An entry (TEXT . POSITION) represents the deletion of the string TEXT\n\
5356 from (abs POSITION). If POSITION is positive, point was at the front\n\
5357 of the text being deleted; if negative, point was at the end.\n\
5359 An entry (t HIGH . LOW) indicates that the buffer previously had\n\
5360 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions\n\
5361 of the visited file's modification time, as of that time. If the\n\
5362 modification time of the most recent save is different, this entry is\n\
5363 obsolete.\n\
5365 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property\n\
5366 was modified between BEG and END. PROPERTY is the property name,\n\
5367 and VALUE is the old value.\n\
5369 An entry (MARKER . DISTANCE) indicates that the marker MARKER\n\
5370 was adjusted in position by the offset DISTANCE (an integer).\n\
5372 An entry of the form POSITION indicates that point was at the buffer\n\
5373 location given by the integer. Undoing an entry of this form places\n\
5374 point at POSITION.\n\
5376 nil marks undo boundaries. The undo command treats the changes\n\
5377 between two undo boundaries as a single step to be undone.\n\
5379 If the value of the variable is t, undo information is not recorded.");
5380 #endif
5381 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5384 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5385 "Non-nil means the mark and region are currently active in this buffer.\n\
5386 Automatically local in all buffers.");
5388 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5389 "Non-nil means that Emacs should use caches to handle long lines more quickly.\n\
5390 This variable is buffer-local, in all buffers.\n\
5392 Normally, the line-motion functions work by scanning the buffer for\n\
5393 newlines. Columnar operations (like move-to-column and\n\
5394 compute-motion) also work by scanning the buffer, summing character\n\
5395 widths as they go. This works well for ordinary text, but if the\n\
5396 buffer's lines are very long (say, more than 500 characters), these\n\
5397 motion functions will take longer to execute. Emacs may also take\n\
5398 longer to update the display.\n\
5400 If cache-long-line-scans is non-nil, these motion functions cache the\n\
5401 results of their scans, and consult the cache to avoid rescanning\n\
5402 regions of the buffer until the text is modified. The caches are most\n\
5403 beneficial when they prevent the most searching---that is, when the\n\
5404 buffer contains long lines and large regions of characters with the\n\
5405 same, fixed screen width.\n\
5407 When cache-long-line-scans is non-nil, processing short lines will\n\
5408 become slightly slower (because of the overhead of consulting the\n\
5409 cache), and the caches will use memory roughly proportional to the\n\
5410 number of newlines and characters whose screen width varies.\n\
5412 The caches require no explicit maintenance; their accuracy is\n\
5413 maintained internally by the Emacs primitives. Enabling or disabling\n\
5414 the cache should not affect the behavior of any of the motion\n\
5415 functions; it should only affect their performance.");
5417 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5418 "Value of point before the last series of scroll operations, or nil.\n\
5419 This variable is always local in all buffers.");
5421 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5422 "List of formats to use when saving this buffer.\n\
5423 This variable is always local in all buffers.\n\
5424 Formats are defined by `format-alist'. This variable is\n\
5425 set when a file is visited. Automatically local in all buffers.");
5427 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5428 &current_buffer->invisibility_spec, Qnil,
5429 "Invisibility spec of this buffer.\n\
5430 This variable is always local in all buffers.\n\
5431 The default is t, which means that text is invisible\n\
5432 if it has a non-nil `invisible' property.\n\
5433 If the value is a list, a text character is invisible if its `invisible'\n\
5434 property is an element in that list.\n\
5435 If an element is a cons cell of the form (PROP . ELLIPSIS),\n\
5436 then characters with property value PROP are invisible,\n\
5437 and they have an ellipsis as well if ELLIPSIS is non-nil.");
5439 DEFVAR_PER_BUFFER ("buffer-display-count",
5440 &current_buffer->display_count, Qnil,
5441 "A number incremented each time this buffer is displayed in a window.\n\
5442 This variable is always local in all buffers.\n\
5443 The function `set-window-buffer increments it.");
5445 DEFVAR_PER_BUFFER ("buffer-display-time",
5446 &current_buffer->display_time, Qnil,
5447 "Time stamp updated each time this buffer is displayed in a window.\n\
5448 This variable is always local in all buffers.\n\
5449 The function `set-window-buffer' updates this variable\n\
5450 to the value obtained by calling `current-time'.\n\
5451 If the buffer has never been shown in a window, the value is nil.");
5453 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5454 "*Non-nil means deactivate the mark when the buffer contents change.\n\
5455 Non-nil also enables highlighting of the region whenever the mark is active.\n\
5456 The variable `highlight-nonselected-windows' controls whether to highlight\n\
5457 all windows or just the selected window.");
5458 Vtransient_mark_mode = Qnil;
5460 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5461 "*Non-nil means disregard read-only status of buffers or characters.\n\
5462 If the value is t, disregard `buffer-read-only' and all `read-only'\n\
5463 text properties. If the value is a list, disregard `buffer-read-only'\n\
5464 and disregard a `read-only' text property if the property value\n\
5465 is a member of the list.");
5466 Vinhibit_read_only = Qnil;
5468 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5469 "Cursor to use in window displaying this buffer.\n\
5470 Values are interpreted as follows:\n\
5472 t use the cursor specified for the frame\n\
5473 nil don't display a cursor\n\
5474 `bar' display a bar cursor with default width\n\
5475 (bar . WIDTH) display a bar cursor with width WIDTH\n\
5476 others display a box cursor.");
5478 DEFVAR_PER_BUFFER ("line-spacing",
5479 &current_buffer->extra_line_spacing, Qnil,
5480 "Additional space to put between lines when displaying a buffer.\n\
5481 The space is measured in pixels, and put below lines on window systems.");
5483 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5484 "List of functions called with no args to query before killing a buffer.");
5485 Vkill_buffer_query_functions = Qnil;
5487 defsubr (&Sbuffer_live_p);
5488 defsubr (&Sbuffer_list);
5489 defsubr (&Sget_buffer);
5490 defsubr (&Sget_file_buffer);
5491 defsubr (&Sget_buffer_create);
5492 defsubr (&Smake_indirect_buffer);
5493 defsubr (&Sgenerate_new_buffer_name);
5494 defsubr (&Sbuffer_name);
5495 /*defsubr (&Sbuffer_number);*/
5496 defsubr (&Sbuffer_file_name);
5497 defsubr (&Sbuffer_base_buffer);
5498 defsubr (&Sbuffer_local_variables);
5499 defsubr (&Sbuffer_modified_p);
5500 defsubr (&Sset_buffer_modified_p);
5501 defsubr (&Sbuffer_modified_tick);
5502 defsubr (&Srename_buffer);
5503 defsubr (&Sother_buffer);
5504 defsubr (&Sbuffer_disable_undo);
5505 defsubr (&Sbuffer_enable_undo);
5506 defsubr (&Skill_buffer);
5507 defsubr (&Sset_buffer_major_mode);
5508 defsubr (&Sswitch_to_buffer);
5509 defsubr (&Spop_to_buffer);
5510 defsubr (&Scurrent_buffer);
5511 defsubr (&Sset_buffer);
5512 defsubr (&Sbarf_if_buffer_read_only);
5513 defsubr (&Sbury_buffer);
5514 defsubr (&Serase_buffer);
5515 defsubr (&Sset_buffer_multibyte);
5516 defsubr (&Skill_all_local_variables);
5518 defsubr (&Soverlayp);
5519 defsubr (&Smake_overlay);
5520 defsubr (&Sdelete_overlay);
5521 defsubr (&Smove_overlay);
5522 defsubr (&Soverlay_start);
5523 defsubr (&Soverlay_end);
5524 defsubr (&Soverlay_buffer);
5525 defsubr (&Soverlay_properties);
5526 defsubr (&Soverlays_at);
5527 defsubr (&Soverlays_in);
5528 defsubr (&Snext_overlay_change);
5529 defsubr (&Sprevious_overlay_change);
5530 defsubr (&Soverlay_recenter);
5531 defsubr (&Soverlay_lists);
5532 defsubr (&Soverlay_get);
5533 defsubr (&Soverlay_put);
5534 defsubr (&Srestore_buffer_modified_p);
5537 void
5538 keys_of_buffer ()
5540 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5541 initial_define_key (control_x_map, 'k', "kill-buffer");
5543 /* This must not be in syms_of_buffer, because Qdisabled is not
5544 initialized when that function gets called. */
5545 Fput (intern ("erase-buffer"), Qdisabled, Qt);