Revert changes of 2003-03-03 and 2003-05-28.
[emacs.git] / src / buffer.c
blob1f339995a2defbf0c6de906982476b8300f7d407
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 /* An error in calling the function here (should someone redfine it)
424 can lead to infinite regress until you run out of stack. rms
425 says that's not worth protecting against. */
426 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
427 /* buf is on buffer-alist, so no gcpro. */
428 call1 (Qucs_set_table_for_input, buf);
430 return buf;
434 /* Return a list of overlays which is a copy of the overlay list
435 LIST, but for buffer B. */
437 static Lisp_Object
438 copy_overlays (b, list)
439 struct buffer *b;
440 Lisp_Object list;
442 Lisp_Object result, buffer;
444 XSETBUFFER (buffer, b);
446 for (result = Qnil; CONSP (list); list = XCDR (list))
448 Lisp_Object overlay, start, end, old_overlay;
449 int charpos;
451 old_overlay = XCAR (list);
452 charpos = marker_position (OVERLAY_START (old_overlay));
453 start = Fmake_marker ();
454 Fset_marker (start, make_number (charpos), buffer);
455 XMARKER (start)->insertion_type
456 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
458 charpos = marker_position (OVERLAY_END (old_overlay));
459 end = Fmake_marker ();
460 Fset_marker (end, make_number (charpos), buffer);
461 XMARKER (end)->insertion_type
462 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
464 overlay = allocate_misc ();
465 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
466 OVERLAY_START (overlay) = start;
467 OVERLAY_END (overlay) = end;
468 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
470 result = Fcons (overlay, result);
473 return Fnreverse (result);
477 /* Clone per-buffer values of buffer FROM.
479 Buffer TO gets the same per-buffer values as FROM, with the
480 following exceptions: (1) TO's name is left untouched, (2) markers
481 are copied and made to refer to TO, and (3) overlay lists are
482 copied. */
484 static void
485 clone_per_buffer_values (from, to)
486 struct buffer *from, *to;
488 Lisp_Object to_buffer;
489 int offset;
491 XSETBUFFER (to_buffer, to);
493 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
494 offset < sizeof *to;
495 offset += sizeof (Lisp_Object))
497 Lisp_Object obj;
499 obj = PER_BUFFER_VALUE (from, offset);
500 if (MARKERP (obj))
502 struct Lisp_Marker *m = XMARKER (obj);
503 obj = Fmake_marker ();
504 XMARKER (obj)->insertion_type = m->insertion_type;
505 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
508 PER_BUFFER_VALUE (to, offset) = obj;
511 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
513 to->overlays_before = copy_overlays (to, from->overlays_before);
514 to->overlays_after = copy_overlays (to, from->overlays_after);
518 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
519 2, 3,
520 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
521 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
522 BASE-BUFFER should be an existing buffer (or buffer name).
523 NAME should be a string which is not the name of an existing buffer.
524 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
525 such as major and minor modes, in the indirect buffer.
526 CLONE nil means the indirect buffer's state is reset to default values. */)
527 (base_buffer, name, clone)
528 Lisp_Object base_buffer, name, clone;
530 Lisp_Object buf;
531 struct buffer *b;
533 buf = Fget_buffer (name);
534 if (!NILP (buf))
535 error ("Buffer name `%s' is in use", SDATA (name));
537 base_buffer = Fget_buffer (base_buffer);
538 if (NILP (base_buffer))
539 error ("No such buffer: `%s'", SDATA (name));
541 if (SCHARS (name) == 0)
542 error ("Empty string for buffer name is not allowed");
544 b = (struct buffer *) allocate_buffer ();
545 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
547 if (XBUFFER (base_buffer)->base_buffer)
548 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
549 else
550 b->base_buffer = XBUFFER (base_buffer);
552 /* Use the base buffer's text object. */
553 b->text = b->base_buffer->text;
555 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
556 BUF_ZV (b) = BUF_ZV (b->base_buffer);
557 BUF_PT (b) = BUF_PT (b->base_buffer);
558 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
559 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
560 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
562 b->newline_cache = 0;
563 b->width_run_cache = 0;
564 b->width_table = Qnil;
566 /* Put this on the chain of all buffers including killed ones. */
567 b->next = all_buffers;
568 all_buffers = b;
570 name = Fcopy_sequence (name);
571 STRING_SET_INTERVALS (name, NULL_INTERVAL);
572 b->name = name;
574 reset_buffer (b);
575 reset_buffer_local_variables (b, 1);
577 /* Put this in the alist of all live buffers. */
578 XSETBUFFER (buf, b);
579 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
581 b->mark = Fmake_marker ();
582 b->name = name;
584 /* The multibyte status belongs to the base buffer. */
585 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
587 /* Make sure the base buffer has markers for its narrowing. */
588 if (NILP (b->base_buffer->pt_marker))
590 b->base_buffer->pt_marker = Fmake_marker ();
591 set_marker_both (b->base_buffer->pt_marker, base_buffer,
592 BUF_PT (b->base_buffer),
593 BUF_PT_BYTE (b->base_buffer));
595 if (NILP (b->base_buffer->begv_marker))
597 b->base_buffer->begv_marker = Fmake_marker ();
598 set_marker_both (b->base_buffer->begv_marker, base_buffer,
599 BUF_BEGV (b->base_buffer),
600 BUF_BEGV_BYTE (b->base_buffer));
602 if (NILP (b->base_buffer->zv_marker))
604 b->base_buffer->zv_marker = Fmake_marker ();
605 set_marker_both (b->base_buffer->zv_marker, base_buffer,
606 BUF_ZV (b->base_buffer),
607 BUF_ZV_BYTE (b->base_buffer));
608 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
611 if (NILP (clone))
613 /* Give the indirect buffer markers for its narrowing. */
614 b->pt_marker = Fmake_marker ();
615 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
616 b->begv_marker = Fmake_marker ();
617 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
618 b->zv_marker = Fmake_marker ();
619 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
620 XMARKER (b->zv_marker)->insertion_type = 1;
622 else
623 clone_per_buffer_values (b->base_buffer, b);
625 return buf;
628 /* Reinitialize everything about a buffer except its name and contents
629 and local variables. */
631 void
632 reset_buffer (b)
633 register struct buffer *b;
635 b->filename = Qnil;
636 b->file_truename = Qnil;
637 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
638 b->modtime = 0;
639 XSETFASTINT (b->save_length, 0);
640 b->last_window_start = 1;
641 /* It is more conservative to start out "changed" than "unchanged". */
642 b->clip_changed = 0;
643 b->prevent_redisplay_optimizations_p = 1;
644 b->backed_up = Qnil;
645 b->auto_save_modified = 0;
646 b->auto_save_failure_time = -1;
647 b->auto_save_file_name = Qnil;
648 b->read_only = Qnil;
649 b->overlays_before = Qnil;
650 b->overlays_after = Qnil;
651 XSETFASTINT (b->overlay_center, 1);
652 b->mark_active = Qnil;
653 b->point_before_scroll = Qnil;
654 b->file_format = Qnil;
655 b->last_selected_window = Qnil;
656 XSETINT (b->display_count, 0);
657 b->display_time = Qnil;
658 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
659 b->cursor_type = buffer_defaults.cursor_type;
660 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
662 b->display_error_modiff = 0;
665 /* Reset buffer B's local variables info.
666 Don't use this on a buffer that has already been in use;
667 it does not treat permanent locals consistently.
668 Instead, use Fkill_all_local_variables.
670 If PERMANENT_TOO is 1, then we reset permanent built-in
671 buffer-local variables. If PERMANENT_TOO is 0,
672 we preserve those. */
674 static void
675 reset_buffer_local_variables (b, permanent_too)
676 register struct buffer *b;
677 int permanent_too;
679 register int offset;
680 int i;
682 /* Reset the major mode to Fundamental, together with all the
683 things that depend on the major mode.
684 default-major-mode is handled at a higher level.
685 We ignore it here. */
686 b->major_mode = Qfundamental_mode;
687 b->keymap = Qnil;
688 b->mode_name = QSFundamental;
689 b->minor_modes = Qnil;
691 /* If the standard case table has been altered and invalidated,
692 fix up its insides first. */
693 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
694 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
695 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
696 Fset_standard_case_table (Vascii_downcase_table);
698 b->downcase_table = Vascii_downcase_table;
699 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
700 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
701 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
702 b->invisibility_spec = Qt;
703 #ifndef DOS_NT
704 b->buffer_file_type = Qnil;
705 #endif
707 /* Reset all (or most) per-buffer variables to their defaults. */
708 b->local_var_alist = Qnil;
709 for (i = 0; i < last_per_buffer_idx; ++i)
710 if (permanent_too || buffer_permanent_local_flags[i] == 0)
711 SET_PER_BUFFER_VALUE_P (b, i, 0);
713 /* For each slot that has a default value,
714 copy that into the slot. */
716 for (offset = PER_BUFFER_VAR_OFFSET (name);
717 offset < sizeof *b;
718 offset += sizeof (Lisp_Object))
720 int idx = PER_BUFFER_IDX (offset);
721 if ((idx > 0
722 && (permanent_too
723 || buffer_permanent_local_flags[idx] == 0))
724 /* Is -2 used anywhere? */
725 || idx == -2)
726 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
730 /* We split this away from generate-new-buffer, because rename-buffer
731 and set-visited-file-name ought to be able to use this to really
732 rename the buffer properly. */
734 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
735 1, 2, 0,
736 doc: /* Return a string that is the name of no existing buffer based on NAME.
737 If there is no live buffer named NAME, then return NAME.
738 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
739 until an unused name is found, and then return that name.
740 Optional second argument IGNORE specifies a name that is okay to use
741 \(if it is in the sequence to be tried)
742 even if a buffer with that name exists. */)
743 (name, ignore)
744 register Lisp_Object name, ignore;
746 register Lisp_Object gentemp, tem;
747 int count;
748 char number[10];
750 CHECK_STRING (name);
752 tem = Fget_buffer (name);
753 if (NILP (tem))
754 return name;
756 count = 1;
757 while (1)
759 sprintf (number, "<%d>", ++count);
760 gentemp = concat2 (name, build_string (number));
761 tem = Fstring_equal (gentemp, ignore);
762 if (!NILP (tem))
763 return gentemp;
764 tem = Fget_buffer (gentemp);
765 if (NILP (tem))
766 return gentemp;
771 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
772 doc: /* Return the name of BUFFER, as a string.
773 With no argument or nil as argument, return the name of the current buffer. */)
774 (buffer)
775 register Lisp_Object buffer;
777 if (NILP (buffer))
778 return current_buffer->name;
779 CHECK_BUFFER (buffer);
780 return XBUFFER (buffer)->name;
783 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
784 doc: /* Return name of file BUFFER is visiting, or nil if none.
785 No argument or nil as argument means use the current buffer. */)
786 (buffer)
787 register Lisp_Object buffer;
789 if (NILP (buffer))
790 return current_buffer->filename;
791 CHECK_BUFFER (buffer);
792 return XBUFFER (buffer)->filename;
795 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
796 0, 1, 0,
797 doc: /* Return the base buffer of indirect buffer BUFFER.
798 If BUFFER is not indirect, return nil. */)
799 (buffer)
800 register Lisp_Object buffer;
802 struct buffer *base;
803 Lisp_Object base_buffer;
805 if (NILP (buffer))
806 base = current_buffer->base_buffer;
807 else
809 CHECK_BUFFER (buffer);
810 base = XBUFFER (buffer)->base_buffer;
813 if (! base)
814 return Qnil;
815 XSETBUFFER (base_buffer, base);
816 return base_buffer;
819 DEFUN ("buffer-local-value", Fbuffer_local_value,
820 Sbuffer_local_value, 2, 2, 0,
821 doc: /* Return the value of VARIABLE in BUFFER.
822 If VARIABLE does not have a buffer-local binding in BUFFER, the value
823 is the default binding of variable. */)
824 (symbol, buffer)
825 register Lisp_Object symbol;
826 register Lisp_Object buffer;
828 register struct buffer *buf;
829 register Lisp_Object result;
831 CHECK_SYMBOL (symbol);
832 CHECK_BUFFER (buffer);
833 buf = XBUFFER (buffer);
835 /* Look in local_var_list */
836 result = Fassoc (symbol, buf->local_var_alist);
837 if (NILP (result))
839 int offset, idx;
840 int found = 0;
842 /* Look in special slots */
843 for (offset = PER_BUFFER_VAR_OFFSET (name);
844 offset < sizeof (struct buffer);
845 /* sizeof EMACS_INT == sizeof Lisp_Object */
846 offset += (sizeof (EMACS_INT)))
848 idx = PER_BUFFER_IDX (offset);
849 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
850 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
851 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
853 result = PER_BUFFER_VALUE (buf, offset);
854 found = 1;
855 break;
859 if (!found)
860 result = Fdefault_value (symbol);
862 else
864 Lisp_Object valcontents;
865 Lisp_Object current_alist_element;
867 /* What binding is loaded right now? */
868 valcontents = SYMBOL_VALUE (symbol);
869 current_alist_element
870 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
872 /* The value of the currently loaded binding is not
873 stored in it, but rather in the realvalue slot.
874 Store that value into the binding it belongs to
875 in case that is the one we are about to use. */
877 Fsetcdr (current_alist_element,
878 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
880 /* Now get the (perhaps updated) value out of the binding. */
881 result = XCDR (result);
884 if (EQ (result, Qunbound))
885 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
887 return result;
890 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
891 Sbuffer_local_variables, 0, 1, 0,
892 doc: /* Return an alist of variables that are buffer-local in BUFFER.
893 Most elements look like (SYMBOL . VALUE), describing one variable.
894 For a symbol that is locally unbound, just the symbol appears in the value.
895 Note that storing new VALUEs in these elements doesn't change the variables.
896 No argument or nil as argument means use current buffer as BUFFER. */)
897 (buffer)
898 register Lisp_Object buffer;
900 register struct buffer *buf;
901 register Lisp_Object result;
903 if (NILP (buffer))
904 buf = current_buffer;
905 else
907 CHECK_BUFFER (buffer);
908 buf = XBUFFER (buffer);
911 result = Qnil;
914 register Lisp_Object tail;
915 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
917 Lisp_Object val, elt;
919 elt = XCAR (tail);
921 /* Reference each variable in the alist in buf.
922 If inquiring about the current buffer, this gets the current values,
923 so store them into the alist so the alist is up to date.
924 If inquiring about some other buffer, this swaps out any values
925 for that buffer, making the alist up to date automatically. */
926 val = find_symbol_value (XCAR (elt));
927 /* Use the current buffer value only if buf is the current buffer. */
928 if (buf != current_buffer)
929 val = XCDR (elt);
931 /* If symbol is unbound, put just the symbol in the list. */
932 if (EQ (val, Qunbound))
933 result = Fcons (XCAR (elt), result);
934 /* Otherwise, put (symbol . value) in the list. */
935 else
936 result = Fcons (Fcons (XCAR (elt), val), result);
940 /* Add on all the variables stored in special slots. */
942 int offset, idx;
944 for (offset = PER_BUFFER_VAR_OFFSET (name);
945 offset < sizeof (struct buffer);
946 /* sizeof EMACS_INT == sizeof Lisp_Object */
947 offset += (sizeof (EMACS_INT)))
949 idx = PER_BUFFER_IDX (offset);
950 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
951 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
952 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
953 PER_BUFFER_VALUE (buf, offset)),
954 result);
958 return result;
962 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
963 0, 1, 0,
964 doc: /* Return t if BUFFER was modified since its file was last read or saved.
965 No argument or nil as argument means use current buffer as BUFFER. */)
966 (buffer)
967 register Lisp_Object buffer;
969 register struct buffer *buf;
970 if (NILP (buffer))
971 buf = current_buffer;
972 else
974 CHECK_BUFFER (buffer);
975 buf = XBUFFER (buffer);
978 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
981 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
982 1, 1, 0,
983 doc: /* Mark current buffer as modified or unmodified according to FLAG.
984 A non-nil FLAG means mark the buffer modified. */)
985 (flag)
986 register Lisp_Object flag;
988 register int already;
989 register Lisp_Object fn;
990 Lisp_Object buffer, window;
992 #ifdef CLASH_DETECTION
993 /* If buffer becoming modified, lock the file.
994 If buffer becoming unmodified, unlock the file. */
996 fn = current_buffer->file_truename;
997 /* Test buffer-file-name so that binding it to nil is effective. */
998 if (!NILP (fn) && ! NILP (current_buffer->filename))
1000 already = SAVE_MODIFF < MODIFF;
1001 if (!already && !NILP (flag))
1002 lock_file (fn);
1003 else if (already && NILP (flag))
1004 unlock_file (fn);
1006 #endif /* CLASH_DETECTION */
1008 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1010 /* Set update_mode_lines only if buffer is displayed in some window.
1011 Packages like jit-lock or lazy-lock preserve a buffer's modified
1012 state by recording/restoring the state around blocks of code.
1013 Setting update_mode_lines makes redisplay consider all windows
1014 (on all frames). Stealth fontification of buffers not displayed
1015 would incur additional redisplay costs if we'd set
1016 update_modes_lines unconditionally.
1018 Ideally, I think there should be another mechanism for fontifying
1019 buffers without "modifying" buffers, or redisplay should be
1020 smarter about updating the `*' in mode lines. --gerd */
1021 XSETBUFFER (buffer, current_buffer);
1022 window = Fget_buffer_window (buffer, Qt);
1023 if (WINDOWP (window))
1025 ++update_mode_lines;
1026 current_buffer->prevent_redisplay_optimizations_p = 1;
1029 return flag;
1032 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1033 Srestore_buffer_modified_p, 1, 1, 0,
1034 doc: /* Like `set-buffer-modified-p', with a differences concerning redisplay.
1035 It is not ensured that mode lines will be updated to show the modified
1036 state of the current buffer. Use with care. */)
1037 (flag)
1038 Lisp_Object flag;
1040 #ifdef CLASH_DETECTION
1041 Lisp_Object fn;
1043 /* If buffer becoming modified, lock the file.
1044 If buffer becoming unmodified, unlock the file. */
1046 fn = current_buffer->file_truename;
1047 /* Test buffer-file-name so that binding it to nil is effective. */
1048 if (!NILP (fn) && ! NILP (current_buffer->filename))
1050 int already = SAVE_MODIFF < MODIFF;
1051 if (!already && !NILP (flag))
1052 lock_file (fn);
1053 else if (already && NILP (flag))
1054 unlock_file (fn);
1056 #endif /* CLASH_DETECTION */
1058 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1059 return flag;
1062 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1063 0, 1, 0,
1064 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1065 Each buffer has a tick counter which is incremented each time the text in
1066 that buffer is changed. It wraps around occasionally.
1067 No argument or nil as argument means use current buffer as BUFFER. */)
1068 (buffer)
1069 register Lisp_Object buffer;
1071 register struct buffer *buf;
1072 if (NILP (buffer))
1073 buf = current_buffer;
1074 else
1076 CHECK_BUFFER (buffer);
1077 buf = XBUFFER (buffer);
1080 return make_number (BUF_MODIFF (buf));
1083 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1084 "sRename buffer (to new name): \nP",
1085 doc: /* Change current buffer's name to NEWNAME (a string).
1086 If second arg UNIQUE is nil or omitted, it is an error if a
1087 buffer named NEWNAME already exists.
1088 If UNIQUE is non-nil, come up with a new name using
1089 `generate-new-buffer-name'.
1090 Interactively, you can set UNIQUE with a prefix argument.
1091 We return the name we actually gave the buffer.
1092 This does not change the name of the visited file (if any). */)
1093 (newname, unique)
1094 register Lisp_Object newname, unique;
1096 register Lisp_Object tem, buf;
1098 CHECK_STRING (newname);
1100 if (SCHARS (newname) == 0)
1101 error ("Empty string is invalid as a buffer name");
1103 tem = Fget_buffer (newname);
1104 if (!NILP (tem))
1106 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1107 rename the buffer automatically so you can create another
1108 with the original name. It makes UNIQUE equivalent to
1109 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1110 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1111 return current_buffer->name;
1112 if (!NILP (unique))
1113 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1114 else
1115 error ("Buffer name `%s' is in use", SDATA (newname));
1118 current_buffer->name = newname;
1120 /* Catch redisplay's attention. Unless we do this, the mode lines for
1121 any windows displaying current_buffer will stay unchanged. */
1122 update_mode_lines++;
1124 XSETBUFFER (buf, current_buffer);
1125 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1126 if (NILP (current_buffer->filename)
1127 && !NILP (current_buffer->auto_save_file_name))
1128 call0 (intern ("rename-auto-save-file"));
1129 /* Refetch since that last call may have done GC. */
1130 return current_buffer->name;
1133 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1134 doc: /* Return most recently selected buffer other than BUFFER.
1135 Buffers not visible in windows are preferred to visible buffers,
1136 unless optional second argument VISIBLE-OK is non-nil.
1137 If the optional third argument FRAME is non-nil, use that frame's
1138 buffer list instead of the selected frame's buffer list.
1139 If no other buffer exists, the buffer `*scratch*' is returned.
1140 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1141 (buffer, visible_ok, frame)
1142 register Lisp_Object buffer, visible_ok, frame;
1144 Lisp_Object Fset_buffer_major_mode ();
1145 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1146 notsogood = Qnil;
1148 if (NILP (frame))
1149 frame = selected_frame;
1151 tail = Vbuffer_alist;
1152 pred = frame_buffer_predicate (frame);
1154 /* Consider buffers that have been seen in the selected frame
1155 before other buffers. */
1157 tem = frame_buffer_list (frame);
1158 add_ons = Qnil;
1159 while (CONSP (tem))
1161 if (BUFFERP (XCAR (tem)))
1162 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1163 tem = XCDR (tem);
1165 tail = nconc2 (Fnreverse (add_ons), tail);
1167 for (; CONSP (tail); tail = XCDR (tail))
1169 buf = Fcdr (XCAR (tail));
1170 if (EQ (buf, buffer))
1171 continue;
1172 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1173 continue;
1174 /* If the selected frame has a buffer_predicate,
1175 disregard buffers that don't fit the predicate. */
1176 if (!NILP (pred))
1178 tem = call1 (pred, buf);
1179 if (NILP (tem))
1180 continue;
1183 if (NILP (visible_ok))
1184 tem = Fget_buffer_window (buf, Qvisible);
1185 else
1186 tem = Qnil;
1187 if (NILP (tem))
1188 return buf;
1189 if (NILP (notsogood))
1190 notsogood = buf;
1192 if (!NILP (notsogood))
1193 return notsogood;
1194 buf = Fget_buffer (build_string ("*scratch*"));
1195 if (NILP (buf))
1197 buf = Fget_buffer_create (build_string ("*scratch*"));
1198 Fset_buffer_major_mode (buf);
1200 return buf;
1203 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
1204 0, 1, "",
1205 doc: /* Make BUFFER stop keeping undo information.
1206 No argument or nil as argument means do this for the current buffer. */)
1207 (buffer)
1208 register Lisp_Object buffer;
1210 Lisp_Object real_buffer;
1212 if (NILP (buffer))
1213 XSETBUFFER (real_buffer, current_buffer);
1214 else
1216 real_buffer = Fget_buffer (buffer);
1217 if (NILP (real_buffer))
1218 nsberror (buffer);
1221 XBUFFER (real_buffer)->undo_list = Qt;
1223 return Qnil;
1226 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1227 0, 1, "",
1228 doc: /* Start keeping undo information for buffer BUFFER.
1229 No argument or nil as argument means do this for the current buffer. */)
1230 (buffer)
1231 register Lisp_Object buffer;
1233 Lisp_Object real_buffer;
1235 if (NILP (buffer))
1236 XSETBUFFER (real_buffer, current_buffer);
1237 else
1239 real_buffer = Fget_buffer (buffer);
1240 if (NILP (real_buffer))
1241 nsberror (buffer);
1244 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1245 XBUFFER (real_buffer)->undo_list = Qnil;
1247 return Qnil;
1251 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1252 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1253 The buffer being killed will be current while the hook is running.\n\
1254 See `kill-buffer'."
1256 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1257 doc: /* Kill the buffer BUFFER.
1258 The argument may be a buffer or may be the name of a buffer.
1259 An argument of nil means kill the current buffer.
1261 Value is t if the buffer is actually killed, nil if user says no.
1263 The value of `kill-buffer-hook' (which may be local to that buffer),
1264 if not void, is a list of functions to be called, with no arguments,
1265 before the buffer is actually killed. The buffer to be killed is current
1266 when the hook functions are called.
1268 Any processes that have this buffer as the `process-buffer' are killed
1269 with SIGHUP. */)
1270 (buffer)
1271 Lisp_Object buffer;
1273 Lisp_Object buf;
1274 register struct buffer *b;
1275 register Lisp_Object tem;
1276 register struct Lisp_Marker *m;
1277 struct gcpro gcpro1;
1279 if (NILP (buffer))
1280 buf = Fcurrent_buffer ();
1281 else
1282 buf = Fget_buffer (buffer);
1283 if (NILP (buf))
1284 nsberror (buffer);
1286 b = XBUFFER (buf);
1288 /* Avoid trouble for buffer already dead. */
1289 if (NILP (b->name))
1290 return Qnil;
1292 /* Query if the buffer is still modified. */
1293 if (INTERACTIVE && !NILP (b->filename)
1294 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1296 GCPRO1 (buf);
1297 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1298 b->name, make_number (0)));
1299 UNGCPRO;
1300 if (NILP (tem))
1301 return Qnil;
1304 /* Run hooks with the buffer to be killed the current buffer. */
1306 int count = SPECPDL_INDEX ();
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, 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 (NILP (flag))
2072 begv = BEGV_BYTE, zv = ZV_BYTE;
2073 else
2074 begv = BEGV, zv = ZV;
2076 if (narrowed)
2077 Fwiden ();
2079 if (NILP (flag))
2081 int pos, stop;
2082 unsigned char *p;
2084 /* Do this first, so it can use CHAR_TO_BYTE
2085 to calculate the old correspondences. */
2086 set_intervals_multibyte (0);
2088 current_buffer->enable_multibyte_characters = Qnil;
2090 Z = Z_BYTE;
2091 BEGV = BEGV_BYTE;
2092 ZV = ZV_BYTE;
2093 GPT = GPT_BYTE;
2094 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2096 tail = BUF_MARKERS (current_buffer);
2097 while (! NILP (tail))
2099 XMARKER (tail)->charpos = XMARKER (tail)->bytepos;
2100 tail = XMARKER (tail)->chain;
2103 /* Convert multibyte form of 8-bit characters to unibyte. */
2104 pos = BEG;
2105 stop = GPT;
2106 p = BEG_ADDR;
2107 while (1)
2109 int c, bytes;
2111 if (pos == stop)
2113 if (pos == Z)
2114 break;
2115 p = GAP_END_ADDR;
2116 stop = Z;
2118 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2119 p += bytes, pos += bytes;
2120 else
2122 c = STRING_CHAR (p, stop - pos);
2123 /* Delete all bytes for this 8-bit character but the
2124 last one, and change the last one to the charcter
2125 code. */
2126 bytes--;
2127 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2128 p = GAP_END_ADDR;
2129 *p++ = c;
2130 pos++;
2131 if (begv > pos)
2132 begv -= bytes;
2133 if (zv > pos)
2134 zv -= bytes;
2135 stop = Z;
2138 if (narrowed)
2139 Fnarrow_to_region (make_number (begv), make_number (zv));
2141 else
2143 int pt = PT;
2144 int pos, stop;
2145 unsigned char *p;
2147 /* Be sure not to have a multibyte sequence striding over the GAP.
2148 Ex: We change this: "...abc\201 _GAP_ \241def..."
2149 to: "...abc _GAP_ \201\241def..." */
2151 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2152 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2154 unsigned char *p = GPT_ADDR - 1;
2156 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2157 if (BASE_LEADING_CODE_P (*p))
2159 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2161 move_gap_both (new_gpt, new_gpt);
2165 /* Make the buffer contents valid as multibyte by converting
2166 8-bit characters to multibyte form. */
2167 pos = BEG;
2168 stop = GPT;
2169 p = BEG_ADDR;
2170 while (1)
2172 int bytes;
2174 if (pos == stop)
2176 if (pos == Z)
2177 break;
2178 p = GAP_END_ADDR;
2179 stop = Z;
2182 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2183 p += bytes, pos += bytes;
2184 else
2186 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2188 bytes = CHAR_STRING (*p, tmp);
2189 *p = tmp[0];
2190 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2191 bytes--;
2192 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2193 /* Now the gap is after the just inserted data. */
2194 pos = GPT;
2195 p = GAP_END_ADDR;
2196 if (pos <= begv)
2197 begv += bytes;
2198 if (pos <= zv)
2199 zv += bytes;
2200 if (pos <= pt)
2201 pt += bytes;
2202 stop = Z;
2206 if (pt != PT)
2207 TEMP_SET_PT (pt);
2209 if (narrowed)
2210 Fnarrow_to_region (make_number (begv), make_number (zv));
2212 /* Do this first, so that chars_in_text asks the right question.
2213 set_intervals_multibyte needs it too. */
2214 current_buffer->enable_multibyte_characters = Qt;
2216 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2217 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2219 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2221 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2222 if (BEGV_BYTE > GPT_BYTE)
2223 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2224 else
2225 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2227 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2228 if (ZV_BYTE > GPT_BYTE)
2229 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2230 else
2231 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2234 int pt_byte = advance_to_char_boundary (PT_BYTE);
2235 int pt;
2237 if (pt_byte > GPT_BYTE)
2238 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2239 else
2240 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2241 TEMP_SET_PT_BOTH (pt, pt_byte);
2244 tail = markers = BUF_MARKERS (current_buffer);
2246 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2247 getting confused by the markers that have not yet been updated.
2248 It is also a signal that it should never create a marker. */
2249 BUF_MARKERS (current_buffer) = Qnil;
2251 while (! NILP (tail))
2253 XMARKER (tail)->bytepos
2254 = advance_to_char_boundary (XMARKER (tail)->bytepos);
2255 XMARKER (tail)->charpos = BYTE_TO_CHAR (XMARKER (tail)->bytepos);
2257 tail = XMARKER (tail)->chain;
2260 /* Make sure no markers were put on the chain
2261 while the chain value was incorrect. */
2262 if (! EQ (BUF_MARKERS (current_buffer), Qnil))
2263 abort ();
2265 BUF_MARKERS (current_buffer) = markers;
2267 /* Do this last, so it can calculate the new correspondences
2268 between chars and bytes. */
2269 set_intervals_multibyte (1);
2272 if (undo_enabled_p)
2273 current_buffer->undo_list = Qnil;
2275 /* Changing the multibyteness of a buffer means that all windows
2276 showing that buffer must be updated thoroughly. */
2277 current_buffer->prevent_redisplay_optimizations_p = 1;
2278 ++windows_or_buffers_changed;
2280 /* Copy this buffer's new multibyte status
2281 into all of its indirect buffers. */
2282 for (other = all_buffers; other; other = other->next)
2283 if (other->base_buffer == current_buffer && !NILP (other->name))
2285 other->enable_multibyte_characters
2286 = current_buffer->enable_multibyte_characters;
2287 other->prevent_redisplay_optimizations_p = 1;
2290 /* Restore the modifiedness of the buffer. */
2291 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2292 Fset_buffer_modified_p (Qnil);
2294 #ifdef subprocesses
2295 /* Update coding systems of this buffer's process (if any). */
2297 Lisp_Object process;
2299 process = Fget_buffer_process (Fcurrent_buffer ());
2300 if (PROCESSP (process))
2301 setup_process_coding_systems (process);
2303 #endif /* subprocesses */
2305 return flag;
2308 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2309 0, 0, 0,
2310 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2311 Most local variable bindings are eliminated so that the default values
2312 become effective once more. Also, the syntax table is set from
2313 `standard-syntax-table', the local keymap is set to nil,
2314 and the abbrev table from `fundamental-mode-abbrev-table'.
2315 This function also forces redisplay of the mode line.
2317 Every function to select a new major mode starts by
2318 calling this function.
2320 As a special exception, local variables whose names have
2321 a non-nil `permanent-local' property are not eliminated by this function.
2323 The first thing this function does is run
2324 the normal hook `change-major-mode-hook'. */)
2327 register Lisp_Object alist, sym, tem;
2328 Lisp_Object oalist;
2330 if (!NILP (Vrun_hooks))
2331 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2332 oalist = current_buffer->local_var_alist;
2334 /* Make sure none of the bindings in oalist
2335 remain swapped in, in their symbols. */
2337 swap_out_buffer_local_variables (current_buffer);
2339 /* Actually eliminate all local bindings of this buffer. */
2341 reset_buffer_local_variables (current_buffer, 0);
2343 /* Any which are supposed to be permanent,
2344 make local again, with the same values they had. */
2346 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2348 sym = XCAR (XCAR (alist));
2349 tem = Fget (sym, Qpermanent_local);
2350 if (! NILP (tem))
2352 Fmake_local_variable (sym);
2353 Fset (sym, XCDR (XCAR (alist)));
2357 /* Force mode-line redisplay. Useful here because all major mode
2358 commands call this function. */
2359 update_mode_lines++;
2361 return Qnil;
2364 /* Make sure no local variables remain set up with buffer B
2365 for their current values. */
2367 static void
2368 swap_out_buffer_local_variables (b)
2369 struct buffer *b;
2371 Lisp_Object oalist, alist, sym, tem, buffer;
2373 XSETBUFFER (buffer, b);
2374 oalist = b->local_var_alist;
2376 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2378 sym = XCAR (XCAR (alist));
2380 /* Need not do anything if some other buffer's binding is now encached. */
2381 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2382 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2384 /* Symbol is set up for this buffer's old local value.
2385 Set it up for the current buffer with the default value. */
2387 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2388 /* Store the symbol's current value into the alist entry
2389 it is currently set up for. This is so that, if the
2390 local is marked permanent, and we make it local again
2391 later in Fkill_all_local_variables, we don't lose the value. */
2392 XSETCDR (XCAR (tem),
2393 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2394 /* Switch to the symbol's default-value alist entry. */
2395 XSETCAR (tem, tem);
2396 /* Mark it as current for buffer B. */
2397 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2398 /* Store the current value into any forwarding in the symbol. */
2399 store_symval_forwarding (sym,
2400 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2401 XCDR (tem), NULL);
2406 /* Find all the overlays in the current buffer that contain position POS.
2407 Return the number found, and store them in a vector in *VEC_PTR.
2408 Store in *LEN_PTR the size allocated for the vector.
2409 Store in *NEXT_PTR the next position after POS where an overlay starts,
2410 or ZV if there are no more overlays.
2411 Store in *PREV_PTR the previous position before POS where an overlay ends,
2412 or where an overlay starts which ends at or after POS;
2413 or BEGV if there are no such overlays.
2414 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2416 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2417 when this function is called.
2419 If EXTEND is non-zero, we make the vector bigger if necessary.
2420 If EXTEND is zero, we never extend the vector,
2421 and we store only as many overlays as will fit.
2422 But we still return the total number of overlays.
2424 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2425 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2426 default (BEGV or ZV). */
2429 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2430 int pos;
2431 int extend;
2432 Lisp_Object **vec_ptr;
2433 int *len_ptr;
2434 int *next_ptr;
2435 int *prev_ptr;
2436 int change_req;
2438 Lisp_Object tail, overlay, start, end;
2439 int idx = 0;
2440 int len = *len_ptr;
2441 Lisp_Object *vec = *vec_ptr;
2442 int next = ZV;
2443 int prev = BEGV;
2444 int inhibit_storing = 0;
2446 for (tail = current_buffer->overlays_before;
2447 GC_CONSP (tail);
2448 tail = XCDR (tail))
2450 int startpos, endpos;
2452 overlay = XCAR (tail);
2454 start = OVERLAY_START (overlay);
2455 end = OVERLAY_END (overlay);
2456 endpos = OVERLAY_POSITION (end);
2457 if (endpos < pos)
2459 if (prev < endpos)
2460 prev = endpos;
2461 break;
2463 startpos = OVERLAY_POSITION (start);
2464 /* This one ends at or after POS
2465 so its start counts for PREV_PTR if it's before POS. */
2466 if (prev < startpos && startpos < pos)
2467 prev = startpos;
2468 if (endpos == pos)
2469 continue;
2470 if (startpos <= pos)
2472 if (idx == len)
2474 /* The supplied vector is full.
2475 Either make it bigger, or don't store any more in it. */
2476 if (extend)
2478 /* Make it work with an initial len == 0. */
2479 len *= 2;
2480 if (len == 0)
2481 len = 4;
2482 *len_ptr = len;
2483 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2484 *vec_ptr = vec;
2486 else
2487 inhibit_storing = 1;
2490 if (!inhibit_storing)
2491 vec[idx] = overlay;
2492 /* Keep counting overlays even if we can't return them all. */
2493 idx++;
2495 else if (startpos < next)
2496 next = startpos;
2499 for (tail = current_buffer->overlays_after;
2500 GC_CONSP (tail);
2501 tail = XCDR (tail))
2503 int startpos, endpos;
2505 overlay = XCAR (tail);
2507 start = OVERLAY_START (overlay);
2508 end = OVERLAY_END (overlay);
2509 startpos = OVERLAY_POSITION (start);
2510 if (pos < startpos)
2512 if (startpos < next)
2513 next = startpos;
2514 break;
2516 endpos = OVERLAY_POSITION (end);
2517 if (pos < endpos)
2519 if (idx == len)
2521 if (extend)
2523 /* Make it work with an initial len == 0. */
2524 len *= 2;
2525 if (len == 0)
2526 len = 4;
2527 *len_ptr = len;
2528 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2529 *vec_ptr = vec;
2531 else
2532 inhibit_storing = 1;
2535 if (!inhibit_storing)
2536 vec[idx] = overlay;
2537 idx++;
2539 if (startpos < pos && startpos > prev)
2540 prev = startpos;
2542 else if (endpos < pos && endpos > prev)
2543 prev = endpos;
2544 else if (endpos == pos && startpos > prev
2545 && (!change_req || startpos < pos))
2546 prev = startpos;
2549 if (next_ptr)
2550 *next_ptr = next;
2551 if (prev_ptr)
2552 *prev_ptr = prev;
2553 return idx;
2556 /* Find all the overlays in the current buffer that overlap the range BEG-END
2557 or are empty at BEG.
2559 Return the number found, and store them in a vector in *VEC_PTR.
2560 Store in *LEN_PTR the size allocated for the vector.
2561 Store in *NEXT_PTR the next position after POS where an overlay starts,
2562 or ZV if there are no more overlays.
2563 Store in *PREV_PTR the previous position before POS where an overlay ends,
2564 or BEGV if there are no previous overlays.
2565 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2567 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2568 when this function is called.
2570 If EXTEND is non-zero, we make the vector bigger if necessary.
2571 If EXTEND is zero, we never extend the vector,
2572 and we store only as many overlays as will fit.
2573 But we still return the total number of overlays. */
2575 static int
2576 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2577 int beg, end;
2578 int extend;
2579 Lisp_Object **vec_ptr;
2580 int *len_ptr;
2581 int *next_ptr;
2582 int *prev_ptr;
2584 Lisp_Object tail, overlay, ostart, oend;
2585 int idx = 0;
2586 int len = *len_ptr;
2587 Lisp_Object *vec = *vec_ptr;
2588 int next = ZV;
2589 int prev = BEGV;
2590 int inhibit_storing = 0;
2592 for (tail = current_buffer->overlays_before;
2593 GC_CONSP (tail);
2594 tail = XCDR (tail))
2596 int startpos, endpos;
2598 overlay = XCAR (tail);
2600 ostart = OVERLAY_START (overlay);
2601 oend = OVERLAY_END (overlay);
2602 endpos = OVERLAY_POSITION (oend);
2603 if (endpos < beg)
2605 if (prev < endpos)
2606 prev = endpos;
2607 break;
2609 startpos = OVERLAY_POSITION (ostart);
2610 /* Count an interval if it either overlaps the range
2611 or is empty at the start of the range. */
2612 if ((beg < endpos && startpos < end)
2613 || (startpos == endpos && beg == endpos))
2615 if (idx == len)
2617 /* The supplied vector is full.
2618 Either make it bigger, or don't store any more in it. */
2619 if (extend)
2621 /* Make it work with an initial len == 0. */
2622 len *= 2;
2623 if (len == 0)
2624 len = 4;
2625 *len_ptr = len;
2626 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2627 *vec_ptr = vec;
2629 else
2630 inhibit_storing = 1;
2633 if (!inhibit_storing)
2634 vec[idx] = overlay;
2635 /* Keep counting overlays even if we can't return them all. */
2636 idx++;
2638 else if (startpos < next)
2639 next = startpos;
2642 for (tail = current_buffer->overlays_after;
2643 GC_CONSP (tail);
2644 tail = XCDR (tail))
2646 int startpos, endpos;
2648 overlay = XCAR (tail);
2650 ostart = OVERLAY_START (overlay);
2651 oend = OVERLAY_END (overlay);
2652 startpos = OVERLAY_POSITION (ostart);
2653 if (end < startpos)
2655 if (startpos < next)
2656 next = startpos;
2657 break;
2659 endpos = OVERLAY_POSITION (oend);
2660 /* Count an interval if it either overlaps the range
2661 or is empty at the start of the range. */
2662 if ((beg < endpos && startpos < end)
2663 || (startpos == endpos && beg == endpos))
2665 if (idx == len)
2667 if (extend)
2669 /* Make it work with an initial len == 0. */
2670 len *= 2;
2671 if (len == 0)
2672 len = 4;
2673 *len_ptr = len;
2674 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2675 *vec_ptr = vec;
2677 else
2678 inhibit_storing = 1;
2681 if (!inhibit_storing)
2682 vec[idx] = overlay;
2683 idx++;
2685 else if (endpos < beg && endpos > prev)
2686 prev = endpos;
2689 if (next_ptr)
2690 *next_ptr = next;
2691 if (prev_ptr)
2692 *prev_ptr = prev;
2693 return idx;
2697 /* Return non-zero if there exists an overlay with a non-nil
2698 `mouse-face' property overlapping OVERLAY. */
2701 mouse_face_overlay_overlaps (overlay)
2702 Lisp_Object overlay;
2704 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2705 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2706 int n, i, size;
2707 Lisp_Object *v, tem;
2709 size = 10;
2710 v = (Lisp_Object *) alloca (size * sizeof *v);
2711 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2712 if (n > size)
2714 v = (Lisp_Object *) alloca (n * sizeof *v);
2715 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2718 for (i = 0; i < n; ++i)
2719 if (!EQ (v[i], overlay)
2720 && (tem = Foverlay_get (overlay, Qmouse_face),
2721 !NILP (tem)))
2722 break;
2724 return i < n;
2729 /* Fast function to just test if we're at an overlay boundary. */
2731 overlay_touches_p (pos)
2732 int pos;
2734 Lisp_Object tail, overlay;
2736 for (tail = current_buffer->overlays_before; GC_CONSP (tail);
2737 tail = XCDR (tail))
2739 int endpos;
2741 overlay = XCAR (tail);
2742 if (!GC_OVERLAYP (overlay))
2743 abort ();
2745 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2746 if (endpos < pos)
2747 break;
2748 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2749 return 1;
2752 for (tail = current_buffer->overlays_after; GC_CONSP (tail);
2753 tail = XCDR (tail))
2755 int startpos;
2757 overlay = XCAR (tail);
2758 if (!GC_OVERLAYP (overlay))
2759 abort ();
2761 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2762 if (pos < startpos)
2763 break;
2764 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2765 return 1;
2767 return 0;
2770 struct sortvec
2772 Lisp_Object overlay;
2773 int beg, end;
2774 int priority;
2777 static int
2778 compare_overlays (v1, v2)
2779 const void *v1, *v2;
2781 const struct sortvec *s1 = (const struct sortvec *) v1;
2782 const struct sortvec *s2 = (const struct sortvec *) v2;
2783 if (s1->priority != s2->priority)
2784 return s1->priority - s2->priority;
2785 if (s1->beg != s2->beg)
2786 return s1->beg - s2->beg;
2787 if (s1->end != s2->end)
2788 return s2->end - s1->end;
2789 return 0;
2792 /* Sort an array of overlays by priority. The array is modified in place.
2793 The return value is the new size; this may be smaller than the original
2794 size if some of the overlays were invalid or were window-specific. */
2796 sort_overlays (overlay_vec, noverlays, w)
2797 Lisp_Object *overlay_vec;
2798 int noverlays;
2799 struct window *w;
2801 int i, j;
2802 struct sortvec *sortvec;
2803 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2805 /* Put the valid and relevant overlays into sortvec. */
2807 for (i = 0, j = 0; i < noverlays; i++)
2809 Lisp_Object tem;
2810 Lisp_Object overlay;
2812 overlay = overlay_vec[i];
2813 if (OVERLAY_VALID (overlay)
2814 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2815 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2817 /* If we're interested in a specific window, then ignore
2818 overlays that are limited to some other window. */
2819 if (w)
2821 Lisp_Object window;
2823 window = Foverlay_get (overlay, Qwindow);
2824 if (WINDOWP (window) && XWINDOW (window) != w)
2825 continue;
2828 /* This overlay is good and counts: put it into sortvec. */
2829 sortvec[j].overlay = overlay;
2830 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2831 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2832 tem = Foverlay_get (overlay, Qpriority);
2833 if (INTEGERP (tem))
2834 sortvec[j].priority = XINT (tem);
2835 else
2836 sortvec[j].priority = 0;
2837 j++;
2840 noverlays = j;
2842 /* Sort the overlays into the proper order: increasing priority. */
2844 if (noverlays > 1)
2845 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2847 for (i = 0; i < noverlays; i++)
2848 overlay_vec[i] = sortvec[i].overlay;
2849 return (noverlays);
2852 struct sortstr
2854 Lisp_Object string, string2;
2855 int size;
2856 int priority;
2859 struct sortstrlist
2861 struct sortstr *buf; /* An array that expands as needed; never freed. */
2862 int size; /* Allocated length of that array. */
2863 int used; /* How much of the array is currently in use. */
2864 int bytes; /* Total length of the strings in buf. */
2867 /* Buffers for storing information about the overlays touching a given
2868 position. These could be automatic variables in overlay_strings, but
2869 it's more efficient to hold onto the memory instead of repeatedly
2870 allocating and freeing it. */
2871 static struct sortstrlist overlay_heads, overlay_tails;
2872 static unsigned char *overlay_str_buf;
2874 /* Allocated length of overlay_str_buf. */
2875 static int overlay_str_len;
2877 /* A comparison function suitable for passing to qsort. */
2878 static int
2879 cmp_for_strings (as1, as2)
2880 char *as1, *as2;
2882 struct sortstr *s1 = (struct sortstr *)as1;
2883 struct sortstr *s2 = (struct sortstr *)as2;
2884 if (s1->size != s2->size)
2885 return s2->size - s1->size;
2886 if (s1->priority != s2->priority)
2887 return s1->priority - s2->priority;
2888 return 0;
2891 static void
2892 record_overlay_string (ssl, str, str2, pri, size)
2893 struct sortstrlist *ssl;
2894 Lisp_Object str, str2, pri;
2895 int size;
2897 int nbytes;
2899 if (ssl->used == ssl->size)
2901 if (ssl->buf)
2902 ssl->size *= 2;
2903 else
2904 ssl->size = 5;
2905 ssl->buf = ((struct sortstr *)
2906 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2908 ssl->buf[ssl->used].string = str;
2909 ssl->buf[ssl->used].string2 = str2;
2910 ssl->buf[ssl->used].size = size;
2911 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2912 ssl->used++;
2914 if (NILP (current_buffer->enable_multibyte_characters))
2915 nbytes = SCHARS (str);
2916 else if (! STRING_MULTIBYTE (str))
2917 nbytes = count_size_as_multibyte (SDATA (str),
2918 SBYTES (str));
2919 else
2920 nbytes = SBYTES (str);
2922 ssl->bytes += nbytes;
2924 if (STRINGP (str2))
2926 if (NILP (current_buffer->enable_multibyte_characters))
2927 nbytes = SCHARS (str2);
2928 else if (! STRING_MULTIBYTE (str2))
2929 nbytes = count_size_as_multibyte (SDATA (str2),
2930 SBYTES (str2));
2931 else
2932 nbytes = SBYTES (str2);
2934 ssl->bytes += nbytes;
2938 /* Return the concatenation of the strings associated with overlays that
2939 begin or end at POS, ignoring overlays that are specific to a window
2940 other than W. The strings are concatenated in the appropriate order:
2941 shorter overlays nest inside longer ones, and higher priority inside
2942 lower. Normally all of the after-strings come first, but zero-sized
2943 overlays have their after-strings ride along with the before-strings
2944 because it would look strange to print them inside-out.
2946 Returns the string length, and stores the contents indirectly through
2947 PSTR, if that variable is non-null. The string may be overwritten by
2948 subsequent calls. */
2951 overlay_strings (pos, w, pstr)
2952 int pos;
2953 struct window *w;
2954 unsigned char **pstr;
2956 Lisp_Object ov, overlay, window, str;
2957 int startpos, endpos;
2958 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
2960 overlay_heads.used = overlay_heads.bytes = 0;
2961 overlay_tails.used = overlay_tails.bytes = 0;
2962 for (ov = current_buffer->overlays_before; CONSP (ov); ov = XCDR (ov))
2964 overlay = XCAR (ov);
2965 if (!OVERLAYP (overlay))
2966 abort ();
2968 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2969 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2970 if (endpos < pos)
2971 break;
2972 if (endpos != pos && startpos != pos)
2973 continue;
2974 window = Foverlay_get (overlay, Qwindow);
2975 if (WINDOWP (window) && XWINDOW (window) != w)
2976 continue;
2977 if (startpos == pos
2978 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2979 record_overlay_string (&overlay_heads, str,
2980 (startpos == endpos
2981 ? Foverlay_get (overlay, Qafter_string)
2982 : Qnil),
2983 Foverlay_get (overlay, Qpriority),
2984 endpos - startpos);
2985 else if (endpos == pos
2986 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2987 record_overlay_string (&overlay_tails, str, Qnil,
2988 Foverlay_get (overlay, Qpriority),
2989 endpos - startpos);
2991 for (ov = current_buffer->overlays_after; CONSP (ov); ov = XCDR (ov))
2993 overlay = XCAR (ov);
2994 if (!OVERLAYP (overlay))
2995 abort ();
2997 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2998 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2999 if (startpos > pos)
3000 break;
3001 if (endpos != pos && startpos != pos)
3002 continue;
3003 window = Foverlay_get (overlay, Qwindow);
3004 if (WINDOWP (window) && XWINDOW (window) != w)
3005 continue;
3006 if (startpos == pos
3007 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3008 record_overlay_string (&overlay_heads, str,
3009 (startpos == endpos
3010 ? Foverlay_get (overlay, Qafter_string)
3011 : Qnil),
3012 Foverlay_get (overlay, Qpriority),
3013 endpos - startpos);
3014 else if (endpos == pos
3015 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3016 record_overlay_string (&overlay_tails, str, Qnil,
3017 Foverlay_get (overlay, Qpriority),
3018 endpos - startpos);
3020 if (overlay_tails.used > 1)
3021 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3022 cmp_for_strings);
3023 if (overlay_heads.used > 1)
3024 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3025 cmp_for_strings);
3026 if (overlay_heads.bytes || overlay_tails.bytes)
3028 Lisp_Object tem;
3029 int i;
3030 unsigned char *p;
3031 int total = overlay_heads.bytes + overlay_tails.bytes;
3033 if (total > overlay_str_len)
3035 overlay_str_len = total;
3036 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3037 total);
3039 p = overlay_str_buf;
3040 for (i = overlay_tails.used; --i >= 0;)
3042 int nbytes;
3043 tem = overlay_tails.buf[i].string;
3044 nbytes = copy_text (SDATA (tem), p,
3045 SBYTES (tem),
3046 STRING_MULTIBYTE (tem), multibyte);
3047 p += nbytes;
3049 for (i = 0; i < overlay_heads.used; ++i)
3051 int nbytes;
3052 tem = overlay_heads.buf[i].string;
3053 nbytes = copy_text (SDATA (tem), p,
3054 SBYTES (tem),
3055 STRING_MULTIBYTE (tem), multibyte);
3056 p += nbytes;
3057 tem = overlay_heads.buf[i].string2;
3058 if (STRINGP (tem))
3060 nbytes = copy_text (SDATA (tem), p,
3061 SBYTES (tem),
3062 STRING_MULTIBYTE (tem), multibyte);
3063 p += nbytes;
3066 if (p != overlay_str_buf + total)
3067 abort ();
3068 if (pstr)
3069 *pstr = overlay_str_buf;
3070 return total;
3072 return 0;
3075 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3077 void
3078 recenter_overlay_lists (buf, pos)
3079 struct buffer *buf;
3080 int pos;
3082 Lisp_Object overlay, tail, next, prev, beg, end;
3084 /* See if anything in overlays_before should move to overlays_after. */
3086 /* We don't strictly need prev in this loop; it should always be nil.
3087 But we use it for symmetry and in case that should cease to be true
3088 with some future change. */
3089 prev = Qnil;
3090 for (tail = buf->overlays_before;
3091 CONSP (tail);
3092 prev = tail, tail = next)
3094 next = XCDR (tail);
3095 overlay = XCAR (tail);
3097 /* If the overlay is not valid, get rid of it. */
3098 if (!OVERLAY_VALID (overlay))
3099 #if 1
3100 abort ();
3101 #else
3103 /* Splice the cons cell TAIL out of overlays_before. */
3104 if (!NILP (prev))
3105 XCDR (prev) = next;
3106 else
3107 buf->overlays_before = next;
3108 tail = prev;
3109 continue;
3111 #endif
3113 beg = OVERLAY_START (overlay);
3114 end = OVERLAY_END (overlay);
3116 if (OVERLAY_POSITION (end) > pos)
3118 /* OVERLAY needs to be moved. */
3119 int where = OVERLAY_POSITION (beg);
3120 Lisp_Object other, other_prev;
3122 /* Splice the cons cell TAIL out of overlays_before. */
3123 if (!NILP (prev))
3124 XSETCDR (prev, next);
3125 else
3126 buf->overlays_before = next;
3128 /* Search thru overlays_after for where to put it. */
3129 other_prev = Qnil;
3130 for (other = buf->overlays_after;
3131 CONSP (other);
3132 other_prev = other, other = XCDR (other))
3134 Lisp_Object otherbeg, otheroverlay;
3136 otheroverlay = XCAR (other);
3137 if (! OVERLAY_VALID (otheroverlay))
3138 abort ();
3140 otherbeg = OVERLAY_START (otheroverlay);
3141 if (OVERLAY_POSITION (otherbeg) >= where)
3142 break;
3145 /* Add TAIL to overlays_after before OTHER. */
3146 XSETCDR (tail, other);
3147 if (!NILP (other_prev))
3148 XSETCDR (other_prev, tail);
3149 else
3150 buf->overlays_after = tail;
3151 tail = prev;
3153 else
3154 /* We've reached the things that should stay in overlays_before.
3155 All the rest of overlays_before must end even earlier,
3156 so stop now. */
3157 break;
3160 /* See if anything in overlays_after should be in overlays_before. */
3161 prev = Qnil;
3162 for (tail = buf->overlays_after;
3163 CONSP (tail);
3164 prev = tail, tail = next)
3166 next = XCDR (tail);
3167 overlay = XCAR (tail);
3169 /* If the overlay is not valid, get rid of it. */
3170 if (!OVERLAY_VALID (overlay))
3171 #if 1
3172 abort ();
3173 #else
3175 /* Splice the cons cell TAIL out of overlays_after. */
3176 if (!NILP (prev))
3177 XCDR (prev) = next;
3178 else
3179 buf->overlays_after = next;
3180 tail = prev;
3181 continue;
3183 #endif
3185 beg = OVERLAY_START (overlay);
3186 end = OVERLAY_END (overlay);
3188 /* Stop looking, when we know that nothing further
3189 can possibly end before POS. */
3190 if (OVERLAY_POSITION (beg) > pos)
3191 break;
3193 if (OVERLAY_POSITION (end) <= pos)
3195 /* OVERLAY needs to be moved. */
3196 int where = OVERLAY_POSITION (end);
3197 Lisp_Object other, other_prev;
3199 /* Splice the cons cell TAIL out of overlays_after. */
3200 if (!NILP (prev))
3201 XSETCDR (prev, next);
3202 else
3203 buf->overlays_after = next;
3205 /* Search thru overlays_before for where to put it. */
3206 other_prev = Qnil;
3207 for (other = buf->overlays_before;
3208 CONSP (other);
3209 other_prev = other, other = XCDR (other))
3211 Lisp_Object otherend, otheroverlay;
3213 otheroverlay = XCAR (other);
3214 if (! OVERLAY_VALID (otheroverlay))
3215 abort ();
3217 otherend = OVERLAY_END (otheroverlay);
3218 if (OVERLAY_POSITION (otherend) <= where)
3219 break;
3222 /* Add TAIL to overlays_before before OTHER. */
3223 XSETCDR (tail, other);
3224 if (!NILP (other_prev))
3225 XSETCDR (other_prev, tail);
3226 else
3227 buf->overlays_before = tail;
3228 tail = prev;
3232 XSETFASTINT (buf->overlay_center, pos);
3235 void
3236 adjust_overlays_for_insert (pos, length)
3237 int pos;
3238 int length;
3240 /* After an insertion, the lists are still sorted properly,
3241 but we may need to update the value of the overlay center. */
3242 if (XFASTINT (current_buffer->overlay_center) >= pos)
3243 XSETFASTINT (current_buffer->overlay_center,
3244 XFASTINT (current_buffer->overlay_center) + length);
3247 void
3248 adjust_overlays_for_delete (pos, length)
3249 int pos;
3250 int length;
3252 if (XFASTINT (current_buffer->overlay_center) < pos)
3253 /* The deletion was to our right. No change needed; the before- and
3254 after-lists are still consistent. */
3256 else if (XFASTINT (current_buffer->overlay_center) > pos + length)
3257 /* The deletion was to our left. We need to adjust the center value
3258 to account for the change in position, but the lists are consistent
3259 given the new value. */
3260 XSETFASTINT (current_buffer->overlay_center,
3261 XFASTINT (current_buffer->overlay_center) - length);
3262 else
3263 /* We're right in the middle. There might be things on the after-list
3264 that now belong on the before-list. Recentering will move them,
3265 and also update the center point. */
3266 recenter_overlay_lists (current_buffer, pos);
3269 /* Fix up overlays that were garbled as a result of permuting markers
3270 in the range START through END. Any overlay with at least one
3271 endpoint in this range will need to be unlinked from the overlay
3272 list and reinserted in its proper place.
3273 Such an overlay might even have negative size at this point.
3274 If so, we'll reverse the endpoints. Can you think of anything
3275 better to do in this situation? */
3276 void
3277 fix_overlays_in_range (start, end)
3278 register int start, end;
3280 Lisp_Object overlay;
3281 Lisp_Object before_list, after_list;
3282 /* These are either nil, indicating that before_list or after_list
3283 should be assigned, or the cons cell the cdr of which should be
3284 assigned. */
3285 Lisp_Object beforep = Qnil, afterp = Qnil;
3286 /* 'Parent', likewise, indicates a cons cell or
3287 current_buffer->overlays_before or overlays_after, depending
3288 which loop we're in. */
3289 Lisp_Object tail, parent;
3290 int startpos, endpos;
3292 /* This algorithm shifts links around instead of consing and GCing.
3293 The loop invariant is that before_list (resp. after_list) is a
3294 well-formed list except that its last element, the CDR of beforep
3295 (resp. afterp) if beforep (afterp) isn't nil or before_list
3296 (after_list) if it is, is still uninitialized. So it's not a bug
3297 that before_list isn't initialized, although it may look
3298 strange. */
3299 for (parent = Qnil, tail = current_buffer->overlays_before; CONSP (tail);)
3301 overlay = XCAR (tail);
3302 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3303 if (endpos < start)
3304 break;
3305 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3306 if (endpos < end
3307 || (startpos >= start && startpos < end))
3309 /* If the overlay is backwards, fix that now. */
3310 if (startpos > endpos)
3312 int tem;
3313 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3314 Qnil);
3315 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3316 Qnil);
3317 tem = startpos; startpos = endpos; endpos = tem;
3319 /* Add it to the end of the wrong list. Later on,
3320 recenter_overlay_lists will move it to the right place. */
3321 if (endpos < XINT (current_buffer->overlay_center))
3323 if (NILP (afterp))
3324 after_list = tail;
3325 else
3326 XSETCDR (afterp, tail);
3327 afterp = tail;
3329 else
3331 if (NILP (beforep))
3332 before_list = tail;
3333 else
3334 XSETCDR (beforep, tail);
3335 beforep = tail;
3337 if (NILP (parent))
3338 current_buffer->overlays_before = XCDR (tail);
3339 else
3340 XSETCDR (parent, XCDR (tail));
3341 tail = XCDR (tail);
3343 else
3344 parent = tail, tail = XCDR (parent);
3346 for (parent = Qnil, tail = current_buffer->overlays_after; CONSP (tail);)
3348 overlay = XCAR (tail);
3349 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3350 if (startpos >= end)
3351 break;
3352 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3353 if (startpos >= start
3354 || (endpos >= start && endpos < end))
3356 if (startpos > endpos)
3358 int tem;
3359 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3360 Qnil);
3361 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3362 Qnil);
3363 tem = startpos; startpos = endpos; endpos = tem;
3365 if (endpos < XINT (current_buffer->overlay_center))
3367 if (NILP (afterp))
3368 after_list = tail;
3369 else
3370 XSETCDR (afterp, tail);
3371 afterp = tail;
3373 else
3375 if (NILP (beforep))
3376 before_list = tail;
3377 else
3378 XSETCDR (beforep, tail);
3379 beforep = tail;
3381 if (NILP (parent))
3382 current_buffer->overlays_after = XCDR (tail);
3383 else
3384 XSETCDR (parent, XCDR (tail));
3385 tail = XCDR (tail);
3387 else
3388 parent = tail, tail = XCDR (parent);
3391 /* Splice the constructed (wrong) lists into the buffer's lists,
3392 and let the recenter function make it sane again. */
3393 if (!NILP (beforep))
3395 XSETCDR (beforep, current_buffer->overlays_before);
3396 current_buffer->overlays_before = before_list;
3398 recenter_overlay_lists (current_buffer,
3399 XINT (current_buffer->overlay_center));
3401 if (!NILP (afterp))
3403 XSETCDR (afterp, current_buffer->overlays_after);
3404 current_buffer->overlays_after = after_list;
3406 recenter_overlay_lists (current_buffer,
3407 XINT (current_buffer->overlay_center));
3410 /* We have two types of overlay: the one whose ending marker is
3411 after-insertion-marker (this is the usual case) and the one whose
3412 ending marker is before-insertion-marker. When `overlays_before'
3413 contains overlays of the latter type and the former type in this
3414 order and both overlays end at inserting position, inserting a text
3415 increases only the ending marker of the latter type, which results
3416 in incorrect ordering of `overlays_before'.
3418 This function fixes ordering of overlays in the slot
3419 `overlays_before' of the buffer *BP. Before the insertion, `point'
3420 was at PREV, and now is at POS. */
3422 void
3423 fix_overlays_before (bp, prev, pos)
3424 struct buffer *bp;
3425 int prev, pos;
3427 /* If parent is nil, replace overlays_before; otherwise, XCDR(parent). */
3428 Lisp_Object tail = bp->overlays_before, parent = Qnil;
3429 Lisp_Object right_pair;
3430 int end;
3432 /* After the insertion, the several overlays may be in incorrect
3433 order. The possibility is that, in the list `overlays_before',
3434 an overlay which ends at POS appears after an overlay which ends
3435 at PREV. Since POS is greater than PREV, we must fix the
3436 ordering of these overlays, by moving overlays ends at POS before
3437 the overlays ends at PREV. */
3439 /* At first, find a place where disordered overlays should be linked
3440 in. It is where an overlay which end before POS exists. (i.e. an
3441 overlay whose ending marker is after-insertion-marker if disorder
3442 exists). */
3443 while (!NILP (tail)
3444 && ((end = OVERLAY_POSITION (OVERLAY_END (XCAR (tail))))
3445 >= pos))
3447 parent = tail;
3448 tail = XCDR (tail);
3451 /* If we don't find such an overlay,
3452 or the found one ends before PREV,
3453 or the found one is the last one in the list,
3454 we don't have to fix anything. */
3455 if (NILP (tail)
3456 || end < prev
3457 || NILP (XCDR (tail)))
3458 return;
3460 right_pair = parent;
3461 parent = tail;
3462 tail = XCDR (tail);
3464 /* Now, end position of overlays in the list TAIL should be before
3465 or equal to PREV. In the loop, an overlay which ends at POS is
3466 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3467 we found an overlay which ends before PREV, the remaining
3468 overlays are in correct order. */
3469 while (!NILP (tail))
3471 end = OVERLAY_POSITION (OVERLAY_END (XCAR (tail)));
3473 if (end == pos)
3474 { /* This overlay is disordered. */
3475 Lisp_Object found = tail;
3477 /* Unlink the found overlay. */
3478 tail = XCDR (found);
3479 XSETCDR (parent, tail);
3480 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3481 and link it into the right place. */
3482 if (NILP (right_pair))
3484 XSETCDR (found, bp->overlays_before);
3485 bp->overlays_before = found;
3487 else
3489 XSETCDR (found, XCDR (right_pair));
3490 XSETCDR (right_pair, found);
3493 else if (end == prev)
3495 parent = tail;
3496 tail = XCDR (tail);
3498 else /* No more disordered overlay. */
3499 break;
3503 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3504 doc: /* Return t if OBJECT is an overlay. */)
3505 (object)
3506 Lisp_Object object;
3508 return (OVERLAYP (object) ? Qt : Qnil);
3511 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3512 doc: /* Create a new overlay with range BEG to END in BUFFER.
3513 If omitted, BUFFER defaults to the current buffer.
3514 BEG and END may be integers or markers.
3515 The fourth arg FRONT-ADVANCE, if non-nil, makes the
3516 front delimiter advance when text is inserted there.
3517 The fifth arg REAR-ADVANCE, if non-nil, makes the
3518 rear delimiter advance when text is inserted there. */)
3519 (beg, end, buffer, front_advance, rear_advance)
3520 Lisp_Object beg, end, buffer;
3521 Lisp_Object front_advance, rear_advance;
3523 Lisp_Object overlay;
3524 struct buffer *b;
3526 if (NILP (buffer))
3527 XSETBUFFER (buffer, current_buffer);
3528 else
3529 CHECK_BUFFER (buffer);
3530 if (MARKERP (beg)
3531 && ! EQ (Fmarker_buffer (beg), buffer))
3532 error ("Marker points into wrong buffer");
3533 if (MARKERP (end)
3534 && ! EQ (Fmarker_buffer (end), buffer))
3535 error ("Marker points into wrong buffer");
3537 CHECK_NUMBER_COERCE_MARKER (beg);
3538 CHECK_NUMBER_COERCE_MARKER (end);
3540 if (XINT (beg) > XINT (end))
3542 Lisp_Object temp;
3543 temp = beg; beg = end; end = temp;
3546 b = XBUFFER (buffer);
3548 beg = Fset_marker (Fmake_marker (), beg, buffer);
3549 end = Fset_marker (Fmake_marker (), end, buffer);
3551 if (!NILP (front_advance))
3552 XMARKER (beg)->insertion_type = 1;
3553 if (!NILP (rear_advance))
3554 XMARKER (end)->insertion_type = 1;
3556 overlay = allocate_misc ();
3557 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3558 XOVERLAY (overlay)->start = beg;
3559 XOVERLAY (overlay)->end = end;
3560 XOVERLAY (overlay)->plist = Qnil;
3562 /* Put the new overlay on the wrong list. */
3563 end = OVERLAY_END (overlay);
3564 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3565 b->overlays_after = Fcons (overlay, b->overlays_after);
3566 else
3567 b->overlays_before = Fcons (overlay, b->overlays_before);
3569 /* This puts it in the right list, and in the right order. */
3570 recenter_overlay_lists (b, XINT (b->overlay_center));
3572 /* We don't need to redisplay the region covered by the overlay, because
3573 the overlay has no properties at the moment. */
3575 return overlay;
3578 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3580 static void
3581 modify_overlay (buf, start, end)
3582 struct buffer *buf;
3583 int start, end;
3585 if (start > end)
3587 int temp = start;
3588 start = end;
3589 end = temp;
3592 BUF_COMPUTE_UNCHANGED (buf, start, end);
3594 /* If this is a buffer not in the selected window,
3595 we must do other windows. */
3596 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3597 windows_or_buffers_changed = 1;
3598 /* If multiple windows show this buffer, we must do other windows. */
3599 else if (buffer_shared > 1)
3600 windows_or_buffers_changed = 1;
3602 ++BUF_OVERLAY_MODIFF (buf);
3606 Lisp_Object Fdelete_overlay ();
3608 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3609 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3610 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3611 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3612 buffer. */)
3613 (overlay, beg, end, buffer)
3614 Lisp_Object overlay, beg, end, buffer;
3616 struct buffer *b, *ob;
3617 Lisp_Object obuffer;
3618 int count = SPECPDL_INDEX ();
3620 CHECK_OVERLAY (overlay);
3621 if (NILP (buffer))
3622 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3623 if (NILP (buffer))
3624 XSETBUFFER (buffer, current_buffer);
3625 CHECK_BUFFER (buffer);
3627 if (MARKERP (beg)
3628 && ! EQ (Fmarker_buffer (beg), buffer))
3629 error ("Marker points into wrong buffer");
3630 if (MARKERP (end)
3631 && ! EQ (Fmarker_buffer (end), buffer))
3632 error ("Marker points into wrong buffer");
3634 CHECK_NUMBER_COERCE_MARKER (beg);
3635 CHECK_NUMBER_COERCE_MARKER (end);
3637 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3638 return Fdelete_overlay (overlay);
3640 if (XINT (beg) > XINT (end))
3642 Lisp_Object temp;
3643 temp = beg; beg = end; end = temp;
3646 specbind (Qinhibit_quit, Qt);
3648 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3649 b = XBUFFER (buffer);
3650 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3652 /* If the overlay has changed buffers, do a thorough redisplay. */
3653 if (!EQ (buffer, obuffer))
3655 /* Redisplay where the overlay was. */
3656 if (!NILP (obuffer))
3658 int o_beg;
3659 int o_end;
3661 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3662 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3664 modify_overlay (ob, o_beg, o_end);
3667 /* Redisplay where the overlay is going to be. */
3668 modify_overlay (b, XINT (beg), XINT (end));
3670 else
3671 /* Redisplay the area the overlay has just left, or just enclosed. */
3673 int o_beg, o_end;
3675 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3676 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3678 if (o_beg == XINT (beg))
3679 modify_overlay (b, o_end, XINT (end));
3680 else if (o_end == XINT (end))
3681 modify_overlay (b, o_beg, XINT (beg));
3682 else
3684 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3685 if (XINT (end) > o_end) o_end = XINT (end);
3686 modify_overlay (b, o_beg, o_end);
3690 if (!NILP (obuffer))
3692 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
3693 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
3696 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3697 Fset_marker (OVERLAY_END (overlay), end, buffer);
3699 /* Put the overlay on the wrong list. */
3700 end = OVERLAY_END (overlay);
3701 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3702 b->overlays_after = Fcons (overlay, b->overlays_after);
3703 else
3704 b->overlays_before = Fcons (overlay, b->overlays_before);
3706 /* This puts it in the right list, and in the right order. */
3707 recenter_overlay_lists (b, XINT (b->overlay_center));
3709 return unbind_to (count, overlay);
3712 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3713 doc: /* Delete the overlay OVERLAY from its buffer. */)
3714 (overlay)
3715 Lisp_Object overlay;
3717 Lisp_Object buffer;
3718 struct buffer *b;
3719 int count = SPECPDL_INDEX ();
3721 CHECK_OVERLAY (overlay);
3723 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3724 if (NILP (buffer))
3725 return Qnil;
3727 b = XBUFFER (buffer);
3728 specbind (Qinhibit_quit, Qt);
3730 b->overlays_before = Fdelq (overlay, b->overlays_before);
3731 b->overlays_after = Fdelq (overlay, b->overlays_after);
3732 modify_overlay (b,
3733 marker_position (OVERLAY_START (overlay)),
3734 marker_position (OVERLAY_END (overlay)));
3735 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3736 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3738 /* When deleting an overlay with before or after strings, turn off
3739 display optimizations for the affected buffer, on the basis that
3740 these strings may contain newlines. This is easier to do than to
3741 check for that situation during redisplay. */
3742 if (!windows_or_buffers_changed
3743 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3744 || !NILP (Foverlay_get (overlay, Qafter_string))))
3745 b->prevent_redisplay_optimizations_p = 1;
3747 return unbind_to (count, Qnil);
3750 /* Overlay dissection functions. */
3752 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3753 doc: /* Return the position at which OVERLAY starts. */)
3754 (overlay)
3755 Lisp_Object overlay;
3757 CHECK_OVERLAY (overlay);
3759 return (Fmarker_position (OVERLAY_START (overlay)));
3762 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3763 doc: /* Return the position at which OVERLAY ends. */)
3764 (overlay)
3765 Lisp_Object overlay;
3767 CHECK_OVERLAY (overlay);
3769 return (Fmarker_position (OVERLAY_END (overlay)));
3772 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3773 doc: /* Return the buffer OVERLAY belongs to. */)
3774 (overlay)
3775 Lisp_Object overlay;
3777 CHECK_OVERLAY (overlay);
3779 return Fmarker_buffer (OVERLAY_START (overlay));
3782 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3783 doc: /* Return a list of the properties on OVERLAY.
3784 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3785 OVERLAY. */)
3786 (overlay)
3787 Lisp_Object overlay;
3789 CHECK_OVERLAY (overlay);
3791 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3795 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3796 doc: /* Return a list of the overlays that contain position POS. */)
3797 (pos)
3798 Lisp_Object pos;
3800 int noverlays;
3801 Lisp_Object *overlay_vec;
3802 int len;
3803 Lisp_Object result;
3805 CHECK_NUMBER_COERCE_MARKER (pos);
3807 len = 10;
3808 /* We can't use alloca here because overlays_at can call xrealloc. */
3809 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3811 /* Put all the overlays we want in a vector in overlay_vec.
3812 Store the length in len. */
3813 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3814 (int *) 0, (int *) 0, 0);
3816 /* Make a list of them all. */
3817 result = Flist (noverlays, overlay_vec);
3819 xfree (overlay_vec);
3820 return result;
3823 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3824 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3825 Overlap means that at least one character is contained within the overlay
3826 and also contained within the specified region.
3827 Empty overlays are included in the result if they are located at BEG
3828 or between BEG and END. */)
3829 (beg, end)
3830 Lisp_Object beg, end;
3832 int noverlays;
3833 Lisp_Object *overlay_vec;
3834 int len;
3835 Lisp_Object result;
3837 CHECK_NUMBER_COERCE_MARKER (beg);
3838 CHECK_NUMBER_COERCE_MARKER (end);
3840 len = 10;
3841 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3843 /* Put all the overlays we want in a vector in overlay_vec.
3844 Store the length in len. */
3845 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3846 (int *) 0, (int *) 0);
3848 /* Make a list of them all. */
3849 result = Flist (noverlays, overlay_vec);
3851 xfree (overlay_vec);
3852 return result;
3855 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3856 1, 1, 0,
3857 doc: /* Return the next position after POS where an overlay starts or ends.
3858 If there are no more overlay boundaries after POS, return (point-max). */)
3859 (pos)
3860 Lisp_Object pos;
3862 int noverlays;
3863 int endpos;
3864 Lisp_Object *overlay_vec;
3865 int len;
3866 int i;
3868 CHECK_NUMBER_COERCE_MARKER (pos);
3870 len = 10;
3871 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3873 /* Put all the overlays we want in a vector in overlay_vec.
3874 Store the length in len.
3875 endpos gets the position where the next overlay starts. */
3876 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3877 &endpos, (int *) 0, 1);
3879 /* If any of these overlays ends before endpos,
3880 use its ending point instead. */
3881 for (i = 0; i < noverlays; i++)
3883 Lisp_Object oend;
3884 int oendpos;
3886 oend = OVERLAY_END (overlay_vec[i]);
3887 oendpos = OVERLAY_POSITION (oend);
3888 if (oendpos < endpos)
3889 endpos = oendpos;
3892 xfree (overlay_vec);
3893 return make_number (endpos);
3896 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3897 Sprevious_overlay_change, 1, 1, 0,
3898 doc: /* Return the previous position before POS where an overlay starts or ends.
3899 If there are no more overlay boundaries before POS, return (point-min). */)
3900 (pos)
3901 Lisp_Object pos;
3903 int noverlays;
3904 int prevpos;
3905 Lisp_Object *overlay_vec;
3906 int len;
3908 CHECK_NUMBER_COERCE_MARKER (pos);
3910 /* At beginning of buffer, we know the answer;
3911 avoid bug subtracting 1 below. */
3912 if (XINT (pos) == BEGV)
3913 return pos;
3915 len = 10;
3916 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3918 /* Put all the overlays we want in a vector in overlay_vec.
3919 Store the length in len.
3920 prevpos gets the position of the previous change. */
3921 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3922 (int *) 0, &prevpos, 1);
3924 xfree (overlay_vec);
3925 return make_number (prevpos);
3928 /* These functions are for debugging overlays. */
3930 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3931 doc: /* Return a pair of lists giving all the overlays of the current buffer.
3932 The car has all the overlays before the overlay center;
3933 the cdr has all the overlays after the overlay center.
3934 Recentering overlays moves overlays between these lists.
3935 The lists you get are copies, so that changing them has no effect.
3936 However, the overlays you get are the real objects that the buffer uses. */)
3939 Lisp_Object before, after;
3940 before = current_buffer->overlays_before;
3941 if (CONSP (before))
3942 before = Fcopy_sequence (before);
3943 after = current_buffer->overlays_after;
3944 if (CONSP (after))
3945 after = Fcopy_sequence (after);
3947 return Fcons (before, after);
3950 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
3951 doc: /* Recenter the overlays of the current buffer around position POS.
3952 That makes overlay lookup faster for positions near POS (but perhaps slower
3953 for positions far away from POS). */)
3954 (pos)
3955 Lisp_Object pos;
3957 CHECK_NUMBER_COERCE_MARKER (pos);
3959 recenter_overlay_lists (current_buffer, XINT (pos));
3960 return Qnil;
3963 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
3964 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
3965 (overlay, prop)
3966 Lisp_Object overlay, prop;
3968 CHECK_OVERLAY (overlay);
3969 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
3972 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
3973 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
3974 (overlay, prop, value)
3975 Lisp_Object overlay, prop, value;
3977 Lisp_Object tail, buffer;
3978 int changed;
3980 CHECK_OVERLAY (overlay);
3982 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3984 for (tail = XOVERLAY (overlay)->plist;
3985 CONSP (tail) && CONSP (XCDR (tail));
3986 tail = XCDR (XCDR (tail)))
3987 if (EQ (XCAR (tail), prop))
3989 changed = !EQ (XCAR (XCDR (tail)), value);
3990 XSETCAR (XCDR (tail), value);
3991 goto found;
3993 /* It wasn't in the list, so add it to the front. */
3994 changed = !NILP (value);
3995 XOVERLAY (overlay)->plist
3996 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
3997 found:
3998 if (! NILP (buffer))
4000 if (changed)
4001 modify_overlay (XBUFFER (buffer),
4002 marker_position (OVERLAY_START (overlay)),
4003 marker_position (OVERLAY_END (overlay)));
4004 if (EQ (prop, Qevaporate) && ! NILP (value)
4005 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4006 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4007 Fdelete_overlay (overlay);
4009 return value;
4012 /* Subroutine of report_overlay_modification. */
4014 /* Lisp vector holding overlay hook functions to call.
4015 Vector elements come in pairs.
4016 Each even-index element is a list of hook functions.
4017 The following odd-index element is the overlay they came from.
4019 Before the buffer change, we fill in this vector
4020 as we call overlay hook functions.
4021 After the buffer change, we get the functions to call from this vector.
4022 This way we always call the same functions before and after the change. */
4023 static Lisp_Object last_overlay_modification_hooks;
4025 /* Number of elements actually used in last_overlay_modification_hooks. */
4026 static int last_overlay_modification_hooks_used;
4028 /* Add one functionlist/overlay pair
4029 to the end of last_overlay_modification_hooks. */
4031 static void
4032 add_overlay_mod_hooklist (functionlist, overlay)
4033 Lisp_Object functionlist, overlay;
4035 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4037 if (last_overlay_modification_hooks_used == oldsize)
4039 Lisp_Object old;
4040 old = last_overlay_modification_hooks;
4041 last_overlay_modification_hooks
4042 = Fmake_vector (make_number (oldsize * 2), Qnil);
4043 bcopy (XVECTOR (old)->contents,
4044 XVECTOR (last_overlay_modification_hooks)->contents,
4045 sizeof (Lisp_Object) * oldsize);
4047 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = functionlist;
4048 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = overlay;
4051 /* Run the modification-hooks of overlays that include
4052 any part of the text in START to END.
4053 If this change is an insertion, also
4054 run the insert-before-hooks of overlay starting at END,
4055 and the insert-after-hooks of overlay ending at START.
4057 This is called both before and after the modification.
4058 AFTER is nonzero when we call after the modification.
4060 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4061 When AFTER is nonzero, they are the start position,
4062 the position after the inserted new text,
4063 and the length of deleted or replaced old text. */
4065 void
4066 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4067 Lisp_Object start, end;
4068 int after;
4069 Lisp_Object arg1, arg2, arg3;
4071 Lisp_Object prop, overlay, tail;
4072 /* 1 if this change is an insertion. */
4073 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4074 int tail_copied;
4075 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4077 overlay = Qnil;
4078 tail = Qnil;
4079 GCPRO5 (overlay, tail, arg1, arg2, arg3);
4081 if (after)
4083 /* Call the functions recorded in last_overlay_modification_hooks
4084 rather than scanning the overlays again.
4085 First copy the vector contents, in case some of these hooks
4086 do subsequent modification of the buffer. */
4087 int size = last_overlay_modification_hooks_used;
4088 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4089 int i;
4091 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4092 copy, size * sizeof (Lisp_Object));
4093 gcpro1.var = copy;
4094 gcpro1.nvars = size;
4096 for (i = 0; i < size;)
4098 Lisp_Object prop, overlay;
4099 prop = copy[i++];
4100 overlay = copy[i++];
4101 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4103 UNGCPRO;
4104 return;
4107 /* We are being called before a change.
4108 Scan the overlays to find the functions to call. */
4109 last_overlay_modification_hooks_used = 0;
4110 tail_copied = 0;
4111 for (tail = current_buffer->overlays_before;
4112 CONSP (tail);
4113 tail = XCDR (tail))
4115 int startpos, endpos;
4116 Lisp_Object ostart, oend;
4118 overlay = XCAR (tail);
4120 ostart = OVERLAY_START (overlay);
4121 oend = OVERLAY_END (overlay);
4122 endpos = OVERLAY_POSITION (oend);
4123 if (XFASTINT (start) > endpos)
4124 break;
4125 startpos = OVERLAY_POSITION (ostart);
4126 if (insertion && (XFASTINT (start) == startpos
4127 || XFASTINT (end) == startpos))
4129 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4130 if (!NILP (prop))
4132 /* Copy TAIL in case the hook recenters the overlay lists. */
4133 if (!tail_copied)
4134 tail = Fcopy_sequence (tail);
4135 tail_copied = 1;
4136 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4139 if (insertion && (XFASTINT (start) == endpos
4140 || XFASTINT (end) == endpos))
4142 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4143 if (!NILP (prop))
4145 if (!tail_copied)
4146 tail = Fcopy_sequence (tail);
4147 tail_copied = 1;
4148 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4151 /* Test for intersecting intervals. This does the right thing
4152 for both insertion and deletion. */
4153 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4155 prop = Foverlay_get (overlay, Qmodification_hooks);
4156 if (!NILP (prop))
4158 if (!tail_copied)
4159 tail = Fcopy_sequence (tail);
4160 tail_copied = 1;
4161 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4166 tail_copied = 0;
4167 for (tail = current_buffer->overlays_after;
4168 CONSP (tail);
4169 tail = XCDR (tail))
4171 int startpos, endpos;
4172 Lisp_Object ostart, oend;
4174 overlay = XCAR (tail);
4176 ostart = OVERLAY_START (overlay);
4177 oend = OVERLAY_END (overlay);
4178 startpos = OVERLAY_POSITION (ostart);
4179 endpos = OVERLAY_POSITION (oend);
4180 if (XFASTINT (end) < startpos)
4181 break;
4182 if (insertion && (XFASTINT (start) == startpos
4183 || XFASTINT (end) == startpos))
4185 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4186 if (!NILP (prop))
4188 if (!tail_copied)
4189 tail = Fcopy_sequence (tail);
4190 tail_copied = 1;
4191 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4194 if (insertion && (XFASTINT (start) == endpos
4195 || XFASTINT (end) == endpos))
4197 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4198 if (!NILP (prop))
4200 if (!tail_copied)
4201 tail = Fcopy_sequence (tail);
4202 tail_copied = 1;
4203 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4206 /* Test for intersecting intervals. This does the right thing
4207 for both insertion and deletion. */
4208 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4210 prop = Foverlay_get (overlay, Qmodification_hooks);
4211 if (!NILP (prop))
4213 if (!tail_copied)
4214 tail = Fcopy_sequence (tail);
4215 tail_copied = 1;
4216 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4221 UNGCPRO;
4224 static void
4225 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4226 Lisp_Object list, overlay;
4227 int after;
4228 Lisp_Object arg1, arg2, arg3;
4230 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4232 GCPRO4 (list, arg1, arg2, arg3);
4233 if (! after)
4234 add_overlay_mod_hooklist (list, overlay);
4236 while (CONSP (list))
4238 if (NILP (arg3))
4239 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4240 else
4241 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4242 list = XCDR (list);
4244 UNGCPRO;
4247 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4248 property is set. */
4249 void
4250 evaporate_overlays (pos)
4251 int pos;
4253 Lisp_Object tail, overlay, hit_list;
4255 hit_list = Qnil;
4256 if (pos <= XFASTINT (current_buffer->overlay_center))
4257 for (tail = current_buffer->overlays_before; CONSP (tail);
4258 tail = XCDR (tail))
4260 int endpos;
4261 overlay = XCAR (tail);
4262 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4263 if (endpos < pos)
4264 break;
4265 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4266 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4267 hit_list = Fcons (overlay, hit_list);
4269 else
4270 for (tail = current_buffer->overlays_after; CONSP (tail);
4271 tail = XCDR (tail))
4273 int startpos;
4274 overlay = XCAR (tail);
4275 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4276 if (startpos > pos)
4277 break;
4278 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4279 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4280 hit_list = Fcons (overlay, hit_list);
4282 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4283 Fdelete_overlay (XCAR (hit_list));
4286 /* Somebody has tried to store a value with an unacceptable type
4287 in the slot with offset OFFSET. */
4289 void
4290 buffer_slot_type_mismatch (offset)
4291 int offset;
4293 Lisp_Object sym;
4294 char *type_name;
4296 switch (XINT (PER_BUFFER_TYPE (offset)))
4298 case Lisp_Int:
4299 type_name = "integers";
4300 break;
4302 case Lisp_String:
4303 type_name = "strings";
4304 break;
4306 case Lisp_Symbol:
4307 type_name = "symbols";
4308 break;
4310 default:
4311 abort ();
4314 sym = PER_BUFFER_SYMBOL (offset);
4315 error ("Only %s should be stored in the buffer-local variable %s",
4316 type_name, SDATA (SYMBOL_NAME (sym)));
4320 /***********************************************************************
4321 Allocation with mmap
4322 ***********************************************************************/
4324 #ifdef USE_MMAP_FOR_BUFFERS
4326 #include <sys/types.h>
4327 #include <sys/mman.h>
4329 #ifndef MAP_ANON
4330 #ifdef MAP_ANONYMOUS
4331 #define MAP_ANON MAP_ANONYMOUS
4332 #else
4333 #define MAP_ANON 0
4334 #endif
4335 #endif
4337 #ifndef MAP_FAILED
4338 #define MAP_FAILED ((void *) -1)
4339 #endif
4341 #include <stdio.h>
4342 #include <errno.h>
4344 #if MAP_ANON == 0
4345 #include <fcntl.h>
4346 #endif
4348 #include "coding.h"
4351 /* Memory is allocated in regions which are mapped using mmap(2).
4352 The current implementation lets the system select mapped
4353 addresses; we're not using MAP_FIXED in general, except when
4354 trying to enlarge regions.
4356 Each mapped region starts with a mmap_region structure, the user
4357 area starts after that structure, aligned to MEM_ALIGN.
4359 +-----------------------+
4360 | struct mmap_info + |
4361 | padding |
4362 +-----------------------+
4363 | user data |
4366 +-----------------------+ */
4368 struct mmap_region
4370 /* User-specified size. */
4371 size_t nbytes_specified;
4373 /* Number of bytes mapped */
4374 size_t nbytes_mapped;
4376 /* Pointer to the location holding the address of the memory
4377 allocated with the mmap'd block. The variable actually points
4378 after this structure. */
4379 POINTER_TYPE **var;
4381 /* Next and previous in list of all mmap'd regions. */
4382 struct mmap_region *next, *prev;
4385 /* Doubly-linked list of mmap'd regions. */
4387 static struct mmap_region *mmap_regions;
4389 /* File descriptor for mmap. If we don't have anonymous mapping,
4390 /dev/zero will be opened on it. */
4392 static int mmap_fd;
4394 /* Temporary storage for mmap_set_vars, see there. */
4396 static struct mmap_region *mmap_regions_1;
4397 static int mmap_fd_1;
4399 /* Page size on this system. */
4401 static int mmap_page_size;
4403 /* 1 means mmap has been intialized. */
4405 static int mmap_initialized_p;
4407 /* Value is X rounded up to the next multiple of N. */
4409 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4411 /* Size of mmap_region structure plus padding. */
4413 #define MMAP_REGION_STRUCT_SIZE \
4414 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4416 /* Given a pointer P to the start of the user-visible part of a mapped
4417 region, return a pointer to the start of the region. */
4419 #define MMAP_REGION(P) \
4420 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4422 /* Given a pointer P to the start of a mapped region, return a pointer
4423 to the start of the user-visible part of the region. */
4425 #define MMAP_USER_AREA(P) \
4426 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4428 #define MEM_ALIGN sizeof (double)
4430 /* Predicate returning true if part of the address range [START .. END]
4431 is currently mapped. Used to prevent overwriting an existing
4432 memory mapping.
4434 Default is to conservativly assume the address range is occupied by
4435 something else. This can be overridden by system configuration
4436 files if system-specific means to determine this exists. */
4438 #ifndef MMAP_ALLOCATED_P
4439 #define MMAP_ALLOCATED_P(start, end) 1
4440 #endif
4442 /* Function prototypes. */
4444 static int mmap_free_1 P_ ((struct mmap_region *));
4445 static int mmap_enlarge P_ ((struct mmap_region *, int));
4446 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4447 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4448 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4449 static void mmap_free P_ ((POINTER_TYPE **ptr));
4450 static void mmap_init P_ ((void));
4453 /* Return a region overlapping address range START...END, or null if
4454 none. END is not including, i.e. the last byte in the range
4455 is at END - 1. */
4457 static struct mmap_region *
4458 mmap_find (start, end)
4459 POINTER_TYPE *start, *end;
4461 struct mmap_region *r;
4462 char *s = (char *) start, *e = (char *) end;
4464 for (r = mmap_regions; r; r = r->next)
4466 char *rstart = (char *) r;
4467 char *rend = rstart + r->nbytes_mapped;
4469 if (/* First byte of range, i.e. START, in this region? */
4470 (s >= rstart && s < rend)
4471 /* Last byte of range, i.e. END - 1, in this region? */
4472 || (e > rstart && e <= rend)
4473 /* First byte of this region in the range? */
4474 || (rstart >= s && rstart < e)
4475 /* Last byte of this region in the range? */
4476 || (rend > s && rend <= e))
4477 break;
4480 return r;
4484 /* Unmap a region. P is a pointer to the start of the user-araa of
4485 the region. Value is non-zero if successful. */
4487 static int
4488 mmap_free_1 (r)
4489 struct mmap_region *r;
4491 if (r->next)
4492 r->next->prev = r->prev;
4493 if (r->prev)
4494 r->prev->next = r->next;
4495 else
4496 mmap_regions = r->next;
4498 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4500 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4501 return 0;
4504 return 1;
4508 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4509 Value is non-zero if successful. */
4511 static int
4512 mmap_enlarge (r, npages)
4513 struct mmap_region *r;
4514 int npages;
4516 char *region_end = (char *) r + r->nbytes_mapped;
4517 size_t nbytes;
4518 int success = 0;
4520 if (npages < 0)
4522 /* Unmap pages at the end of the region. */
4523 nbytes = - npages * mmap_page_size;
4524 if (munmap (region_end - nbytes, nbytes) == -1)
4525 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4526 else
4528 r->nbytes_mapped -= nbytes;
4529 success = 1;
4532 else if (npages > 0)
4534 nbytes = npages * mmap_page_size;
4536 /* Try to map additional pages at the end of the region. We
4537 cannot do this if the address range is already occupied by
4538 something else because mmap deletes any previous mapping.
4539 I'm not sure this is worth doing, let's see. */
4540 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4542 POINTER_TYPE *p;
4544 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4545 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4546 if (p == MAP_FAILED)
4547 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4548 else if (p != (POINTER_TYPE *) region_end)
4550 /* Kernels are free to choose a different address. In
4551 that case, unmap what we've mapped above; we have
4552 no use for it. */
4553 if (munmap (p, nbytes) == -1)
4554 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4556 else
4558 r->nbytes_mapped += nbytes;
4559 success = 1;
4564 return success;
4568 /* Set or reset variables holding references to mapped regions. If
4569 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4570 non-zero, set all variables to the start of the user-areas
4571 of mapped regions.
4573 This function is called from Fdump_emacs to ensure that the dumped
4574 Emacs doesn't contain references to memory that won't be mapped
4575 when Emacs starts. */
4577 void
4578 mmap_set_vars (restore_p)
4579 int restore_p;
4581 struct mmap_region *r;
4583 if (restore_p)
4585 mmap_regions = mmap_regions_1;
4586 mmap_fd = mmap_fd_1;
4587 for (r = mmap_regions; r; r = r->next)
4588 *r->var = MMAP_USER_AREA (r);
4590 else
4592 for (r = mmap_regions; r; r = r->next)
4593 *r->var = NULL;
4594 mmap_regions_1 = mmap_regions;
4595 mmap_regions = NULL;
4596 mmap_fd_1 = mmap_fd;
4597 mmap_fd = -1;
4602 /* Allocate a block of storage large enough to hold NBYTES bytes of
4603 data. A pointer to the data is returned in *VAR. VAR is thus the
4604 address of some variable which will use the data area.
4606 The allocation of 0 bytes is valid.
4608 If we can't allocate the necessary memory, set *VAR to null, and
4609 return null. */
4611 static POINTER_TYPE *
4612 mmap_alloc (var, nbytes)
4613 POINTER_TYPE **var;
4614 size_t nbytes;
4616 void *p;
4617 size_t map;
4619 mmap_init ();
4621 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4622 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4623 mmap_fd, 0);
4625 if (p == MAP_FAILED)
4627 if (errno != ENOMEM)
4628 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4629 p = NULL;
4631 else
4633 struct mmap_region *r = (struct mmap_region *) p;
4635 r->nbytes_specified = nbytes;
4636 r->nbytes_mapped = map;
4637 r->var = var;
4638 r->prev = NULL;
4639 r->next = mmap_regions;
4640 if (r->next)
4641 r->next->prev = r;
4642 mmap_regions = r;
4644 p = MMAP_USER_AREA (p);
4647 return *var = p;
4651 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4652 resize it to size NBYTES. Change *VAR to reflect the new block,
4653 and return this value. If more memory cannot be allocated, then
4654 leave *VAR unchanged, and return null. */
4656 static POINTER_TYPE *
4657 mmap_realloc (var, nbytes)
4658 POINTER_TYPE **var;
4659 size_t nbytes;
4661 POINTER_TYPE *result;
4663 mmap_init ();
4665 if (*var == NULL)
4666 result = mmap_alloc (var, nbytes);
4667 else if (nbytes == 0)
4669 mmap_free (var);
4670 result = mmap_alloc (var, nbytes);
4672 else
4674 struct mmap_region *r = MMAP_REGION (*var);
4675 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4677 if (room < nbytes)
4679 /* Must enlarge. */
4680 POINTER_TYPE *old_ptr = *var;
4682 /* Try to map additional pages at the end of the region.
4683 If that fails, allocate a new region, copy data
4684 from the old region, then free it. */
4685 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4686 / mmap_page_size)))
4688 r->nbytes_specified = nbytes;
4689 *var = result = old_ptr;
4691 else if (mmap_alloc (var, nbytes))
4693 bcopy (old_ptr, *var, r->nbytes_specified);
4694 mmap_free_1 (MMAP_REGION (old_ptr));
4695 result = *var;
4696 r = MMAP_REGION (result);
4697 r->nbytes_specified = nbytes;
4699 else
4701 *var = old_ptr;
4702 result = NULL;
4705 else if (room - nbytes >= mmap_page_size)
4707 /* Shrinking by at least a page. Let's give some
4708 memory back to the system.
4710 The extra parens are to make the division happens first,
4711 on positive values, so we know it will round towards
4712 zero. */
4713 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4714 result = *var;
4715 r->nbytes_specified = nbytes;
4717 else
4719 /* Leave it alone. */
4720 result = *var;
4721 r->nbytes_specified = nbytes;
4725 return result;
4729 /* Free a block of relocatable storage whose data is pointed to by
4730 PTR. Store 0 in *PTR to show there's no block allocated. */
4732 static void
4733 mmap_free (var)
4734 POINTER_TYPE **var;
4736 mmap_init ();
4738 if (*var)
4740 mmap_free_1 (MMAP_REGION (*var));
4741 *var = NULL;
4746 /* Perform necessary intializations for the use of mmap. */
4748 static void
4749 mmap_init ()
4751 #if MAP_ANON == 0
4752 /* The value of mmap_fd is initially 0 in temacs, and -1
4753 in a dumped Emacs. */
4754 if (mmap_fd <= 0)
4756 /* No anonymous mmap -- we need the file descriptor. */
4757 mmap_fd = open ("/dev/zero", O_RDONLY);
4758 if (mmap_fd == -1)
4759 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4761 #endif /* MAP_ANON == 0 */
4763 if (mmap_initialized_p)
4764 return;
4765 mmap_initialized_p = 1;
4767 #if MAP_ANON != 0
4768 mmap_fd = -1;
4769 #endif
4771 mmap_page_size = getpagesize ();
4774 #endif /* USE_MMAP_FOR_BUFFERS */
4778 /***********************************************************************
4779 Buffer-text Allocation
4780 ***********************************************************************/
4782 #ifdef REL_ALLOC
4783 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4784 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4785 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4786 #endif /* REL_ALLOC */
4789 /* Allocate NBYTES bytes for buffer B's text buffer. */
4791 static void
4792 alloc_buffer_text (b, nbytes)
4793 struct buffer *b;
4794 size_t nbytes;
4796 POINTER_TYPE *p;
4798 BLOCK_INPUT;
4799 #if defined USE_MMAP_FOR_BUFFERS
4800 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4801 #elif defined REL_ALLOC
4802 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4803 #else
4804 p = xmalloc (nbytes);
4805 #endif
4807 if (p == NULL)
4809 UNBLOCK_INPUT;
4810 memory_full ();
4813 b->text->beg = (unsigned char *) p;
4814 UNBLOCK_INPUT;
4817 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4818 shrink it. */
4820 void
4821 enlarge_buffer_text (b, delta)
4822 struct buffer *b;
4823 int delta;
4825 POINTER_TYPE *p;
4826 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4827 + delta);
4828 BLOCK_INPUT;
4829 #if defined USE_MMAP_FOR_BUFFERS
4830 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4831 #elif defined REL_ALLOC
4832 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4833 #else
4834 p = xrealloc (b->text->beg, nbytes);
4835 #endif
4837 if (p == NULL)
4839 UNBLOCK_INPUT;
4840 memory_full ();
4843 BUF_BEG_ADDR (b) = (unsigned char *) p;
4844 UNBLOCK_INPUT;
4848 /* Free buffer B's text buffer. */
4850 static void
4851 free_buffer_text (b)
4852 struct buffer *b;
4854 BLOCK_INPUT;
4856 #if defined USE_MMAP_FOR_BUFFERS
4857 mmap_free ((POINTER_TYPE **) &b->text->beg);
4858 #elif defined REL_ALLOC
4859 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4860 #else
4861 xfree (b->text->beg);
4862 #endif
4864 BUF_BEG_ADDR (b) = NULL;
4865 UNBLOCK_INPUT;
4870 /***********************************************************************
4871 Initialization
4872 ***********************************************************************/
4874 void
4875 init_buffer_once ()
4877 int idx;
4879 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4881 /* Make sure all markable slots in buffer_defaults
4882 are initialized reasonably, so mark_buffer won't choke. */
4883 reset_buffer (&buffer_defaults);
4884 reset_buffer_local_variables (&buffer_defaults, 1);
4885 reset_buffer (&buffer_local_symbols);
4886 reset_buffer_local_variables (&buffer_local_symbols, 1);
4887 /* Prevent GC from getting confused. */
4888 buffer_defaults.text = &buffer_defaults.own_text;
4889 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4890 BUF_INTERVALS (&buffer_defaults) = 0;
4891 BUF_INTERVALS (&buffer_local_symbols) = 0;
4892 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4893 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4895 /* Set up the default values of various buffer slots. */
4896 /* Must do these before making the first buffer! */
4898 /* real setup is done in bindings.el */
4899 buffer_defaults.mode_line_format = build_string ("%-");
4900 buffer_defaults.header_line_format = Qnil;
4901 buffer_defaults.abbrev_mode = Qnil;
4902 buffer_defaults.overwrite_mode = Qnil;
4903 buffer_defaults.case_fold_search = Qt;
4904 buffer_defaults.auto_fill_function = Qnil;
4905 buffer_defaults.selective_display = Qnil;
4906 #ifndef old
4907 buffer_defaults.selective_display_ellipses = Qt;
4908 #endif
4909 buffer_defaults.abbrev_table = Qnil;
4910 buffer_defaults.display_table = Qnil;
4911 buffer_defaults.undo_list = Qnil;
4912 buffer_defaults.mark_active = Qnil;
4913 buffer_defaults.file_format = Qnil;
4914 buffer_defaults.overlays_before = Qnil;
4915 buffer_defaults.overlays_after = Qnil;
4916 XSETFASTINT (buffer_defaults.overlay_center, BEG);
4918 XSETFASTINT (buffer_defaults.tab_width, 8);
4919 buffer_defaults.truncate_lines = Qnil;
4920 buffer_defaults.ctl_arrow = Qt;
4921 buffer_defaults.direction_reversed = Qnil;
4922 buffer_defaults.cursor_type = Qt;
4923 buffer_defaults.extra_line_spacing = Qnil;
4925 #ifdef DOS_NT
4926 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4927 #endif
4928 buffer_defaults.enable_multibyte_characters = Qt;
4929 buffer_defaults.buffer_file_coding_system = Qnil;
4930 XSETFASTINT (buffer_defaults.fill_column, 70);
4931 XSETFASTINT (buffer_defaults.left_margin, 0);
4932 buffer_defaults.cache_long_line_scans = Qnil;
4933 buffer_defaults.file_truename = Qnil;
4934 XSETFASTINT (buffer_defaults.display_count, 0);
4935 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
4936 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
4937 buffer_defaults.left_fringe_width = Qnil;
4938 buffer_defaults.right_fringe_width = Qnil;
4939 buffer_defaults.fringes_outside_margins = Qnil;
4940 buffer_defaults.scroll_bar_width = Qnil;
4941 buffer_defaults.vertical_scroll_bar_type = Qt;
4942 buffer_defaults.indicate_empty_lines = Qnil;
4943 buffer_defaults.scroll_up_aggressively = Qnil;
4944 buffer_defaults.scroll_down_aggressively = Qnil;
4945 buffer_defaults.display_time = Qnil;
4947 /* Assign the local-flags to the slots that have default values.
4948 The local flag is a bit that is used in the buffer
4949 to say that it has its own local value for the slot.
4950 The local flag bits are in the local_var_flags slot of the buffer. */
4952 /* Nothing can work if this isn't true */
4953 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4955 /* 0 means not a lisp var, -1 means always local, else mask */
4956 bzero (&buffer_local_flags, sizeof buffer_local_flags);
4957 XSETINT (buffer_local_flags.filename, -1);
4958 XSETINT (buffer_local_flags.directory, -1);
4959 XSETINT (buffer_local_flags.backed_up, -1);
4960 XSETINT (buffer_local_flags.save_length, -1);
4961 XSETINT (buffer_local_flags.auto_save_file_name, -1);
4962 XSETINT (buffer_local_flags.read_only, -1);
4963 XSETINT (buffer_local_flags.major_mode, -1);
4964 XSETINT (buffer_local_flags.mode_name, -1);
4965 XSETINT (buffer_local_flags.undo_list, -1);
4966 XSETINT (buffer_local_flags.mark_active, -1);
4967 XSETINT (buffer_local_flags.point_before_scroll, -1);
4968 XSETINT (buffer_local_flags.file_truename, -1);
4969 XSETINT (buffer_local_flags.invisibility_spec, -1);
4970 XSETINT (buffer_local_flags.file_format, -1);
4971 XSETINT (buffer_local_flags.display_count, -1);
4972 XSETINT (buffer_local_flags.display_time, -1);
4973 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
4975 idx = 1;
4976 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
4977 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
4978 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
4979 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
4980 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
4981 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
4982 #ifndef old
4983 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
4984 #endif
4985 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
4986 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
4987 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
4988 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
4989 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
4990 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
4991 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
4992 #ifdef DOS_NT
4993 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
4994 /* Make this one a permanent local. */
4995 buffer_permanent_local_flags[idx++] = 1;
4996 #endif
4997 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
4998 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
4999 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5000 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5001 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5002 /* Make this one a permanent local. */
5003 buffer_permanent_local_flags[idx++] = 1;
5004 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5005 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5006 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5007 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5008 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5009 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5010 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5011 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5012 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5013 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5014 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5015 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5016 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5018 /* Need more room? */
5019 if (idx >= MAX_PER_BUFFER_VARS)
5020 abort ();
5021 last_per_buffer_idx = idx;
5023 Vbuffer_alist = Qnil;
5024 current_buffer = 0;
5025 all_buffers = 0;
5027 QSFundamental = build_string ("Fundamental");
5029 Qfundamental_mode = intern ("fundamental-mode");
5030 buffer_defaults.major_mode = Qfundamental_mode;
5032 Qmode_class = intern ("mode-class");
5034 Qprotected_field = intern ("protected-field");
5036 Qpermanent_local = intern ("permanent-local");
5038 Qkill_buffer_hook = intern ("kill-buffer-hook");
5040 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5042 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5044 /* super-magic invisible buffer */
5045 Vbuffer_alist = Qnil;
5047 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5049 inhibit_modification_hooks = 0;
5052 void
5053 init_buffer ()
5055 char buf[MAXPATHLEN + 1];
5056 char *pwd;
5057 struct stat dotstat, pwdstat;
5058 Lisp_Object temp;
5059 int rc;
5061 #ifdef USE_MMAP_FOR_BUFFERS
5063 /* When using the ralloc implementation based on mmap(2), buffer
5064 text pointers will have been set to null in the dumped Emacs.
5065 Map new memory. */
5066 struct buffer *b;
5068 for (b = all_buffers; b; b = b->next)
5069 if (b->text->beg == NULL)
5070 enlarge_buffer_text (b, 0);
5072 #endif /* USE_MMAP_FOR_BUFFERS */
5074 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5075 if (NILP (buffer_defaults.enable_multibyte_characters))
5076 Fset_buffer_multibyte (Qnil);
5078 /* If PWD is accurate, use it instead of calling getwd. PWD is
5079 sometimes a nicer name, and using it may avoid a fatal error if a
5080 parent directory is searchable but not readable. */
5081 if ((pwd = getenv ("PWD")) != 0
5082 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5083 && stat (pwd, &pwdstat) == 0
5084 && stat (".", &dotstat) == 0
5085 && dotstat.st_ino == pwdstat.st_ino
5086 && dotstat.st_dev == pwdstat.st_dev
5087 && strlen (pwd) < MAXPATHLEN)
5088 strcpy (buf, pwd);
5089 #ifdef HAVE_GETCWD
5090 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5091 fatal ("`getcwd' failed: %s\n", strerror (errno));
5092 #else
5093 else if (getwd (buf) == 0)
5094 fatal ("`getwd' failed: %s\n", buf);
5095 #endif
5097 #ifndef VMS
5098 /* Maybe this should really use some standard subroutine
5099 whose definition is filename syntax dependent. */
5100 rc = strlen (buf);
5101 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5103 buf[rc] = DIRECTORY_SEP;
5104 buf[rc + 1] = '\0';
5106 #endif /* not VMS */
5108 current_buffer->directory = build_string (buf);
5110 /* Add /: to the front of the name
5111 if it would otherwise be treated as magic. */
5112 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5113 if (! NILP (temp)
5114 /* If the default dir is just /, TEMP is non-nil
5115 because of the ange-ftp completion handler.
5116 However, it is not necessary to turn / into /:/.
5117 So avoid doing that. */
5118 && strcmp ("/", SDATA (current_buffer->directory)))
5119 current_buffer->directory
5120 = concat2 (build_string ("/:"), current_buffer->directory);
5122 temp = get_minibuffer (0);
5123 XBUFFER (temp)->directory = current_buffer->directory;
5126 /* initialize the buffer routines */
5127 void
5128 syms_of_buffer ()
5130 staticpro (&last_overlay_modification_hooks);
5131 last_overlay_modification_hooks
5132 = Fmake_vector (make_number (10), Qnil);
5134 staticpro (&Vbuffer_defaults);
5135 staticpro (&Vbuffer_local_symbols);
5136 staticpro (&Qfundamental_mode);
5137 staticpro (&Qmode_class);
5138 staticpro (&QSFundamental);
5139 staticpro (&Vbuffer_alist);
5140 staticpro (&Qprotected_field);
5141 staticpro (&Qpermanent_local);
5142 staticpro (&Qkill_buffer_hook);
5143 Qoverlayp = intern ("overlayp");
5144 staticpro (&Qoverlayp);
5145 Qevaporate = intern ("evaporate");
5146 staticpro (&Qevaporate);
5147 Qmodification_hooks = intern ("modification-hooks");
5148 staticpro (&Qmodification_hooks);
5149 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5150 staticpro (&Qinsert_in_front_hooks);
5151 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5152 staticpro (&Qinsert_behind_hooks);
5153 Qget_file_buffer = intern ("get-file-buffer");
5154 staticpro (&Qget_file_buffer);
5155 Qpriority = intern ("priority");
5156 staticpro (&Qpriority);
5157 Qwindow = intern ("window");
5158 staticpro (&Qwindow);
5159 Qbefore_string = intern ("before-string");
5160 staticpro (&Qbefore_string);
5161 Qafter_string = intern ("after-string");
5162 staticpro (&Qafter_string);
5163 Qfirst_change_hook = intern ("first-change-hook");
5164 staticpro (&Qfirst_change_hook);
5165 Qbefore_change_functions = intern ("before-change-functions");
5166 staticpro (&Qbefore_change_functions);
5167 Qafter_change_functions = intern ("after-change-functions");
5168 staticpro (&Qafter_change_functions);
5169 staticpro (&Qucs_set_table_for_input);
5171 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5172 staticpro (&Qkill_buffer_query_functions);
5174 Fput (Qprotected_field, Qerror_conditions,
5175 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5176 Fput (Qprotected_field, Qerror_message,
5177 build_string ("Attempt to modify a protected field"));
5179 /* All these use DEFVAR_LISP_NOPRO because the slots in
5180 buffer_defaults will all be marked via Vbuffer_defaults. */
5182 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5183 &buffer_defaults.mode_line_format,
5184 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5185 This is the same as (default-value 'mode-line-format). */);
5187 DEFVAR_LISP_NOPRO ("default-header-line-format",
5188 &buffer_defaults.header_line_format,
5189 doc: /* Default value of `header-line-format' for buffers that don't override it.
5190 This is the same as (default-value 'header-line-format). */);
5192 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5193 doc: /* Default value of `cursor-type' for buffers that don't override it.
5194 This is the same as (default-value 'cursor-type). */);
5196 DEFVAR_LISP_NOPRO ("default-line-spacing",
5197 &buffer_defaults.extra_line_spacing,
5198 doc: /* Default value of `line-spacing' for buffers that don't override it.
5199 This is the same as (default-value 'line-spacing). */);
5201 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5202 &buffer_defaults.abbrev_mode,
5203 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5204 This is the same as (default-value 'abbrev-mode). */);
5206 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5207 &buffer_defaults.ctl_arrow,
5208 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5209 This is the same as (default-value 'ctl-arrow). */);
5211 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5212 &buffer_defaults.direction_reversed,
5213 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5214 This is the same as (default-value 'direction-reversed). */);
5216 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5217 &buffer_defaults.enable_multibyte_characters,
5218 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5219 This is the same as (default-value 'enable-multibyte-characters). */);
5221 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5222 &buffer_defaults.buffer_file_coding_system,
5223 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5224 This is the same as (default-value 'buffer-file-coding-system). */);
5226 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5227 &buffer_defaults.truncate_lines,
5228 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5229 This is the same as (default-value 'truncate-lines). */);
5231 DEFVAR_LISP_NOPRO ("default-fill-column",
5232 &buffer_defaults.fill_column,
5233 doc: /* Default value of `fill-column' for buffers that do not override it.
5234 This is the same as (default-value 'fill-column). */);
5236 DEFVAR_LISP_NOPRO ("default-left-margin",
5237 &buffer_defaults.left_margin,
5238 doc: /* Default value of `left-margin' for buffers that do not override it.
5239 This is the same as (default-value 'left-margin). */);
5241 DEFVAR_LISP_NOPRO ("default-tab-width",
5242 &buffer_defaults.tab_width,
5243 doc: /* Default value of `tab-width' for buffers that do not override it.
5244 This is the same as (default-value 'tab-width). */);
5246 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5247 &buffer_defaults.case_fold_search,
5248 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5249 This is the same as (default-value 'case-fold-search). */);
5251 #ifdef DOS_NT
5252 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5253 &buffer_defaults.buffer_file_type,
5254 doc: /* Default file type for buffers that do not override it.
5255 This is the same as (default-value 'buffer-file-type).
5256 The file type is nil for text, t for binary. */);
5257 #endif
5259 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5260 &buffer_defaults.left_margin_cols,
5261 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5262 This is the same as (default-value 'left-margin-width). */);
5264 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5265 &buffer_defaults.right_margin_cols,
5266 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5267 This is the same as (default-value 'right-margin-width). */);
5269 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5270 &buffer_defaults.left_fringe_width,
5271 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5272 This is the same as (default-value 'left-fringe-width). */);
5274 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5275 &buffer_defaults.right_fringe_width,
5276 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5277 This is the same as (default-value 'right-fringe-width). */);
5279 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5280 &buffer_defaults.fringes_outside_margins,
5281 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5282 This is the same as (default-value 'fringes-outside-margins). */);
5284 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5285 &buffer_defaults.scroll_bar_width,
5286 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5287 This is the same as (default-value 'scroll-bar-width). */);
5289 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5290 &buffer_defaults.vertical_scroll_bar_type,
5291 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5292 This is the same as (default-value 'vertical-scroll-bar). */);
5294 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5295 &buffer_defaults.indicate_empty_lines,
5296 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5297 This is the same as (default-value 'indicate-empty-lines). */);
5299 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5300 &buffer_defaults.scroll_up_aggressively,
5301 doc: /* Default value of `scroll-up-aggressively'.
5302 This value applies in buffers that don't have their own local values.
5303 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5305 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5306 &buffer_defaults.scroll_down_aggressively,
5307 doc: /* Default value of `scroll-down-aggressively'.
5308 This value applies in buffers that don't have their own local values.
5309 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5311 DEFVAR_PER_BUFFER ("header-line-format",
5312 &current_buffer->header_line_format,
5313 Qnil,
5314 doc: /* Analogous to `mode-line-format', but controls the header line.
5315 The header line appears, optionally, at the top of a window;
5316 the mode line appears at the bottom. */);
5318 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5319 Qnil,
5320 doc: /* Template for displaying mode line for current buffer.
5321 Each buffer has its own value of this variable.
5322 Value may be nil, a string, a symbol or a list or cons cell.
5323 A value of nil means don't display a mode line.
5324 For a symbol, its value is used (but it is ignored if t or nil).
5325 A string appearing directly as the value of a symbol is processed verbatim
5326 in that the %-constructs below are not recognized.
5327 Note that unless the symbol is marked as a `risky-local-variable', all
5328 properties in any strings, as well as all :eval and :propertize forms
5329 in the value of that symbol will be ignored.
5330 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5331 is used as a mode line element. Be careful--FORM should not load any files,
5332 because that can cause an infinite recursion.
5333 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5334 with the specified properties PROPS applied.
5335 For a list whose car is a symbol, the symbol's value is taken,
5336 and if that is non-nil, the cadr of the list is processed recursively.
5337 Otherwise, the caddr of the list (if there is one) is processed.
5338 For a list whose car is a string or list, each element is processed
5339 recursively and the results are effectively concatenated.
5340 For a list whose car is an integer, the cdr of the list is processed
5341 and padded (if the number is positive) or truncated (if negative)
5342 to the width specified by that number.
5343 A string is printed verbatim in the mode line except for %-constructs:
5344 (%-constructs are allowed when the string is the entire mode-line-format
5345 or when it is found in a cons-cell or a list)
5346 %b -- print buffer name. %f -- print visited file name.
5347 %F -- print frame name.
5348 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5349 %& is like %*, but ignore read-only-ness.
5350 % means buffer is read-only and * means it is modified.
5351 For a modified read-only buffer, %* gives % and %+ gives *.
5352 %s -- print process status. %l -- print the current line number.
5353 %c -- print the current column number (this makes editing slower).
5354 To make the column number update correctly in all cases,
5355 `column-number-mode' must be non-nil.
5356 %p -- print percent of buffer above top of window, or Top, Bot or All.
5357 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5358 or print Bottom or All.
5359 %m -- print the mode name.
5360 %n -- print Narrow if appropriate.
5361 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5362 %Z -- like %z, but including the end-of-line format.
5363 %[ -- print one [ for each recursive editing level. %] similar.
5364 %% -- print %. %- -- print infinitely many dashes.
5365 Decimal digits after the % specify field width to which to pad. */);
5367 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5368 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5369 nil here means use current buffer's major mode. */);
5371 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5372 make_number (Lisp_Symbol),
5373 doc: /* Symbol for current buffer's major mode. */);
5375 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5376 Qnil,
5377 doc: /* Pretty name of current buffer's major mode (a string). */);
5379 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5380 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5382 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5383 Qnil,
5384 doc: /* *Non-nil if searches and matches should ignore case. */);
5386 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5387 make_number (Lisp_Int),
5388 doc: /* *Column beyond which automatic line-wrapping should happen.
5389 Interactively, you can set this using \\[set-fill-column]. */);
5391 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5392 make_number (Lisp_Int),
5393 doc: /* *Column for the default indent-line-function to indent to.
5394 Linefeed indents to this column in Fundamental mode. */);
5396 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5397 make_number (Lisp_Int),
5398 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5400 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5401 doc: /* *Non-nil means display control chars with uparrow.
5402 A value of nil means use backslash and octal digits.
5403 This variable does not apply to characters whose display is specified
5404 in the current display table (if there is one). */);
5406 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5407 &current_buffer->enable_multibyte_characters,
5408 Qnil,
5409 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5410 Otherwise they are regarded as unibyte. This affects the display,
5411 file I/O and the behavior of various editing commands.
5413 This variable is buffer-local but you cannot set it directly;
5414 use the function `set-buffer-multibyte' to change a buffer's representation.
5415 Changing its default value with `setq-default' is supported.
5416 See also variable `default-enable-multibyte-characters' and Info node
5417 `(elisp)Text Representations'. */);
5418 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5420 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5421 &current_buffer->buffer_file_coding_system, Qnil,
5422 doc: /* Coding system to be used for encoding the buffer contents on saving.
5423 This variable applies to saving the buffer, and also to `write-region'
5424 and other functions that use `write-region'.
5425 It does not apply to sending output to subprocesses, however.
5427 If this is nil, the buffer is saved without any code conversion
5428 unless some coding system is specified in `file-coding-system-alist'
5429 for the buffer file.
5431 If the text to be saved cannot be encoded as specified by this variable,
5432 an alternative encoding is selected by `select-safe-coding-system', which see.
5434 The variable `coding-system-for-write', if non-nil, overrides this variable.
5436 This variable is never applied to a way of decoding a file while reading it. */);
5438 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5439 Qnil,
5440 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5442 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5443 doc: /* *Non-nil means do not display continuation lines.
5444 Instead, give each line of text just one screen line.
5446 Note that this is overridden by the variable
5447 `truncate-partial-width-windows' if that variable is non-nil
5448 and this buffer is not full-frame width. */);
5450 #ifdef DOS_NT
5451 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5452 Qnil,
5453 doc: /* Non-nil if the visited file is a binary file.
5454 This variable is meaningful on MS-DOG and Windows NT.
5455 On those systems, it is automatically local in every buffer.
5456 On other systems, this variable is normally always nil. */);
5457 #endif
5459 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5460 make_number (Lisp_String),
5461 doc: /* Name of default directory of current buffer. Should end with slash.
5462 To interactively change the default directory, use command `cd'. */);
5464 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5465 Qnil,
5466 doc: /* Function called (if non-nil) to perform auto-fill.
5467 It is called after self-inserting any character specified in
5468 the `auto-fill-chars' table.
5469 NOTE: This variable is not a hook;
5470 its value may not be a list of functions. */);
5472 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5473 make_number (Lisp_String),
5474 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5476 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5477 make_number (Lisp_String),
5478 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5479 The truename of a file is calculated by `file-truename'
5480 and then abbreviated with `abbreviate-file-name'. */);
5482 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5483 &current_buffer->auto_save_file_name,
5484 make_number (Lisp_String),
5485 doc: /* Name of file for auto-saving current buffer.
5486 If it is nil, that means don't auto-save this buffer. */);
5488 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5489 doc: /* Non-nil if this buffer is read-only. */);
5491 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5492 doc: /* Non-nil if this buffer's file has been backed up.
5493 Backing up is done before the first time the file is saved. */);
5495 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5496 make_number (Lisp_Int),
5497 doc: /* Length of current buffer when last read in, saved or auto-saved.
5498 0 initially. */);
5500 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5501 Qnil,
5502 doc: /* Non-nil enables selective display.
5503 An Integer N as value means display only lines
5504 that start with less than n columns of space.
5505 A value of t means that the character ^M makes itself and
5506 all the rest of the line invisible; also, when saving the buffer
5507 in a file, save the ^M as a newline. */);
5509 #ifndef old
5510 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5511 &current_buffer->selective_display_ellipses,
5512 Qnil,
5513 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5514 #endif
5516 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5517 doc: /* Non-nil if self-insertion should replace existing text.
5518 The value should be one of `overwrite-mode-textual',
5519 `overwrite-mode-binary', or nil.
5520 If it is `overwrite-mode-textual', self-insertion still
5521 inserts at the end of a line, and inserts when point is before a tab,
5522 until the tab is filled in.
5523 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5525 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5526 Qnil,
5527 doc: /* Display table that controls display of the contents of current buffer.
5529 If this variable is nil, the value of `standard-display-table' is used.
5530 Each window can have its own, overriding display table, see
5531 `set-window-display-table' and `window-display-table'.
5533 The display table is a char-table created with `make-display-table'.
5534 A char-table is an array indexed by character codes. Normal array
5535 primitives `aref' and `aset' can be used to access elements of a char-table.
5537 Each of the char-table elements control how to display the corresponding
5538 text character: the element at index C in the table says how to display
5539 the character whose code is C. Each element should be a vector of
5540 characters or nil. nil means display the character in the default fashion;
5541 otherwise, the characters from the vector are delivered to the screen
5542 instead of the original character.
5544 For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5545 a capital Y instead of each X character.
5547 In addition, a char-table has six extra slots to control the display of:
5549 the end of a truncated screen line (extra-slot 0, a single character);
5550 the end of a continued line (extra-slot 1, a single character);
5551 the escape character used to display character codes in octal
5552 (extra-slot 2, a single character);
5553 the character used as an arrow for control characters (extra-slot 3,
5554 a single character);
5555 the decoration indicating the presence of invisible lines (extra-slot 4,
5556 a vector of characters);
5557 the character used to draw the border between side-by-side windows
5558 (extra-slot 5, a single character).
5560 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5562 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5563 Qnil,
5564 doc: /* *Width of left marginal area for display of a buffer.
5565 A value of nil means no marginal area. */);
5567 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5568 Qnil,
5569 doc: /* *Width of right marginal area for display of a buffer.
5570 A value of nil means no marginal area. */);
5572 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5573 Qnil,
5574 doc: /* *Width of this buffer's left fringe (in pixels).
5575 A value of 0 means no left fringe is shown in this buffer's window.
5576 A value of nil means to use the left fringe width from the window's frame. */);
5578 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5579 Qnil,
5580 doc: /* *Width of this buffer's right fringe (in pixels).
5581 A value of 0 means no right fringe is shown in this buffer's window.
5582 A value of nil means to use the right fringe width from the window's frame. */);
5584 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5585 Qnil,
5586 doc: /* *Non-nil means to display fringes outside display margins.
5587 A value of nil means to display fringes between margins and buffer text. */);
5589 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5590 Qnil,
5591 doc: /* *Width of this buffer's scroll bars in pixels.
5592 A value of nil means to use the scroll bar width from the window's frame. */);
5594 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5595 Qnil,
5596 doc: /* *Position of this buffer's vertical scroll bar.
5597 A value of left or right means to place the vertical scroll bar at that side
5598 of the window; a value of nil means that this window has no vertical scroll bar.
5599 A value of t means to use the vertical scroll bar type from the window's frame. */);
5601 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5602 &current_buffer->indicate_empty_lines, Qnil,
5603 doc: /* *Visually indicate empty lines after the buffer end.
5604 If non-nil, a bitmap is displayed in the left fringe of a window on
5605 window-systems. */);
5607 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5608 &current_buffer->scroll_up_aggressively, Qnil,
5609 doc: /* How far to scroll windows upward.
5610 If you move point off the bottom, the window scrolls automatically.
5611 This variable controls how far it scrolls. nil, the default,
5612 means scroll to center point. A fraction means scroll to put point
5613 that fraction of the window's height from the bottom of the window.
5614 When the value is 0.0, point goes at the bottom line, which in the simple
5615 case that you moved off with C-f means scrolling just one line. 1.0 means
5616 point goes at the top, so that in that simple case, the window
5617 window scrolls by a full window height. Meaningful values are
5618 between 0.0 and 1.0, inclusive. */);
5620 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5621 &current_buffer->scroll_down_aggressively, Qnil,
5622 doc: /* How far to scroll windows downward.
5623 If you move point off the top, the window scrolls automatically.
5624 This variable controls how far it scrolls. nil, the default,
5625 means scroll to center point. A fraction means scroll to put point
5626 that fraction of the window's height from the top of the window.
5627 When the value is 0.0, point goes at the top line, which in the simple
5628 case that you moved off with C-b means scrolling just one line. 1.0 means
5629 point goes at the bottom, so that in that simple case, the window
5630 window scrolls by a full window height. Meaningful values are
5631 between 0.0 and 1.0, inclusive. */);
5633 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5634 "Don't ask.");
5637 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5638 doc: /* List of functions to call before each text change.
5639 Two arguments are passed to each function: the positions of
5640 the beginning and end of the range of old text to be changed.
5641 \(For an insertion, the beginning and end are at the same place.)
5642 No information is given about the length of the text after the change.
5644 Buffer changes made while executing the `before-change-functions'
5645 don't call any before-change or after-change functions.
5646 That's because these variables are temporarily set to nil.
5647 As a result, a hook function cannot straightforwardly alter the value of
5648 these variables. See the Emacs Lisp manual for a way of
5649 accomplishing an equivalent result by using other variables.
5651 If an unhandled error happens in running these functions,
5652 the variable's value remains nil. That prevents the error
5653 from happening repeatedly and making Emacs nonfunctional. */);
5654 Vbefore_change_functions = Qnil;
5656 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5657 doc: /* List of functions to call after each text change.
5658 Three arguments are passed to each function: the positions of
5659 the beginning and end of the range of changed text,
5660 and the length in bytes of the pre-change text replaced by that range.
5661 \(For an insertion, the pre-change length is zero;
5662 for a deletion, that length is the number of bytes deleted,
5663 and the post-change beginning and end are at the same place.)
5665 Buffer changes made while executing the `after-change-functions'
5666 don't call any before-change or after-change functions.
5667 That's because these variables are temporarily set to nil.
5668 As a result, a hook function cannot straightforwardly alter the value of
5669 these variables. See the Emacs Lisp manual for a way of
5670 accomplishing an equivalent result by using other variables.
5672 If an unhandled error happens in running these functions,
5673 the variable's value remains nil. That prevents the error
5674 from happening repeatedly and making Emacs nonfunctional. */);
5675 Vafter_change_functions = Qnil;
5677 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5678 doc: /* A list of functions to call before changing a buffer which is unmodified.
5679 The functions are run using the `run-hooks' function. */);
5680 Vfirst_change_hook = Qnil;
5682 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5683 doc: /* List of undo entries in current buffer.
5684 Recent changes come first; older changes follow newer.
5686 An entry (BEG . END) represents an insertion which begins at
5687 position BEG and ends at position END.
5689 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5690 from (abs POSITION). If POSITION is positive, point was at the front
5691 of the text being deleted; if negative, point was at the end.
5693 An entry (t HIGH . LOW) indicates that the buffer previously had
5694 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5695 of the visited file's modification time, as of that time. If the
5696 modification time of the most recent save is different, this entry is
5697 obsolete.
5699 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5700 was modified between BEG and END. PROPERTY is the property name,
5701 and VALUE is the old value.
5703 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5704 was adjusted in position by the offset DISTANCE (an integer).
5706 An entry of the form POSITION indicates that point was at the buffer
5707 location given by the integer. Undoing an entry of this form places
5708 point at POSITION.
5710 nil marks undo boundaries. The undo command treats the changes
5711 between two undo boundaries as a single step to be undone.
5713 If the value of the variable is t, undo information is not recorded. */);
5715 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5716 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5718 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5719 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5721 Normally, the line-motion functions work by scanning the buffer for
5722 newlines. Columnar operations (like move-to-column and
5723 compute-motion) also work by scanning the buffer, summing character
5724 widths as they go. This works well for ordinary text, but if the
5725 buffer's lines are very long (say, more than 500 characters), these
5726 motion functions will take longer to execute. Emacs may also take
5727 longer to update the display.
5729 If cache-long-line-scans is non-nil, these motion functions cache the
5730 results of their scans, and consult the cache to avoid rescanning
5731 regions of the buffer until the text is modified. The caches are most
5732 beneficial when they prevent the most searching---that is, when the
5733 buffer contains long lines and large regions of characters with the
5734 same, fixed screen width.
5736 When cache-long-line-scans is non-nil, processing short lines will
5737 become slightly slower (because of the overhead of consulting the
5738 cache), and the caches will use memory roughly proportional to the
5739 number of newlines and characters whose screen width varies.
5741 The caches require no explicit maintenance; their accuracy is
5742 maintained internally by the Emacs primitives. Enabling or disabling
5743 the cache should not affect the behavior of any of the motion
5744 functions; it should only affect their performance. */);
5746 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5747 doc: /* Value of point before the last series of scroll operations, or nil. */);
5749 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5750 doc: /* List of formats to use when saving this buffer.
5751 Formats are defined by `format-alist'. This variable is
5752 set when a file is visited. */);
5754 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5755 &current_buffer->invisibility_spec, Qnil,
5756 doc: /* Invisibility spec of this buffer.
5757 The default is t, which means that text is invisible
5758 if it has a non-nil `invisible' property.
5759 If the value is a list, a text character is invisible if its `invisible'
5760 property is an element in that list.
5761 If an element is a cons cell of the form (PROP . ELLIPSIS),
5762 then characters with property value PROP are invisible,
5763 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5765 DEFVAR_PER_BUFFER ("buffer-display-count",
5766 &current_buffer->display_count, Qnil,
5767 doc: /* A number incremented each time this buffer is displayed in a window.
5768 The function `set-window-buffer' increments it. */);
5770 DEFVAR_PER_BUFFER ("buffer-display-time",
5771 &current_buffer->display_time, Qnil,
5772 doc: /* Time stamp updated each time this buffer is displayed in a window.
5773 The function `set-window-buffer' updates this variable
5774 to the value obtained by calling `current-time'.
5775 If the buffer has never been shown in a window, the value is nil. */);
5777 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5778 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5779 Non-nil also enables highlighting of the region whenever the mark is active.
5780 The variable `highlight-nonselected-windows' controls whether to highlight
5781 all windows or just the selected window. */);
5782 Vtransient_mark_mode = Qnil;
5784 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5785 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5786 If the value is t, disregard `buffer-read-only' and all `read-only'
5787 text properties. If the value is a list, disregard `buffer-read-only'
5788 and disregard a `read-only' text property if the property value
5789 is a member of the list. */);
5790 Vinhibit_read_only = Qnil;
5792 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5793 doc: /* Cursor to use when this buffer is in the selected window.
5794 Values are interpreted as follows:
5796 t use the cursor specified for the frame
5797 nil don't display a cursor
5798 bar display a bar cursor with default width
5799 (bar . WIDTH) display a bar cursor with width WIDTH
5800 ANYTHING ELSE display a box cursor.
5802 When the buffer is displayed in a nonselected window,
5803 this variable has no effect; the cursor appears as a hollow box. */);
5805 DEFVAR_PER_BUFFER ("line-spacing",
5806 &current_buffer->extra_line_spacing, Qnil,
5807 doc: /* Additional space to put between lines when displaying a buffer.
5808 The space is measured in pixels, and put below lines on window systems. */);
5810 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5811 doc: /* List of functions called with no args to query before killing a buffer. */);
5812 Vkill_buffer_query_functions = Qnil;
5814 defsubr (&Sbuffer_live_p);
5815 defsubr (&Sbuffer_list);
5816 defsubr (&Sget_buffer);
5817 defsubr (&Sget_file_buffer);
5818 defsubr (&Sget_buffer_create);
5819 defsubr (&Smake_indirect_buffer);
5820 defsubr (&Sgenerate_new_buffer_name);
5821 defsubr (&Sbuffer_name);
5822 /*defsubr (&Sbuffer_number);*/
5823 defsubr (&Sbuffer_file_name);
5824 defsubr (&Sbuffer_base_buffer);
5825 defsubr (&Sbuffer_local_value);
5826 defsubr (&Sbuffer_local_variables);
5827 defsubr (&Sbuffer_modified_p);
5828 defsubr (&Sset_buffer_modified_p);
5829 defsubr (&Sbuffer_modified_tick);
5830 defsubr (&Srename_buffer);
5831 defsubr (&Sother_buffer);
5832 defsubr (&Sbuffer_disable_undo);
5833 defsubr (&Sbuffer_enable_undo);
5834 defsubr (&Skill_buffer);
5835 defsubr (&Sset_buffer_major_mode);
5836 defsubr (&Sswitch_to_buffer);
5837 defsubr (&Spop_to_buffer);
5838 defsubr (&Scurrent_buffer);
5839 defsubr (&Sset_buffer);
5840 defsubr (&Sbarf_if_buffer_read_only);
5841 defsubr (&Sbury_buffer);
5842 defsubr (&Serase_buffer);
5843 defsubr (&Sset_buffer_multibyte);
5844 defsubr (&Skill_all_local_variables);
5846 defsubr (&Soverlayp);
5847 defsubr (&Smake_overlay);
5848 defsubr (&Sdelete_overlay);
5849 defsubr (&Smove_overlay);
5850 defsubr (&Soverlay_start);
5851 defsubr (&Soverlay_end);
5852 defsubr (&Soverlay_buffer);
5853 defsubr (&Soverlay_properties);
5854 defsubr (&Soverlays_at);
5855 defsubr (&Soverlays_in);
5856 defsubr (&Snext_overlay_change);
5857 defsubr (&Sprevious_overlay_change);
5858 defsubr (&Soverlay_recenter);
5859 defsubr (&Soverlay_lists);
5860 defsubr (&Soverlay_get);
5861 defsubr (&Soverlay_put);
5862 defsubr (&Srestore_buffer_modified_p);
5865 void
5866 keys_of_buffer ()
5868 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5869 initial_define_key (control_x_map, 'k', "kill-buffer");
5871 /* This must not be in syms_of_buffer, because Qdisabled is not
5872 initialized when that function gets called. */
5873 Fput (intern ("erase-buffer"), Qdisabled, Qt);