(Fset_window_scroll_bars): Fix typo in argument name.
[emacs.git] / src / buffer.c
blobdd3db48cb987ea68d3680b4231fca2310402c4bd
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985,86,87,88,89,93,94,95,97,98, 1999, 2000, 2001, 02, 2003
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
43 #include "lisp.h"
44 #include "intervals.h"
45 #include "window.h"
46 #include "commands.h"
47 #include "buffer.h"
48 #include "charset.h"
49 #include "region-cache.h"
50 #include "indent.h"
51 #include "blockinput.h"
52 #include "keyboard.h"
53 #include "keymap.h"
54 #include "frame.h"
56 struct buffer *current_buffer; /* the current buffer */
58 /* First buffer in chain of all buffers (in reverse order of creation).
59 Threaded through ->next. */
61 struct buffer *all_buffers;
63 /* This structure holds the default values of the buffer-local variables
64 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
65 The default value occupies the same slot in this structure
66 as an individual buffer's value occupies in that buffer.
67 Setting the default value also goes through the alist of buffers
68 and stores into each buffer that does not say it has a local value. */
70 struct buffer buffer_defaults;
72 /* A Lisp_Object pointer to the above, used for staticpro */
74 static Lisp_Object Vbuffer_defaults;
76 /* This structure marks which slots in a buffer have corresponding
77 default values in buffer_defaults.
78 Each such slot has a nonzero value in this structure.
79 The value has only one nonzero bit.
81 When a buffer has its own local value for a slot,
82 the entry for that slot (found in the same slot in this structure)
83 is turned on in the buffer's local_flags array.
85 If a slot in this structure is -1, then even though there may
86 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
87 and the corresponding slot in buffer_defaults is not used.
89 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
90 but there is a default value which is copied into each buffer.
92 If a slot in this structure is negative, then even though there may
93 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
94 and the corresponding slot in buffer_defaults is not used.
96 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
97 zero, that is a bug */
99 struct buffer buffer_local_flags;
101 /* This structure holds the names of symbols whose values may be
102 buffer-local. It is indexed and accessed in the same way as the above. */
104 struct buffer buffer_local_symbols;
105 /* A Lisp_Object pointer to the above, used for staticpro */
106 static Lisp_Object Vbuffer_local_symbols;
108 /* This structure holds the required types for the values in the
109 buffer-local slots. If a slot contains Qnil, then the
110 corresponding buffer slot may contain a value of any type. If a
111 slot contains an integer, then prospective values' tags must be
112 equal to that integer (except nil is always allowed).
113 When a tag does not match, the function
114 buffer_slot_type_mismatch will signal an error.
116 If a slot here contains -1, the corresponding variable is read-only. */
117 struct buffer buffer_local_types;
119 /* Flags indicating which built-in buffer-local variables
120 are permanent locals. */
121 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
123 /* Number of per-buffer variables used. */
125 int last_per_buffer_idx;
127 Lisp_Object Fset_buffer ();
128 void set_buffer_internal ();
129 void set_buffer_internal_1 ();
130 static void call_overlay_mod_hooks ();
131 static void swap_out_buffer_local_variables ();
132 static void reset_buffer_local_variables ();
134 /* Alist of all buffer names vs the buffers. */
135 /* This used to be a variable, but is no longer,
136 to prevent lossage due to user rplac'ing this alist or its elements. */
137 Lisp_Object Vbuffer_alist;
139 /* Functions to call before and after each text change. */
140 Lisp_Object Vbefore_change_functions;
141 Lisp_Object Vafter_change_functions;
143 Lisp_Object Vtransient_mark_mode;
145 /* t means ignore all read-only text properties.
146 A list means ignore such a property if its value is a member of the list.
147 Any non-nil value means ignore buffer-read-only. */
148 Lisp_Object Vinhibit_read_only;
150 /* List of functions to call that can query about killing a buffer.
151 If any of these functions returns nil, we don't kill it. */
152 Lisp_Object Vkill_buffer_query_functions;
153 Lisp_Object Qkill_buffer_query_functions;
155 /* List of functions to call before changing an unmodified buffer. */
156 Lisp_Object Vfirst_change_hook;
158 Lisp_Object Qfirst_change_hook;
159 Lisp_Object Qbefore_change_functions;
160 Lisp_Object Qafter_change_functions;
161 Lisp_Object Qucs_set_table_for_input;
163 /* If nonzero, all modification hooks are suppressed. */
164 int inhibit_modification_hooks;
166 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
168 Lisp_Object Qprotected_field;
170 Lisp_Object QSFundamental; /* A string "Fundamental" */
172 Lisp_Object Qkill_buffer_hook;
174 Lisp_Object Qget_file_buffer;
176 Lisp_Object Qoverlayp;
178 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
180 Lisp_Object Qmodification_hooks;
181 Lisp_Object Qinsert_in_front_hooks;
182 Lisp_Object Qinsert_behind_hooks;
184 static void alloc_buffer_text P_ ((struct buffer *, size_t));
185 static void free_buffer_text P_ ((struct buffer *b));
186 static Lisp_Object copy_overlays P_ ((struct buffer *, Lisp_Object));
187 static void modify_overlay P_ ((struct buffer *, int, int));
190 /* For debugging; temporary. See set_buffer_internal. */
191 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
193 void
194 nsberror (spec)
195 Lisp_Object spec;
197 if (STRINGP (spec))
198 error ("No buffer named %s", SDATA (spec));
199 error ("Invalid buffer argument");
202 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
203 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
204 Value is nil if OBJECT is not a buffer or if it has been killed. */)
205 (object)
206 Lisp_Object object;
208 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
209 ? Qt : Qnil);
212 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
213 doc: /* Return a list of all existing live buffers.
214 If the optional arg FRAME is a frame, we return the buffer list
215 in the proper order for that frame: the buffers in FRAME's `buffer-list'
216 frame parameter come first, followed by the rest of the buffers. */)
217 (frame)
218 Lisp_Object frame;
220 Lisp_Object framelist, general;
221 general = Fmapcar (Qcdr, Vbuffer_alist);
223 if (FRAMEP (frame))
225 Lisp_Object tail;
227 CHECK_FRAME (frame);
229 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
231 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
232 tail = framelist;
233 while (! NILP (tail))
235 general = Fdelq (XCAR (tail), general);
236 tail = XCDR (tail);
238 return nconc2 (framelist, general);
241 return general;
244 /* Like Fassoc, but use Fstring_equal to compare
245 (which ignores text properties),
246 and don't ever QUIT. */
248 static Lisp_Object
249 assoc_ignore_text_properties (key, list)
250 register Lisp_Object key;
251 Lisp_Object list;
253 register Lisp_Object tail;
254 for (tail = list; CONSP (tail); tail = XCDR (tail))
256 register Lisp_Object elt, tem;
257 elt = XCAR (tail);
258 tem = Fstring_equal (Fcar (elt), key);
259 if (!NILP (tem))
260 return elt;
262 return Qnil;
265 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
266 doc: /* Return the buffer named NAME (a string).
267 If there is no live buffer named NAME, return nil.
268 NAME may also be a buffer; if so, the value is that buffer. */)
269 (name)
270 register Lisp_Object name;
272 if (BUFFERP (name))
273 return name;
274 CHECK_STRING (name);
276 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
279 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
280 doc: /* Return the buffer visiting file FILENAME (a string).
281 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
282 If there is no such live buffer, return nil.
283 See also `find-buffer-visiting'. */)
284 (filename)
285 register Lisp_Object filename;
287 register Lisp_Object tail, buf, tem;
288 Lisp_Object handler;
290 CHECK_STRING (filename);
291 filename = Fexpand_file_name (filename, Qnil);
293 /* If the file name has special constructs in it,
294 call the corresponding file handler. */
295 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
296 if (!NILP (handler))
297 return call2 (handler, Qget_file_buffer, filename);
299 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
301 buf = Fcdr (XCAR (tail));
302 if (!BUFFERP (buf)) continue;
303 if (!STRINGP (XBUFFER (buf)->filename)) continue;
304 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
305 if (!NILP (tem))
306 return buf;
308 return Qnil;
311 Lisp_Object
312 get_truename_buffer (filename)
313 register Lisp_Object filename;
315 register Lisp_Object tail, buf, tem;
317 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
319 buf = Fcdr (XCAR (tail));
320 if (!BUFFERP (buf)) continue;
321 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
322 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
323 if (!NILP (tem))
324 return buf;
326 return Qnil;
329 /* Incremented for each buffer created, to assign the buffer number. */
330 int buffer_count;
332 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
333 doc: /* Return the buffer named NAME, or create such a buffer and return it.
334 A new buffer is created if there is no live buffer named NAME.
335 If NAME starts with a space, the new buffer does not keep undo information.
336 If NAME is a buffer instead of a string, then it is the value returned.
337 The value is never nil. */)
338 (name)
339 register Lisp_Object name;
341 register Lisp_Object buf;
342 register struct buffer *b;
344 buf = Fget_buffer (name);
345 if (!NILP (buf))
346 return buf;
348 if (SCHARS (name) == 0)
349 error ("Empty string for buffer name is not allowed");
351 b = (struct buffer *) allocate_buffer ();
353 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
355 /* An ordinary buffer uses its own struct buffer_text. */
356 b->text = &b->own_text;
357 b->base_buffer = 0;
359 BUF_GAP_SIZE (b) = 20;
360 BLOCK_INPUT;
361 /* We allocate extra 1-byte at the tail and keep it always '\0' for
362 anchoring a search. */
363 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
364 UNBLOCK_INPUT;
365 if (! BUF_BEG_ADDR (b))
366 buffer_memory_full ();
368 BUF_PT (b) = BEG;
369 BUF_GPT (b) = BEG;
370 BUF_BEGV (b) = BEG;
371 BUF_ZV (b) = BEG;
372 BUF_Z (b) = BEG;
373 BUF_PT_BYTE (b) = BEG_BYTE;
374 BUF_GPT_BYTE (b) = BEG_BYTE;
375 BUF_BEGV_BYTE (b) = BEG_BYTE;
376 BUF_ZV_BYTE (b) = BEG_BYTE;
377 BUF_Z_BYTE (b) = BEG_BYTE;
378 BUF_MODIFF (b) = 1;
379 BUF_OVERLAY_MODIFF (b) = 1;
380 BUF_SAVE_MODIFF (b) = 1;
381 BUF_INTERVALS (b) = 0;
382 BUF_UNCHANGED_MODIFIED (b) = 1;
383 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
384 BUF_END_UNCHANGED (b) = 0;
385 BUF_BEG_UNCHANGED (b) = 0;
386 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
388 b->newline_cache = 0;
389 b->width_run_cache = 0;
390 b->width_table = Qnil;
391 b->prevent_redisplay_optimizations_p = 1;
393 /* Put this on the chain of all buffers including killed ones. */
394 b->next = all_buffers;
395 all_buffers = b;
397 /* An ordinary buffer normally doesn't need markers
398 to handle BEGV and ZV. */
399 b->pt_marker = Qnil;
400 b->begv_marker = Qnil;
401 b->zv_marker = Qnil;
403 name = Fcopy_sequence (name);
404 STRING_SET_INTERVALS (name, NULL_INTERVAL);
405 b->name = name;
407 if (SREF (name, 0) != ' ')
408 b->undo_list = Qnil;
409 else
410 b->undo_list = Qt;
412 reset_buffer (b);
413 reset_buffer_local_variables (b, 1);
415 b->mark = Fmake_marker ();
416 BUF_MARKERS (b) = Qnil;
417 b->name = name;
419 /* Put this in the alist of all live buffers. */
420 XSETBUFFER (buf, b);
421 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
423 /* Fixme: Protect against errors, which would trigger infinite
424 regress? */
425 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
426 /* buff is on buffer-alist, so no gcpro */
427 call1 (Qucs_set_table_for_input, buf);
429 return buf;
433 /* Return a list of overlays which is a copy of the overlay list
434 LIST, but for buffer B. */
436 static Lisp_Object
437 copy_overlays (b, list)
438 struct buffer *b;
439 Lisp_Object list;
441 Lisp_Object result, buffer;
443 XSETBUFFER (buffer, b);
445 for (result = Qnil; CONSP (list); list = XCDR (list))
447 Lisp_Object overlay, start, end, old_overlay;
448 int charpos;
450 old_overlay = XCAR (list);
451 charpos = marker_position (OVERLAY_START (old_overlay));
452 start = Fmake_marker ();
453 Fset_marker (start, make_number (charpos), buffer);
454 XMARKER (start)->insertion_type
455 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
457 charpos = marker_position (OVERLAY_END (old_overlay));
458 end = Fmake_marker ();
459 Fset_marker (end, make_number (charpos), buffer);
460 XMARKER (end)->insertion_type
461 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
463 overlay = allocate_misc ();
464 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
465 OVERLAY_START (overlay) = start;
466 OVERLAY_END (overlay) = end;
467 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
469 result = Fcons (overlay, result);
472 return Fnreverse (result);
476 /* Clone per-buffer values of buffer FROM.
478 Buffer TO gets the same per-buffer values as FROM, with the
479 following exceptions: (1) TO's name is left untouched, (2) markers
480 are copied and made to refer to TO, and (3) overlay lists are
481 copied. */
483 static void
484 clone_per_buffer_values (from, to)
485 struct buffer *from, *to;
487 Lisp_Object to_buffer;
488 int offset;
490 XSETBUFFER (to_buffer, to);
492 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
493 offset < sizeof *to;
494 offset += sizeof (Lisp_Object))
496 Lisp_Object obj;
498 obj = PER_BUFFER_VALUE (from, offset);
499 if (MARKERP (obj))
501 struct Lisp_Marker *m = XMARKER (obj);
502 obj = Fmake_marker ();
503 XMARKER (obj)->insertion_type = m->insertion_type;
504 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
507 PER_BUFFER_VALUE (to, offset) = obj;
510 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
512 to->overlays_before = copy_overlays (to, from->overlays_before);
513 to->overlays_after = copy_overlays (to, from->overlays_after);
517 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
518 2, 3,
519 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
520 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
521 BASE-BUFFER should be an existing buffer (or buffer name).
522 NAME should be a string which is not the name of an existing buffer.
523 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
524 such as major and minor modes, in the indirect buffer.
525 CLONE nil means the indirect buffer's state is reset to default values. */)
526 (base_buffer, name, clone)
527 Lisp_Object base_buffer, name, clone;
529 Lisp_Object buf;
530 struct buffer *b;
532 buf = Fget_buffer (name);
533 if (!NILP (buf))
534 error ("Buffer name `%s' is in use", SDATA (name));
536 base_buffer = Fget_buffer (base_buffer);
537 if (NILP (base_buffer))
538 error ("No such buffer: `%s'", SDATA (name));
540 if (SCHARS (name) == 0)
541 error ("Empty string for buffer name is not allowed");
543 b = (struct buffer *) allocate_buffer ();
544 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
546 if (XBUFFER (base_buffer)->base_buffer)
547 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
548 else
549 b->base_buffer = XBUFFER (base_buffer);
551 /* Use the base buffer's text object. */
552 b->text = b->base_buffer->text;
554 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
555 BUF_ZV (b) = BUF_ZV (b->base_buffer);
556 BUF_PT (b) = BUF_PT (b->base_buffer);
557 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
558 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
559 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
561 b->newline_cache = 0;
562 b->width_run_cache = 0;
563 b->width_table = Qnil;
565 /* Put this on the chain of all buffers including killed ones. */
566 b->next = all_buffers;
567 all_buffers = b;
569 name = Fcopy_sequence (name);
570 STRING_SET_INTERVALS (name, NULL_INTERVAL);
571 b->name = name;
573 reset_buffer (b);
574 reset_buffer_local_variables (b, 1);
576 /* Put this in the alist of all live buffers. */
577 XSETBUFFER (buf, b);
578 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
580 b->mark = Fmake_marker ();
581 b->name = name;
583 /* The multibyte status belongs to the base buffer. */
584 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
586 /* Make sure the base buffer has markers for its narrowing. */
587 if (NILP (b->base_buffer->pt_marker))
589 b->base_buffer->pt_marker = Fmake_marker ();
590 set_marker_both (b->base_buffer->pt_marker, base_buffer,
591 BUF_PT (b->base_buffer),
592 BUF_PT_BYTE (b->base_buffer));
594 if (NILP (b->base_buffer->begv_marker))
596 b->base_buffer->begv_marker = Fmake_marker ();
597 set_marker_both (b->base_buffer->begv_marker, base_buffer,
598 BUF_BEGV (b->base_buffer),
599 BUF_BEGV_BYTE (b->base_buffer));
601 if (NILP (b->base_buffer->zv_marker))
603 b->base_buffer->zv_marker = Fmake_marker ();
604 set_marker_both (b->base_buffer->zv_marker, base_buffer,
605 BUF_ZV (b->base_buffer),
606 BUF_ZV_BYTE (b->base_buffer));
607 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
610 if (NILP (clone))
612 /* Give the indirect buffer markers for its narrowing. */
613 b->pt_marker = Fmake_marker ();
614 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
615 b->begv_marker = Fmake_marker ();
616 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
617 b->zv_marker = Fmake_marker ();
618 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
619 XMARKER (b->zv_marker)->insertion_type = 1;
621 else
622 clone_per_buffer_values (b->base_buffer, b);
624 return buf;
627 /* Reinitialize everything about a buffer except its name and contents
628 and local variables. */
630 void
631 reset_buffer (b)
632 register struct buffer *b;
634 b->filename = Qnil;
635 b->file_truename = Qnil;
636 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
637 b->modtime = 0;
638 XSETFASTINT (b->save_length, 0);
639 b->last_window_start = 1;
640 /* It is more conservative to start out "changed" than "unchanged". */
641 b->clip_changed = 0;
642 b->prevent_redisplay_optimizations_p = 1;
643 b->backed_up = Qnil;
644 b->auto_save_modified = 0;
645 b->auto_save_failure_time = -1;
646 b->auto_save_file_name = Qnil;
647 b->read_only = Qnil;
648 b->overlays_before = Qnil;
649 b->overlays_after = Qnil;
650 XSETFASTINT (b->overlay_center, 1);
651 b->mark_active = Qnil;
652 b->point_before_scroll = Qnil;
653 b->file_format = Qnil;
654 b->last_selected_window = Qnil;
655 XSETINT (b->display_count, 0);
656 b->display_time = Qnil;
657 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
658 b->cursor_type = buffer_defaults.cursor_type;
659 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
661 b->display_error_modiff = 0;
664 /* Reset buffer B's local variables info.
665 Don't use this on a buffer that has already been in use;
666 it does not treat permanent locals consistently.
667 Instead, use Fkill_all_local_variables.
669 If PERMANENT_TOO is 1, then we reset permanent built-in
670 buffer-local variables. If PERMANENT_TOO is 0,
671 we preserve those. */
673 static void
674 reset_buffer_local_variables (b, permanent_too)
675 register struct buffer *b;
676 int permanent_too;
678 register int offset;
679 int i;
681 /* Reset the major mode to Fundamental, together with all the
682 things that depend on the major mode.
683 default-major-mode is handled at a higher level.
684 We ignore it here. */
685 b->major_mode = Qfundamental_mode;
686 b->keymap = Qnil;
687 b->mode_name = QSFundamental;
688 b->minor_modes = Qnil;
690 /* If the standard case table has been altered and invalidated,
691 fix up its insides first. */
692 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
693 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
694 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
695 Fset_standard_case_table (Vascii_downcase_table);
697 b->downcase_table = Vascii_downcase_table;
698 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
699 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
700 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
701 b->invisibility_spec = Qt;
702 #ifndef DOS_NT
703 b->buffer_file_type = Qnil;
704 #endif
706 /* Reset all (or most) per-buffer variables to their defaults. */
707 b->local_var_alist = Qnil;
708 for (i = 0; i < last_per_buffer_idx; ++i)
709 if (permanent_too || buffer_permanent_local_flags[i] == 0)
710 SET_PER_BUFFER_VALUE_P (b, i, 0);
712 /* For each slot that has a default value,
713 copy that into the slot. */
715 for (offset = PER_BUFFER_VAR_OFFSET (name);
716 offset < sizeof *b;
717 offset += sizeof (Lisp_Object))
719 int idx = PER_BUFFER_IDX (offset);
720 if ((idx > 0
721 && (permanent_too
722 || buffer_permanent_local_flags[idx] == 0))
723 /* Is -2 used anywhere? */
724 || idx == -2)
725 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
729 /* We split this away from generate-new-buffer, because rename-buffer
730 and set-visited-file-name ought to be able to use this to really
731 rename the buffer properly. */
733 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
734 1, 2, 0,
735 doc: /* Return a string that is the name of no existing buffer based on NAME.
736 If there is no live buffer named NAME, then return NAME.
737 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
738 until an unused name is found, and then return that name.
739 Optional second argument IGNORE specifies a name that is okay to use
740 \(if it is in the sequence to be tried)
741 even if a buffer with that name exists. */)
742 (name, ignore)
743 register Lisp_Object name, ignore;
745 register Lisp_Object gentemp, tem;
746 int count;
747 char number[10];
749 CHECK_STRING (name);
751 tem = Fget_buffer (name);
752 if (NILP (tem))
753 return name;
755 count = 1;
756 while (1)
758 sprintf (number, "<%d>", ++count);
759 gentemp = concat2 (name, build_string (number));
760 tem = Fstring_equal (gentemp, ignore);
761 if (!NILP (tem))
762 return gentemp;
763 tem = Fget_buffer (gentemp);
764 if (NILP (tem))
765 return gentemp;
770 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
771 doc: /* Return the name of BUFFER, as a string.
772 With no argument or nil as argument, return the name of the current buffer. */)
773 (buffer)
774 register Lisp_Object buffer;
776 if (NILP (buffer))
777 return current_buffer->name;
778 CHECK_BUFFER (buffer);
779 return XBUFFER (buffer)->name;
782 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
783 doc: /* Return name of file BUFFER is visiting, or nil if none.
784 No argument or nil as argument means use the current buffer. */)
785 (buffer)
786 register Lisp_Object buffer;
788 if (NILP (buffer))
789 return current_buffer->filename;
790 CHECK_BUFFER (buffer);
791 return XBUFFER (buffer)->filename;
794 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
795 0, 1, 0,
796 doc: /* Return the base buffer of indirect buffer BUFFER.
797 If BUFFER is not indirect, return nil. */)
798 (buffer)
799 register Lisp_Object buffer;
801 struct buffer *base;
802 Lisp_Object base_buffer;
804 if (NILP (buffer))
805 base = current_buffer->base_buffer;
806 else
808 CHECK_BUFFER (buffer);
809 base = XBUFFER (buffer)->base_buffer;
812 if (! base)
813 return Qnil;
814 XSETBUFFER (base_buffer, base);
815 return base_buffer;
818 DEFUN ("buffer-local-value", Fbuffer_local_value,
819 Sbuffer_local_value, 2, 2, 0,
820 doc: /* Return the value of VARIABLE in BUFFER.
821 If VARIABLE does not have a buffer-local binding in BUFFER, the value
822 is the default binding of variable. */)
823 (symbol, buffer)
824 register Lisp_Object symbol;
825 register Lisp_Object buffer;
827 register struct buffer *buf;
828 register Lisp_Object result;
830 CHECK_SYMBOL (symbol);
831 CHECK_BUFFER (buffer);
832 buf = XBUFFER (buffer);
834 /* Look in local_var_list */
835 result = Fassoc (symbol, buf->local_var_alist);
836 if (NILP (result))
838 int offset, idx;
839 int found = 0;
841 /* Look in special slots */
842 for (offset = PER_BUFFER_VAR_OFFSET (name);
843 offset < sizeof (struct buffer);
844 /* sizeof EMACS_INT == sizeof Lisp_Object */
845 offset += (sizeof (EMACS_INT)))
847 idx = PER_BUFFER_IDX (offset);
848 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
849 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
850 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
852 result = PER_BUFFER_VALUE (buf, offset);
853 found = 1;
854 break;
858 if (!found)
859 result = Fdefault_value (symbol);
861 else
863 Lisp_Object valcontents;
864 Lisp_Object current_alist_element;
866 /* What binding is loaded right now? */
867 valcontents = SYMBOL_VALUE (symbol);
868 current_alist_element
869 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
871 /* The value of the currently loaded binding is not
872 stored in it, but rather in the realvalue slot.
873 Store that value into the binding it belongs to
874 in case that is the one we are about to use. */
876 Fsetcdr (current_alist_element,
877 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
879 /* Now get the (perhaps updated) value out of the binding. */
880 result = XCDR (result);
883 if (EQ (result, Qunbound))
884 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
886 return result;
889 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
890 Sbuffer_local_variables, 0, 1, 0,
891 doc: /* Return an alist of variables that are buffer-local in BUFFER.
892 Most elements look like (SYMBOL . VALUE), describing one variable.
893 For a symbol that is locally unbound, just the symbol appears in the value.
894 Note that storing new VALUEs in these elements doesn't change the variables.
895 No argument or nil as argument means use current buffer as BUFFER. */)
896 (buffer)
897 register Lisp_Object buffer;
899 register struct buffer *buf;
900 register Lisp_Object result;
902 if (NILP (buffer))
903 buf = current_buffer;
904 else
906 CHECK_BUFFER (buffer);
907 buf = XBUFFER (buffer);
910 result = Qnil;
913 register Lisp_Object tail;
914 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
916 Lisp_Object val, elt;
918 elt = XCAR (tail);
920 /* Reference each variable in the alist in buf.
921 If inquiring about the current buffer, this gets the current values,
922 so store them into the alist so the alist is up to date.
923 If inquiring about some other buffer, this swaps out any values
924 for that buffer, making the alist up to date automatically. */
925 val = find_symbol_value (XCAR (elt));
926 /* Use the current buffer value only if buf is the current buffer. */
927 if (buf != current_buffer)
928 val = XCDR (elt);
930 /* If symbol is unbound, put just the symbol in the list. */
931 if (EQ (val, Qunbound))
932 result = Fcons (XCAR (elt), result);
933 /* Otherwise, put (symbol . value) in the list. */
934 else
935 result = Fcons (Fcons (XCAR (elt), val), result);
939 /* Add on all the variables stored in special slots. */
941 int offset, idx;
943 for (offset = PER_BUFFER_VAR_OFFSET (name);
944 offset < sizeof (struct buffer);
945 /* sizeof EMACS_INT == sizeof Lisp_Object */
946 offset += (sizeof (EMACS_INT)))
948 idx = PER_BUFFER_IDX (offset);
949 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
950 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
951 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
952 PER_BUFFER_VALUE (buf, offset)),
953 result);
957 return result;
961 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
962 0, 1, 0,
963 doc: /* Return t if BUFFER was modified since its file was last read or saved.
964 No argument or nil as argument means use current buffer as BUFFER. */)
965 (buffer)
966 register Lisp_Object buffer;
968 register struct buffer *buf;
969 if (NILP (buffer))
970 buf = current_buffer;
971 else
973 CHECK_BUFFER (buffer);
974 buf = XBUFFER (buffer);
977 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
980 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
981 1, 1, 0,
982 doc: /* Mark current buffer as modified or unmodified according to FLAG.
983 A non-nil FLAG means mark the buffer modified. */)
984 (flag)
985 register Lisp_Object flag;
987 register int already;
988 register Lisp_Object fn;
989 Lisp_Object buffer, window;
991 #ifdef CLASH_DETECTION
992 /* If buffer becoming modified, lock the file.
993 If buffer becoming unmodified, unlock the file. */
995 fn = current_buffer->file_truename;
996 /* Test buffer-file-name so that binding it to nil is effective. */
997 if (!NILP (fn) && ! NILP (current_buffer->filename))
999 already = SAVE_MODIFF < MODIFF;
1000 if (!already && !NILP (flag))
1001 lock_file (fn);
1002 else if (already && NILP (flag))
1003 unlock_file (fn);
1005 #endif /* CLASH_DETECTION */
1007 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1009 /* Set update_mode_lines only if buffer is displayed in some window.
1010 Packages like jit-lock or lazy-lock preserve a buffer's modified
1011 state by recording/restoring the state around blocks of code.
1012 Setting update_mode_lines makes redisplay consider all windows
1013 (on all frames). Stealth fontification of buffers not displayed
1014 would incur additional redisplay costs if we'd set
1015 update_modes_lines unconditionally.
1017 Ideally, I think there should be another mechanism for fontifying
1018 buffers without "modifying" buffers, or redisplay should be
1019 smarter about updating the `*' in mode lines. --gerd */
1020 XSETBUFFER (buffer, current_buffer);
1021 window = Fget_buffer_window (buffer, Qt);
1022 if (WINDOWP (window))
1024 ++update_mode_lines;
1025 current_buffer->prevent_redisplay_optimizations_p = 1;
1028 return flag;
1031 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1032 Srestore_buffer_modified_p, 1, 1, 0,
1033 doc: /* Like `set-buffer-modified-p', with a differences concerning redisplay.
1034 It is not ensured that mode lines will be updated to show the modified
1035 state of the current buffer. Use with care. */)
1036 (flag)
1037 Lisp_Object flag;
1039 #ifdef CLASH_DETECTION
1040 Lisp_Object fn;
1042 /* If buffer becoming modified, lock the file.
1043 If buffer becoming unmodified, unlock the file. */
1045 fn = current_buffer->file_truename;
1046 /* Test buffer-file-name so that binding it to nil is effective. */
1047 if (!NILP (fn) && ! NILP (current_buffer->filename))
1049 int already = SAVE_MODIFF < MODIFF;
1050 if (!already && !NILP (flag))
1051 lock_file (fn);
1052 else if (already && NILP (flag))
1053 unlock_file (fn);
1055 #endif /* CLASH_DETECTION */
1057 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1058 return flag;
1061 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1062 0, 1, 0,
1063 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1064 Each buffer has a tick counter which is incremented each time the text in
1065 that buffer is changed. It wraps around occasionally.
1066 No argument or nil as argument means use current buffer as BUFFER. */)
1067 (buffer)
1068 register Lisp_Object buffer;
1070 register struct buffer *buf;
1071 if (NILP (buffer))
1072 buf = current_buffer;
1073 else
1075 CHECK_BUFFER (buffer);
1076 buf = XBUFFER (buffer);
1079 return make_number (BUF_MODIFF (buf));
1082 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1083 "sRename buffer (to new name): \nP",
1084 doc: /* Change current buffer's name to NEWNAME (a string).
1085 If second arg UNIQUE is nil or omitted, it is an error if a
1086 buffer named NEWNAME already exists.
1087 If UNIQUE is non-nil, come up with a new name using
1088 `generate-new-buffer-name'.
1089 Interactively, you can set UNIQUE with a prefix argument.
1090 We return the name we actually gave the buffer.
1091 This does not change the name of the visited file (if any). */)
1092 (newname, unique)
1093 register Lisp_Object newname, unique;
1095 register Lisp_Object tem, buf;
1097 CHECK_STRING (newname);
1099 if (SCHARS (newname) == 0)
1100 error ("Empty string is invalid as a buffer name");
1102 tem = Fget_buffer (newname);
1103 if (!NILP (tem))
1105 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1106 rename the buffer automatically so you can create another
1107 with the original name. It makes UNIQUE equivalent to
1108 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1109 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1110 return current_buffer->name;
1111 if (!NILP (unique))
1112 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1113 else
1114 error ("Buffer name `%s' is in use", SDATA (newname));
1117 current_buffer->name = newname;
1119 /* Catch redisplay's attention. Unless we do this, the mode lines for
1120 any windows displaying current_buffer will stay unchanged. */
1121 update_mode_lines++;
1123 XSETBUFFER (buf, current_buffer);
1124 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1125 if (NILP (current_buffer->filename)
1126 && !NILP (current_buffer->auto_save_file_name))
1127 call0 (intern ("rename-auto-save-file"));
1128 /* Refetch since that last call may have done GC. */
1129 return current_buffer->name;
1132 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1133 doc: /* Return most recently selected buffer other than BUFFER.
1134 Buffers not visible in windows are preferred to visible buffers,
1135 unless optional second argument VISIBLE-OK is non-nil.
1136 If the optional third argument FRAME is non-nil, use that frame's
1137 buffer list instead of the selected frame's buffer list.
1138 If no other buffer exists, the buffer `*scratch*' is returned.
1139 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1140 (buffer, visible_ok, frame)
1141 register Lisp_Object buffer, visible_ok, frame;
1143 Lisp_Object Fset_buffer_major_mode ();
1144 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1145 notsogood = Qnil;
1147 if (NILP (frame))
1148 frame = selected_frame;
1150 tail = Vbuffer_alist;
1151 pred = frame_buffer_predicate (frame);
1153 /* Consider buffers that have been seen in the selected frame
1154 before other buffers. */
1156 tem = frame_buffer_list (frame);
1157 add_ons = Qnil;
1158 while (CONSP (tem))
1160 if (BUFFERP (XCAR (tem)))
1161 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1162 tem = XCDR (tem);
1164 tail = nconc2 (Fnreverse (add_ons), tail);
1166 for (; CONSP (tail); tail = XCDR (tail))
1168 buf = Fcdr (XCAR (tail));
1169 if (EQ (buf, buffer))
1170 continue;
1171 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1172 continue;
1173 /* If the selected frame has a buffer_predicate,
1174 disregard buffers that don't fit the predicate. */
1175 if (!NILP (pred))
1177 tem = call1 (pred, buf);
1178 if (NILP (tem))
1179 continue;
1182 if (NILP (visible_ok))
1183 tem = Fget_buffer_window (buf, Qvisible);
1184 else
1185 tem = Qnil;
1186 if (NILP (tem))
1187 return buf;
1188 if (NILP (notsogood))
1189 notsogood = buf;
1191 if (!NILP (notsogood))
1192 return notsogood;
1193 buf = Fget_buffer (build_string ("*scratch*"));
1194 if (NILP (buf))
1196 buf = Fget_buffer_create (build_string ("*scratch*"));
1197 Fset_buffer_major_mode (buf);
1199 return buf;
1202 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
1203 0, 1, "",
1204 doc: /* Make BUFFER stop keeping undo information.
1205 No argument or nil as argument means do this for the current buffer. */)
1206 (buffer)
1207 register Lisp_Object buffer;
1209 Lisp_Object real_buffer;
1211 if (NILP (buffer))
1212 XSETBUFFER (real_buffer, current_buffer);
1213 else
1215 real_buffer = Fget_buffer (buffer);
1216 if (NILP (real_buffer))
1217 nsberror (buffer);
1220 XBUFFER (real_buffer)->undo_list = Qt;
1222 return Qnil;
1225 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1226 0, 1, "",
1227 doc: /* Start keeping undo information for buffer BUFFER.
1228 No argument or nil as argument means do this for the current buffer. */)
1229 (buffer)
1230 register Lisp_Object buffer;
1232 Lisp_Object real_buffer;
1234 if (NILP (buffer))
1235 XSETBUFFER (real_buffer, current_buffer);
1236 else
1238 real_buffer = Fget_buffer (buffer);
1239 if (NILP (real_buffer))
1240 nsberror (buffer);
1243 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1244 XBUFFER (real_buffer)->undo_list = Qnil;
1246 return Qnil;
1250 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1251 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1252 The buffer being killed will be current while the hook is running.\n\
1253 See `kill-buffer'."
1255 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1256 doc: /* Kill the buffer BUFFER.
1257 The argument may be a buffer or may be the name of a buffer.
1258 An argument of nil means kill the current buffer.
1260 Value is t if the buffer is actually killed, nil if user says no.
1262 The value of `kill-buffer-hook' (which may be local to that buffer),
1263 if not void, is a list of functions to be called, with no arguments,
1264 before the buffer is actually killed. The buffer to be killed is current
1265 when the hook functions are called.
1267 Any processes that have this buffer as the `process-buffer' are killed
1268 with SIGHUP. */)
1269 (buffer)
1270 Lisp_Object buffer;
1272 Lisp_Object buf;
1273 register struct buffer *b;
1274 register Lisp_Object tem;
1275 register struct Lisp_Marker *m;
1276 struct gcpro gcpro1;
1278 if (NILP (buffer))
1279 buf = Fcurrent_buffer ();
1280 else
1281 buf = Fget_buffer (buffer);
1282 if (NILP (buf))
1283 nsberror (buffer);
1285 b = XBUFFER (buf);
1287 /* Avoid trouble for buffer already dead. */
1288 if (NILP (b->name))
1289 return Qnil;
1291 /* Query if the buffer is still modified. */
1292 if (INTERACTIVE && !NILP (b->filename)
1293 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1295 GCPRO1 (buf);
1296 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1297 b->name, make_number (0)));
1298 UNGCPRO;
1299 if (NILP (tem))
1300 return Qnil;
1303 /* Run hooks with the buffer to be killed the current buffer. */
1305 int count = SPECPDL_INDEX ();
1306 Lisp_Object list;
1307 Lisp_Object arglist[1];
1309 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1310 set_buffer_internal (b);
1312 /* First run the query functions; if any query is answered no,
1313 don't kill the buffer. */
1314 arglist[0] = Qkill_buffer_query_functions;
1315 if (NILP (Frun_hook_with_args_until_failure (1, arglist)))
1316 return unbind_to (count, Qnil);
1318 /* Then run the hooks. */
1319 Frun_hooks (1, &Qkill_buffer_hook);
1320 unbind_to (count, Qnil);
1323 /* We have no more questions to ask. Verify that it is valid
1324 to kill the buffer. This must be done after the questions
1325 since anything can happen within do_yes_or_no_p. */
1327 /* Don't kill the minibuffer now current. */
1328 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1329 return Qnil;
1331 if (NILP (b->name))
1332 return Qnil;
1334 /* When we kill a base buffer, kill all its indirect buffers.
1335 We do it at this stage so nothing terrible happens if they
1336 ask questions or their hooks get errors. */
1337 if (! b->base_buffer)
1339 struct buffer *other;
1341 GCPRO1 (buf);
1343 for (other = all_buffers; other; other = other->next)
1344 /* all_buffers contains dead buffers too;
1345 don't re-kill them. */
1346 if (other->base_buffer == b && !NILP (other->name))
1348 Lisp_Object buf;
1349 XSETBUFFER (buf, other);
1350 Fkill_buffer (buf);
1353 UNGCPRO;
1356 /* Make this buffer not be current.
1357 In the process, notice if this is the sole visible buffer
1358 and give up if so. */
1359 if (b == current_buffer)
1361 tem = Fother_buffer (buf, Qnil, Qnil);
1362 Fset_buffer (tem);
1363 if (b == current_buffer)
1364 return Qnil;
1367 /* Notice if the buffer to kill is the sole visible buffer
1368 when we're currently in the mini-buffer, and give up if so. */
1369 XSETBUFFER (tem, current_buffer);
1370 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1372 tem = Fother_buffer (buf, Qnil, Qnil);
1373 if (EQ (buf, tem))
1374 return Qnil;
1377 /* Now there is no question: we can kill the buffer. */
1379 #ifdef CLASH_DETECTION
1380 /* Unlock this buffer's file, if it is locked. */
1381 unlock_buffer (b);
1382 #endif /* CLASH_DETECTION */
1384 kill_buffer_processes (buf);
1386 tem = Vinhibit_quit;
1387 Vinhibit_quit = Qt;
1388 replace_buffer_in_all_windows (buf);
1389 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1390 frames_discard_buffer (buf);
1391 Vinhibit_quit = tem;
1393 /* Delete any auto-save file, if we saved it in this session.
1394 But not if the buffer is modified. */
1395 if (STRINGP (b->auto_save_file_name)
1396 && b->auto_save_modified != 0
1397 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1398 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b))
1400 Lisp_Object tem;
1401 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1402 if (! NILP (tem))
1403 internal_delete_file (b->auto_save_file_name);
1406 if (b->base_buffer)
1408 /* Unchain all markers that belong to this indirect buffer.
1409 Don't unchain the markers that belong to the base buffer
1410 or its other indirect buffers. */
1411 for (tem = BUF_MARKERS (b); !NILP (tem); )
1413 Lisp_Object next;
1414 m = XMARKER (tem);
1415 next = m->chain;
1416 if (m->buffer == b)
1417 unchain_marker (tem);
1418 tem = next;
1421 else
1423 /* Unchain all markers of this buffer and its indirect buffers.
1424 and leave them pointing nowhere. */
1425 for (tem = BUF_MARKERS (b); !NILP (tem); )
1427 m = XMARKER (tem);
1428 m->buffer = 0;
1429 tem = m->chain;
1430 m->chain = Qnil;
1432 BUF_MARKERS (b) = Qnil;
1433 BUF_INTERVALS (b) = NULL_INTERVAL;
1435 /* Perhaps we should explicitly free the interval tree here... */
1438 /* Reset the local variables, so that this buffer's local values
1439 won't be protected from GC. They would be protected
1440 if they happened to remain encached in their symbols.
1441 This gets rid of them for certain. */
1442 swap_out_buffer_local_variables (b);
1443 reset_buffer_local_variables (b, 1);
1445 b->name = Qnil;
1447 BLOCK_INPUT;
1448 if (! b->base_buffer)
1449 free_buffer_text (b);
1451 if (b->newline_cache)
1453 free_region_cache (b->newline_cache);
1454 b->newline_cache = 0;
1456 if (b->width_run_cache)
1458 free_region_cache (b->width_run_cache);
1459 b->width_run_cache = 0;
1461 b->width_table = Qnil;
1462 UNBLOCK_INPUT;
1463 b->undo_list = Qnil;
1465 return Qt;
1468 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1469 we do this each time BUF is selected visibly, the more recently
1470 selected buffers are always closer to the front of the list. This
1471 means that other_buffer is more likely to choose a relevant buffer. */
1473 void
1474 record_buffer (buf)
1475 Lisp_Object buf;
1477 register Lisp_Object link, prev;
1478 Lisp_Object frame;
1479 frame = selected_frame;
1481 prev = Qnil;
1482 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1484 if (EQ (XCDR (XCAR (link)), buf))
1485 break;
1486 prev = link;
1489 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1490 we cannot use Fdelq itself here because it allows quitting. */
1492 if (NILP (prev))
1493 Vbuffer_alist = XCDR (Vbuffer_alist);
1494 else
1495 XSETCDR (prev, XCDR (XCDR (prev)));
1497 XSETCDR (link, Vbuffer_alist);
1498 Vbuffer_alist = link;
1500 /* Now move this buffer to the front of frame_buffer_list also. */
1502 prev = Qnil;
1503 for (link = frame_buffer_list (frame); CONSP (link);
1504 link = XCDR (link))
1506 if (EQ (XCAR (link), buf))
1507 break;
1508 prev = link;
1511 /* Effectively do delq. */
1513 if (CONSP (link))
1515 if (NILP (prev))
1516 set_frame_buffer_list (frame,
1517 XCDR (frame_buffer_list (frame)));
1518 else
1519 XSETCDR (prev, XCDR (XCDR (prev)));
1521 XSETCDR (link, frame_buffer_list (frame));
1522 set_frame_buffer_list (frame, link);
1524 else
1525 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1528 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1529 doc: /* Set an appropriate major mode for BUFFER.
1530 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1531 according to `default-major-mode'.
1532 Use this function before selecting the buffer, since it may need to inspect
1533 the current buffer's major mode. */)
1534 (buffer)
1535 Lisp_Object buffer;
1537 int count;
1538 Lisp_Object function;
1540 if (STRINGP (XBUFFER (buffer)->name)
1541 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1542 function = find_symbol_value (intern ("initial-major-mode"));
1543 else
1545 function = buffer_defaults.major_mode;
1546 if (NILP (function)
1547 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1548 function = current_buffer->major_mode;
1551 if (NILP (function) || EQ (function, Qfundamental_mode))
1552 return Qnil;
1554 count = SPECPDL_INDEX ();
1556 /* To select a nonfundamental mode,
1557 select the buffer temporarily and then call the mode function. */
1559 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1561 Fset_buffer (buffer);
1562 call0 (function);
1564 return unbind_to (count, Qnil);
1567 /* If switching buffers in WINDOW would be an error, return
1568 a C string saying what the error would be. */
1570 char *
1571 no_switch_window (window)
1572 Lisp_Object window;
1574 Lisp_Object tem;
1575 if (EQ (minibuf_window, window))
1576 return "Cannot switch buffers in minibuffer window";
1577 tem = Fwindow_dedicated_p (window);
1578 if (EQ (tem, Qt))
1579 return "Cannot switch buffers in a dedicated window";
1580 return NULL;
1583 /* Switch to buffer BUFFER in the selected window.
1584 If NORECORD is non-nil, don't call record_buffer. */
1586 Lisp_Object
1587 switch_to_buffer_1 (buffer, norecord)
1588 Lisp_Object buffer, norecord;
1590 register Lisp_Object buf;
1592 if (NILP (buffer))
1593 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1594 else
1596 buf = Fget_buffer (buffer);
1597 if (NILP (buf))
1599 buf = Fget_buffer_create (buffer);
1600 Fset_buffer_major_mode (buf);
1603 Fset_buffer (buf);
1604 if (NILP (norecord))
1605 record_buffer (buf);
1607 Fset_window_buffer (EQ (selected_window, minibuf_window)
1608 ? Fnext_window (minibuf_window, Qnil, Qnil)
1609 : selected_window,
1610 buf, Qnil);
1612 return buf;
1615 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1616 doc: /* Select buffer BUFFER in the current window.
1617 BUFFER may be a buffer or a buffer name.
1618 Optional second arg NORECORD non-nil means
1619 do not put this buffer at the front of the list of recently selected ones.
1621 WARNING: This is NOT the way to work on another buffer temporarily
1622 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1623 the window-buffer correspondences. */)
1624 (buffer, norecord)
1625 Lisp_Object buffer, norecord;
1627 char *err;
1629 err = no_switch_window (selected_window);
1630 if (err) error (err);
1632 return switch_to_buffer_1 (buffer, norecord);
1635 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1636 doc: /* Select buffer BUFFER in some window, preferably a different one.
1637 If BUFFER is nil, then some other buffer is chosen.
1638 If `pop-up-windows' is non-nil, windows can be split to do this.
1639 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1640 window even if BUFFER is already visible in the selected window.
1641 This uses the function `display-buffer' as a subroutine; see the documentation
1642 of `display-buffer' for additional customization information.
1644 Optional third arg NORECORD non-nil means
1645 do not put this buffer at the front of the list of recently selected ones. */)
1646 (buffer, other_window, norecord)
1647 Lisp_Object buffer, other_window, norecord;
1649 register Lisp_Object buf;
1650 if (NILP (buffer))
1651 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1652 else
1654 buf = Fget_buffer (buffer);
1655 if (NILP (buf))
1657 buf = Fget_buffer_create (buffer);
1658 Fset_buffer_major_mode (buf);
1661 Fset_buffer (buf);
1662 if (NILP (norecord))
1663 /* Why bother ? Fselect_window will do it for us anyway. -stef */
1664 record_buffer (buf);
1665 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1666 return buf;
1669 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1670 doc: /* Return the current buffer as a Lisp object. */)
1673 register Lisp_Object buf;
1674 XSETBUFFER (buf, current_buffer);
1675 return buf;
1678 /* Set the current buffer to B.
1680 We previously set windows_or_buffers_changed here to invalidate
1681 global unchanged information in beg_unchanged and end_unchanged.
1682 This is no longer necessary because we now compute unchanged
1683 information on a buffer-basis. Every action affecting other
1684 windows than the selected one requires a select_window at some
1685 time, and that increments windows_or_buffers_changed. */
1687 void
1688 set_buffer_internal (b)
1689 register struct buffer *b;
1691 if (current_buffer != b)
1692 set_buffer_internal_1 (b);
1695 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1696 This is used by redisplay. */
1698 void
1699 set_buffer_internal_1 (b)
1700 register struct buffer *b;
1702 register struct buffer *old_buf;
1703 register Lisp_Object tail, valcontents;
1704 Lisp_Object tem;
1706 #ifdef USE_MMAP_FOR_BUFFERS
1707 if (b->text->beg == NULL)
1708 enlarge_buffer_text (b, 0);
1709 #endif /* USE_MMAP_FOR_BUFFERS */
1711 if (current_buffer == b)
1712 return;
1714 old_buf = current_buffer;
1715 current_buffer = b;
1716 last_known_column_point = -1; /* invalidate indentation cache */
1718 if (old_buf)
1720 /* Put the undo list back in the base buffer, so that it appears
1721 that an indirect buffer shares the undo list of its base. */
1722 if (old_buf->base_buffer)
1723 old_buf->base_buffer->undo_list = old_buf->undo_list;
1725 /* If the old current buffer has markers to record PT, BEGV and ZV
1726 when it is not current, update them now. */
1727 if (! NILP (old_buf->pt_marker))
1729 Lisp_Object obuf;
1730 XSETBUFFER (obuf, old_buf);
1731 set_marker_both (old_buf->pt_marker, obuf,
1732 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1734 if (! NILP (old_buf->begv_marker))
1736 Lisp_Object obuf;
1737 XSETBUFFER (obuf, old_buf);
1738 set_marker_both (old_buf->begv_marker, obuf,
1739 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1741 if (! NILP (old_buf->zv_marker))
1743 Lisp_Object obuf;
1744 XSETBUFFER (obuf, old_buf);
1745 set_marker_both (old_buf->zv_marker, obuf,
1746 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1750 /* Get the undo list from the base buffer, so that it appears
1751 that an indirect buffer shares the undo list of its base. */
1752 if (b->base_buffer)
1753 b->undo_list = b->base_buffer->undo_list;
1755 /* If the new current buffer has markers to record PT, BEGV and ZV
1756 when it is not current, fetch them now. */
1757 if (! NILP (b->pt_marker))
1759 BUF_PT (b) = marker_position (b->pt_marker);
1760 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1762 if (! NILP (b->begv_marker))
1764 BUF_BEGV (b) = marker_position (b->begv_marker);
1765 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1767 if (! NILP (b->zv_marker))
1769 BUF_ZV (b) = marker_position (b->zv_marker);
1770 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1773 /* Look down buffer's list of local Lisp variables
1774 to find and update any that forward into C variables. */
1776 for (tail = b->local_var_alist; !NILP (tail); tail = XCDR (tail))
1778 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1779 if ((BUFFER_LOCAL_VALUEP (valcontents)
1780 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1781 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1782 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1783 /* Just reference the variable
1784 to cause it to become set for this buffer. */
1785 Fsymbol_value (XCAR (XCAR (tail)));
1788 /* Do the same with any others that were local to the previous buffer */
1790 if (old_buf)
1791 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCDR (tail))
1793 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1794 if ((BUFFER_LOCAL_VALUEP (valcontents)
1795 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1796 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1797 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1798 /* Just reference the variable
1799 to cause it to become set for this buffer. */
1800 Fsymbol_value (XCAR (XCAR (tail)));
1804 /* Switch to buffer B temporarily for redisplay purposes.
1805 This avoids certain things that don't need to be done within redisplay. */
1807 void
1808 set_buffer_temp (b)
1809 struct buffer *b;
1811 register struct buffer *old_buf;
1813 if (current_buffer == b)
1814 return;
1816 old_buf = current_buffer;
1817 current_buffer = b;
1819 if (old_buf)
1821 /* If the old current buffer has markers to record PT, BEGV and ZV
1822 when it is not current, update them now. */
1823 if (! NILP (old_buf->pt_marker))
1825 Lisp_Object obuf;
1826 XSETBUFFER (obuf, old_buf);
1827 set_marker_both (old_buf->pt_marker, obuf,
1828 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1830 if (! NILP (old_buf->begv_marker))
1832 Lisp_Object obuf;
1833 XSETBUFFER (obuf, old_buf);
1834 set_marker_both (old_buf->begv_marker, obuf,
1835 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1837 if (! NILP (old_buf->zv_marker))
1839 Lisp_Object obuf;
1840 XSETBUFFER (obuf, old_buf);
1841 set_marker_both (old_buf->zv_marker, obuf,
1842 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1846 /* If the new current buffer has markers to record PT, BEGV and ZV
1847 when it is not current, fetch them now. */
1848 if (! NILP (b->pt_marker))
1850 BUF_PT (b) = marker_position (b->pt_marker);
1851 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1853 if (! NILP (b->begv_marker))
1855 BUF_BEGV (b) = marker_position (b->begv_marker);
1856 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1858 if (! NILP (b->zv_marker))
1860 BUF_ZV (b) = marker_position (b->zv_marker);
1861 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1865 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1866 doc: /* Make the buffer BUFFER current for editing operations.
1867 BUFFER may be a buffer or the name of an existing buffer.
1868 See also `save-excursion' when you want to make a buffer current temporarily.
1869 This function does not display the buffer, so its effect ends
1870 when the current command terminates.
1871 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1872 (buffer)
1873 register Lisp_Object buffer;
1875 register Lisp_Object buf;
1876 buf = Fget_buffer (buffer);
1877 if (NILP (buf))
1878 nsberror (buffer);
1879 if (NILP (XBUFFER (buf)->name))
1880 error ("Selecting deleted buffer");
1881 set_buffer_internal (XBUFFER (buf));
1882 return buf;
1885 /* Set the current buffer to BUFFER provided it is alive. */
1887 Lisp_Object
1888 set_buffer_if_live (buffer)
1889 Lisp_Object buffer;
1891 if (! NILP (XBUFFER (buffer)->name))
1892 Fset_buffer (buffer);
1893 return Qnil;
1896 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1897 Sbarf_if_buffer_read_only, 0, 0, 0,
1898 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1901 if (!NILP (current_buffer->read_only)
1902 && NILP (Vinhibit_read_only))
1903 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1904 return Qnil;
1907 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1908 doc: /* Put BUFFER at the end of the list of all buffers.
1909 There it is the least likely candidate for `other-buffer' to return;
1910 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1911 If BUFFER is nil or omitted, bury the current buffer.
1912 Also, if BUFFER is nil or omitted, remove the current buffer from the
1913 selected window if it is displayed there. */)
1914 (buffer)
1915 register Lisp_Object buffer;
1917 /* Figure out what buffer we're going to bury. */
1918 if (NILP (buffer))
1920 Lisp_Object tem;
1921 XSETBUFFER (buffer, current_buffer);
1923 tem = Fwindow_buffer (selected_window);
1924 /* If we're burying the current buffer, unshow it. */
1925 if (EQ (buffer, tem))
1927 if (NILP (Fwindow_dedicated_p (selected_window)))
1928 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1929 else if (NILP (XWINDOW (selected_window)->parent))
1930 Ficonify_frame (Fwindow_frame (selected_window));
1931 else
1932 Fdelete_window (selected_window);
1935 else
1937 Lisp_Object buf1;
1939 buf1 = Fget_buffer (buffer);
1940 if (NILP (buf1))
1941 nsberror (buffer);
1942 buffer = buf1;
1945 /* Move buffer to the end of the buffer list. Do nothing if the
1946 buffer is killed. */
1947 if (!NILP (XBUFFER (buffer)->name))
1949 Lisp_Object aelt, link;
1951 aelt = Frassq (buffer, Vbuffer_alist);
1952 link = Fmemq (aelt, Vbuffer_alist);
1953 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1954 XSETCDR (link, Qnil);
1955 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1957 /* Removing BUFFER from frame-specific lists
1958 has the effect of putting BUFFER at the end
1959 of the combined list in each frame. */
1960 frames_discard_buffer (buffer);
1963 return Qnil;
1966 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1967 doc: /* Delete the entire contents of the current buffer.
1968 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1969 so the buffer is truly empty after this. */)
1972 Fwiden ();
1974 del_range (BEG, Z);
1976 current_buffer->last_window_start = 1;
1977 /* Prevent warnings, or suspension of auto saving, that would happen
1978 if future size is less than past size. Use of erase-buffer
1979 implies that the future text is not really related to the past text. */
1980 XSETFASTINT (current_buffer->save_length, 0);
1981 return Qnil;
1984 void
1985 validate_region (b, e)
1986 register Lisp_Object *b, *e;
1988 CHECK_NUMBER_COERCE_MARKER (*b);
1989 CHECK_NUMBER_COERCE_MARKER (*e);
1991 if (XINT (*b) > XINT (*e))
1993 Lisp_Object tem;
1994 tem = *b; *b = *e; *e = tem;
1997 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1998 && XINT (*e) <= ZV))
1999 args_out_of_range (*b, *e);
2002 /* Advance BYTE_POS up to a character boundary
2003 and return the adjusted position. */
2005 static int
2006 advance_to_char_boundary (byte_pos)
2007 int byte_pos;
2009 int c;
2011 if (byte_pos == BEG)
2012 /* Beginning of buffer is always a character boundary. */
2013 return BEG;
2015 c = FETCH_BYTE (byte_pos);
2016 if (! CHAR_HEAD_P (c))
2018 /* We should advance BYTE_POS only when C is a constituent of a
2019 multibyte sequence. */
2020 int orig_byte_pos = byte_pos;
2024 byte_pos--;
2025 c = FETCH_BYTE (byte_pos);
2027 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2028 INC_POS (byte_pos);
2029 if (byte_pos < orig_byte_pos)
2030 byte_pos = orig_byte_pos;
2031 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2032 surely advance to the correct character boundary. If C is
2033 not, BYTE_POS was unchanged. */
2036 return byte_pos;
2039 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2040 1, 1, 0,
2041 doc: /* Set the multibyte flag of the current buffer to FLAG.
2042 If FLAG is t, this makes the buffer a multibyte buffer.
2043 If FLAG is nil, this makes the buffer a single-byte buffer.
2044 The buffer contents remain unchanged as a sequence of bytes
2045 but the contents viewed as characters do change. */)
2046 (flag)
2047 Lisp_Object flag;
2049 Lisp_Object tail, markers;
2050 struct buffer *other;
2051 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
2052 int begv = BEGV, zv = ZV;
2053 int narrowed = (BEG != begv || Z != zv);
2054 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2056 if (current_buffer->base_buffer)
2057 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2059 /* Do nothing if nothing actually changes. */
2060 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2061 return flag;
2063 /* It would be better to update the list,
2064 but this is good enough for now. */
2065 if (undo_enabled_p)
2066 current_buffer->undo_list = Qt;
2068 /* If the cached position is for this buffer, clear it out. */
2069 clear_charpos_cache (current_buffer);
2071 if (narrowed)
2072 Fwiden ();
2074 if (NILP (flag))
2076 int pos, stop;
2077 unsigned char *p;
2079 /* Do this first, so it can use CHAR_TO_BYTE
2080 to calculate the old correspondences. */
2081 set_intervals_multibyte (0);
2083 current_buffer->enable_multibyte_characters = Qnil;
2085 Z = Z_BYTE;
2086 BEGV = BEGV_BYTE;
2087 ZV = ZV_BYTE;
2088 GPT = GPT_BYTE;
2089 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2091 tail = BUF_MARKERS (current_buffer);
2092 while (! NILP (tail))
2094 XMARKER (tail)->charpos = XMARKER (tail)->bytepos;
2095 tail = XMARKER (tail)->chain;
2098 /* Convert multibyte form of 8-bit characters to unibyte. */
2099 pos = BEG;
2100 stop = GPT;
2101 p = BEG_ADDR;
2102 while (1)
2104 int c, bytes;
2106 if (pos == stop)
2108 if (pos == Z)
2109 break;
2110 p = GAP_END_ADDR;
2111 stop = Z;
2113 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2114 p += bytes, pos += bytes;
2115 else
2117 c = STRING_CHAR (p, stop - pos);
2118 /* Delete all bytes for this 8-bit character but the
2119 last one, and change the last one to the charcter
2120 code. */
2121 bytes--;
2122 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2123 p = GAP_END_ADDR;
2124 *p++ = c;
2125 pos++;
2126 if (begv > pos)
2127 begv -= bytes;
2128 if (zv > pos)
2129 zv -= bytes;
2130 stop = Z;
2133 if (narrowed)
2134 Fnarrow_to_region (make_number (begv), make_number (zv));
2136 else
2138 int pt = PT;
2139 int pos, stop;
2140 unsigned char *p;
2142 /* Be sure not to have a multibyte sequence striding over the GAP.
2143 Ex: We change this: "...abc\201 _GAP_ \241def..."
2144 to: "...abc _GAP_ \201\241def..." */
2146 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2147 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2149 unsigned char *p = GPT_ADDR - 1;
2151 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2152 if (BASE_LEADING_CODE_P (*p))
2154 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2156 move_gap_both (new_gpt, new_gpt);
2160 /* Make the buffer contents valid as multibyte by converting
2161 8-bit characters to multibyte form. */
2162 pos = BEG;
2163 stop = GPT;
2164 p = BEG_ADDR;
2165 while (1)
2167 int bytes;
2169 if (pos == stop)
2171 if (pos == Z)
2172 break;
2173 p = GAP_END_ADDR;
2174 stop = Z;
2177 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2178 p += bytes, pos += bytes;
2179 else
2181 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2183 bytes = CHAR_STRING (*p, tmp);
2184 *p = tmp[0];
2185 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2186 bytes--;
2187 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2188 /* Now the gap is after the just inserted data. */
2189 pos = GPT;
2190 p = GAP_END_ADDR;
2191 if (pos <= begv)
2192 begv += bytes;
2193 if (pos <= zv)
2194 zv += bytes;
2195 if (pos <= pt)
2196 pt += bytes;
2197 stop = Z;
2201 if (pt != PT)
2202 TEMP_SET_PT (pt);
2204 if (narrowed)
2205 Fnarrow_to_region (make_number (begv), make_number (zv));
2207 /* Do this first, so that chars_in_text asks the right question.
2208 set_intervals_multibyte needs it too. */
2209 current_buffer->enable_multibyte_characters = Qt;
2211 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2212 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2214 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2216 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2217 if (BEGV_BYTE > GPT_BYTE)
2218 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2219 else
2220 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2222 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2223 if (ZV_BYTE > GPT_BYTE)
2224 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2225 else
2226 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2229 int pt_byte = advance_to_char_boundary (PT_BYTE);
2230 int pt;
2232 if (pt_byte > GPT_BYTE)
2233 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2234 else
2235 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2236 TEMP_SET_PT_BOTH (pt, pt_byte);
2239 tail = markers = BUF_MARKERS (current_buffer);
2241 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2242 getting confused by the markers that have not yet been updated.
2243 It is also a signal that it should never create a marker. */
2244 BUF_MARKERS (current_buffer) = Qnil;
2246 while (! NILP (tail))
2248 XMARKER (tail)->bytepos
2249 = advance_to_char_boundary (XMARKER (tail)->bytepos);
2250 XMARKER (tail)->charpos = BYTE_TO_CHAR (XMARKER (tail)->bytepos);
2252 tail = XMARKER (tail)->chain;
2255 /* Make sure no markers were put on the chain
2256 while the chain value was incorrect. */
2257 if (! EQ (BUF_MARKERS (current_buffer), Qnil))
2258 abort ();
2260 BUF_MARKERS (current_buffer) = markers;
2262 /* Do this last, so it can calculate the new correspondences
2263 between chars and bytes. */
2264 set_intervals_multibyte (1);
2267 if (undo_enabled_p)
2268 current_buffer->undo_list = Qnil;
2270 /* Changing the multibyteness of a buffer means that all windows
2271 showing that buffer must be updated thoroughly. */
2272 current_buffer->prevent_redisplay_optimizations_p = 1;
2273 ++windows_or_buffers_changed;
2275 /* Copy this buffer's new multibyte status
2276 into all of its indirect buffers. */
2277 for (other = all_buffers; other; other = other->next)
2278 if (other->base_buffer == current_buffer && !NILP (other->name))
2280 other->enable_multibyte_characters
2281 = current_buffer->enable_multibyte_characters;
2282 other->prevent_redisplay_optimizations_p = 1;
2285 /* Restore the modifiedness of the buffer. */
2286 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2287 Fset_buffer_modified_p (Qnil);
2289 #ifdef subprocesses
2290 /* Update coding systems of this buffer's process (if any). */
2292 Lisp_Object process;
2294 process = Fget_buffer_process (Fcurrent_buffer ());
2295 if (PROCESSP (process))
2296 setup_process_coding_systems (process);
2298 #endif /* subprocesses */
2300 return flag;
2303 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2304 0, 0, 0,
2305 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2306 Most local variable bindings are eliminated so that the default values
2307 become effective once more. Also, the syntax table is set from
2308 `standard-syntax-table', the local keymap is set to nil,
2309 and the abbrev table from `fundamental-mode-abbrev-table'.
2310 This function also forces redisplay of the mode line.
2312 Every function to select a new major mode starts by
2313 calling this function.
2315 As a special exception, local variables whose names have
2316 a non-nil `permanent-local' property are not eliminated by this function.
2318 The first thing this function does is run
2319 the normal hook `change-major-mode-hook'. */)
2322 register Lisp_Object alist, sym, tem;
2323 Lisp_Object oalist;
2325 if (!NILP (Vrun_hooks))
2326 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2327 oalist = current_buffer->local_var_alist;
2329 /* Make sure none of the bindings in oalist
2330 remain swapped in, in their symbols. */
2332 swap_out_buffer_local_variables (current_buffer);
2334 /* Actually eliminate all local bindings of this buffer. */
2336 reset_buffer_local_variables (current_buffer, 0);
2338 /* Any which are supposed to be permanent,
2339 make local again, with the same values they had. */
2341 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2343 sym = XCAR (XCAR (alist));
2344 tem = Fget (sym, Qpermanent_local);
2345 if (! NILP (tem))
2347 Fmake_local_variable (sym);
2348 Fset (sym, XCDR (XCAR (alist)));
2352 /* Force mode-line redisplay. Useful here because all major mode
2353 commands call this function. */
2354 update_mode_lines++;
2356 return Qnil;
2359 /* Make sure no local variables remain set up with buffer B
2360 for their current values. */
2362 static void
2363 swap_out_buffer_local_variables (b)
2364 struct buffer *b;
2366 Lisp_Object oalist, alist, sym, tem, buffer;
2368 XSETBUFFER (buffer, b);
2369 oalist = b->local_var_alist;
2371 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2373 sym = XCAR (XCAR (alist));
2375 /* Need not do anything if some other buffer's binding is now encached. */
2376 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2377 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2379 /* Symbol is set up for this buffer's old local value.
2380 Set it up for the current buffer with the default value. */
2382 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2383 /* Store the symbol's current value into the alist entry
2384 it is currently set up for. This is so that, if the
2385 local is marked permanent, and we make it local again
2386 later in Fkill_all_local_variables, we don't lose the value. */
2387 XSETCDR (XCAR (tem),
2388 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2389 /* Switch to the symbol's default-value alist entry. */
2390 XSETCAR (tem, tem);
2391 /* Mark it as current for buffer B. */
2392 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2393 /* Store the current value into any forwarding in the symbol. */
2394 store_symval_forwarding (sym,
2395 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2396 XCDR (tem), NULL);
2401 /* Find all the overlays in the current buffer that contain position POS.
2402 Return the number found, and store them in a vector in *VEC_PTR.
2403 Store in *LEN_PTR the size allocated for the vector.
2404 Store in *NEXT_PTR the next position after POS where an overlay starts,
2405 or ZV if there are no more overlays.
2406 Store in *PREV_PTR the previous position before POS where an overlay ends,
2407 or where an overlay starts which ends at or after POS;
2408 or BEGV if there are no such overlays.
2409 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2411 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2412 when this function is called.
2414 If EXTEND is non-zero, we make the vector bigger if necessary.
2415 If EXTEND is zero, we never extend the vector,
2416 and we store only as many overlays as will fit.
2417 But we still return the total number of overlays.
2419 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2420 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2421 default (BEGV or ZV). */
2424 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2425 int pos;
2426 int extend;
2427 Lisp_Object **vec_ptr;
2428 int *len_ptr;
2429 int *next_ptr;
2430 int *prev_ptr;
2431 int change_req;
2433 Lisp_Object tail, overlay, start, end;
2434 int idx = 0;
2435 int len = *len_ptr;
2436 Lisp_Object *vec = *vec_ptr;
2437 int next = ZV;
2438 int prev = BEGV;
2439 int inhibit_storing = 0;
2441 for (tail = current_buffer->overlays_before;
2442 GC_CONSP (tail);
2443 tail = XCDR (tail))
2445 int startpos, endpos;
2447 overlay = XCAR (tail);
2449 start = OVERLAY_START (overlay);
2450 end = OVERLAY_END (overlay);
2451 endpos = OVERLAY_POSITION (end);
2452 if (endpos < pos)
2454 if (prev < endpos)
2455 prev = endpos;
2456 break;
2458 startpos = OVERLAY_POSITION (start);
2459 /* This one ends at or after POS
2460 so its start counts for PREV_PTR if it's before POS. */
2461 if (prev < startpos && startpos < pos)
2462 prev = startpos;
2463 if (endpos == pos)
2464 continue;
2465 if (startpos <= pos)
2467 if (idx == len)
2469 /* The supplied vector is full.
2470 Either make it bigger, or don't store any more in it. */
2471 if (extend)
2473 /* Make it work with an initial len == 0. */
2474 len *= 2;
2475 if (len == 0)
2476 len = 4;
2477 *len_ptr = len;
2478 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2479 *vec_ptr = vec;
2481 else
2482 inhibit_storing = 1;
2485 if (!inhibit_storing)
2486 vec[idx] = overlay;
2487 /* Keep counting overlays even if we can't return them all. */
2488 idx++;
2490 else if (startpos < next)
2491 next = startpos;
2494 for (tail = current_buffer->overlays_after;
2495 GC_CONSP (tail);
2496 tail = XCDR (tail))
2498 int startpos, endpos;
2500 overlay = XCAR (tail);
2502 start = OVERLAY_START (overlay);
2503 end = OVERLAY_END (overlay);
2504 startpos = OVERLAY_POSITION (start);
2505 if (pos < startpos)
2507 if (startpos < next)
2508 next = startpos;
2509 break;
2511 endpos = OVERLAY_POSITION (end);
2512 if (pos < endpos)
2514 if (idx == len)
2516 if (extend)
2518 /* Make it work with an initial len == 0. */
2519 len *= 2;
2520 if (len == 0)
2521 len = 4;
2522 *len_ptr = len;
2523 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2524 *vec_ptr = vec;
2526 else
2527 inhibit_storing = 1;
2530 if (!inhibit_storing)
2531 vec[idx] = overlay;
2532 idx++;
2534 if (startpos < pos && startpos > prev)
2535 prev = startpos;
2537 else if (endpos < pos && endpos > prev)
2538 prev = endpos;
2539 else if (endpos == pos && startpos > prev
2540 && (!change_req || startpos < pos))
2541 prev = startpos;
2544 if (next_ptr)
2545 *next_ptr = next;
2546 if (prev_ptr)
2547 *prev_ptr = prev;
2548 return idx;
2551 /* Find all the overlays in the current buffer that overlap the range BEG-END
2552 or are empty at BEG.
2554 Return the number found, and store them in a vector in *VEC_PTR.
2555 Store in *LEN_PTR the size allocated for the vector.
2556 Store in *NEXT_PTR the next position after POS where an overlay starts,
2557 or ZV if there are no more overlays.
2558 Store in *PREV_PTR the previous position before POS where an overlay ends,
2559 or BEGV if there are no previous overlays.
2560 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2562 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2563 when this function is called.
2565 If EXTEND is non-zero, we make the vector bigger if necessary.
2566 If EXTEND is zero, we never extend the vector,
2567 and we store only as many overlays as will fit.
2568 But we still return the total number of overlays. */
2570 static int
2571 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2572 int beg, end;
2573 int extend;
2574 Lisp_Object **vec_ptr;
2575 int *len_ptr;
2576 int *next_ptr;
2577 int *prev_ptr;
2579 Lisp_Object tail, overlay, ostart, oend;
2580 int idx = 0;
2581 int len = *len_ptr;
2582 Lisp_Object *vec = *vec_ptr;
2583 int next = ZV;
2584 int prev = BEGV;
2585 int inhibit_storing = 0;
2587 for (tail = current_buffer->overlays_before;
2588 GC_CONSP (tail);
2589 tail = XCDR (tail))
2591 int startpos, endpos;
2593 overlay = XCAR (tail);
2595 ostart = OVERLAY_START (overlay);
2596 oend = OVERLAY_END (overlay);
2597 endpos = OVERLAY_POSITION (oend);
2598 if (endpos < beg)
2600 if (prev < endpos)
2601 prev = endpos;
2602 break;
2604 startpos = OVERLAY_POSITION (ostart);
2605 /* Count an interval if it either overlaps the range
2606 or is empty at the start of the range. */
2607 if ((beg < endpos && startpos < end)
2608 || (startpos == endpos && beg == endpos))
2610 if (idx == len)
2612 /* The supplied vector is full.
2613 Either make it bigger, or don't store any more in it. */
2614 if (extend)
2616 /* Make it work with an initial len == 0. */
2617 len *= 2;
2618 if (len == 0)
2619 len = 4;
2620 *len_ptr = len;
2621 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2622 *vec_ptr = vec;
2624 else
2625 inhibit_storing = 1;
2628 if (!inhibit_storing)
2629 vec[idx] = overlay;
2630 /* Keep counting overlays even if we can't return them all. */
2631 idx++;
2633 else if (startpos < next)
2634 next = startpos;
2637 for (tail = current_buffer->overlays_after;
2638 GC_CONSP (tail);
2639 tail = XCDR (tail))
2641 int startpos, endpos;
2643 overlay = XCAR (tail);
2645 ostart = OVERLAY_START (overlay);
2646 oend = OVERLAY_END (overlay);
2647 startpos = OVERLAY_POSITION (ostart);
2648 if (end < startpos)
2650 if (startpos < next)
2651 next = startpos;
2652 break;
2654 endpos = OVERLAY_POSITION (oend);
2655 /* Count an interval if it either overlaps the range
2656 or is empty at the start of the range. */
2657 if ((beg < endpos && startpos < end)
2658 || (startpos == endpos && beg == endpos))
2660 if (idx == len)
2662 if (extend)
2664 /* Make it work with an initial len == 0. */
2665 len *= 2;
2666 if (len == 0)
2667 len = 4;
2668 *len_ptr = len;
2669 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2670 *vec_ptr = vec;
2672 else
2673 inhibit_storing = 1;
2676 if (!inhibit_storing)
2677 vec[idx] = overlay;
2678 idx++;
2680 else if (endpos < beg && endpos > prev)
2681 prev = endpos;
2684 if (next_ptr)
2685 *next_ptr = next;
2686 if (prev_ptr)
2687 *prev_ptr = prev;
2688 return idx;
2692 /* Return non-zero if there exists an overlay with a non-nil
2693 `mouse-face' property overlapping OVERLAY. */
2696 mouse_face_overlay_overlaps (overlay)
2697 Lisp_Object overlay;
2699 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2700 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2701 int n, i, size;
2702 Lisp_Object *v, tem;
2704 size = 10;
2705 v = (Lisp_Object *) alloca (size * sizeof *v);
2706 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2707 if (n > size)
2709 v = (Lisp_Object *) alloca (n * sizeof *v);
2710 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2713 for (i = 0; i < n; ++i)
2714 if (!EQ (v[i], overlay)
2715 && (tem = Foverlay_get (overlay, Qmouse_face),
2716 !NILP (tem)))
2717 break;
2719 return i < n;
2724 /* Fast function to just test if we're at an overlay boundary. */
2726 overlay_touches_p (pos)
2727 int pos;
2729 Lisp_Object tail, overlay;
2731 for (tail = current_buffer->overlays_before; GC_CONSP (tail);
2732 tail = XCDR (tail))
2734 int endpos;
2736 overlay = XCAR (tail);
2737 if (!GC_OVERLAYP (overlay))
2738 abort ();
2740 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2741 if (endpos < pos)
2742 break;
2743 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2744 return 1;
2747 for (tail = current_buffer->overlays_after; GC_CONSP (tail);
2748 tail = XCDR (tail))
2750 int startpos;
2752 overlay = XCAR (tail);
2753 if (!GC_OVERLAYP (overlay))
2754 abort ();
2756 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2757 if (pos < startpos)
2758 break;
2759 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2760 return 1;
2762 return 0;
2765 struct sortvec
2767 Lisp_Object overlay;
2768 int beg, end;
2769 int priority;
2772 static int
2773 compare_overlays (v1, v2)
2774 const void *v1, *v2;
2776 const struct sortvec *s1 = (const struct sortvec *) v1;
2777 const struct sortvec *s2 = (const struct sortvec *) v2;
2778 if (s1->priority != s2->priority)
2779 return s1->priority - s2->priority;
2780 if (s1->beg != s2->beg)
2781 return s1->beg - s2->beg;
2782 if (s1->end != s2->end)
2783 return s2->end - s1->end;
2784 return 0;
2787 /* Sort an array of overlays by priority. The array is modified in place.
2788 The return value is the new size; this may be smaller than the original
2789 size if some of the overlays were invalid or were window-specific. */
2791 sort_overlays (overlay_vec, noverlays, w)
2792 Lisp_Object *overlay_vec;
2793 int noverlays;
2794 struct window *w;
2796 int i, j;
2797 struct sortvec *sortvec;
2798 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2800 /* Put the valid and relevant overlays into sortvec. */
2802 for (i = 0, j = 0; i < noverlays; i++)
2804 Lisp_Object tem;
2805 Lisp_Object overlay;
2807 overlay = overlay_vec[i];
2808 if (OVERLAY_VALID (overlay)
2809 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2810 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2812 /* If we're interested in a specific window, then ignore
2813 overlays that are limited to some other window. */
2814 if (w)
2816 Lisp_Object window;
2818 window = Foverlay_get (overlay, Qwindow);
2819 if (WINDOWP (window) && XWINDOW (window) != w)
2820 continue;
2823 /* This overlay is good and counts: put it into sortvec. */
2824 sortvec[j].overlay = overlay;
2825 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2826 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2827 tem = Foverlay_get (overlay, Qpriority);
2828 if (INTEGERP (tem))
2829 sortvec[j].priority = XINT (tem);
2830 else
2831 sortvec[j].priority = 0;
2832 j++;
2835 noverlays = j;
2837 /* Sort the overlays into the proper order: increasing priority. */
2839 if (noverlays > 1)
2840 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2842 for (i = 0; i < noverlays; i++)
2843 overlay_vec[i] = sortvec[i].overlay;
2844 return (noverlays);
2847 struct sortstr
2849 Lisp_Object string, string2;
2850 int size;
2851 int priority;
2854 struct sortstrlist
2856 struct sortstr *buf; /* An array that expands as needed; never freed. */
2857 int size; /* Allocated length of that array. */
2858 int used; /* How much of the array is currently in use. */
2859 int bytes; /* Total length of the strings in buf. */
2862 /* Buffers for storing information about the overlays touching a given
2863 position. These could be automatic variables in overlay_strings, but
2864 it's more efficient to hold onto the memory instead of repeatedly
2865 allocating and freeing it. */
2866 static struct sortstrlist overlay_heads, overlay_tails;
2867 static unsigned char *overlay_str_buf;
2869 /* Allocated length of overlay_str_buf. */
2870 static int overlay_str_len;
2872 /* A comparison function suitable for passing to qsort. */
2873 static int
2874 cmp_for_strings (as1, as2)
2875 char *as1, *as2;
2877 struct sortstr *s1 = (struct sortstr *)as1;
2878 struct sortstr *s2 = (struct sortstr *)as2;
2879 if (s1->size != s2->size)
2880 return s2->size - s1->size;
2881 if (s1->priority != s2->priority)
2882 return s1->priority - s2->priority;
2883 return 0;
2886 static void
2887 record_overlay_string (ssl, str, str2, pri, size)
2888 struct sortstrlist *ssl;
2889 Lisp_Object str, str2, pri;
2890 int size;
2892 int nbytes;
2894 if (ssl->used == ssl->size)
2896 if (ssl->buf)
2897 ssl->size *= 2;
2898 else
2899 ssl->size = 5;
2900 ssl->buf = ((struct sortstr *)
2901 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2903 ssl->buf[ssl->used].string = str;
2904 ssl->buf[ssl->used].string2 = str2;
2905 ssl->buf[ssl->used].size = size;
2906 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2907 ssl->used++;
2909 if (NILP (current_buffer->enable_multibyte_characters))
2910 nbytes = SCHARS (str);
2911 else if (! STRING_MULTIBYTE (str))
2912 nbytes = count_size_as_multibyte (SDATA (str),
2913 SBYTES (str));
2914 else
2915 nbytes = SBYTES (str);
2917 ssl->bytes += nbytes;
2919 if (STRINGP (str2))
2921 if (NILP (current_buffer->enable_multibyte_characters))
2922 nbytes = SCHARS (str2);
2923 else if (! STRING_MULTIBYTE (str2))
2924 nbytes = count_size_as_multibyte (SDATA (str2),
2925 SBYTES (str2));
2926 else
2927 nbytes = SBYTES (str2);
2929 ssl->bytes += nbytes;
2933 /* Return the concatenation of the strings associated with overlays that
2934 begin or end at POS, ignoring overlays that are specific to a window
2935 other than W. The strings are concatenated in the appropriate order:
2936 shorter overlays nest inside longer ones, and higher priority inside
2937 lower. Normally all of the after-strings come first, but zero-sized
2938 overlays have their after-strings ride along with the before-strings
2939 because it would look strange to print them inside-out.
2941 Returns the string length, and stores the contents indirectly through
2942 PSTR, if that variable is non-null. The string may be overwritten by
2943 subsequent calls. */
2946 overlay_strings (pos, w, pstr)
2947 int pos;
2948 struct window *w;
2949 unsigned char **pstr;
2951 Lisp_Object ov, overlay, window, str;
2952 int startpos, endpos;
2953 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
2955 overlay_heads.used = overlay_heads.bytes = 0;
2956 overlay_tails.used = overlay_tails.bytes = 0;
2957 for (ov = current_buffer->overlays_before; CONSP (ov); ov = XCDR (ov))
2959 overlay = XCAR (ov);
2960 if (!OVERLAYP (overlay))
2961 abort ();
2963 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2964 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2965 if (endpos < pos)
2966 break;
2967 if (endpos != pos && startpos != pos)
2968 continue;
2969 window = Foverlay_get (overlay, Qwindow);
2970 if (WINDOWP (window) && XWINDOW (window) != w)
2971 continue;
2972 if (startpos == pos
2973 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2974 record_overlay_string (&overlay_heads, str,
2975 (startpos == endpos
2976 ? Foverlay_get (overlay, Qafter_string)
2977 : Qnil),
2978 Foverlay_get (overlay, Qpriority),
2979 endpos - startpos);
2980 else if (endpos == pos
2981 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2982 record_overlay_string (&overlay_tails, str, Qnil,
2983 Foverlay_get (overlay, Qpriority),
2984 endpos - startpos);
2986 for (ov = current_buffer->overlays_after; CONSP (ov); ov = XCDR (ov))
2988 overlay = XCAR (ov);
2989 if (!OVERLAYP (overlay))
2990 abort ();
2992 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2993 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2994 if (startpos > pos)
2995 break;
2996 if (endpos != pos && startpos != pos)
2997 continue;
2998 window = Foverlay_get (overlay, Qwindow);
2999 if (WINDOWP (window) && XWINDOW (window) != w)
3000 continue;
3001 if (startpos == pos
3002 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3003 record_overlay_string (&overlay_heads, str,
3004 (startpos == endpos
3005 ? Foverlay_get (overlay, Qafter_string)
3006 : Qnil),
3007 Foverlay_get (overlay, Qpriority),
3008 endpos - startpos);
3009 else if (endpos == pos
3010 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3011 record_overlay_string (&overlay_tails, str, Qnil,
3012 Foverlay_get (overlay, Qpriority),
3013 endpos - startpos);
3015 if (overlay_tails.used > 1)
3016 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3017 cmp_for_strings);
3018 if (overlay_heads.used > 1)
3019 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3020 cmp_for_strings);
3021 if (overlay_heads.bytes || overlay_tails.bytes)
3023 Lisp_Object tem;
3024 int i;
3025 unsigned char *p;
3026 int total = overlay_heads.bytes + overlay_tails.bytes;
3028 if (total > overlay_str_len)
3030 overlay_str_len = total;
3031 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3032 total);
3034 p = overlay_str_buf;
3035 for (i = overlay_tails.used; --i >= 0;)
3037 int nbytes;
3038 tem = overlay_tails.buf[i].string;
3039 nbytes = copy_text (SDATA (tem), p,
3040 SBYTES (tem),
3041 STRING_MULTIBYTE (tem), multibyte);
3042 p += nbytes;
3044 for (i = 0; i < overlay_heads.used; ++i)
3046 int nbytes;
3047 tem = overlay_heads.buf[i].string;
3048 nbytes = copy_text (SDATA (tem), p,
3049 SBYTES (tem),
3050 STRING_MULTIBYTE (tem), multibyte);
3051 p += nbytes;
3052 tem = overlay_heads.buf[i].string2;
3053 if (STRINGP (tem))
3055 nbytes = copy_text (SDATA (tem), p,
3056 SBYTES (tem),
3057 STRING_MULTIBYTE (tem), multibyte);
3058 p += nbytes;
3061 if (p != overlay_str_buf + total)
3062 abort ();
3063 if (pstr)
3064 *pstr = overlay_str_buf;
3065 return total;
3067 return 0;
3070 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3072 void
3073 recenter_overlay_lists (buf, pos)
3074 struct buffer *buf;
3075 int pos;
3077 Lisp_Object overlay, tail, next, prev, beg, end;
3079 /* See if anything in overlays_before should move to overlays_after. */
3081 /* We don't strictly need prev in this loop; it should always be nil.
3082 But we use it for symmetry and in case that should cease to be true
3083 with some future change. */
3084 prev = Qnil;
3085 for (tail = buf->overlays_before;
3086 CONSP (tail);
3087 prev = tail, tail = next)
3089 next = XCDR (tail);
3090 overlay = XCAR (tail);
3092 /* If the overlay is not valid, get rid of it. */
3093 if (!OVERLAY_VALID (overlay))
3094 #if 1
3095 abort ();
3096 #else
3098 /* Splice the cons cell TAIL out of overlays_before. */
3099 if (!NILP (prev))
3100 XCDR (prev) = next;
3101 else
3102 buf->overlays_before = next;
3103 tail = prev;
3104 continue;
3106 #endif
3108 beg = OVERLAY_START (overlay);
3109 end = OVERLAY_END (overlay);
3111 if (OVERLAY_POSITION (end) > pos)
3113 /* OVERLAY needs to be moved. */
3114 int where = OVERLAY_POSITION (beg);
3115 Lisp_Object other, other_prev;
3117 /* Splice the cons cell TAIL out of overlays_before. */
3118 if (!NILP (prev))
3119 XSETCDR (prev, next);
3120 else
3121 buf->overlays_before = next;
3123 /* Search thru overlays_after for where to put it. */
3124 other_prev = Qnil;
3125 for (other = buf->overlays_after;
3126 CONSP (other);
3127 other_prev = other, other = XCDR (other))
3129 Lisp_Object otherbeg, otheroverlay;
3131 otheroverlay = XCAR (other);
3132 if (! OVERLAY_VALID (otheroverlay))
3133 abort ();
3135 otherbeg = OVERLAY_START (otheroverlay);
3136 if (OVERLAY_POSITION (otherbeg) >= where)
3137 break;
3140 /* Add TAIL to overlays_after before OTHER. */
3141 XSETCDR (tail, other);
3142 if (!NILP (other_prev))
3143 XSETCDR (other_prev, tail);
3144 else
3145 buf->overlays_after = tail;
3146 tail = prev;
3148 else
3149 /* We've reached the things that should stay in overlays_before.
3150 All the rest of overlays_before must end even earlier,
3151 so stop now. */
3152 break;
3155 /* See if anything in overlays_after should be in overlays_before. */
3156 prev = Qnil;
3157 for (tail = buf->overlays_after;
3158 CONSP (tail);
3159 prev = tail, tail = next)
3161 next = XCDR (tail);
3162 overlay = XCAR (tail);
3164 /* If the overlay is not valid, get rid of it. */
3165 if (!OVERLAY_VALID (overlay))
3166 #if 1
3167 abort ();
3168 #else
3170 /* Splice the cons cell TAIL out of overlays_after. */
3171 if (!NILP (prev))
3172 XCDR (prev) = next;
3173 else
3174 buf->overlays_after = next;
3175 tail = prev;
3176 continue;
3178 #endif
3180 beg = OVERLAY_START (overlay);
3181 end = OVERLAY_END (overlay);
3183 /* Stop looking, when we know that nothing further
3184 can possibly end before POS. */
3185 if (OVERLAY_POSITION (beg) > pos)
3186 break;
3188 if (OVERLAY_POSITION (end) <= pos)
3190 /* OVERLAY needs to be moved. */
3191 int where = OVERLAY_POSITION (end);
3192 Lisp_Object other, other_prev;
3194 /* Splice the cons cell TAIL out of overlays_after. */
3195 if (!NILP (prev))
3196 XSETCDR (prev, next);
3197 else
3198 buf->overlays_after = next;
3200 /* Search thru overlays_before for where to put it. */
3201 other_prev = Qnil;
3202 for (other = buf->overlays_before;
3203 CONSP (other);
3204 other_prev = other, other = XCDR (other))
3206 Lisp_Object otherend, otheroverlay;
3208 otheroverlay = XCAR (other);
3209 if (! OVERLAY_VALID (otheroverlay))
3210 abort ();
3212 otherend = OVERLAY_END (otheroverlay);
3213 if (OVERLAY_POSITION (otherend) <= where)
3214 break;
3217 /* Add TAIL to overlays_before before OTHER. */
3218 XSETCDR (tail, other);
3219 if (!NILP (other_prev))
3220 XSETCDR (other_prev, tail);
3221 else
3222 buf->overlays_before = tail;
3223 tail = prev;
3227 XSETFASTINT (buf->overlay_center, pos);
3230 void
3231 adjust_overlays_for_insert (pos, length)
3232 int pos;
3233 int length;
3235 /* After an insertion, the lists are still sorted properly,
3236 but we may need to update the value of the overlay center. */
3237 if (XFASTINT (current_buffer->overlay_center) >= pos)
3238 XSETFASTINT (current_buffer->overlay_center,
3239 XFASTINT (current_buffer->overlay_center) + length);
3242 void
3243 adjust_overlays_for_delete (pos, length)
3244 int pos;
3245 int length;
3247 if (XFASTINT (current_buffer->overlay_center) < pos)
3248 /* The deletion was to our right. No change needed; the before- and
3249 after-lists are still consistent. */
3251 else if (XFASTINT (current_buffer->overlay_center) > pos + length)
3252 /* The deletion was to our left. We need to adjust the center value
3253 to account for the change in position, but the lists are consistent
3254 given the new value. */
3255 XSETFASTINT (current_buffer->overlay_center,
3256 XFASTINT (current_buffer->overlay_center) - length);
3257 else
3258 /* We're right in the middle. There might be things on the after-list
3259 that now belong on the before-list. Recentering will move them,
3260 and also update the center point. */
3261 recenter_overlay_lists (current_buffer, pos);
3264 /* Fix up overlays that were garbled as a result of permuting markers
3265 in the range START through END. Any overlay with at least one
3266 endpoint in this range will need to be unlinked from the overlay
3267 list and reinserted in its proper place.
3268 Such an overlay might even have negative size at this point.
3269 If so, we'll reverse the endpoints. Can you think of anything
3270 better to do in this situation? */
3271 void
3272 fix_overlays_in_range (start, end)
3273 register int start, end;
3275 Lisp_Object overlay;
3276 Lisp_Object before_list, after_list;
3277 /* These are either nil, indicating that before_list or after_list
3278 should be assigned, or the cons cell the cdr of which should be
3279 assigned. */
3280 Lisp_Object beforep = Qnil, afterp = Qnil;
3281 /* 'Parent', likewise, indicates a cons cell or
3282 current_buffer->overlays_before or overlays_after, depending
3283 which loop we're in. */
3284 Lisp_Object tail, parent;
3285 int startpos, endpos;
3287 /* This algorithm shifts links around instead of consing and GCing.
3288 The loop invariant is that before_list (resp. after_list) is a
3289 well-formed list except that its last element, the CDR of beforep
3290 (resp. afterp) if beforep (afterp) isn't nil or before_list
3291 (after_list) if it is, is still uninitialized. So it's not a bug
3292 that before_list isn't initialized, although it may look
3293 strange. */
3294 for (parent = Qnil, tail = current_buffer->overlays_before; CONSP (tail);)
3296 overlay = XCAR (tail);
3297 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3298 if (endpos < start)
3299 break;
3300 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3301 if (endpos < end
3302 || (startpos >= start && startpos < end))
3304 /* If the overlay is backwards, fix that now. */
3305 if (startpos > endpos)
3307 int tem;
3308 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3309 Qnil);
3310 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3311 Qnil);
3312 tem = startpos; startpos = endpos; endpos = tem;
3314 /* Add it to the end of the wrong list. Later on,
3315 recenter_overlay_lists will move it to the right place. */
3316 if (endpos < XINT (current_buffer->overlay_center))
3318 if (NILP (afterp))
3319 after_list = tail;
3320 else
3321 XSETCDR (afterp, tail);
3322 afterp = tail;
3324 else
3326 if (NILP (beforep))
3327 before_list = tail;
3328 else
3329 XSETCDR (beforep, tail);
3330 beforep = tail;
3332 if (NILP (parent))
3333 current_buffer->overlays_before = XCDR (tail);
3334 else
3335 XSETCDR (parent, XCDR (tail));
3336 tail = XCDR (tail);
3338 else
3339 parent = tail, tail = XCDR (parent);
3341 for (parent = Qnil, tail = current_buffer->overlays_after; CONSP (tail);)
3343 overlay = XCAR (tail);
3344 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3345 if (startpos >= end)
3346 break;
3347 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3348 if (startpos >= start
3349 || (endpos >= start && endpos < end))
3351 if (startpos > endpos)
3353 int tem;
3354 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3355 Qnil);
3356 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3357 Qnil);
3358 tem = startpos; startpos = endpos; endpos = tem;
3360 if (endpos < XINT (current_buffer->overlay_center))
3362 if (NILP (afterp))
3363 after_list = tail;
3364 else
3365 XSETCDR (afterp, tail);
3366 afterp = tail;
3368 else
3370 if (NILP (beforep))
3371 before_list = tail;
3372 else
3373 XSETCDR (beforep, tail);
3374 beforep = tail;
3376 if (NILP (parent))
3377 current_buffer->overlays_after = XCDR (tail);
3378 else
3379 XSETCDR (parent, XCDR (tail));
3380 tail = XCDR (tail);
3382 else
3383 parent = tail, tail = XCDR (parent);
3386 /* Splice the constructed (wrong) lists into the buffer's lists,
3387 and let the recenter function make it sane again. */
3388 if (!NILP (beforep))
3390 XSETCDR (beforep, current_buffer->overlays_before);
3391 current_buffer->overlays_before = before_list;
3393 recenter_overlay_lists (current_buffer,
3394 XINT (current_buffer->overlay_center));
3396 if (!NILP (afterp))
3398 XSETCDR (afterp, current_buffer->overlays_after);
3399 current_buffer->overlays_after = after_list;
3401 recenter_overlay_lists (current_buffer,
3402 XINT (current_buffer->overlay_center));
3405 /* We have two types of overlay: the one whose ending marker is
3406 after-insertion-marker (this is the usual case) and the one whose
3407 ending marker is before-insertion-marker. When `overlays_before'
3408 contains overlays of the latter type and the former type in this
3409 order and both overlays end at inserting position, inserting a text
3410 increases only the ending marker of the latter type, which results
3411 in incorrect ordering of `overlays_before'.
3413 This function fixes ordering of overlays in the slot
3414 `overlays_before' of the buffer *BP. Before the insertion, `point'
3415 was at PREV, and now is at POS. */
3417 void
3418 fix_overlays_before (bp, prev, pos)
3419 struct buffer *bp;
3420 int prev, pos;
3422 /* If parent is nil, replace overlays_before; otherwise, XCDR(parent). */
3423 Lisp_Object tail = bp->overlays_before, parent = Qnil;
3424 Lisp_Object right_pair;
3425 int end;
3427 /* After the insertion, the several overlays may be in incorrect
3428 order. The possibility is that, in the list `overlays_before',
3429 an overlay which ends at POS appears after an overlay which ends
3430 at PREV. Since POS is greater than PREV, we must fix the
3431 ordering of these overlays, by moving overlays ends at POS before
3432 the overlays ends at PREV. */
3434 /* At first, find a place where disordered overlays should be linked
3435 in. It is where an overlay which end before POS exists. (i.e. an
3436 overlay whose ending marker is after-insertion-marker if disorder
3437 exists). */
3438 while (!NILP (tail)
3439 && ((end = OVERLAY_POSITION (OVERLAY_END (XCAR (tail))))
3440 >= pos))
3442 parent = tail;
3443 tail = XCDR (tail);
3446 /* If we don't find such an overlay,
3447 or the found one ends before PREV,
3448 or the found one is the last one in the list,
3449 we don't have to fix anything. */
3450 if (NILP (tail)
3451 || end < prev
3452 || NILP (XCDR (tail)))
3453 return;
3455 right_pair = parent;
3456 parent = tail;
3457 tail = XCDR (tail);
3459 /* Now, end position of overlays in the list TAIL should be before
3460 or equal to PREV. In the loop, an overlay which ends at POS is
3461 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3462 we found an overlay which ends before PREV, the remaining
3463 overlays are in correct order. */
3464 while (!NILP (tail))
3466 end = OVERLAY_POSITION (OVERLAY_END (XCAR (tail)));
3468 if (end == pos)
3469 { /* This overlay is disordered. */
3470 Lisp_Object found = tail;
3472 /* Unlink the found overlay. */
3473 tail = XCDR (found);
3474 XSETCDR (parent, tail);
3475 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3476 and link it into the right place. */
3477 if (NILP (right_pair))
3479 XSETCDR (found, bp->overlays_before);
3480 bp->overlays_before = found;
3482 else
3484 XSETCDR (found, XCDR (right_pair));
3485 XSETCDR (right_pair, found);
3488 else if (end == prev)
3490 parent = tail;
3491 tail = XCDR (tail);
3493 else /* No more disordered overlay. */
3494 break;
3498 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3499 doc: /* Return t if OBJECT is an overlay. */)
3500 (object)
3501 Lisp_Object object;
3503 return (OVERLAYP (object) ? Qt : Qnil);
3506 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3507 doc: /* Create a new overlay with range BEG to END in BUFFER.
3508 If omitted, BUFFER defaults to the current buffer.
3509 BEG and END may be integers or markers.
3510 The fourth arg FRONT-ADVANCE, if non-nil, makes the
3511 front delimiter advance when text is inserted there.
3512 The fifth arg REAR-ADVANCE, if non-nil, makes the
3513 rear delimiter advance when text is inserted there. */)
3514 (beg, end, buffer, front_advance, rear_advance)
3515 Lisp_Object beg, end, buffer;
3516 Lisp_Object front_advance, rear_advance;
3518 Lisp_Object overlay;
3519 struct buffer *b;
3521 if (NILP (buffer))
3522 XSETBUFFER (buffer, current_buffer);
3523 else
3524 CHECK_BUFFER (buffer);
3525 if (MARKERP (beg)
3526 && ! EQ (Fmarker_buffer (beg), buffer))
3527 error ("Marker points into wrong buffer");
3528 if (MARKERP (end)
3529 && ! EQ (Fmarker_buffer (end), buffer))
3530 error ("Marker points into wrong buffer");
3532 CHECK_NUMBER_COERCE_MARKER (beg);
3533 CHECK_NUMBER_COERCE_MARKER (end);
3535 if (XINT (beg) > XINT (end))
3537 Lisp_Object temp;
3538 temp = beg; beg = end; end = temp;
3541 b = XBUFFER (buffer);
3543 beg = Fset_marker (Fmake_marker (), beg, buffer);
3544 end = Fset_marker (Fmake_marker (), end, buffer);
3546 if (!NILP (front_advance))
3547 XMARKER (beg)->insertion_type = 1;
3548 if (!NILP (rear_advance))
3549 XMARKER (end)->insertion_type = 1;
3551 overlay = allocate_misc ();
3552 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3553 XOVERLAY (overlay)->start = beg;
3554 XOVERLAY (overlay)->end = end;
3555 XOVERLAY (overlay)->plist = Qnil;
3557 /* Put the new overlay on the wrong list. */
3558 end = OVERLAY_END (overlay);
3559 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3560 b->overlays_after = Fcons (overlay, b->overlays_after);
3561 else
3562 b->overlays_before = Fcons (overlay, b->overlays_before);
3564 /* This puts it in the right list, and in the right order. */
3565 recenter_overlay_lists (b, XINT (b->overlay_center));
3567 /* We don't need to redisplay the region covered by the overlay, because
3568 the overlay has no properties at the moment. */
3570 return overlay;
3573 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3575 static void
3576 modify_overlay (buf, start, end)
3577 struct buffer *buf;
3578 int start, end;
3580 if (start > end)
3582 int temp = start;
3583 start = end;
3584 end = temp;
3587 BUF_COMPUTE_UNCHANGED (buf, start, end);
3589 /* If this is a buffer not in the selected window,
3590 we must do other windows. */
3591 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3592 windows_or_buffers_changed = 1;
3593 /* If multiple windows show this buffer, we must do other windows. */
3594 else if (buffer_shared > 1)
3595 windows_or_buffers_changed = 1;
3597 ++BUF_OVERLAY_MODIFF (buf);
3601 Lisp_Object Fdelete_overlay ();
3603 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3604 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3605 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3606 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3607 buffer. */)
3608 (overlay, beg, end, buffer)
3609 Lisp_Object overlay, beg, end, buffer;
3611 struct buffer *b, *ob;
3612 Lisp_Object obuffer;
3613 int count = SPECPDL_INDEX ();
3615 CHECK_OVERLAY (overlay);
3616 if (NILP (buffer))
3617 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3618 if (NILP (buffer))
3619 XSETBUFFER (buffer, current_buffer);
3620 CHECK_BUFFER (buffer);
3622 if (MARKERP (beg)
3623 && ! EQ (Fmarker_buffer (beg), buffer))
3624 error ("Marker points into wrong buffer");
3625 if (MARKERP (end)
3626 && ! EQ (Fmarker_buffer (end), buffer))
3627 error ("Marker points into wrong buffer");
3629 CHECK_NUMBER_COERCE_MARKER (beg);
3630 CHECK_NUMBER_COERCE_MARKER (end);
3632 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3633 return Fdelete_overlay (overlay);
3635 if (XINT (beg) > XINT (end))
3637 Lisp_Object temp;
3638 temp = beg; beg = end; end = temp;
3641 specbind (Qinhibit_quit, Qt);
3643 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3644 b = XBUFFER (buffer);
3645 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3647 /* If the overlay has changed buffers, do a thorough redisplay. */
3648 if (!EQ (buffer, obuffer))
3650 /* Redisplay where the overlay was. */
3651 if (!NILP (obuffer))
3653 int o_beg;
3654 int o_end;
3656 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3657 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3659 modify_overlay (ob, o_beg, o_end);
3662 /* Redisplay where the overlay is going to be. */
3663 modify_overlay (b, XINT (beg), XINT (end));
3665 else
3666 /* Redisplay the area the overlay has just left, or just enclosed. */
3668 int o_beg, o_end;
3670 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3671 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3673 if (o_beg == XINT (beg))
3674 modify_overlay (b, o_end, XINT (end));
3675 else if (o_end == XINT (end))
3676 modify_overlay (b, o_beg, XINT (beg));
3677 else
3679 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3680 if (XINT (end) > o_end) o_end = XINT (end);
3681 modify_overlay (b, o_beg, o_end);
3685 if (!NILP (obuffer))
3687 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
3688 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
3691 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3692 Fset_marker (OVERLAY_END (overlay), end, buffer);
3694 /* Put the overlay on the wrong list. */
3695 end = OVERLAY_END (overlay);
3696 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3697 b->overlays_after = Fcons (overlay, b->overlays_after);
3698 else
3699 b->overlays_before = Fcons (overlay, b->overlays_before);
3701 /* This puts it in the right list, and in the right order. */
3702 recenter_overlay_lists (b, XINT (b->overlay_center));
3704 return unbind_to (count, overlay);
3707 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3708 doc: /* Delete the overlay OVERLAY from its buffer. */)
3709 (overlay)
3710 Lisp_Object overlay;
3712 Lisp_Object buffer;
3713 struct buffer *b;
3714 int count = SPECPDL_INDEX ();
3716 CHECK_OVERLAY (overlay);
3718 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3719 if (NILP (buffer))
3720 return Qnil;
3722 b = XBUFFER (buffer);
3723 specbind (Qinhibit_quit, Qt);
3725 b->overlays_before = Fdelq (overlay, b->overlays_before);
3726 b->overlays_after = Fdelq (overlay, b->overlays_after);
3727 modify_overlay (b,
3728 marker_position (OVERLAY_START (overlay)),
3729 marker_position (OVERLAY_END (overlay)));
3730 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3731 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3733 /* When deleting an overlay with before or after strings, turn off
3734 display optimizations for the affected buffer, on the basis that
3735 these strings may contain newlines. This is easier to do than to
3736 check for that situation during redisplay. */
3737 if (!windows_or_buffers_changed
3738 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3739 || !NILP (Foverlay_get (overlay, Qafter_string))))
3740 b->prevent_redisplay_optimizations_p = 1;
3742 return unbind_to (count, Qnil);
3745 /* Overlay dissection functions. */
3747 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3748 doc: /* Return the position at which OVERLAY starts. */)
3749 (overlay)
3750 Lisp_Object overlay;
3752 CHECK_OVERLAY (overlay);
3754 return (Fmarker_position (OVERLAY_START (overlay)));
3757 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3758 doc: /* Return the position at which OVERLAY ends. */)
3759 (overlay)
3760 Lisp_Object overlay;
3762 CHECK_OVERLAY (overlay);
3764 return (Fmarker_position (OVERLAY_END (overlay)));
3767 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3768 doc: /* Return the buffer OVERLAY belongs to. */)
3769 (overlay)
3770 Lisp_Object overlay;
3772 CHECK_OVERLAY (overlay);
3774 return Fmarker_buffer (OVERLAY_START (overlay));
3777 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3778 doc: /* Return a list of the properties on OVERLAY.
3779 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3780 OVERLAY. */)
3781 (overlay)
3782 Lisp_Object overlay;
3784 CHECK_OVERLAY (overlay);
3786 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3790 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3791 doc: /* Return a list of the overlays that contain position POS. */)
3792 (pos)
3793 Lisp_Object pos;
3795 int noverlays;
3796 Lisp_Object *overlay_vec;
3797 int len;
3798 Lisp_Object result;
3800 CHECK_NUMBER_COERCE_MARKER (pos);
3802 len = 10;
3803 /* We can't use alloca here because overlays_at can call xrealloc. */
3804 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3806 /* Put all the overlays we want in a vector in overlay_vec.
3807 Store the length in len. */
3808 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3809 (int *) 0, (int *) 0, 0);
3811 /* Make a list of them all. */
3812 result = Flist (noverlays, overlay_vec);
3814 xfree (overlay_vec);
3815 return result;
3818 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3819 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3820 Overlap means that at least one character is contained within the overlay
3821 and also contained within the specified region.
3822 Empty overlays are included in the result if they are located at BEG
3823 or between BEG and END. */)
3824 (beg, end)
3825 Lisp_Object beg, end;
3827 int noverlays;
3828 Lisp_Object *overlay_vec;
3829 int len;
3830 Lisp_Object result;
3832 CHECK_NUMBER_COERCE_MARKER (beg);
3833 CHECK_NUMBER_COERCE_MARKER (end);
3835 len = 10;
3836 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3838 /* Put all the overlays we want in a vector in overlay_vec.
3839 Store the length in len. */
3840 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3841 (int *) 0, (int *) 0);
3843 /* Make a list of them all. */
3844 result = Flist (noverlays, overlay_vec);
3846 xfree (overlay_vec);
3847 return result;
3850 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3851 1, 1, 0,
3852 doc: /* Return the next position after POS where an overlay starts or ends.
3853 If there are no more overlay boundaries after POS, return (point-max). */)
3854 (pos)
3855 Lisp_Object pos;
3857 int noverlays;
3858 int endpos;
3859 Lisp_Object *overlay_vec;
3860 int len;
3861 int i;
3863 CHECK_NUMBER_COERCE_MARKER (pos);
3865 len = 10;
3866 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3868 /* Put all the overlays we want in a vector in overlay_vec.
3869 Store the length in len.
3870 endpos gets the position where the next overlay starts. */
3871 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3872 &endpos, (int *) 0, 1);
3874 /* If any of these overlays ends before endpos,
3875 use its ending point instead. */
3876 for (i = 0; i < noverlays; i++)
3878 Lisp_Object oend;
3879 int oendpos;
3881 oend = OVERLAY_END (overlay_vec[i]);
3882 oendpos = OVERLAY_POSITION (oend);
3883 if (oendpos < endpos)
3884 endpos = oendpos;
3887 xfree (overlay_vec);
3888 return make_number (endpos);
3891 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3892 Sprevious_overlay_change, 1, 1, 0,
3893 doc: /* Return the previous position before POS where an overlay starts or ends.
3894 If there are no more overlay boundaries before POS, return (point-min). */)
3895 (pos)
3896 Lisp_Object pos;
3898 int noverlays;
3899 int prevpos;
3900 Lisp_Object *overlay_vec;
3901 int len;
3903 CHECK_NUMBER_COERCE_MARKER (pos);
3905 /* At beginning of buffer, we know the answer;
3906 avoid bug subtracting 1 below. */
3907 if (XINT (pos) == BEGV)
3908 return pos;
3910 len = 10;
3911 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3913 /* Put all the overlays we want in a vector in overlay_vec.
3914 Store the length in len.
3915 prevpos gets the position of the previous change. */
3916 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3917 (int *) 0, &prevpos, 1);
3919 xfree (overlay_vec);
3920 return make_number (prevpos);
3923 /* These functions are for debugging overlays. */
3925 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3926 doc: /* Return a pair of lists giving all the overlays of the current buffer.
3927 The car has all the overlays before the overlay center;
3928 the cdr has all the overlays after the overlay center.
3929 Recentering overlays moves overlays between these lists.
3930 The lists you get are copies, so that changing them has no effect.
3931 However, the overlays you get are the real objects that the buffer uses. */)
3934 Lisp_Object before, after;
3935 before = current_buffer->overlays_before;
3936 if (CONSP (before))
3937 before = Fcopy_sequence (before);
3938 after = current_buffer->overlays_after;
3939 if (CONSP (after))
3940 after = Fcopy_sequence (after);
3942 return Fcons (before, after);
3945 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
3946 doc: /* Recenter the overlays of the current buffer around position POS.
3947 That makes overlay lookup faster for positions near POS (but perhaps slower
3948 for positions far away from POS). */)
3949 (pos)
3950 Lisp_Object pos;
3952 CHECK_NUMBER_COERCE_MARKER (pos);
3954 recenter_overlay_lists (current_buffer, XINT (pos));
3955 return Qnil;
3958 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
3959 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
3960 (overlay, prop)
3961 Lisp_Object overlay, prop;
3963 CHECK_OVERLAY (overlay);
3964 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
3967 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
3968 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
3969 (overlay, prop, value)
3970 Lisp_Object overlay, prop, value;
3972 Lisp_Object tail, buffer;
3973 int changed;
3975 CHECK_OVERLAY (overlay);
3977 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3979 for (tail = XOVERLAY (overlay)->plist;
3980 CONSP (tail) && CONSP (XCDR (tail));
3981 tail = XCDR (XCDR (tail)))
3982 if (EQ (XCAR (tail), prop))
3984 changed = !EQ (XCAR (XCDR (tail)), value);
3985 XSETCAR (XCDR (tail), value);
3986 goto found;
3988 /* It wasn't in the list, so add it to the front. */
3989 changed = !NILP (value);
3990 XOVERLAY (overlay)->plist
3991 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
3992 found:
3993 if (! NILP (buffer))
3995 if (changed)
3996 modify_overlay (XBUFFER (buffer),
3997 marker_position (OVERLAY_START (overlay)),
3998 marker_position (OVERLAY_END (overlay)));
3999 if (EQ (prop, Qevaporate) && ! NILP (value)
4000 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4001 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4002 Fdelete_overlay (overlay);
4004 return value;
4007 /* Subroutine of report_overlay_modification. */
4009 /* Lisp vector holding overlay hook functions to call.
4010 Vector elements come in pairs.
4011 Each even-index element is a list of hook functions.
4012 The following odd-index element is the overlay they came from.
4014 Before the buffer change, we fill in this vector
4015 as we call overlay hook functions.
4016 After the buffer change, we get the functions to call from this vector.
4017 This way we always call the same functions before and after the change. */
4018 static Lisp_Object last_overlay_modification_hooks;
4020 /* Number of elements actually used in last_overlay_modification_hooks. */
4021 static int last_overlay_modification_hooks_used;
4023 /* Add one functionlist/overlay pair
4024 to the end of last_overlay_modification_hooks. */
4026 static void
4027 add_overlay_mod_hooklist (functionlist, overlay)
4028 Lisp_Object functionlist, overlay;
4030 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4032 if (last_overlay_modification_hooks_used == oldsize)
4034 Lisp_Object old;
4035 old = last_overlay_modification_hooks;
4036 last_overlay_modification_hooks
4037 = Fmake_vector (make_number (oldsize * 2), Qnil);
4038 bcopy (XVECTOR (old)->contents,
4039 XVECTOR (last_overlay_modification_hooks)->contents,
4040 sizeof (Lisp_Object) * oldsize);
4042 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = functionlist;
4043 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = overlay;
4046 /* Run the modification-hooks of overlays that include
4047 any part of the text in START to END.
4048 If this change is an insertion, also
4049 run the insert-before-hooks of overlay starting at END,
4050 and the insert-after-hooks of overlay ending at START.
4052 This is called both before and after the modification.
4053 AFTER is nonzero when we call after the modification.
4055 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4056 When AFTER is nonzero, they are the start position,
4057 the position after the inserted new text,
4058 and the length of deleted or replaced old text. */
4060 void
4061 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4062 Lisp_Object start, end;
4063 int after;
4064 Lisp_Object arg1, arg2, arg3;
4066 Lisp_Object prop, overlay, tail;
4067 /* 1 if this change is an insertion. */
4068 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4069 int tail_copied;
4070 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4072 overlay = Qnil;
4073 tail = Qnil;
4074 GCPRO5 (overlay, tail, arg1, arg2, arg3);
4076 if (after)
4078 /* Call the functions recorded in last_overlay_modification_hooks
4079 rather than scanning the overlays again.
4080 First copy the vector contents, in case some of these hooks
4081 do subsequent modification of the buffer. */
4082 int size = last_overlay_modification_hooks_used;
4083 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4084 int i;
4086 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4087 copy, size * sizeof (Lisp_Object));
4088 gcpro1.var = copy;
4089 gcpro1.nvars = size;
4091 for (i = 0; i < size;)
4093 Lisp_Object prop, overlay;
4094 prop = copy[i++];
4095 overlay = copy[i++];
4096 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4098 UNGCPRO;
4099 return;
4102 /* We are being called before a change.
4103 Scan the overlays to find the functions to call. */
4104 last_overlay_modification_hooks_used = 0;
4105 tail_copied = 0;
4106 for (tail = current_buffer->overlays_before;
4107 CONSP (tail);
4108 tail = XCDR (tail))
4110 int startpos, endpos;
4111 Lisp_Object ostart, oend;
4113 overlay = XCAR (tail);
4115 ostart = OVERLAY_START (overlay);
4116 oend = OVERLAY_END (overlay);
4117 endpos = OVERLAY_POSITION (oend);
4118 if (XFASTINT (start) > endpos)
4119 break;
4120 startpos = OVERLAY_POSITION (ostart);
4121 if (insertion && (XFASTINT (start) == startpos
4122 || XFASTINT (end) == startpos))
4124 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4125 if (!NILP (prop))
4127 /* Copy TAIL in case the hook recenters the overlay lists. */
4128 if (!tail_copied)
4129 tail = Fcopy_sequence (tail);
4130 tail_copied = 1;
4131 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4134 if (insertion && (XFASTINT (start) == endpos
4135 || XFASTINT (end) == endpos))
4137 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4138 if (!NILP (prop))
4140 if (!tail_copied)
4141 tail = Fcopy_sequence (tail);
4142 tail_copied = 1;
4143 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4146 /* Test for intersecting intervals. This does the right thing
4147 for both insertion and deletion. */
4148 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4150 prop = Foverlay_get (overlay, Qmodification_hooks);
4151 if (!NILP (prop))
4153 if (!tail_copied)
4154 tail = Fcopy_sequence (tail);
4155 tail_copied = 1;
4156 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4161 tail_copied = 0;
4162 for (tail = current_buffer->overlays_after;
4163 CONSP (tail);
4164 tail = XCDR (tail))
4166 int startpos, endpos;
4167 Lisp_Object ostart, oend;
4169 overlay = XCAR (tail);
4171 ostart = OVERLAY_START (overlay);
4172 oend = OVERLAY_END (overlay);
4173 startpos = OVERLAY_POSITION (ostart);
4174 endpos = OVERLAY_POSITION (oend);
4175 if (XFASTINT (end) < startpos)
4176 break;
4177 if (insertion && (XFASTINT (start) == startpos
4178 || XFASTINT (end) == startpos))
4180 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4181 if (!NILP (prop))
4183 if (!tail_copied)
4184 tail = Fcopy_sequence (tail);
4185 tail_copied = 1;
4186 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4189 if (insertion && (XFASTINT (start) == endpos
4190 || XFASTINT (end) == endpos))
4192 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4193 if (!NILP (prop))
4195 if (!tail_copied)
4196 tail = Fcopy_sequence (tail);
4197 tail_copied = 1;
4198 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4201 /* Test for intersecting intervals. This does the right thing
4202 for both insertion and deletion. */
4203 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4205 prop = Foverlay_get (overlay, Qmodification_hooks);
4206 if (!NILP (prop))
4208 if (!tail_copied)
4209 tail = Fcopy_sequence (tail);
4210 tail_copied = 1;
4211 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4216 UNGCPRO;
4219 static void
4220 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4221 Lisp_Object list, overlay;
4222 int after;
4223 Lisp_Object arg1, arg2, arg3;
4225 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4227 GCPRO4 (list, arg1, arg2, arg3);
4228 if (! after)
4229 add_overlay_mod_hooklist (list, overlay);
4231 while (CONSP (list))
4233 if (NILP (arg3))
4234 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4235 else
4236 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4237 list = XCDR (list);
4239 UNGCPRO;
4242 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4243 property is set. */
4244 void
4245 evaporate_overlays (pos)
4246 int pos;
4248 Lisp_Object tail, overlay, hit_list;
4250 hit_list = Qnil;
4251 if (pos <= XFASTINT (current_buffer->overlay_center))
4252 for (tail = current_buffer->overlays_before; CONSP (tail);
4253 tail = XCDR (tail))
4255 int endpos;
4256 overlay = XCAR (tail);
4257 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4258 if (endpos < pos)
4259 break;
4260 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4261 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4262 hit_list = Fcons (overlay, hit_list);
4264 else
4265 for (tail = current_buffer->overlays_after; CONSP (tail);
4266 tail = XCDR (tail))
4268 int startpos;
4269 overlay = XCAR (tail);
4270 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4271 if (startpos > pos)
4272 break;
4273 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4274 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4275 hit_list = Fcons (overlay, hit_list);
4277 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4278 Fdelete_overlay (XCAR (hit_list));
4281 /* Somebody has tried to store a value with an unacceptable type
4282 in the slot with offset OFFSET. */
4284 void
4285 buffer_slot_type_mismatch (offset)
4286 int offset;
4288 Lisp_Object sym;
4289 char *type_name;
4291 switch (XINT (PER_BUFFER_TYPE (offset)))
4293 case Lisp_Int:
4294 type_name = "integers";
4295 break;
4297 case Lisp_String:
4298 type_name = "strings";
4299 break;
4301 case Lisp_Symbol:
4302 type_name = "symbols";
4303 break;
4305 default:
4306 abort ();
4309 sym = PER_BUFFER_SYMBOL (offset);
4310 error ("Only %s should be stored in the buffer-local variable %s",
4311 type_name, SDATA (SYMBOL_NAME (sym)));
4315 /***********************************************************************
4316 Allocation with mmap
4317 ***********************************************************************/
4319 #ifdef USE_MMAP_FOR_BUFFERS
4321 #include <sys/types.h>
4322 #include <sys/mman.h>
4324 #ifndef MAP_ANON
4325 #ifdef MAP_ANONYMOUS
4326 #define MAP_ANON MAP_ANONYMOUS
4327 #else
4328 #define MAP_ANON 0
4329 #endif
4330 #endif
4332 #ifndef MAP_FAILED
4333 #define MAP_FAILED ((void *) -1)
4334 #endif
4336 #include <stdio.h>
4337 #include <errno.h>
4339 #if MAP_ANON == 0
4340 #include <fcntl.h>
4341 #endif
4343 #include "coding.h"
4346 /* Memory is allocated in regions which are mapped using mmap(2).
4347 The current implementation lets the system select mapped
4348 addresses; we're not using MAP_FIXED in general, except when
4349 trying to enlarge regions.
4351 Each mapped region starts with a mmap_region structure, the user
4352 area starts after that structure, aligned to MEM_ALIGN.
4354 +-----------------------+
4355 | struct mmap_info + |
4356 | padding |
4357 +-----------------------+
4358 | user data |
4361 +-----------------------+ */
4363 struct mmap_region
4365 /* User-specified size. */
4366 size_t nbytes_specified;
4368 /* Number of bytes mapped */
4369 size_t nbytes_mapped;
4371 /* Pointer to the location holding the address of the memory
4372 allocated with the mmap'd block. The variable actually points
4373 after this structure. */
4374 POINTER_TYPE **var;
4376 /* Next and previous in list of all mmap'd regions. */
4377 struct mmap_region *next, *prev;
4380 /* Doubly-linked list of mmap'd regions. */
4382 static struct mmap_region *mmap_regions;
4384 /* File descriptor for mmap. If we don't have anonymous mapping,
4385 /dev/zero will be opened on it. */
4387 static int mmap_fd;
4389 /* Temporary storage for mmap_set_vars, see there. */
4391 static struct mmap_region *mmap_regions_1;
4392 static int mmap_fd_1;
4394 /* Page size on this system. */
4396 static int mmap_page_size;
4398 /* 1 means mmap has been intialized. */
4400 static int mmap_initialized_p;
4402 /* Value is X rounded up to the next multiple of N. */
4404 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4406 /* Size of mmap_region structure plus padding. */
4408 #define MMAP_REGION_STRUCT_SIZE \
4409 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4411 /* Given a pointer P to the start of the user-visible part of a mapped
4412 region, return a pointer to the start of the region. */
4414 #define MMAP_REGION(P) \
4415 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4417 /* Given a pointer P to the start of a mapped region, return a pointer
4418 to the start of the user-visible part of the region. */
4420 #define MMAP_USER_AREA(P) \
4421 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4423 #define MEM_ALIGN sizeof (double)
4425 /* Predicate returning true if part of the address range [START .. END]
4426 is currently mapped. Used to prevent overwriting an existing
4427 memory mapping.
4429 Default is to conservativly assume the address range is occupied by
4430 something else. This can be overridden by system configuration
4431 files if system-specific means to determine this exists. */
4433 #ifndef MMAP_ALLOCATED_P
4434 #define MMAP_ALLOCATED_P(start, end) 1
4435 #endif
4437 /* Function prototypes. */
4439 static int mmap_free_1 P_ ((struct mmap_region *));
4440 static int mmap_enlarge P_ ((struct mmap_region *, int));
4441 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4442 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4443 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4444 static void mmap_free P_ ((POINTER_TYPE **ptr));
4445 static void mmap_init P_ ((void));
4448 /* Return a region overlapping address range START...END, or null if
4449 none. END is not including, i.e. the last byte in the range
4450 is at END - 1. */
4452 static struct mmap_region *
4453 mmap_find (start, end)
4454 POINTER_TYPE *start, *end;
4456 struct mmap_region *r;
4457 char *s = (char *) start, *e = (char *) end;
4459 for (r = mmap_regions; r; r = r->next)
4461 char *rstart = (char *) r;
4462 char *rend = rstart + r->nbytes_mapped;
4464 if (/* First byte of range, i.e. START, in this region? */
4465 (s >= rstart && s < rend)
4466 /* Last byte of range, i.e. END - 1, in this region? */
4467 || (e > rstart && e <= rend)
4468 /* First byte of this region in the range? */
4469 || (rstart >= s && rstart < e)
4470 /* Last byte of this region in the range? */
4471 || (rend > s && rend <= e))
4472 break;
4475 return r;
4479 /* Unmap a region. P is a pointer to the start of the user-araa of
4480 the region. Value is non-zero if successful. */
4482 static int
4483 mmap_free_1 (r)
4484 struct mmap_region *r;
4486 if (r->next)
4487 r->next->prev = r->prev;
4488 if (r->prev)
4489 r->prev->next = r->next;
4490 else
4491 mmap_regions = r->next;
4493 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4495 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4496 return 0;
4499 return 1;
4503 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4504 Value is non-zero if successful. */
4506 static int
4507 mmap_enlarge (r, npages)
4508 struct mmap_region *r;
4509 int npages;
4511 char *region_end = (char *) r + r->nbytes_mapped;
4512 size_t nbytes;
4513 int success = 0;
4515 if (npages < 0)
4517 /* Unmap pages at the end of the region. */
4518 nbytes = - npages * mmap_page_size;
4519 if (munmap (region_end - nbytes, nbytes) == -1)
4520 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4521 else
4523 r->nbytes_mapped -= nbytes;
4524 success = 1;
4527 else if (npages > 0)
4529 nbytes = npages * mmap_page_size;
4531 /* Try to map additional pages at the end of the region. We
4532 cannot do this if the address range is already occupied by
4533 something else because mmap deletes any previous mapping.
4534 I'm not sure this is worth doing, let's see. */
4535 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4537 POINTER_TYPE *p;
4539 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4540 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4541 if (p == MAP_FAILED)
4542 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4543 else if (p != (POINTER_TYPE *) region_end)
4545 /* Kernels are free to choose a different address. In
4546 that case, unmap what we've mapped above; we have
4547 no use for it. */
4548 if (munmap (p, nbytes) == -1)
4549 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4551 else
4553 r->nbytes_mapped += nbytes;
4554 success = 1;
4559 return success;
4563 /* Set or reset variables holding references to mapped regions. If
4564 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4565 non-zero, set all variables to the start of the user-areas
4566 of mapped regions.
4568 This function is called from Fdump_emacs to ensure that the dumped
4569 Emacs doesn't contain references to memory that won't be mapped
4570 when Emacs starts. */
4572 void
4573 mmap_set_vars (restore_p)
4574 int restore_p;
4576 struct mmap_region *r;
4578 if (restore_p)
4580 mmap_regions = mmap_regions_1;
4581 mmap_fd = mmap_fd_1;
4582 for (r = mmap_regions; r; r = r->next)
4583 *r->var = MMAP_USER_AREA (r);
4585 else
4587 for (r = mmap_regions; r; r = r->next)
4588 *r->var = NULL;
4589 mmap_regions_1 = mmap_regions;
4590 mmap_regions = NULL;
4591 mmap_fd_1 = mmap_fd;
4592 mmap_fd = -1;
4597 /* Allocate a block of storage large enough to hold NBYTES bytes of
4598 data. A pointer to the data is returned in *VAR. VAR is thus the
4599 address of some variable which will use the data area.
4601 The allocation of 0 bytes is valid.
4603 If we can't allocate the necessary memory, set *VAR to null, and
4604 return null. */
4606 static POINTER_TYPE *
4607 mmap_alloc (var, nbytes)
4608 POINTER_TYPE **var;
4609 size_t nbytes;
4611 void *p;
4612 size_t map;
4614 mmap_init ();
4616 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4617 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4618 mmap_fd, 0);
4620 if (p == MAP_FAILED)
4622 if (errno != ENOMEM)
4623 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4624 p = NULL;
4626 else
4628 struct mmap_region *r = (struct mmap_region *) p;
4630 r->nbytes_specified = nbytes;
4631 r->nbytes_mapped = map;
4632 r->var = var;
4633 r->prev = NULL;
4634 r->next = mmap_regions;
4635 if (r->next)
4636 r->next->prev = r;
4637 mmap_regions = r;
4639 p = MMAP_USER_AREA (p);
4642 return *var = p;
4646 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4647 resize it to size NBYTES. Change *VAR to reflect the new block,
4648 and return this value. If more memory cannot be allocated, then
4649 leave *VAR unchanged, and return null. */
4651 static POINTER_TYPE *
4652 mmap_realloc (var, nbytes)
4653 POINTER_TYPE **var;
4654 size_t nbytes;
4656 POINTER_TYPE *result;
4658 mmap_init ();
4660 if (*var == NULL)
4661 result = mmap_alloc (var, nbytes);
4662 else if (nbytes == 0)
4664 mmap_free (var);
4665 result = mmap_alloc (var, nbytes);
4667 else
4669 struct mmap_region *r = MMAP_REGION (*var);
4670 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4672 if (room < nbytes)
4674 /* Must enlarge. */
4675 POINTER_TYPE *old_ptr = *var;
4677 /* Try to map additional pages at the end of the region.
4678 If that fails, allocate a new region, copy data
4679 from the old region, then free it. */
4680 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4681 / mmap_page_size)))
4683 r->nbytes_specified = nbytes;
4684 *var = result = old_ptr;
4686 else if (mmap_alloc (var, nbytes))
4688 bcopy (old_ptr, *var, r->nbytes_specified);
4689 mmap_free_1 (MMAP_REGION (old_ptr));
4690 result = *var;
4691 r = MMAP_REGION (result);
4692 r->nbytes_specified = nbytes;
4694 else
4696 *var = old_ptr;
4697 result = NULL;
4700 else if (room - nbytes >= mmap_page_size)
4702 /* Shrinking by at least a page. Let's give some
4703 memory back to the system.
4705 The extra parens are to make the division happens first,
4706 on positive values, so we know it will round towards
4707 zero. */
4708 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4709 result = *var;
4710 r->nbytes_specified = nbytes;
4712 else
4714 /* Leave it alone. */
4715 result = *var;
4716 r->nbytes_specified = nbytes;
4720 return result;
4724 /* Free a block of relocatable storage whose data is pointed to by
4725 PTR. Store 0 in *PTR to show there's no block allocated. */
4727 static void
4728 mmap_free (var)
4729 POINTER_TYPE **var;
4731 mmap_init ();
4733 if (*var)
4735 mmap_free_1 (MMAP_REGION (*var));
4736 *var = NULL;
4741 /* Perform necessary intializations for the use of mmap. */
4743 static void
4744 mmap_init ()
4746 #if MAP_ANON == 0
4747 /* The value of mmap_fd is initially 0 in temacs, and -1
4748 in a dumped Emacs. */
4749 if (mmap_fd <= 0)
4751 /* No anonymous mmap -- we need the file descriptor. */
4752 mmap_fd = open ("/dev/zero", O_RDONLY);
4753 if (mmap_fd == -1)
4754 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4756 #endif /* MAP_ANON == 0 */
4758 if (mmap_initialized_p)
4759 return;
4760 mmap_initialized_p = 1;
4762 #if MAP_ANON != 0
4763 mmap_fd = -1;
4764 #endif
4766 mmap_page_size = getpagesize ();
4769 #endif /* USE_MMAP_FOR_BUFFERS */
4773 /***********************************************************************
4774 Buffer-text Allocation
4775 ***********************************************************************/
4777 #ifdef REL_ALLOC
4778 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4779 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4780 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4781 #endif /* REL_ALLOC */
4784 /* Allocate NBYTES bytes for buffer B's text buffer. */
4786 static void
4787 alloc_buffer_text (b, nbytes)
4788 struct buffer *b;
4789 size_t nbytes;
4791 POINTER_TYPE *p;
4793 BLOCK_INPUT;
4794 #if defined USE_MMAP_FOR_BUFFERS
4795 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4796 #elif defined REL_ALLOC
4797 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4798 #else
4799 p = xmalloc (nbytes);
4800 #endif
4802 if (p == NULL)
4804 UNBLOCK_INPUT;
4805 memory_full ();
4808 b->text->beg = (unsigned char *) p;
4809 UNBLOCK_INPUT;
4812 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4813 shrink it. */
4815 void
4816 enlarge_buffer_text (b, delta)
4817 struct buffer *b;
4818 int delta;
4820 POINTER_TYPE *p;
4821 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4822 + delta);
4823 BLOCK_INPUT;
4824 #if defined USE_MMAP_FOR_BUFFERS
4825 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4826 #elif defined REL_ALLOC
4827 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4828 #else
4829 p = xrealloc (b->text->beg, nbytes);
4830 #endif
4832 if (p == NULL)
4834 UNBLOCK_INPUT;
4835 memory_full ();
4838 BUF_BEG_ADDR (b) = (unsigned char *) p;
4839 UNBLOCK_INPUT;
4843 /* Free buffer B's text buffer. */
4845 static void
4846 free_buffer_text (b)
4847 struct buffer *b;
4849 BLOCK_INPUT;
4851 #if defined USE_MMAP_FOR_BUFFERS
4852 mmap_free ((POINTER_TYPE **) &b->text->beg);
4853 #elif defined REL_ALLOC
4854 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4855 #else
4856 xfree (b->text->beg);
4857 #endif
4859 BUF_BEG_ADDR (b) = NULL;
4860 UNBLOCK_INPUT;
4865 /***********************************************************************
4866 Initialization
4867 ***********************************************************************/
4869 void
4870 init_buffer_once ()
4872 int idx;
4874 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4876 /* Make sure all markable slots in buffer_defaults
4877 are initialized reasonably, so mark_buffer won't choke. */
4878 reset_buffer (&buffer_defaults);
4879 reset_buffer_local_variables (&buffer_defaults, 1);
4880 reset_buffer (&buffer_local_symbols);
4881 reset_buffer_local_variables (&buffer_local_symbols, 1);
4882 /* Prevent GC from getting confused. */
4883 buffer_defaults.text = &buffer_defaults.own_text;
4884 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4885 BUF_INTERVALS (&buffer_defaults) = 0;
4886 BUF_INTERVALS (&buffer_local_symbols) = 0;
4887 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4888 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4890 /* Set up the default values of various buffer slots. */
4891 /* Must do these before making the first buffer! */
4893 /* real setup is done in bindings.el */
4894 buffer_defaults.mode_line_format = build_string ("%-");
4895 buffer_defaults.header_line_format = Qnil;
4896 buffer_defaults.abbrev_mode = Qnil;
4897 buffer_defaults.overwrite_mode = Qnil;
4898 buffer_defaults.case_fold_search = Qt;
4899 buffer_defaults.auto_fill_function = Qnil;
4900 buffer_defaults.selective_display = Qnil;
4901 #ifndef old
4902 buffer_defaults.selective_display_ellipses = Qt;
4903 #endif
4904 buffer_defaults.abbrev_table = Qnil;
4905 buffer_defaults.display_table = Qnil;
4906 buffer_defaults.undo_list = Qnil;
4907 buffer_defaults.mark_active = Qnil;
4908 buffer_defaults.file_format = Qnil;
4909 buffer_defaults.overlays_before = Qnil;
4910 buffer_defaults.overlays_after = Qnil;
4911 XSETFASTINT (buffer_defaults.overlay_center, BEG);
4913 XSETFASTINT (buffer_defaults.tab_width, 8);
4914 buffer_defaults.truncate_lines = Qnil;
4915 buffer_defaults.ctl_arrow = Qt;
4916 buffer_defaults.direction_reversed = Qnil;
4917 buffer_defaults.cursor_type = Qt;
4918 buffer_defaults.extra_line_spacing = Qnil;
4920 #ifdef DOS_NT
4921 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4922 #endif
4923 buffer_defaults.enable_multibyte_characters = Qt;
4924 buffer_defaults.buffer_file_coding_system = Qnil;
4925 XSETFASTINT (buffer_defaults.fill_column, 70);
4926 XSETFASTINT (buffer_defaults.left_margin, 0);
4927 buffer_defaults.cache_long_line_scans = Qnil;
4928 buffer_defaults.file_truename = Qnil;
4929 XSETFASTINT (buffer_defaults.display_count, 0);
4930 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
4931 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
4932 buffer_defaults.left_fringe_width = Qnil;
4933 buffer_defaults.right_fringe_width = Qnil;
4934 buffer_defaults.fringes_outside_margins = Qnil;
4935 buffer_defaults.scroll_bar_width = Qnil;
4936 buffer_defaults.vertical_scroll_bar_type = Qt;
4937 buffer_defaults.indicate_empty_lines = Qnil;
4938 buffer_defaults.scroll_up_aggressively = Qnil;
4939 buffer_defaults.scroll_down_aggressively = Qnil;
4940 buffer_defaults.display_time = Qnil;
4942 /* Assign the local-flags to the slots that have default values.
4943 The local flag is a bit that is used in the buffer
4944 to say that it has its own local value for the slot.
4945 The local flag bits are in the local_var_flags slot of the buffer. */
4947 /* Nothing can work if this isn't true */
4948 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4950 /* 0 means not a lisp var, -1 means always local, else mask */
4951 bzero (&buffer_local_flags, sizeof buffer_local_flags);
4952 XSETINT (buffer_local_flags.filename, -1);
4953 XSETINT (buffer_local_flags.directory, -1);
4954 XSETINT (buffer_local_flags.backed_up, -1);
4955 XSETINT (buffer_local_flags.save_length, -1);
4956 XSETINT (buffer_local_flags.auto_save_file_name, -1);
4957 XSETINT (buffer_local_flags.read_only, -1);
4958 XSETINT (buffer_local_flags.major_mode, -1);
4959 XSETINT (buffer_local_flags.mode_name, -1);
4960 XSETINT (buffer_local_flags.undo_list, -1);
4961 XSETINT (buffer_local_flags.mark_active, -1);
4962 XSETINT (buffer_local_flags.point_before_scroll, -1);
4963 XSETINT (buffer_local_flags.file_truename, -1);
4964 XSETINT (buffer_local_flags.invisibility_spec, -1);
4965 XSETINT (buffer_local_flags.file_format, -1);
4966 XSETINT (buffer_local_flags.display_count, -1);
4967 XSETINT (buffer_local_flags.display_time, -1);
4968 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
4970 idx = 1;
4971 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
4972 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
4973 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
4974 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
4975 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
4976 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
4977 #ifndef old
4978 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
4979 #endif
4980 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
4981 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
4982 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
4983 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
4984 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
4985 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
4986 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
4987 #ifdef DOS_NT
4988 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
4989 /* Make this one a permanent local. */
4990 buffer_permanent_local_flags[idx++] = 1;
4991 #endif
4992 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
4993 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
4994 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
4995 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
4996 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
4997 /* Make this one a permanent local. */
4998 buffer_permanent_local_flags[idx++] = 1;
4999 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5000 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5001 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5002 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5003 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5004 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5005 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5006 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5007 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5008 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5009 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5010 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5011 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5013 /* Need more room? */
5014 if (idx >= MAX_PER_BUFFER_VARS)
5015 abort ();
5016 last_per_buffer_idx = idx;
5018 Vbuffer_alist = Qnil;
5019 current_buffer = 0;
5020 all_buffers = 0;
5022 QSFundamental = build_string ("Fundamental");
5024 Qfundamental_mode = intern ("fundamental-mode");
5025 buffer_defaults.major_mode = Qfundamental_mode;
5027 Qmode_class = intern ("mode-class");
5029 Qprotected_field = intern ("protected-field");
5031 Qpermanent_local = intern ("permanent-local");
5033 Qkill_buffer_hook = intern ("kill-buffer-hook");
5035 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5037 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5039 /* super-magic invisible buffer */
5040 Vbuffer_alist = Qnil;
5042 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5044 inhibit_modification_hooks = 0;
5047 void
5048 init_buffer ()
5050 char buf[MAXPATHLEN + 1];
5051 char *pwd;
5052 struct stat dotstat, pwdstat;
5053 Lisp_Object temp;
5054 int rc;
5056 #ifdef USE_MMAP_FOR_BUFFERS
5058 /* When using the ralloc implementation based on mmap(2), buffer
5059 text pointers will have been set to null in the dumped Emacs.
5060 Map new memory. */
5061 struct buffer *b;
5063 for (b = all_buffers; b; b = b->next)
5064 if (b->text->beg == NULL)
5065 enlarge_buffer_text (b, 0);
5067 #endif /* USE_MMAP_FOR_BUFFERS */
5069 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5070 if (NILP (buffer_defaults.enable_multibyte_characters))
5071 Fset_buffer_multibyte (Qnil);
5073 /* If PWD is accurate, use it instead of calling getwd. PWD is
5074 sometimes a nicer name, and using it may avoid a fatal error if a
5075 parent directory is searchable but not readable. */
5076 if ((pwd = getenv ("PWD")) != 0
5077 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5078 && stat (pwd, &pwdstat) == 0
5079 && stat (".", &dotstat) == 0
5080 && dotstat.st_ino == pwdstat.st_ino
5081 && dotstat.st_dev == pwdstat.st_dev
5082 && strlen (pwd) < MAXPATHLEN)
5083 strcpy (buf, pwd);
5084 #ifdef HAVE_GETCWD
5085 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5086 fatal ("`getcwd' failed: %s\n", strerror (errno));
5087 #else
5088 else if (getwd (buf) == 0)
5089 fatal ("`getwd' failed: %s\n", buf);
5090 #endif
5092 #ifndef VMS
5093 /* Maybe this should really use some standard subroutine
5094 whose definition is filename syntax dependent. */
5095 rc = strlen (buf);
5096 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5098 buf[rc] = DIRECTORY_SEP;
5099 buf[rc + 1] = '\0';
5101 #endif /* not VMS */
5103 current_buffer->directory = build_string (buf);
5105 /* Add /: to the front of the name
5106 if it would otherwise be treated as magic. */
5107 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5108 if (! NILP (temp)
5109 /* If the default dir is just /, TEMP is non-nil
5110 because of the ange-ftp completion handler.
5111 However, it is not necessary to turn / into /:/.
5112 So avoid doing that. */
5113 && strcmp ("/", SDATA (current_buffer->directory)))
5114 current_buffer->directory
5115 = concat2 (build_string ("/:"), current_buffer->directory);
5117 temp = get_minibuffer (0);
5118 XBUFFER (temp)->directory = current_buffer->directory;
5121 /* initialize the buffer routines */
5122 void
5123 syms_of_buffer ()
5125 staticpro (&last_overlay_modification_hooks);
5126 last_overlay_modification_hooks
5127 = Fmake_vector (make_number (10), Qnil);
5129 staticpro (&Vbuffer_defaults);
5130 staticpro (&Vbuffer_local_symbols);
5131 staticpro (&Qfundamental_mode);
5132 staticpro (&Qmode_class);
5133 staticpro (&QSFundamental);
5134 staticpro (&Vbuffer_alist);
5135 staticpro (&Qprotected_field);
5136 staticpro (&Qpermanent_local);
5137 staticpro (&Qkill_buffer_hook);
5138 Qoverlayp = intern ("overlayp");
5139 staticpro (&Qoverlayp);
5140 Qevaporate = intern ("evaporate");
5141 staticpro (&Qevaporate);
5142 Qmodification_hooks = intern ("modification-hooks");
5143 staticpro (&Qmodification_hooks);
5144 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5145 staticpro (&Qinsert_in_front_hooks);
5146 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5147 staticpro (&Qinsert_behind_hooks);
5148 Qget_file_buffer = intern ("get-file-buffer");
5149 staticpro (&Qget_file_buffer);
5150 Qpriority = intern ("priority");
5151 staticpro (&Qpriority);
5152 Qwindow = intern ("window");
5153 staticpro (&Qwindow);
5154 Qbefore_string = intern ("before-string");
5155 staticpro (&Qbefore_string);
5156 Qafter_string = intern ("after-string");
5157 staticpro (&Qafter_string);
5158 Qfirst_change_hook = intern ("first-change-hook");
5159 staticpro (&Qfirst_change_hook);
5160 Qbefore_change_functions = intern ("before-change-functions");
5161 staticpro (&Qbefore_change_functions);
5162 Qafter_change_functions = intern ("after-change-functions");
5163 staticpro (&Qafter_change_functions);
5164 staticpro (&Qucs_set_table_for_input);
5166 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5167 staticpro (&Qkill_buffer_query_functions);
5169 Fput (Qprotected_field, Qerror_conditions,
5170 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5171 Fput (Qprotected_field, Qerror_message,
5172 build_string ("Attempt to modify a protected field"));
5174 /* All these use DEFVAR_LISP_NOPRO because the slots in
5175 buffer_defaults will all be marked via Vbuffer_defaults. */
5177 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5178 &buffer_defaults.mode_line_format,
5179 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5180 This is the same as (default-value 'mode-line-format). */);
5182 DEFVAR_LISP_NOPRO ("default-header-line-format",
5183 &buffer_defaults.header_line_format,
5184 doc: /* Default value of `header-line-format' for buffers that don't override it.
5185 This is the same as (default-value 'header-line-format). */);
5187 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5188 doc: /* Default value of `cursor-type' for buffers that don't override it.
5189 This is the same as (default-value 'cursor-type). */);
5191 DEFVAR_LISP_NOPRO ("default-line-spacing",
5192 &buffer_defaults.extra_line_spacing,
5193 doc: /* Default value of `line-spacing' for buffers that don't override it.
5194 This is the same as (default-value 'line-spacing). */);
5196 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5197 &buffer_defaults.abbrev_mode,
5198 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5199 This is the same as (default-value 'abbrev-mode). */);
5201 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5202 &buffer_defaults.ctl_arrow,
5203 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5204 This is the same as (default-value 'ctl-arrow). */);
5206 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5207 &buffer_defaults.direction_reversed,
5208 doc: /* Default value of `direction_reversed' for buffers that do not override it.
5209 This is the same as (default-value 'direction-reversed). */);
5211 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5212 &buffer_defaults.enable_multibyte_characters,
5213 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5214 This is the same as (default-value 'enable-multibyte-characters). */);
5216 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5217 &buffer_defaults.buffer_file_coding_system,
5218 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5219 This is the same as (default-value 'buffer-file-coding-system). */);
5221 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5222 &buffer_defaults.truncate_lines,
5223 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5224 This is the same as (default-value 'truncate-lines). */);
5226 DEFVAR_LISP_NOPRO ("default-fill-column",
5227 &buffer_defaults.fill_column,
5228 doc: /* Default value of `fill-column' for buffers that do not override it.
5229 This is the same as (default-value 'fill-column). */);
5231 DEFVAR_LISP_NOPRO ("default-left-margin",
5232 &buffer_defaults.left_margin,
5233 doc: /* Default value of `left-margin' for buffers that do not override it.
5234 This is the same as (default-value 'left-margin). */);
5236 DEFVAR_LISP_NOPRO ("default-tab-width",
5237 &buffer_defaults.tab_width,
5238 doc: /* Default value of `tab-width' for buffers that do not override it.
5239 This is the same as (default-value 'tab-width). */);
5241 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5242 &buffer_defaults.case_fold_search,
5243 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5244 This is the same as (default-value 'case-fold-search). */);
5246 #ifdef DOS_NT
5247 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5248 &buffer_defaults.buffer_file_type,
5249 doc: /* Default file type for buffers that do not override it.
5250 This is the same as (default-value 'buffer-file-type).
5251 The file type is nil for text, t for binary. */);
5252 #endif
5254 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5255 &buffer_defaults.left_margin_cols,
5256 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5257 This is the same as (default-value 'left-margin-width). */);
5259 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5260 &buffer_defaults.right_margin_cols,
5261 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5262 This is the same as (default-value 'right-margin-width). */);
5264 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5265 &buffer_defaults.left_fringe_width,
5266 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5267 This is the same as (default-value 'left-fringe-width). */);
5269 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5270 &buffer_defaults.right_fringe_width,
5271 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5272 This is the same as (default-value 'right-fringe-width). */);
5274 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5275 &buffer_defaults.fringes_outside_margins,
5276 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5277 This is the same as (default-value 'fringes-outside-margins). */);
5279 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5280 &buffer_defaults.scroll_bar_width,
5281 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5282 This is the same as (default-value 'scroll-bar-width). */);
5284 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5285 &buffer_defaults.vertical_scroll_bar_type,
5286 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5287 This is the same as (default-value 'vertical-scroll-bar). */);
5289 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5290 &buffer_defaults.indicate_empty_lines,
5291 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5292 This is the same as (default-value 'indicate-empty-lines). */);
5294 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5295 &buffer_defaults.scroll_up_aggressively,
5296 doc: /* Default value of `scroll-up-aggressively'.
5297 This value applies in buffers that don't have their own local values.
5298 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5300 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5301 &buffer_defaults.scroll_down_aggressively,
5302 doc: /* Default value of `scroll-down-aggressively'.
5303 This value applies in buffers that don't have their own local values.
5304 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5306 DEFVAR_PER_BUFFER ("header-line-format",
5307 &current_buffer->header_line_format,
5308 Qnil,
5309 doc: /* Analogous to `mode-line-format', but controls the header line.
5310 The header line appears, optionally, at the top of a window;
5311 the mode line appears at the bottom. */);
5313 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5314 Qnil,
5315 doc: /* Template for displaying mode line for current buffer.
5316 Each buffer has its own value of this variable.
5317 Value may be nil, a string, a symbol or a list or cons cell.
5318 A value of nil means don't display a mode line.
5319 For a symbol, its value is used (but it is ignored if t or nil).
5320 A string appearing directly as the value of a symbol is processed verbatim
5321 in that the %-constructs below are not recognized.
5322 Note that unless the symbol is marked as a `risky-local-variable', all
5323 properties in any strings, as well as all :eval and :propertize forms
5324 in the value of that symbol will be ignored.
5325 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5326 is used as a mode line element. Be careful--FORM should not load any files,
5327 because that can cause an infinite recursion.
5328 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5329 with the specified properties PROPS applied.
5330 For a list whose car is a symbol, the symbol's value is taken,
5331 and if that is non-nil, the cadr of the list is processed recursively.
5332 Otherwise, the caddr of the list (if there is one) is processed.
5333 For a list whose car is a string or list, each element is processed
5334 recursively and the results are effectively concatenated.
5335 For a list whose car is an integer, the cdr of the list is processed
5336 and padded (if the number is positive) or truncated (if negative)
5337 to the width specified by that number.
5338 A string is printed verbatim in the mode line except for %-constructs:
5339 (%-constructs are allowed when the string is the entire mode-line-format
5340 or when it is found in a cons-cell or a list)
5341 %b -- print buffer name. %f -- print visited file name.
5342 %F -- print frame name.
5343 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5344 %& is like %*, but ignore read-only-ness.
5345 % means buffer is read-only and * means it is modified.
5346 For a modified read-only buffer, %* gives % and %+ gives *.
5347 %s -- print process status. %l -- print the current line number.
5348 %c -- print the current column number (this makes editing slower).
5349 To make the column number update correctly in all cases,
5350 `column-number-mode' must be non-nil.
5351 %p -- print percent of buffer above top of window, or Top, Bot or All.
5352 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5353 or print Bottom or All.
5354 %m -- print the mode name.
5355 %n -- print Narrow if appropriate.
5356 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5357 %Z -- like %z, but including the end-of-line format.
5358 %[ -- print one [ for each recursive editing level. %] similar.
5359 %% -- print %. %- -- print infinitely many dashes.
5360 Decimal digits after the % specify field width to which to pad. */);
5362 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5363 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5364 nil here means use current buffer's major mode. */);
5366 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5367 make_number (Lisp_Symbol),
5368 doc: /* Symbol for current buffer's major mode. */);
5370 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5371 Qnil,
5372 doc: /* Pretty name of current buffer's major mode (a string). */);
5374 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5375 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5377 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5378 Qnil,
5379 doc: /* *Non-nil if searches and matches should ignore case. */);
5381 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5382 make_number (Lisp_Int),
5383 doc: /* *Column beyond which automatic line-wrapping should happen.
5384 Interactively, you can set this using \\[set-fill-column]. */);
5386 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5387 make_number (Lisp_Int),
5388 doc: /* *Column for the default indent-line-function to indent to.
5389 Linefeed indents to this column in Fundamental mode. */);
5391 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5392 make_number (Lisp_Int),
5393 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5395 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5396 doc: /* *Non-nil means display control chars with uparrow.
5397 A value of nil means use backslash and octal digits.
5398 This variable does not apply to characters whose display is specified
5399 in the current display table (if there is one). */);
5401 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5402 &current_buffer->enable_multibyte_characters,
5403 Qnil,
5404 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5405 Otherwise they are regarded as unibyte. This affects the display,
5406 file I/O and the behavior of various editing commands.
5408 This variable is buffer-local but you cannot set it directly;
5409 use the function `set-buffer-multibyte' to change a buffer's representation.
5410 Changing its default value with `setq-default' is supported.
5411 See also variable `default-enable-multibyte-characters' and Info node
5412 `(elisp)Text Representations'. */);
5413 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5415 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5416 &current_buffer->buffer_file_coding_system, Qnil,
5417 doc: /* Coding system to be used for encoding the buffer contents on saving.
5418 This variable applies to saving the buffer, and also to `write-region'
5419 and other functions that use `write-region'.
5420 It does not apply to sending output to subprocesses, however.
5422 If this is nil, the buffer is saved without any code conversion
5423 unless some coding system is specified in `file-coding-system-alist'
5424 for the buffer file.
5426 If the text to be saved cannot be encoded as specified by this variable,
5427 an alternative encoding is selected by `select-safe-coding-system', which see.
5429 The variable `coding-system-for-write', if non-nil, overrides this variable.
5431 This variable is never applied to a way of decoding a file while reading it. */);
5433 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5434 Qnil,
5435 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5437 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5438 doc: /* *Non-nil means do not display continuation lines.
5439 Instead, give each line of text just one screen line.
5441 Note that this is overridden by the variable
5442 `truncate-partial-width-windows' if that variable is non-nil
5443 and this buffer is not full-frame width. */);
5445 #ifdef DOS_NT
5446 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5447 Qnil,
5448 doc: /* Non-nil if the visited file is a binary file.
5449 This variable is meaningful on MS-DOG and Windows NT.
5450 On those systems, it is automatically local in every buffer.
5451 On other systems, this variable is normally always nil. */);
5452 #endif
5454 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5455 make_number (Lisp_String),
5456 doc: /* Name of default directory of current buffer. Should end with slash.
5457 To interactively change the default directory, use command `cd'. */);
5459 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5460 Qnil,
5461 doc: /* Function called (if non-nil) to perform auto-fill.
5462 It is called after self-inserting any character specified in
5463 the `auto-fill-chars' table.
5464 NOTE: This variable is not a hook;
5465 its value may not be a list of functions. */);
5467 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5468 make_number (Lisp_String),
5469 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5471 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5472 make_number (Lisp_String),
5473 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5474 The truename of a file is calculated by `file-truename'
5475 and then abbreviated with `abbreviate-file-name'. */);
5477 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5478 &current_buffer->auto_save_file_name,
5479 make_number (Lisp_String),
5480 doc: /* Name of file for auto-saving current buffer.
5481 If it is nil, that means don't auto-save this buffer. */);
5483 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5484 doc: /* Non-nil if this buffer is read-only. */);
5486 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5487 doc: /* Non-nil if this buffer's file has been backed up.
5488 Backing up is done before the first time the file is saved. */);
5490 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5491 make_number (Lisp_Int),
5492 doc: /* Length of current buffer when last read in, saved or auto-saved.
5493 0 initially. */);
5495 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5496 Qnil,
5497 doc: /* Non-nil enables selective display.
5498 An Integer N as value means display only lines
5499 that start with less than n columns of space.
5500 A value of t means that the character ^M makes itself and
5501 all the rest of the line invisible; also, when saving the buffer
5502 in a file, save the ^M as a newline. */);
5504 #ifndef old
5505 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5506 &current_buffer->selective_display_ellipses,
5507 Qnil,
5508 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5509 #endif
5511 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5512 doc: /* Non-nil if self-insertion should replace existing text.
5513 The value should be one of `overwrite-mode-textual',
5514 `overwrite-mode-binary', or nil.
5515 If it is `overwrite-mode-textual', self-insertion still
5516 inserts at the end of a line, and inserts when point is before a tab,
5517 until the tab is filled in.
5518 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5520 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5521 Qnil,
5522 doc: /* Display table that controls display of the contents of current buffer.
5524 If this variable is nil, the value of `standard-display-table' is used.
5525 Each window can have its own, overriding display table, see
5526 `set-window-display-table' and `window-display-table'.
5528 The display table is a char-table created with `make-display-table'.
5529 A char-table is an array indexed by character codes. Normal array
5530 primitives `aref' and `aset' can be used to access elements of a char-table.
5532 Each of the char-table elements control how to display the corresponding
5533 text character: the element at index C in the table says how to display
5534 the character whose code is C. Each element should be a vector of
5535 characters or nil. nil means display the character in the default fashion;
5536 otherwise, the characters from the vector are delivered to the screen
5537 instead of the original character.
5539 For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5540 a capital Y instead of each X character.
5542 In addition, a char-table has six extra slots to control the display of:
5544 the end of a truncated screen line (extra-slot 0, a single character);
5545 the end of a continued line (extra-slot 1, a single character);
5546 the escape character used to display character codes in octal
5547 (extra-slot 2, a single character);
5548 the character used as an arrow for control characters (extra-slot 3,
5549 a single character);
5550 the decoration indicating the presence of invisible lines (extra-slot 4,
5551 a vector of characters);
5552 the character used to draw the border between side-by-side windows
5553 (extra-slot 5, a single character).
5555 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5557 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5558 Qnil,
5559 doc: /* *Width of left marginal area for display of a buffer.
5560 A value of nil means no marginal area. */);
5562 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5563 Qnil,
5564 doc: /* *Width of right marginal area for display of a buffer.
5565 A value of nil means no marginal area. */);
5567 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5568 Qnil,
5569 doc: /* *Width of this buffer's left fringe (in pixels).
5570 A value of 0 means no left fringe is shown in this buffer's window.
5571 A value of nil means to use the left fringe width from the window's frame. */);
5573 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5574 Qnil,
5575 doc: /* *Width of this buffer's right fringe (in pixels).
5576 A value of 0 means no right fringe is shown in this buffer's window.
5577 A value of nil means to use the right fringe width from the window's frame. */);
5579 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5580 Qnil,
5581 doc: /* *Non-nil means to display fringes outside display margins.
5582 A value of nil means to display fringes between margins and buffer text. */);
5584 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5585 Qnil,
5586 doc: /* *Width of this buffer's scroll bars in pixels.
5587 A value of nil means to use the scroll bar width from the window's frame. */);
5589 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5590 Qnil,
5591 doc: /* *Position of this buffer's vertical scroll bar.
5592 A value of left or right means to place the vertical scroll bar at that side
5593 of the window; a value of nil means that this window has no vertical scroll bar.
5594 A value of t means to use the vertical scroll bar type from the window's frame. */);
5596 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5597 &current_buffer->indicate_empty_lines, Qnil,
5598 doc: /* *Visually indicate empty lines after the buffer end.
5599 If non-nil, a bitmap is displayed in the left fringe of a window on
5600 window-systems. */);
5602 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5603 &current_buffer->scroll_up_aggressively, Qnil,
5604 doc: /* How far to scroll windows upward.
5605 If you move point off the bottom, the window scrolls automatically.
5606 This variable controls how far it scrolls. nil, the default,
5607 means scroll to center point. A fraction means scroll to put point
5608 that fraction of the window's height from the bottom of the window.
5609 When the value is 0.0, point goes at the bottom line, which in the simple
5610 case that you moved off with C-f means scrolling just one line. 1.0 means
5611 point goes at the top, so that in that simple case, the window
5612 window scrolls by a full window height. Meaningful values are
5613 between 0.0 and 1.0, inclusive. */);
5615 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5616 &current_buffer->scroll_down_aggressively, Qnil,
5617 doc: /* How far to scroll windows downward.
5618 If you move point off the top, the window scrolls automatically.
5619 This variable controls how far it scrolls. nil, the default,
5620 means scroll to center point. A fraction means scroll to put point
5621 that fraction of the window's height from the top of the window.
5622 When the value is 0.0, point goes at the top line, which in the simple
5623 case that you moved off with C-b means scrolling just one line. 1.0 means
5624 point goes at the bottom, so that in that simple case, the window
5625 window scrolls by a full window height. Meaningful values are
5626 between 0.0 and 1.0, inclusive. */);
5628 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5629 "Don't ask.");
5632 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5633 doc: /* List of functions to call before each text change.
5634 Two arguments are passed to each function: the positions of
5635 the beginning and end of the range of old text to be changed.
5636 \(For an insertion, the beginning and end are at the same place.)
5637 No information is given about the length of the text after the change.
5639 Buffer changes made while executing the `before-change-functions'
5640 don't call any before-change or after-change functions.
5641 That's because these variables are temporarily set to nil.
5642 As a result, a hook function cannot straightforwardly alter the value of
5643 these variables. See the Emacs Lisp manual for a way of
5644 accomplishing an equivalent result by using other variables.
5646 If an unhandled error happens in running these functions,
5647 the variable's value remains nil. That prevents the error
5648 from happening repeatedly and making Emacs nonfunctional. */);
5649 Vbefore_change_functions = Qnil;
5651 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5652 doc: /* List of functions to call after each text change.
5653 Three arguments are passed to each function: the positions of
5654 the beginning and end of the range of changed text,
5655 and the length in bytes of the pre-change text replaced by that range.
5656 \(For an insertion, the pre-change length is zero;
5657 for a deletion, that length is the number of bytes deleted,
5658 and the post-change beginning and end are at the same place.)
5660 Buffer changes made while executing the `after-change-functions'
5661 don't call any before-change or after-change functions.
5662 That's because these variables are temporarily set to nil.
5663 As a result, a hook function cannot straightforwardly alter the value of
5664 these variables. See the Emacs Lisp manual for a way of
5665 accomplishing an equivalent result by using other variables.
5667 If an unhandled error happens in running these functions,
5668 the variable's value remains nil. That prevents the error
5669 from happening repeatedly and making Emacs nonfunctional. */);
5670 Vafter_change_functions = Qnil;
5672 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5673 doc: /* A list of functions to call before changing a buffer which is unmodified.
5674 The functions are run using the `run-hooks' function. */);
5675 Vfirst_change_hook = Qnil;
5677 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5678 doc: /* List of undo entries in current buffer.
5679 Recent changes come first; older changes follow newer.
5681 An entry (BEG . END) represents an insertion which begins at
5682 position BEG and ends at position END.
5684 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5685 from (abs POSITION). If POSITION is positive, point was at the front
5686 of the text being deleted; if negative, point was at the end.
5688 An entry (t HIGH . LOW) indicates that the buffer previously had
5689 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5690 of the visited file's modification time, as of that time. If the
5691 modification time of the most recent save is different, this entry is
5692 obsolete.
5694 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5695 was modified between BEG and END. PROPERTY is the property name,
5696 and VALUE is the old value.
5698 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5699 was adjusted in position by the offset DISTANCE (an integer).
5701 An entry of the form POSITION indicates that point was at the buffer
5702 location given by the integer. Undoing an entry of this form places
5703 point at POSITION.
5705 nil marks undo boundaries. The undo command treats the changes
5706 between two undo boundaries as a single step to be undone.
5708 If the value of the variable is t, undo information is not recorded. */);
5710 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5711 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5713 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5714 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5716 Normally, the line-motion functions work by scanning the buffer for
5717 newlines. Columnar operations (like move-to-column and
5718 compute-motion) also work by scanning the buffer, summing character
5719 widths as they go. This works well for ordinary text, but if the
5720 buffer's lines are very long (say, more than 500 characters), these
5721 motion functions will take longer to execute. Emacs may also take
5722 longer to update the display.
5724 If cache-long-line-scans is non-nil, these motion functions cache the
5725 results of their scans, and consult the cache to avoid rescanning
5726 regions of the buffer until the text is modified. The caches are most
5727 beneficial when they prevent the most searching---that is, when the
5728 buffer contains long lines and large regions of characters with the
5729 same, fixed screen width.
5731 When cache-long-line-scans is non-nil, processing short lines will
5732 become slightly slower (because of the overhead of consulting the
5733 cache), and the caches will use memory roughly proportional to the
5734 number of newlines and characters whose screen width varies.
5736 The caches require no explicit maintenance; their accuracy is
5737 maintained internally by the Emacs primitives. Enabling or disabling
5738 the cache should not affect the behavior of any of the motion
5739 functions; it should only affect their performance. */);
5741 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5742 doc: /* Value of point before the last series of scroll operations, or nil. */);
5744 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5745 doc: /* List of formats to use when saving this buffer.
5746 Formats are defined by `format-alist'. This variable is
5747 set when a file is visited. */);
5749 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5750 &current_buffer->invisibility_spec, Qnil,
5751 doc: /* Invisibility spec of this buffer.
5752 The default is t, which means that text is invisible
5753 if it has a non-nil `invisible' property.
5754 If the value is a list, a text character is invisible if its `invisible'
5755 property is an element in that list.
5756 If an element is a cons cell of the form (PROP . ELLIPSIS),
5757 then characters with property value PROP are invisible,
5758 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5760 DEFVAR_PER_BUFFER ("buffer-display-count",
5761 &current_buffer->display_count, Qnil,
5762 doc: /* A number incremented each time this buffer is displayed in a window.
5763 The function `set-window-buffer' increments it. */);
5765 DEFVAR_PER_BUFFER ("buffer-display-time",
5766 &current_buffer->display_time, Qnil,
5767 doc: /* Time stamp updated each time this buffer is displayed in a window.
5768 The function `set-window-buffer' updates this variable
5769 to the value obtained by calling `current-time'.
5770 If the buffer has never been shown in a window, the value is nil. */);
5772 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5773 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5774 Non-nil also enables highlighting of the region whenever the mark is active.
5775 The variable `highlight-nonselected-windows' controls whether to highlight
5776 all windows or just the selected window. */);
5777 Vtransient_mark_mode = Qnil;
5779 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5780 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5781 If the value is t, disregard `buffer-read-only' and all `read-only'
5782 text properties. If the value is a list, disregard `buffer-read-only'
5783 and disregard a `read-only' text property if the property value
5784 is a member of the list. */);
5785 Vinhibit_read_only = Qnil;
5787 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5788 doc: /* Cursor to use when this buffer is in the selected window.
5789 Values are interpreted as follows:
5791 t use the cursor specified for the frame
5792 nil don't display a cursor
5793 bar display a bar cursor with default width
5794 (bar . WIDTH) display a bar cursor with width WIDTH
5795 ANYTHING ELSE display a box cursor.
5797 When the buffer is displayed in a nonselected window,
5798 this variable has no effect; the cursor appears as a hollow box. */);
5800 DEFVAR_PER_BUFFER ("line-spacing",
5801 &current_buffer->extra_line_spacing, Qnil,
5802 doc: /* Additional space to put between lines when displaying a buffer.
5803 The space is measured in pixels, and put below lines on window systems. */);
5805 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5806 doc: /* List of functions called with no args to query before killing a buffer. */);
5807 Vkill_buffer_query_functions = Qnil;
5809 defsubr (&Sbuffer_live_p);
5810 defsubr (&Sbuffer_list);
5811 defsubr (&Sget_buffer);
5812 defsubr (&Sget_file_buffer);
5813 defsubr (&Sget_buffer_create);
5814 defsubr (&Smake_indirect_buffer);
5815 defsubr (&Sgenerate_new_buffer_name);
5816 defsubr (&Sbuffer_name);
5817 /*defsubr (&Sbuffer_number);*/
5818 defsubr (&Sbuffer_file_name);
5819 defsubr (&Sbuffer_base_buffer);
5820 defsubr (&Sbuffer_local_value);
5821 defsubr (&Sbuffer_local_variables);
5822 defsubr (&Sbuffer_modified_p);
5823 defsubr (&Sset_buffer_modified_p);
5824 defsubr (&Sbuffer_modified_tick);
5825 defsubr (&Srename_buffer);
5826 defsubr (&Sother_buffer);
5827 defsubr (&Sbuffer_disable_undo);
5828 defsubr (&Sbuffer_enable_undo);
5829 defsubr (&Skill_buffer);
5830 defsubr (&Sset_buffer_major_mode);
5831 defsubr (&Sswitch_to_buffer);
5832 defsubr (&Spop_to_buffer);
5833 defsubr (&Scurrent_buffer);
5834 defsubr (&Sset_buffer);
5835 defsubr (&Sbarf_if_buffer_read_only);
5836 defsubr (&Sbury_buffer);
5837 defsubr (&Serase_buffer);
5838 defsubr (&Sset_buffer_multibyte);
5839 defsubr (&Skill_all_local_variables);
5841 defsubr (&Soverlayp);
5842 defsubr (&Smake_overlay);
5843 defsubr (&Sdelete_overlay);
5844 defsubr (&Smove_overlay);
5845 defsubr (&Soverlay_start);
5846 defsubr (&Soverlay_end);
5847 defsubr (&Soverlay_buffer);
5848 defsubr (&Soverlay_properties);
5849 defsubr (&Soverlays_at);
5850 defsubr (&Soverlays_in);
5851 defsubr (&Snext_overlay_change);
5852 defsubr (&Sprevious_overlay_change);
5853 defsubr (&Soverlay_recenter);
5854 defsubr (&Soverlay_lists);
5855 defsubr (&Soverlay_get);
5856 defsubr (&Soverlay_put);
5857 defsubr (&Srestore_buffer_modified_p);
5860 void
5861 keys_of_buffer ()
5863 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5864 initial_define_key (control_x_map, 'k', "kill-buffer");
5866 /* This must not be in syms_of_buffer, because Qdisabled is not
5867 initialized when that function gets called. */
5868 Fput (intern ("erase-buffer"), Qdisabled, Qt);