(syms_of_buffer): Fix a few typos.
[emacs.git] / src / buffer.c
blobb0c8c370931aed8956864a02895228a0516f1556
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985,86,87,88,89,93,94,95,97,98, 1999, 2000, 2001, 02, 03, 2004
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 [probably SunOS? -stef] , 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 DECL_ALIGN (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 corresponding to a DEFVAR_PER_BUFFER is
93 zero, that is a bug */
95 struct buffer buffer_local_flags;
97 /* This structure holds the names of symbols whose values may be
98 buffer-local. It is indexed and accessed in the same way as the above. */
100 DECL_ALIGN (struct buffer, buffer_local_symbols);
102 /* A Lisp_Object pointer to the above, used for staticpro */
103 static Lisp_Object Vbuffer_local_symbols;
105 /* This structure holds the required types for the values in the
106 buffer-local slots. If a slot contains Qnil, then the
107 corresponding buffer slot may contain a value of any type. If a
108 slot contains an integer, then prospective values' tags must be
109 equal to that integer (except nil is always allowed).
110 When a tag does not match, the function
111 buffer_slot_type_mismatch will signal an error.
113 If a slot here contains -1, the corresponding variable is read-only. */
114 struct buffer buffer_local_types;
116 /* Flags indicating which built-in buffer-local variables
117 are permanent locals. */
118 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
120 /* Number of per-buffer variables used. */
122 int last_per_buffer_idx;
124 Lisp_Object Fset_buffer ();
125 void set_buffer_internal ();
126 void set_buffer_internal_1 ();
127 static void call_overlay_mod_hooks ();
128 static void swap_out_buffer_local_variables ();
129 static void reset_buffer_local_variables ();
131 /* Alist of all buffer names vs the buffers. */
132 /* This used to be a variable, but is no longer,
133 to prevent lossage due to user rplac'ing this alist or its elements. */
134 Lisp_Object Vbuffer_alist;
136 /* Functions to call before and after each text change. */
137 Lisp_Object Vbefore_change_functions;
138 Lisp_Object Vafter_change_functions;
140 Lisp_Object Vtransient_mark_mode;
142 /* t means ignore all read-only text properties.
143 A list means ignore such a property if its value is a member of the list.
144 Any non-nil value means ignore buffer-read-only. */
145 Lisp_Object Vinhibit_read_only;
147 /* List of functions to call that can query about killing a buffer.
148 If any of these functions returns nil, we don't kill it. */
149 Lisp_Object Vkill_buffer_query_functions;
150 Lisp_Object Qkill_buffer_query_functions;
152 /* List of functions to call before changing an unmodified buffer. */
153 Lisp_Object Vfirst_change_hook;
155 Lisp_Object Qfirst_change_hook;
156 Lisp_Object Qbefore_change_functions;
157 Lisp_Object Qafter_change_functions;
158 Lisp_Object Qucs_set_table_for_input;
160 /* If nonzero, all modification hooks are suppressed. */
161 int inhibit_modification_hooks;
163 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
165 Lisp_Object Qprotected_field;
167 Lisp_Object QSFundamental; /* A string "Fundamental" */
169 Lisp_Object Qkill_buffer_hook;
171 Lisp_Object Qget_file_buffer;
173 Lisp_Object Qoverlayp;
175 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
177 Lisp_Object Qmodification_hooks;
178 Lisp_Object Qinsert_in_front_hooks;
179 Lisp_Object Qinsert_behind_hooks;
181 static void alloc_buffer_text P_ ((struct buffer *, size_t));
182 static void free_buffer_text P_ ((struct buffer *b));
183 static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
184 static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
187 /* For debugging; temporary. See set_buffer_internal. */
188 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
190 void
191 nsberror (spec)
192 Lisp_Object spec;
194 if (STRINGP (spec))
195 error ("No buffer named %s", SDATA (spec));
196 error ("Invalid buffer argument");
199 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
200 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
201 Value is nil if OBJECT is not a buffer or if it has been killed. */)
202 (object)
203 Lisp_Object object;
205 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
206 ? Qt : Qnil);
209 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
210 doc: /* Return a list of all existing live buffers.
211 If the optional arg FRAME is a frame, we return the buffer list
212 in the proper order for that frame: the buffers in FRAME's `buffer-list'
213 frame parameter come first, followed by the rest of the buffers. */)
214 (frame)
215 Lisp_Object frame;
217 Lisp_Object framelist, general;
218 general = Fmapcar (Qcdr, Vbuffer_alist);
220 if (FRAMEP (frame))
222 Lisp_Object tail;
224 CHECK_FRAME (frame);
226 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
228 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
229 tail = framelist;
230 while (! NILP (tail))
232 general = Fdelq (XCAR (tail), general);
233 tail = XCDR (tail);
235 return nconc2 (framelist, general);
238 return general;
241 /* Like Fassoc, but use Fstring_equal to compare
242 (which ignores text properties),
243 and don't ever QUIT. */
245 static Lisp_Object
246 assoc_ignore_text_properties (key, list)
247 register Lisp_Object key;
248 Lisp_Object list;
250 register Lisp_Object tail;
251 for (tail = list; CONSP (tail); tail = XCDR (tail))
253 register Lisp_Object elt, tem;
254 elt = XCAR (tail);
255 tem = Fstring_equal (Fcar (elt), key);
256 if (!NILP (tem))
257 return elt;
259 return Qnil;
262 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
263 doc: /* Return the buffer named NAME (a string).
264 If there is no live buffer named NAME, return nil.
265 NAME may also be a buffer; if so, the value is that buffer. */)
266 (name)
267 register Lisp_Object name;
269 if (BUFFERP (name))
270 return name;
271 CHECK_STRING (name);
273 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
276 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
277 doc: /* Return the buffer visiting file FILENAME (a string).
278 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
279 If there is no such live buffer, return nil.
280 See also `find-buffer-visiting'. */)
281 (filename)
282 register Lisp_Object filename;
284 register Lisp_Object tail, buf, tem;
285 Lisp_Object handler;
287 CHECK_STRING (filename);
288 filename = Fexpand_file_name (filename, Qnil);
290 /* If the file name has special constructs in it,
291 call the corresponding file handler. */
292 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
293 if (!NILP (handler))
294 return call2 (handler, Qget_file_buffer, filename);
296 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
298 buf = Fcdr (XCAR (tail));
299 if (!BUFFERP (buf)) continue;
300 if (!STRINGP (XBUFFER (buf)->filename)) continue;
301 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
302 if (!NILP (tem))
303 return buf;
305 return Qnil;
308 Lisp_Object
309 get_truename_buffer (filename)
310 register Lisp_Object filename;
312 register Lisp_Object tail, buf, tem;
314 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
316 buf = Fcdr (XCAR (tail));
317 if (!BUFFERP (buf)) continue;
318 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
319 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
320 if (!NILP (tem))
321 return buf;
323 return Qnil;
326 /* Incremented for each buffer created, to assign the buffer number. */
327 int buffer_count;
329 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
330 doc: /* Return the buffer named NAME, or create such a buffer and return it.
331 A new buffer is created if there is no live buffer named NAME.
332 If NAME starts with a space, the new buffer does not keep undo information.
333 If NAME is a buffer instead of a string, then it is the value returned.
334 The value is never nil. */)
335 (name)
336 register Lisp_Object name;
338 register Lisp_Object buf;
339 register struct buffer *b;
341 buf = Fget_buffer (name);
342 if (!NILP (buf))
343 return buf;
345 if (SCHARS (name) == 0)
346 error ("Empty string for buffer name is not allowed");
348 b = (struct buffer *) allocate_buffer ();
350 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
352 /* An ordinary buffer uses its own struct buffer_text. */
353 b->text = &b->own_text;
354 b->base_buffer = 0;
356 BUF_GAP_SIZE (b) = 20;
357 BLOCK_INPUT;
358 /* We allocate extra 1-byte at the tail and keep it always '\0' for
359 anchoring a search. */
360 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
361 UNBLOCK_INPUT;
362 if (! BUF_BEG_ADDR (b))
363 buffer_memory_full ();
365 BUF_PT (b) = BEG;
366 BUF_GPT (b) = BEG;
367 BUF_BEGV (b) = BEG;
368 BUF_ZV (b) = BEG;
369 BUF_Z (b) = BEG;
370 BUF_PT_BYTE (b) = BEG_BYTE;
371 BUF_GPT_BYTE (b) = BEG_BYTE;
372 BUF_BEGV_BYTE (b) = BEG_BYTE;
373 BUF_ZV_BYTE (b) = BEG_BYTE;
374 BUF_Z_BYTE (b) = BEG_BYTE;
375 BUF_MODIFF (b) = 1;
376 BUF_OVERLAY_MODIFF (b) = 1;
377 BUF_SAVE_MODIFF (b) = 1;
378 BUF_INTERVALS (b) = 0;
379 BUF_UNCHANGED_MODIFIED (b) = 1;
380 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
381 BUF_END_UNCHANGED (b) = 0;
382 BUF_BEG_UNCHANGED (b) = 0;
383 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
385 b->newline_cache = 0;
386 b->width_run_cache = 0;
387 b->width_table = Qnil;
388 b->prevent_redisplay_optimizations_p = 1;
390 /* Put this on the chain of all buffers including killed ones. */
391 b->next = all_buffers;
392 all_buffers = b;
394 /* An ordinary buffer normally doesn't need markers
395 to handle BEGV and ZV. */
396 b->pt_marker = Qnil;
397 b->begv_marker = Qnil;
398 b->zv_marker = Qnil;
400 name = Fcopy_sequence (name);
401 STRING_SET_INTERVALS (name, NULL_INTERVAL);
402 b->name = name;
404 if (SREF (name, 0) != ' ')
405 b->undo_list = Qnil;
406 else
407 b->undo_list = Qt;
409 reset_buffer (b);
410 reset_buffer_local_variables (b, 1);
412 b->mark = Fmake_marker ();
413 BUF_MARKERS (b) = NULL;
414 b->name = name;
416 /* Put this in the alist of all live buffers. */
417 XSETBUFFER (buf, b);
418 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
420 /* An error in calling the function here (should someone redfine it)
421 can lead to infinite regress until you run out of stack. rms
422 says that's not worth protecting against. */
423 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
424 /* buf is on buffer-alist, so no gcpro. */
425 call1 (Qucs_set_table_for_input, buf);
427 return buf;
431 /* Return a list of overlays which is a copy of the overlay list
432 LIST, but for buffer B. */
434 static struct Lisp_Overlay *
435 copy_overlays (b, list)
436 struct buffer *b;
437 struct Lisp_Overlay *list;
439 Lisp_Object buffer;
440 struct Lisp_Overlay *result = NULL, *tail = NULL;
442 XSETBUFFER (buffer, b);
444 for (; list; list = list->next)
446 Lisp_Object overlay, start, end, old_overlay;
447 EMACS_INT charpos;
449 XSETMISC (old_overlay, list);
450 charpos = marker_position (OVERLAY_START (old_overlay));
451 start = Fmake_marker ();
452 Fset_marker (start, make_number (charpos), buffer);
453 XMARKER (start)->insertion_type
454 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
456 charpos = marker_position (OVERLAY_END (old_overlay));
457 end = Fmake_marker ();
458 Fset_marker (end, make_number (charpos), buffer);
459 XMARKER (end)->insertion_type
460 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
462 overlay = allocate_misc ();
463 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
464 OVERLAY_START (overlay) = start;
465 OVERLAY_END (overlay) = end;
466 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
467 XOVERLAY (overlay)->next = NULL;
469 if (tail)
470 tail = tail->next = XOVERLAY (overlay);
471 else
472 result = tail = XOVERLAY (overlay);
475 return result;
479 /* Clone per-buffer values of buffer FROM.
481 Buffer TO gets the same per-buffer values as FROM, with the
482 following exceptions: (1) TO's name is left untouched, (2) markers
483 are copied and made to refer to TO, and (3) overlay lists are
484 copied. */
486 static void
487 clone_per_buffer_values (from, to)
488 struct buffer *from, *to;
490 Lisp_Object to_buffer, tem;
491 int offset;
493 XSETBUFFER (to_buffer, to);
495 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
496 offset < sizeof *to;
497 offset += sizeof (Lisp_Object))
499 Lisp_Object obj;
501 obj = PER_BUFFER_VALUE (from, offset);
502 if (MARKERP (obj))
504 struct Lisp_Marker *m = XMARKER (obj);
505 obj = Fmake_marker ();
506 XMARKER (obj)->insertion_type = m->insertion_type;
507 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
510 PER_BUFFER_VALUE (to, offset) = obj;
513 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
515 to->overlays_before = copy_overlays (to, from->overlays_before);
516 to->overlays_after = copy_overlays (to, from->overlays_after);
518 /* Copy the alist of local variables,
519 and all the alist elements too. */
520 to->local_var_alist
521 = Fcopy_sequence (from->local_var_alist);
522 for (tem = to->local_var_alist; CONSP (tem);
523 tem = XCDR (tem))
524 XSETCAR (tem, Fcons (XCAR (XCAR (tem)), XCDR (XCAR (tem))));
528 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
529 2, 3,
530 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
531 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
532 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
533 NAME should be a string which is not the name of an existing buffer.
534 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
535 such as major and minor modes, in the indirect buffer.
536 CLONE nil means the indirect buffer's state is reset to default values. */)
537 (base_buffer, name, clone)
538 Lisp_Object base_buffer, name, clone;
540 Lisp_Object buf, tem;
541 struct buffer *b;
543 CHECK_STRING (name);
544 buf = Fget_buffer (name);
545 if (!NILP (buf))
546 error ("Buffer name `%s' is in use", SDATA (name));
548 tem = base_buffer;
549 base_buffer = Fget_buffer (base_buffer);
550 if (NILP (base_buffer))
551 error ("No such buffer: `%s'", SDATA (tem));
552 if (NILP (XBUFFER (base_buffer)->name))
553 error ("Base buffer has been killed");
555 if (SCHARS (name) == 0)
556 error ("Empty string for buffer name is not allowed");
558 b = (struct buffer *) allocate_buffer ();
559 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
561 if (XBUFFER (base_buffer)->base_buffer)
562 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
563 else
564 b->base_buffer = XBUFFER (base_buffer);
566 /* Use the base buffer's text object. */
567 b->text = b->base_buffer->text;
569 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
570 BUF_ZV (b) = BUF_ZV (b->base_buffer);
571 BUF_PT (b) = BUF_PT (b->base_buffer);
572 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
573 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
574 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
576 b->newline_cache = 0;
577 b->width_run_cache = 0;
578 b->width_table = Qnil;
580 /* Put this on the chain of all buffers including killed ones. */
581 b->next = all_buffers;
582 all_buffers = b;
584 name = Fcopy_sequence (name);
585 STRING_SET_INTERVALS (name, NULL_INTERVAL);
586 b->name = name;
588 reset_buffer (b);
589 reset_buffer_local_variables (b, 1);
591 /* Put this in the alist of all live buffers. */
592 XSETBUFFER (buf, b);
593 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
595 b->mark = Fmake_marker ();
596 b->name = name;
598 /* The multibyte status belongs to the base buffer. */
599 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
601 /* Make sure the base buffer has markers for its narrowing. */
602 if (NILP (b->base_buffer->pt_marker))
604 b->base_buffer->pt_marker = Fmake_marker ();
605 set_marker_both (b->base_buffer->pt_marker, base_buffer,
606 BUF_PT (b->base_buffer),
607 BUF_PT_BYTE (b->base_buffer));
609 if (NILP (b->base_buffer->begv_marker))
611 b->base_buffer->begv_marker = Fmake_marker ();
612 set_marker_both (b->base_buffer->begv_marker, base_buffer,
613 BUF_BEGV (b->base_buffer),
614 BUF_BEGV_BYTE (b->base_buffer));
616 if (NILP (b->base_buffer->zv_marker))
618 b->base_buffer->zv_marker = Fmake_marker ();
619 set_marker_both (b->base_buffer->zv_marker, base_buffer,
620 BUF_ZV (b->base_buffer),
621 BUF_ZV_BYTE (b->base_buffer));
622 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
625 if (NILP (clone))
627 /* Give the indirect buffer markers for its narrowing. */
628 b->pt_marker = Fmake_marker ();
629 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
630 b->begv_marker = Fmake_marker ();
631 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
632 b->zv_marker = Fmake_marker ();
633 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
634 XMARKER (b->zv_marker)->insertion_type = 1;
636 else
637 clone_per_buffer_values (b->base_buffer, b);
639 return buf;
642 void
643 delete_all_overlays (b)
644 struct buffer *b;
646 Lisp_Object overlay;
648 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
649 have to empty the list, otherwise we end up with overlays that
650 think they belong to this buffer while the buffer doesn't know about
651 them any more. */
652 while (b->overlays_before)
654 XSETMISC (overlay, b->overlays_before);
655 Fdelete_overlay (overlay);
657 while (b->overlays_after)
659 XSETMISC (overlay, b->overlays_after);
660 Fdelete_overlay (overlay);
662 eassert (b->overlays_before == NULL);
663 eassert (b->overlays_after == NULL);
666 /* Reinitialize everything about a buffer except its name and contents
667 and local variables.
668 If called on an already-initialized buffer, the list of overlays
669 should be deleted before calling this function, otherwise we end up
670 with overlays that claim to belong to the buffer but the buffer
671 claims it doesn't belong to it. */
673 void
674 reset_buffer (b)
675 register struct buffer *b;
677 b->filename = Qnil;
678 b->file_truename = Qnil;
679 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
680 b->modtime = 0;
681 XSETFASTINT (b->save_length, 0);
682 b->last_window_start = 1;
683 /* It is more conservative to start out "changed" than "unchanged". */
684 b->clip_changed = 0;
685 b->prevent_redisplay_optimizations_p = 1;
686 b->backed_up = Qnil;
687 b->auto_save_modified = 0;
688 b->auto_save_failure_time = -1;
689 b->auto_save_file_name = Qnil;
690 b->read_only = Qnil;
691 b->overlays_before = NULL;
692 b->overlays_after = NULL;
693 b->overlay_center = BEG;
694 b->mark_active = Qnil;
695 b->point_before_scroll = Qnil;
696 b->file_format = Qnil;
697 b->auto_save_file_format = Qt;
698 b->last_selected_window = Qnil;
699 XSETINT (b->display_count, 0);
700 b->display_time = Qnil;
701 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
702 b->cursor_type = buffer_defaults.cursor_type;
703 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
705 b->display_error_modiff = 0;
708 /* Reset buffer B's local variables info.
709 Don't use this on a buffer that has already been in use;
710 it does not treat permanent locals consistently.
711 Instead, use Fkill_all_local_variables.
713 If PERMANENT_TOO is 1, then we reset permanent built-in
714 buffer-local variables. If PERMANENT_TOO is 0,
715 we preserve those. */
717 static void
718 reset_buffer_local_variables (b, permanent_too)
719 register struct buffer *b;
720 int permanent_too;
722 register int offset;
723 int i;
725 /* Reset the major mode to Fundamental, together with all the
726 things that depend on the major mode.
727 default-major-mode is handled at a higher level.
728 We ignore it here. */
729 b->major_mode = Qfundamental_mode;
730 b->keymap = Qnil;
731 b->mode_name = QSFundamental;
732 b->minor_modes = Qnil;
734 /* If the standard case table has been altered and invalidated,
735 fix up its insides first. */
736 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
737 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
738 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
739 Fset_standard_case_table (Vascii_downcase_table);
741 b->downcase_table = Vascii_downcase_table;
742 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
743 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
744 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
745 b->invisibility_spec = Qt;
746 #ifndef DOS_NT
747 b->buffer_file_type = Qnil;
748 #endif
750 /* Reset all (or most) per-buffer variables to their defaults. */
751 b->local_var_alist = Qnil;
752 for (i = 0; i < last_per_buffer_idx; ++i)
753 if (permanent_too || buffer_permanent_local_flags[i] == 0)
754 SET_PER_BUFFER_VALUE_P (b, i, 0);
756 /* For each slot that has a default value,
757 copy that into the slot. */
759 for (offset = PER_BUFFER_VAR_OFFSET (name);
760 offset < sizeof *b;
761 offset += sizeof (Lisp_Object))
763 int idx = PER_BUFFER_IDX (offset);
764 if ((idx > 0
765 && (permanent_too
766 || buffer_permanent_local_flags[idx] == 0))
767 /* Is -2 used anywhere? */
768 || idx == -2)
769 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
773 /* We split this away from generate-new-buffer, because rename-buffer
774 and set-visited-file-name ought to be able to use this to really
775 rename the buffer properly. */
777 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
778 1, 2, 0,
779 doc: /* Return a string that is the name of no existing buffer based on NAME.
780 If there is no live buffer named NAME, then return NAME.
781 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
782 \(starting at 2) until an unused name is found, and then return that name.
783 Optional second argument IGNORE specifies a name that is okay to use
784 \(if it is in the sequence to be tried)
785 even if a buffer with that name exists. */)
786 (name, ignore)
787 register Lisp_Object name, ignore;
789 register Lisp_Object gentemp, tem;
790 int count;
791 char number[10];
793 CHECK_STRING (name);
795 tem = Fstring_equal (name, ignore);
796 if (!NILP (tem))
797 return name;
798 tem = Fget_buffer (name);
799 if (NILP (tem))
800 return name;
802 count = 1;
803 while (1)
805 sprintf (number, "<%d>", ++count);
806 gentemp = concat2 (name, build_string (number));
807 tem = Fstring_equal (gentemp, ignore);
808 if (!NILP (tem))
809 return gentemp;
810 tem = Fget_buffer (gentemp);
811 if (NILP (tem))
812 return gentemp;
817 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
818 doc: /* Return the name of BUFFER, as a string.
819 With no argument or nil as argument, return the name of the current buffer. */)
820 (buffer)
821 register Lisp_Object buffer;
823 if (NILP (buffer))
824 return current_buffer->name;
825 CHECK_BUFFER (buffer);
826 return XBUFFER (buffer)->name;
829 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
830 doc: /* Return name of file BUFFER is visiting, or nil if none.
831 No argument or nil as argument means use the current buffer. */)
832 (buffer)
833 register Lisp_Object buffer;
835 if (NILP (buffer))
836 return current_buffer->filename;
837 CHECK_BUFFER (buffer);
838 return XBUFFER (buffer)->filename;
841 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
842 0, 1, 0,
843 doc: /* Return the base buffer of indirect buffer BUFFER.
844 If BUFFER is not indirect, return nil.
845 BUFFER defaults to the current buffer. */)
846 (buffer)
847 register Lisp_Object buffer;
849 struct buffer *base;
850 Lisp_Object base_buffer;
852 if (NILP (buffer))
853 base = current_buffer->base_buffer;
854 else
856 CHECK_BUFFER (buffer);
857 base = XBUFFER (buffer)->base_buffer;
860 if (! base)
861 return Qnil;
862 XSETBUFFER (base_buffer, base);
863 return base_buffer;
866 DEFUN ("buffer-local-value", Fbuffer_local_value,
867 Sbuffer_local_value, 2, 2, 0,
868 doc: /* Return the value of VARIABLE in BUFFER.
869 If VARIABLE does not have a buffer-local binding in BUFFER, the value
870 is the default binding of variable. */)
871 (symbol, buffer)
872 register Lisp_Object symbol;
873 register Lisp_Object buffer;
875 register struct buffer *buf;
876 register Lisp_Object result;
878 CHECK_SYMBOL (symbol);
879 CHECK_BUFFER (buffer);
880 buf = XBUFFER (buffer);
882 /* Look in local_var_list */
883 result = Fassoc (symbol, buf->local_var_alist);
884 if (NILP (result))
886 int offset, idx;
887 int found = 0;
889 /* Look in special slots */
890 for (offset = PER_BUFFER_VAR_OFFSET (name);
891 offset < sizeof (struct buffer);
892 /* sizeof EMACS_INT == sizeof Lisp_Object */
893 offset += (sizeof (EMACS_INT)))
895 idx = PER_BUFFER_IDX (offset);
896 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
897 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
898 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
900 result = PER_BUFFER_VALUE (buf, offset);
901 found = 1;
902 break;
906 if (!found)
907 result = Fdefault_value (symbol);
909 else
911 Lisp_Object valcontents;
912 Lisp_Object current_alist_element;
914 /* What binding is loaded right now? */
915 valcontents = SYMBOL_VALUE (symbol);
916 current_alist_element
917 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
919 /* The value of the currently loaded binding is not
920 stored in it, but rather in the realvalue slot.
921 Store that value into the binding it belongs to
922 in case that is the one we are about to use. */
924 Fsetcdr (current_alist_element,
925 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
927 /* Now get the (perhaps updated) value out of the binding. */
928 result = XCDR (result);
931 if (EQ (result, Qunbound))
932 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
934 return result;
937 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
938 Sbuffer_local_variables, 0, 1, 0,
939 doc: /* Return an alist of variables that are buffer-local in BUFFER.
940 Most elements look like (SYMBOL . VALUE), describing one variable.
941 For a symbol that is locally unbound, just the symbol appears in the value.
942 Note that storing new VALUEs in these elements doesn't change the variables.
943 No argument or nil as argument means use current buffer as BUFFER. */)
944 (buffer)
945 register Lisp_Object buffer;
947 register struct buffer *buf;
948 register Lisp_Object result;
950 if (NILP (buffer))
951 buf = current_buffer;
952 else
954 CHECK_BUFFER (buffer);
955 buf = XBUFFER (buffer);
958 result = Qnil;
961 register Lisp_Object tail;
962 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
964 Lisp_Object val, elt;
966 elt = XCAR (tail);
968 /* Reference each variable in the alist in buf.
969 If inquiring about the current buffer, this gets the current values,
970 so store them into the alist so the alist is up to date.
971 If inquiring about some other buffer, this swaps out any values
972 for that buffer, making the alist up to date automatically. */
973 val = find_symbol_value (XCAR (elt));
974 /* Use the current buffer value only if buf is the current buffer. */
975 if (buf != current_buffer)
976 val = XCDR (elt);
978 /* If symbol is unbound, put just the symbol in the list. */
979 if (EQ (val, Qunbound))
980 result = Fcons (XCAR (elt), result);
981 /* Otherwise, put (symbol . value) in the list. */
982 else
983 result = Fcons (Fcons (XCAR (elt), val), result);
987 /* Add on all the variables stored in special slots. */
989 int offset, idx;
991 for (offset = PER_BUFFER_VAR_OFFSET (name);
992 offset < sizeof (struct buffer);
993 /* sizeof EMACS_INT == sizeof Lisp_Object */
994 offset += (sizeof (EMACS_INT)))
996 idx = PER_BUFFER_IDX (offset);
997 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
998 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
999 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1000 PER_BUFFER_VALUE (buf, offset)),
1001 result);
1005 return result;
1009 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1010 0, 1, 0,
1011 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1012 No argument or nil as argument means use current buffer as BUFFER. */)
1013 (buffer)
1014 register Lisp_Object buffer;
1016 register struct buffer *buf;
1017 if (NILP (buffer))
1018 buf = current_buffer;
1019 else
1021 CHECK_BUFFER (buffer);
1022 buf = XBUFFER (buffer);
1025 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1028 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1029 1, 1, 0,
1030 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1031 A non-nil FLAG means mark the buffer modified. */)
1032 (flag)
1033 register Lisp_Object flag;
1035 register int already;
1036 register Lisp_Object fn;
1037 Lisp_Object buffer, window;
1039 #ifdef CLASH_DETECTION
1040 /* If buffer becoming modified, lock the file.
1041 If buffer becoming unmodified, unlock the file. */
1043 fn = current_buffer->file_truename;
1044 /* Test buffer-file-name so that binding it to nil is effective. */
1045 if (!NILP (fn) && ! NILP (current_buffer->filename))
1047 already = SAVE_MODIFF < MODIFF;
1048 if (!already && !NILP (flag))
1049 lock_file (fn);
1050 else if (already && NILP (flag))
1051 unlock_file (fn);
1053 #endif /* CLASH_DETECTION */
1055 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1057 /* Set update_mode_lines only if buffer is displayed in some window.
1058 Packages like jit-lock or lazy-lock preserve a buffer's modified
1059 state by recording/restoring the state around blocks of code.
1060 Setting update_mode_lines makes redisplay consider all windows
1061 (on all frames). Stealth fontification of buffers not displayed
1062 would incur additional redisplay costs if we'd set
1063 update_modes_lines unconditionally.
1065 Ideally, I think there should be another mechanism for fontifying
1066 buffers without "modifying" buffers, or redisplay should be
1067 smarter about updating the `*' in mode lines. --gerd */
1068 XSETBUFFER (buffer, current_buffer);
1069 window = Fget_buffer_window (buffer, Qt);
1070 if (WINDOWP (window))
1072 ++update_mode_lines;
1073 current_buffer->prevent_redisplay_optimizations_p = 1;
1076 return flag;
1079 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1080 Srestore_buffer_modified_p, 1, 1, 0,
1081 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1082 It is not ensured that mode lines will be updated to show the modified
1083 state of the current buffer. Use with care. */)
1084 (flag)
1085 Lisp_Object flag;
1087 #ifdef CLASH_DETECTION
1088 Lisp_Object fn;
1090 /* If buffer becoming modified, lock the file.
1091 If buffer becoming unmodified, unlock the file. */
1093 fn = current_buffer->file_truename;
1094 /* Test buffer-file-name so that binding it to nil is effective. */
1095 if (!NILP (fn) && ! NILP (current_buffer->filename))
1097 int already = SAVE_MODIFF < MODIFF;
1098 if (!already && !NILP (flag))
1099 lock_file (fn);
1100 else if (already && NILP (flag))
1101 unlock_file (fn);
1103 #endif /* CLASH_DETECTION */
1105 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1106 return flag;
1109 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1110 0, 1, 0,
1111 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1112 Each buffer has a tick counter which is incremented each time the text in
1113 that buffer is changed. It wraps around occasionally.
1114 No argument or nil as argument means use current buffer as BUFFER. */)
1115 (buffer)
1116 register Lisp_Object buffer;
1118 register struct buffer *buf;
1119 if (NILP (buffer))
1120 buf = current_buffer;
1121 else
1123 CHECK_BUFFER (buffer);
1124 buf = XBUFFER (buffer);
1127 return make_number (BUF_MODIFF (buf));
1130 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1131 "sRename buffer (to new name): \nP",
1132 doc: /* Change current buffer's name to NEWNAME (a string).
1133 If second arg UNIQUE is nil or omitted, it is an error if a
1134 buffer named NEWNAME already exists.
1135 If UNIQUE is non-nil, come up with a new name using
1136 `generate-new-buffer-name'.
1137 Interactively, you can set UNIQUE with a prefix argument.
1138 We return the name we actually gave the buffer.
1139 This does not change the name of the visited file (if any). */)
1140 (newname, unique)
1141 register Lisp_Object newname, unique;
1143 register Lisp_Object tem, buf;
1145 CHECK_STRING (newname);
1147 if (SCHARS (newname) == 0)
1148 error ("Empty string is invalid as a buffer name");
1150 tem = Fget_buffer (newname);
1151 if (!NILP (tem))
1153 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1154 rename the buffer automatically so you can create another
1155 with the original name. It makes UNIQUE equivalent to
1156 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1157 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1158 return current_buffer->name;
1159 if (!NILP (unique))
1160 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1161 else
1162 error ("Buffer name `%s' is in use", SDATA (newname));
1165 current_buffer->name = newname;
1167 /* Catch redisplay's attention. Unless we do this, the mode lines for
1168 any windows displaying current_buffer will stay unchanged. */
1169 update_mode_lines++;
1171 XSETBUFFER (buf, current_buffer);
1172 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1173 if (NILP (current_buffer->filename)
1174 && !NILP (current_buffer->auto_save_file_name))
1175 call0 (intern ("rename-auto-save-file"));
1176 /* Refetch since that last call may have done GC. */
1177 return current_buffer->name;
1180 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1181 doc: /* Return most recently selected buffer other than BUFFER.
1182 Buffers not visible in windows are preferred to visible buffers,
1183 unless optional second argument VISIBLE-OK is non-nil.
1184 If the optional third argument FRAME is non-nil, use that frame's
1185 buffer list instead of the selected frame's buffer list.
1186 If no other buffer exists, the buffer `*scratch*' is returned.
1187 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1188 (buffer, visible_ok, frame)
1189 register Lisp_Object buffer, visible_ok, frame;
1191 Lisp_Object Fset_buffer_major_mode ();
1192 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1193 notsogood = Qnil;
1195 if (NILP (frame))
1196 frame = selected_frame;
1198 tail = Vbuffer_alist;
1199 pred = frame_buffer_predicate (frame);
1201 /* Consider buffers that have been seen in the selected frame
1202 before other buffers. */
1204 tem = frame_buffer_list (frame);
1205 add_ons = Qnil;
1206 while (CONSP (tem))
1208 if (BUFFERP (XCAR (tem)))
1209 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1210 tem = XCDR (tem);
1212 tail = nconc2 (Fnreverse (add_ons), tail);
1214 for (; CONSP (tail); tail = XCDR (tail))
1216 buf = Fcdr (XCAR (tail));
1217 if (EQ (buf, buffer))
1218 continue;
1219 if (NILP (buf))
1220 continue;
1221 if (NILP (XBUFFER (buf)->name))
1222 continue;
1223 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1224 continue;
1225 /* If the selected frame has a buffer_predicate,
1226 disregard buffers that don't fit the predicate. */
1227 if (!NILP (pred))
1229 tem = call1 (pred, buf);
1230 if (NILP (tem))
1231 continue;
1234 if (NILP (visible_ok))
1235 tem = Fget_buffer_window (buf, Qvisible);
1236 else
1237 tem = Qnil;
1238 if (NILP (tem))
1239 return buf;
1240 if (NILP (notsogood))
1241 notsogood = buf;
1243 if (!NILP (notsogood))
1244 return notsogood;
1245 buf = Fget_buffer (build_string ("*scratch*"));
1246 if (NILP (buf))
1248 buf = Fget_buffer_create (build_string ("*scratch*"));
1249 Fset_buffer_major_mode (buf);
1251 return buf;
1254 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
1255 0, 1, "",
1256 doc: /* Make BUFFER stop keeping undo information.
1257 No argument or nil as argument means do this for the current buffer. */)
1258 (buffer)
1259 register Lisp_Object buffer;
1261 Lisp_Object real_buffer;
1263 if (NILP (buffer))
1264 XSETBUFFER (real_buffer, current_buffer);
1265 else
1267 real_buffer = Fget_buffer (buffer);
1268 if (NILP (real_buffer))
1269 nsberror (buffer);
1272 XBUFFER (real_buffer)->undo_list = Qt;
1274 return Qnil;
1277 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1278 0, 1, "",
1279 doc: /* Start keeping undo information for buffer BUFFER.
1280 No argument or nil as argument means do this for the current buffer. */)
1281 (buffer)
1282 register Lisp_Object buffer;
1284 Lisp_Object real_buffer;
1286 if (NILP (buffer))
1287 XSETBUFFER (real_buffer, current_buffer);
1288 else
1290 real_buffer = Fget_buffer (buffer);
1291 if (NILP (real_buffer))
1292 nsberror (buffer);
1295 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1296 XBUFFER (real_buffer)->undo_list = Qnil;
1298 return Qnil;
1302 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1303 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1304 The buffer being killed will be current while the hook is running.\n\
1305 See `kill-buffer'."
1307 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1308 doc: /* Kill the buffer BUFFER.
1309 The argument may be a buffer or may be the name of a buffer.
1310 An argument of nil means kill the current buffer.
1312 Value is t if the buffer is actually killed, nil if user says no.
1314 The value of `kill-buffer-hook' (which may be local to that buffer),
1315 if not void, is a list of functions to be called, with no arguments,
1316 before the buffer is actually killed. The buffer to be killed is current
1317 when the hook functions are called.
1319 Any processes that have this buffer as the `process-buffer' are killed
1320 with SIGHUP. */)
1321 (buffer)
1322 Lisp_Object buffer;
1324 Lisp_Object buf;
1325 register struct buffer *b;
1326 register Lisp_Object tem;
1327 register struct Lisp_Marker *m;
1328 struct gcpro gcpro1;
1330 if (NILP (buffer))
1331 buf = Fcurrent_buffer ();
1332 else
1333 buf = Fget_buffer (buffer);
1334 if (NILP (buf))
1335 nsberror (buffer);
1337 b = XBUFFER (buf);
1339 /* Avoid trouble for buffer already dead. */
1340 if (NILP (b->name))
1341 return Qnil;
1343 /* Query if the buffer is still modified. */
1344 if (INTERACTIVE && !NILP (b->filename)
1345 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1347 GCPRO1 (buf);
1348 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1349 b->name, make_number (0)));
1350 UNGCPRO;
1351 if (NILP (tem))
1352 return Qnil;
1355 /* Run hooks with the buffer to be killed the current buffer. */
1357 int count = SPECPDL_INDEX ();
1358 Lisp_Object arglist[1];
1360 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1361 set_buffer_internal (b);
1363 /* First run the query functions; if any query is answered no,
1364 don't kill the buffer. */
1365 arglist[0] = Qkill_buffer_query_functions;
1366 if (NILP (Frun_hook_with_args_until_failure (1, arglist)))
1367 return unbind_to (count, Qnil);
1369 /* Then run the hooks. */
1370 Frun_hooks (1, &Qkill_buffer_hook);
1371 unbind_to (count, Qnil);
1374 /* We have no more questions to ask. Verify that it is valid
1375 to kill the buffer. This must be done after the questions
1376 since anything can happen within do_yes_or_no_p. */
1378 /* Don't kill the minibuffer now current. */
1379 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1380 return Qnil;
1382 if (NILP (b->name))
1383 return Qnil;
1385 /* When we kill a base buffer, kill all its indirect buffers.
1386 We do it at this stage so nothing terrible happens if they
1387 ask questions or their hooks get errors. */
1388 if (! b->base_buffer)
1390 struct buffer *other;
1392 GCPRO1 (buf);
1394 for (other = all_buffers; other; other = other->next)
1395 /* all_buffers contains dead buffers too;
1396 don't re-kill them. */
1397 if (other->base_buffer == b && !NILP (other->name))
1399 Lisp_Object buf;
1400 XSETBUFFER (buf, other);
1401 Fkill_buffer (buf);
1404 UNGCPRO;
1407 /* Make this buffer not be current.
1408 In the process, notice if this is the sole visible buffer
1409 and give up if so. */
1410 if (b == current_buffer)
1412 tem = Fother_buffer (buf, Qnil, Qnil);
1413 Fset_buffer (tem);
1414 if (b == current_buffer)
1415 return Qnil;
1418 /* Notice if the buffer to kill is the sole visible buffer
1419 when we're currently in the mini-buffer, and give up if so. */
1420 XSETBUFFER (tem, current_buffer);
1421 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1423 tem = Fother_buffer (buf, Qnil, Qnil);
1424 if (EQ (buf, tem))
1425 return Qnil;
1428 /* Now there is no question: we can kill the buffer. */
1430 #ifdef CLASH_DETECTION
1431 /* Unlock this buffer's file, if it is locked. */
1432 unlock_buffer (b);
1433 #endif /* CLASH_DETECTION */
1435 kill_buffer_processes (buf);
1436 clear_charpos_cache (b);
1438 tem = Vinhibit_quit;
1439 Vinhibit_quit = Qt;
1440 replace_buffer_in_all_windows (buf);
1441 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1442 frames_discard_buffer (buf);
1443 Vinhibit_quit = tem;
1445 /* Delete any auto-save file, if we saved it in this session.
1446 But not if the buffer is modified. */
1447 if (STRINGP (b->auto_save_file_name)
1448 && b->auto_save_modified != 0
1449 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1450 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1451 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1453 Lisp_Object tem;
1454 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1455 if (! NILP (tem))
1456 internal_delete_file (b->auto_save_file_name);
1459 if (b->base_buffer)
1461 /* Unchain all markers that belong to this indirect buffer.
1462 Don't unchain the markers that belong to the base buffer
1463 or its other indirect buffers. */
1464 for (m = BUF_MARKERS (b); m; )
1466 struct Lisp_Marker *next = m->next;
1467 if (m->buffer == b)
1468 unchain_marker (m);
1469 m = next;
1472 else
1474 /* Unchain all markers of this buffer and its indirect buffers.
1475 and leave them pointing nowhere. */
1476 for (m = BUF_MARKERS (b); m; )
1478 struct Lisp_Marker *next = m->next;
1479 m->buffer = 0;
1480 m->next = NULL;
1481 m = next;
1483 BUF_MARKERS (b) = NULL;
1484 BUF_INTERVALS (b) = NULL_INTERVAL;
1486 /* Perhaps we should explicitly free the interval tree here... */
1489 /* Reset the local variables, so that this buffer's local values
1490 won't be protected from GC. They would be protected
1491 if they happened to remain encached in their symbols.
1492 This gets rid of them for certain. */
1493 swap_out_buffer_local_variables (b);
1494 reset_buffer_local_variables (b, 1);
1496 b->name = Qnil;
1498 BLOCK_INPUT;
1499 if (! b->base_buffer)
1500 free_buffer_text (b);
1502 if (b->newline_cache)
1504 free_region_cache (b->newline_cache);
1505 b->newline_cache = 0;
1507 if (b->width_run_cache)
1509 free_region_cache (b->width_run_cache);
1510 b->width_run_cache = 0;
1512 b->width_table = Qnil;
1513 UNBLOCK_INPUT;
1514 b->undo_list = Qnil;
1516 return Qt;
1519 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1520 we do this each time BUF is selected visibly, the more recently
1521 selected buffers are always closer to the front of the list. This
1522 means that other_buffer is more likely to choose a relevant buffer. */
1524 void
1525 record_buffer (buf)
1526 Lisp_Object buf;
1528 register Lisp_Object link, prev;
1529 Lisp_Object frame;
1530 frame = selected_frame;
1532 prev = Qnil;
1533 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1535 if (EQ (XCDR (XCAR (link)), buf))
1536 break;
1537 prev = link;
1540 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1541 we cannot use Fdelq itself here because it allows quitting. */
1543 if (NILP (prev))
1544 Vbuffer_alist = XCDR (Vbuffer_alist);
1545 else
1546 XSETCDR (prev, XCDR (XCDR (prev)));
1548 XSETCDR (link, Vbuffer_alist);
1549 Vbuffer_alist = link;
1551 /* Now move this buffer to the front of frame_buffer_list also. */
1553 prev = Qnil;
1554 for (link = frame_buffer_list (frame); CONSP (link);
1555 link = XCDR (link))
1557 if (EQ (XCAR (link), buf))
1558 break;
1559 prev = link;
1562 /* Effectively do delq. */
1564 if (CONSP (link))
1566 if (NILP (prev))
1567 set_frame_buffer_list (frame,
1568 XCDR (frame_buffer_list (frame)));
1569 else
1570 XSETCDR (prev, XCDR (XCDR (prev)));
1572 XSETCDR (link, frame_buffer_list (frame));
1573 set_frame_buffer_list (frame, link);
1575 else
1576 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1579 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1580 doc: /* Set an appropriate major mode for BUFFER.
1581 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1582 according to `default-major-mode'.
1583 Use this function before selecting the buffer, since it may need to inspect
1584 the current buffer's major mode. */)
1585 (buffer)
1586 Lisp_Object buffer;
1588 int count;
1589 Lisp_Object function;
1591 if (STRINGP (XBUFFER (buffer)->name)
1592 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1593 function = find_symbol_value (intern ("initial-major-mode"));
1594 else
1596 function = buffer_defaults.major_mode;
1597 if (NILP (function)
1598 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1599 function = current_buffer->major_mode;
1602 if (NILP (function) || EQ (function, Qfundamental_mode))
1603 return Qnil;
1605 count = SPECPDL_INDEX ();
1607 /* To select a nonfundamental mode,
1608 select the buffer temporarily and then call the mode function. */
1610 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1612 Fset_buffer (buffer);
1613 call0 (function);
1615 return unbind_to (count, Qnil);
1618 /* If switching buffers in WINDOW would be an error, return
1619 a C string saying what the error would be. */
1621 char *
1622 no_switch_window (window)
1623 Lisp_Object window;
1625 Lisp_Object tem;
1626 if (EQ (minibuf_window, window))
1627 return "Cannot switch buffers in minibuffer window";
1628 tem = Fwindow_dedicated_p (window);
1629 if (EQ (tem, Qt))
1630 return "Cannot switch buffers in a dedicated window";
1631 return NULL;
1634 /* Switch to buffer BUFFER in the selected window.
1635 If NORECORD is non-nil, don't call record_buffer. */
1637 Lisp_Object
1638 switch_to_buffer_1 (buffer, norecord)
1639 Lisp_Object buffer, norecord;
1641 register Lisp_Object buf;
1643 if (NILP (buffer))
1644 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1645 else
1647 buf = Fget_buffer (buffer);
1648 if (NILP (buf))
1650 buf = Fget_buffer_create (buffer);
1651 Fset_buffer_major_mode (buf);
1654 Fset_buffer (buf);
1655 if (NILP (norecord))
1656 record_buffer (buf);
1658 Fset_window_buffer (EQ (selected_window, minibuf_window)
1659 ? Fnext_window (minibuf_window, Qnil, Qnil)
1660 : selected_window,
1661 buf, Qnil);
1663 return buf;
1666 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1667 doc: /* Select buffer BUFFER in the current window.
1668 If BUFFER does not identify an existing buffer,
1669 then this function creates a buffer with that name.
1671 When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1672 or nil. If BUFFER is nil, then this function chooses a buffer
1673 using `other-buffer'.
1674 Optional second arg NORECORD non-nil means
1675 do not put this buffer at the front of the list of recently selected ones.
1676 This function returns the buffer it switched to.
1678 WARNING: This is NOT the way to work on another buffer temporarily
1679 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1680 the window-buffer correspondences. */)
1681 (buffer, norecord)
1682 Lisp_Object buffer, norecord;
1684 char *err;
1686 if (EQ (buffer, Fwindow_buffer (selected_window)))
1687 /* Basically a NOP. Avoid signalling an error if the selected window
1688 is dedicated, or a minibuffer, ... */
1689 return Fset_buffer (buffer);
1691 err = no_switch_window (selected_window);
1692 if (err) error (err);
1694 return switch_to_buffer_1 (buffer, norecord);
1697 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1698 doc: /* Select buffer BUFFER in some window, preferably a different one.
1699 BUFFER may be a buffer, a string \(a buffer name), or nil.
1700 If BUFFER is a string which is not the name of an existing buffer,
1701 then this function creates a buffer with that name.
1702 If BUFFER is nil, then it chooses some other buffer.
1703 If `pop-up-windows' is non-nil, windows can be split to do this.
1704 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1705 window even if BUFFER is already visible in the selected window,
1706 and ignore `same-window-regexps' and `same-window-buffer-names'.
1707 This function returns the buffer it switched to.
1708 This uses the function `display-buffer' as a subroutine; see the documentation
1709 of `display-buffer' for additional customization information.
1711 Optional third arg NORECORD non-nil means
1712 do not put this buffer at the front of the list of recently selected ones. */)
1713 (buffer, other_window, norecord)
1714 Lisp_Object buffer, other_window, norecord;
1716 register Lisp_Object buf;
1717 if (NILP (buffer))
1718 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1719 else
1721 buf = Fget_buffer (buffer);
1722 if (NILP (buf))
1724 buf = Fget_buffer_create (buffer);
1725 Fset_buffer_major_mode (buf);
1728 Fset_buffer (buf);
1729 if (NILP (norecord))
1730 /* Why bother ? Fselect_window will do it for us anyway. -stef */
1731 record_buffer (buf);
1732 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1733 return buf;
1736 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1737 doc: /* Return the current buffer as a Lisp object. */)
1740 register Lisp_Object buf;
1741 XSETBUFFER (buf, current_buffer);
1742 return buf;
1745 /* Set the current buffer to B.
1747 We previously set windows_or_buffers_changed here to invalidate
1748 global unchanged information in beg_unchanged and end_unchanged.
1749 This is no longer necessary because we now compute unchanged
1750 information on a buffer-basis. Every action affecting other
1751 windows than the selected one requires a select_window at some
1752 time, and that increments windows_or_buffers_changed. */
1754 void
1755 set_buffer_internal (b)
1756 register struct buffer *b;
1758 if (current_buffer != b)
1759 set_buffer_internal_1 (b);
1762 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1763 This is used by redisplay. */
1765 void
1766 set_buffer_internal_1 (b)
1767 register struct buffer *b;
1769 register struct buffer *old_buf;
1770 register Lisp_Object tail, valcontents;
1771 Lisp_Object tem;
1773 #ifdef USE_MMAP_FOR_BUFFERS
1774 if (b->text->beg == NULL)
1775 enlarge_buffer_text (b, 0);
1776 #endif /* USE_MMAP_FOR_BUFFERS */
1778 if (current_buffer == b)
1779 return;
1781 old_buf = current_buffer;
1782 current_buffer = b;
1783 last_known_column_point = -1; /* invalidate indentation cache */
1785 if (old_buf)
1787 /* Put the undo list back in the base buffer, so that it appears
1788 that an indirect buffer shares the undo list of its base. */
1789 if (old_buf->base_buffer)
1790 old_buf->base_buffer->undo_list = old_buf->undo_list;
1792 /* If the old current buffer has markers to record PT, BEGV and ZV
1793 when it is not current, update them now. */
1794 if (! NILP (old_buf->pt_marker))
1796 Lisp_Object obuf;
1797 XSETBUFFER (obuf, old_buf);
1798 set_marker_both (old_buf->pt_marker, obuf,
1799 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1801 if (! NILP (old_buf->begv_marker))
1803 Lisp_Object obuf;
1804 XSETBUFFER (obuf, old_buf);
1805 set_marker_both (old_buf->begv_marker, obuf,
1806 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1808 if (! NILP (old_buf->zv_marker))
1810 Lisp_Object obuf;
1811 XSETBUFFER (obuf, old_buf);
1812 set_marker_both (old_buf->zv_marker, obuf,
1813 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1817 /* Get the undo list from the base buffer, so that it appears
1818 that an indirect buffer shares the undo list of its base. */
1819 if (b->base_buffer)
1820 b->undo_list = b->base_buffer->undo_list;
1822 /* If the new current buffer has markers to record PT, BEGV and ZV
1823 when it is not current, fetch them now. */
1824 if (! NILP (b->pt_marker))
1826 BUF_PT (b) = marker_position (b->pt_marker);
1827 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1829 if (! NILP (b->begv_marker))
1831 BUF_BEGV (b) = marker_position (b->begv_marker);
1832 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1834 if (! NILP (b->zv_marker))
1836 BUF_ZV (b) = marker_position (b->zv_marker);
1837 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1840 /* Look down buffer's list of local Lisp variables
1841 to find and update any that forward into C variables. */
1843 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1845 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1846 if ((BUFFER_LOCAL_VALUEP (valcontents)
1847 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1848 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1849 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1850 /* Just reference the variable
1851 to cause it to become set for this buffer. */
1852 Fsymbol_value (XCAR (XCAR (tail)));
1855 /* Do the same with any others that were local to the previous buffer */
1857 if (old_buf)
1858 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1860 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1861 if ((BUFFER_LOCAL_VALUEP (valcontents)
1862 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1863 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1864 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1865 /* Just reference the variable
1866 to cause it to become set for this buffer. */
1867 Fsymbol_value (XCAR (XCAR (tail)));
1871 /* Switch to buffer B temporarily for redisplay purposes.
1872 This avoids certain things that don't need to be done within redisplay. */
1874 void
1875 set_buffer_temp (b)
1876 struct buffer *b;
1878 register struct buffer *old_buf;
1880 if (current_buffer == b)
1881 return;
1883 old_buf = current_buffer;
1884 current_buffer = b;
1886 if (old_buf)
1888 /* If the old current buffer has markers to record PT, BEGV and ZV
1889 when it is not current, update them now. */
1890 if (! NILP (old_buf->pt_marker))
1892 Lisp_Object obuf;
1893 XSETBUFFER (obuf, old_buf);
1894 set_marker_both (old_buf->pt_marker, obuf,
1895 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1897 if (! NILP (old_buf->begv_marker))
1899 Lisp_Object obuf;
1900 XSETBUFFER (obuf, old_buf);
1901 set_marker_both (old_buf->begv_marker, obuf,
1902 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1904 if (! NILP (old_buf->zv_marker))
1906 Lisp_Object obuf;
1907 XSETBUFFER (obuf, old_buf);
1908 set_marker_both (old_buf->zv_marker, obuf,
1909 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1913 /* If the new current buffer has markers to record PT, BEGV and ZV
1914 when it is not current, fetch them now. */
1915 if (! NILP (b->pt_marker))
1917 BUF_PT (b) = marker_position (b->pt_marker);
1918 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1920 if (! NILP (b->begv_marker))
1922 BUF_BEGV (b) = marker_position (b->begv_marker);
1923 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1925 if (! NILP (b->zv_marker))
1927 BUF_ZV (b) = marker_position (b->zv_marker);
1928 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1932 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1933 doc: /* Make the buffer BUFFER current for editing operations.
1934 BUFFER may be a buffer or the name of an existing buffer.
1935 See also `save-excursion' when you want to make a buffer current temporarily.
1936 This function does not display the buffer, so its effect ends
1937 when the current command terminates.
1938 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1939 (buffer)
1940 register Lisp_Object buffer;
1942 register Lisp_Object buf;
1943 buf = Fget_buffer (buffer);
1944 if (NILP (buf))
1945 nsberror (buffer);
1946 if (NILP (XBUFFER (buf)->name))
1947 error ("Selecting deleted buffer");
1948 set_buffer_internal (XBUFFER (buf));
1949 return buf;
1952 /* Set the current buffer to BUFFER provided it is alive. */
1954 Lisp_Object
1955 set_buffer_if_live (buffer)
1956 Lisp_Object buffer;
1958 if (! NILP (XBUFFER (buffer)->name))
1959 Fset_buffer (buffer);
1960 return Qnil;
1963 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1964 Sbarf_if_buffer_read_only, 0, 0, 0,
1965 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1968 if (!NILP (current_buffer->read_only)
1969 && NILP (Vinhibit_read_only))
1970 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1971 return Qnil;
1974 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1975 doc: /* Put BUFFER at the end of the list of all buffers.
1976 There it is the least likely candidate for `other-buffer' to return;
1977 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1978 If BUFFER is nil or omitted, bury the current buffer.
1979 Also, if BUFFER is nil or omitted, remove the current buffer from the
1980 selected window if it is displayed there. */)
1981 (buffer)
1982 register Lisp_Object buffer;
1984 /* Figure out what buffer we're going to bury. */
1985 if (NILP (buffer))
1987 Lisp_Object tem;
1988 XSETBUFFER (buffer, current_buffer);
1990 tem = Fwindow_buffer (selected_window);
1991 /* If we're burying the current buffer, unshow it. */
1992 if (EQ (buffer, tem))
1994 if (NILP (Fwindow_dedicated_p (selected_window)))
1995 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1996 else if (NILP (XWINDOW (selected_window)->parent))
1997 Ficonify_frame (Fwindow_frame (selected_window));
1998 else
1999 Fdelete_window (selected_window);
2002 else
2004 Lisp_Object buf1;
2006 buf1 = Fget_buffer (buffer);
2007 if (NILP (buf1))
2008 nsberror (buffer);
2009 buffer = buf1;
2012 /* Move buffer to the end of the buffer list. Do nothing if the
2013 buffer is killed. */
2014 if (!NILP (XBUFFER (buffer)->name))
2016 Lisp_Object aelt, link;
2018 aelt = Frassq (buffer, Vbuffer_alist);
2019 link = Fmemq (aelt, Vbuffer_alist);
2020 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2021 XSETCDR (link, Qnil);
2022 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2024 /* Removing BUFFER from frame-specific lists
2025 has the effect of putting BUFFER at the end
2026 of the combined list in each frame. */
2027 frames_discard_buffer (buffer);
2030 return Qnil;
2033 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2034 doc: /* Delete the entire contents of the current buffer.
2035 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2036 so the buffer is truly empty after this. */)
2039 Fwiden ();
2041 del_range (BEG, Z);
2043 current_buffer->last_window_start = 1;
2044 /* Prevent warnings, or suspension of auto saving, that would happen
2045 if future size is less than past size. Use of erase-buffer
2046 implies that the future text is not really related to the past text. */
2047 XSETFASTINT (current_buffer->save_length, 0);
2048 return Qnil;
2051 void
2052 validate_region (b, e)
2053 register Lisp_Object *b, *e;
2055 CHECK_NUMBER_COERCE_MARKER (*b);
2056 CHECK_NUMBER_COERCE_MARKER (*e);
2058 if (XINT (*b) > XINT (*e))
2060 Lisp_Object tem;
2061 tem = *b; *b = *e; *e = tem;
2064 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2065 && XINT (*e) <= ZV))
2066 args_out_of_range (*b, *e);
2069 /* Advance BYTE_POS up to a character boundary
2070 and return the adjusted position. */
2072 static int
2073 advance_to_char_boundary (byte_pos)
2074 int byte_pos;
2076 int c;
2078 if (byte_pos == BEG)
2079 /* Beginning of buffer is always a character boundary. */
2080 return BEG;
2082 c = FETCH_BYTE (byte_pos);
2083 if (! CHAR_HEAD_P (c))
2085 /* We should advance BYTE_POS only when C is a constituent of a
2086 multibyte sequence. */
2087 int orig_byte_pos = byte_pos;
2091 byte_pos--;
2092 c = FETCH_BYTE (byte_pos);
2094 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2095 INC_POS (byte_pos);
2096 if (byte_pos < orig_byte_pos)
2097 byte_pos = orig_byte_pos;
2098 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2099 surely advance to the correct character boundary. If C is
2100 not, BYTE_POS was unchanged. */
2103 return byte_pos;
2106 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2107 1, 1, 0,
2108 doc: /* Set the multibyte flag of the current buffer to FLAG.
2109 If FLAG is t, this makes the buffer a multibyte buffer.
2110 If FLAG is nil, this makes the buffer a single-byte buffer.
2111 The buffer contents remain unchanged as a sequence of bytes
2112 but the contents viewed as characters do change.
2113 If the multibyte flag was really changed, undo information of the
2114 current buffer is cleared. */)
2115 (flag)
2116 Lisp_Object flag;
2118 struct Lisp_Marker *tail, *markers;
2119 struct buffer *other;
2120 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
2121 int begv, zv;
2122 int narrowed = (BEG != BEGV || Z != ZV);
2123 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2125 if (current_buffer->base_buffer)
2126 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2128 /* Do nothing if nothing actually changes. */
2129 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2130 return flag;
2132 /* It would be better to update the list,
2133 but this is good enough for now. */
2134 if (undo_enabled_p)
2135 current_buffer->undo_list = Qt;
2137 /* If the cached position is for this buffer, clear it out. */
2138 clear_charpos_cache (current_buffer);
2140 if (NILP (flag))
2141 begv = BEGV_BYTE, zv = ZV_BYTE;
2142 else
2143 begv = BEGV, zv = ZV;
2145 if (narrowed)
2146 Fwiden ();
2148 if (NILP (flag))
2150 int pos, stop;
2151 unsigned char *p;
2153 /* Do this first, so it can use CHAR_TO_BYTE
2154 to calculate the old correspondences. */
2155 set_intervals_multibyte (0);
2157 current_buffer->enable_multibyte_characters = Qnil;
2159 Z = Z_BYTE;
2160 BEGV = BEGV_BYTE;
2161 ZV = ZV_BYTE;
2162 GPT = GPT_BYTE;
2163 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2166 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2167 tail->charpos = tail->bytepos;
2169 /* Convert multibyte form of 8-bit characters to unibyte. */
2170 pos = BEG;
2171 stop = GPT;
2172 p = BEG_ADDR;
2173 while (1)
2175 int c, bytes;
2177 if (pos == stop)
2179 if (pos == Z)
2180 break;
2181 p = GAP_END_ADDR;
2182 stop = Z;
2184 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2185 p += bytes, pos += bytes;
2186 else
2188 c = STRING_CHAR (p, stop - pos);
2189 /* Delete all bytes for this 8-bit character but the
2190 last one, and change the last one to the charcter
2191 code. */
2192 bytes--;
2193 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2194 p = GAP_END_ADDR;
2195 *p++ = c;
2196 pos++;
2197 if (begv > pos)
2198 begv -= bytes;
2199 if (zv > pos)
2200 zv -= bytes;
2201 stop = Z;
2204 if (narrowed)
2205 Fnarrow_to_region (make_number (begv), make_number (zv));
2207 else
2209 int pt = PT;
2210 int pos, stop;
2211 unsigned char *p;
2213 /* Be sure not to have a multibyte sequence striding over the GAP.
2214 Ex: We change this: "...abc\201 _GAP_ \241def..."
2215 to: "...abc _GAP_ \201\241def..." */
2217 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2218 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2220 unsigned char *p = GPT_ADDR - 1;
2222 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2223 if (BASE_LEADING_CODE_P (*p))
2225 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2227 move_gap_both (new_gpt, new_gpt);
2231 /* Make the buffer contents valid as multibyte by converting
2232 8-bit characters to multibyte form. */
2233 pos = BEG;
2234 stop = GPT;
2235 p = BEG_ADDR;
2236 while (1)
2238 int bytes;
2240 if (pos == stop)
2242 if (pos == Z)
2243 break;
2244 p = GAP_END_ADDR;
2245 stop = Z;
2248 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2249 p += bytes, pos += bytes;
2250 else
2252 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2254 bytes = CHAR_STRING (*p, tmp);
2255 *p = tmp[0];
2256 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2257 bytes--;
2258 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2259 /* Now the gap is after the just inserted data. */
2260 pos = GPT;
2261 p = GAP_END_ADDR;
2262 if (pos <= begv)
2263 begv += bytes;
2264 if (pos <= zv)
2265 zv += bytes;
2266 if (pos <= pt)
2267 pt += bytes;
2268 stop = Z;
2272 if (pt != PT)
2273 TEMP_SET_PT (pt);
2275 if (narrowed)
2276 Fnarrow_to_region (make_number (begv), make_number (zv));
2278 /* Do this first, so that chars_in_text asks the right question.
2279 set_intervals_multibyte needs it too. */
2280 current_buffer->enable_multibyte_characters = Qt;
2282 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2283 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2285 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2287 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2288 if (BEGV_BYTE > GPT_BYTE)
2289 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2290 else
2291 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2293 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2294 if (ZV_BYTE > GPT_BYTE)
2295 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2296 else
2297 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2300 int pt_byte = advance_to_char_boundary (PT_BYTE);
2301 int pt;
2303 if (pt_byte > GPT_BYTE)
2304 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2305 else
2306 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2307 TEMP_SET_PT_BOTH (pt, pt_byte);
2310 tail = markers = BUF_MARKERS (current_buffer);
2312 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2313 getting confused by the markers that have not yet been updated.
2314 It is also a signal that it should never create a marker. */
2315 BUF_MARKERS (current_buffer) = NULL;
2317 for (; tail; tail = tail->next)
2319 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2320 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2323 /* Make sure no markers were put on the chain
2324 while the chain value was incorrect. */
2325 if (BUF_MARKERS (current_buffer))
2326 abort ();
2328 BUF_MARKERS (current_buffer) = markers;
2330 /* Do this last, so it can calculate the new correspondences
2331 between chars and bytes. */
2332 set_intervals_multibyte (1);
2335 if (undo_enabled_p)
2336 current_buffer->undo_list = Qnil;
2338 /* Changing the multibyteness of a buffer means that all windows
2339 showing that buffer must be updated thoroughly. */
2340 current_buffer->prevent_redisplay_optimizations_p = 1;
2341 ++windows_or_buffers_changed;
2343 /* Copy this buffer's new multibyte status
2344 into all of its indirect buffers. */
2345 for (other = all_buffers; other; other = other->next)
2346 if (other->base_buffer == current_buffer && !NILP (other->name))
2348 other->enable_multibyte_characters
2349 = current_buffer->enable_multibyte_characters;
2350 other->prevent_redisplay_optimizations_p = 1;
2353 /* Restore the modifiedness of the buffer. */
2354 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2355 Fset_buffer_modified_p (Qnil);
2357 #ifdef subprocesses
2358 /* Update coding systems of this buffer's process (if any). */
2360 Lisp_Object process;
2362 process = Fget_buffer_process (Fcurrent_buffer ());
2363 if (PROCESSP (process))
2364 setup_process_coding_systems (process);
2366 #endif /* subprocesses */
2368 return flag;
2371 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2372 0, 0, 0,
2373 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2374 Most local variable bindings are eliminated so that the default values
2375 become effective once more. Also, the syntax table is set from
2376 `standard-syntax-table', the local keymap is set to nil,
2377 and the abbrev table from `fundamental-mode-abbrev-table'.
2378 This function also forces redisplay of the mode line.
2380 Every function to select a new major mode starts by
2381 calling this function.
2383 As a special exception, local variables whose names have
2384 a non-nil `permanent-local' property are not eliminated by this function.
2386 The first thing this function does is run
2387 the normal hook `change-major-mode-hook'. */)
2390 register Lisp_Object alist, sym, tem;
2391 Lisp_Object oalist;
2393 if (!NILP (Vrun_hooks))
2394 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2395 oalist = current_buffer->local_var_alist;
2397 /* Make sure none of the bindings in oalist
2398 remain swapped in, in their symbols. */
2400 swap_out_buffer_local_variables (current_buffer);
2402 /* Actually eliminate all local bindings of this buffer. */
2404 reset_buffer_local_variables (current_buffer, 0);
2406 /* Any which are supposed to be permanent,
2407 make local again, with the same values they had. */
2409 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2411 sym = XCAR (XCAR (alist));
2412 tem = Fget (sym, Qpermanent_local);
2413 if (! NILP (tem))
2415 Fmake_local_variable (sym);
2416 Fset (sym, XCDR (XCAR (alist)));
2420 /* Force mode-line redisplay. Useful here because all major mode
2421 commands call this function. */
2422 update_mode_lines++;
2424 return Qnil;
2427 /* Make sure no local variables remain set up with buffer B
2428 for their current values. */
2430 static void
2431 swap_out_buffer_local_variables (b)
2432 struct buffer *b;
2434 Lisp_Object oalist, alist, sym, tem, buffer;
2436 XSETBUFFER (buffer, b);
2437 oalist = b->local_var_alist;
2439 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2441 sym = XCAR (XCAR (alist));
2443 /* Need not do anything if some other buffer's binding is now encached. */
2444 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2445 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2447 /* Symbol is set up for this buffer's old local value.
2448 Set it up for the current buffer with the default value. */
2450 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2451 /* Store the symbol's current value into the alist entry
2452 it is currently set up for. This is so that, if the
2453 local is marked permanent, and we make it local again
2454 later in Fkill_all_local_variables, we don't lose the value. */
2455 XSETCDR (XCAR (tem),
2456 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2457 /* Switch to the symbol's default-value alist entry. */
2458 XSETCAR (tem, tem);
2459 /* Mark it as current for buffer B. */
2460 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2461 /* Store the current value into any forwarding in the symbol. */
2462 store_symval_forwarding (sym,
2463 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2464 XCDR (tem), NULL);
2469 /* Find all the overlays in the current buffer that contain position POS.
2470 Return the number found, and store them in a vector in *VEC_PTR.
2471 Store in *LEN_PTR the size allocated for the vector.
2472 Store in *NEXT_PTR the next position after POS where an overlay starts,
2473 or ZV if there are no more overlays.
2474 Store in *PREV_PTR the previous position before POS where an overlay ends,
2475 or where an overlay starts which ends at or after POS;
2476 or BEGV if there are no such overlays.
2477 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2479 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2480 when this function is called.
2482 If EXTEND is non-zero, we make the vector bigger if necessary.
2483 If EXTEND is zero, we never extend the vector,
2484 and we store only as many overlays as will fit.
2485 But we still return the total number of overlays.
2487 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2488 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2489 default (BEGV or ZV). */
2492 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2493 EMACS_INT pos;
2494 int extend;
2495 Lisp_Object **vec_ptr;
2496 int *len_ptr;
2497 int *next_ptr;
2498 int *prev_ptr;
2499 int change_req;
2501 Lisp_Object overlay, start, end;
2502 struct Lisp_Overlay *tail;
2503 int idx = 0;
2504 int len = *len_ptr;
2505 Lisp_Object *vec = *vec_ptr;
2506 int next = ZV;
2507 int prev = BEGV;
2508 int inhibit_storing = 0;
2510 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2512 int startpos, endpos;
2514 XSETMISC (overlay, tail);
2516 start = OVERLAY_START (overlay);
2517 end = OVERLAY_END (overlay);
2518 endpos = OVERLAY_POSITION (end);
2519 if (endpos < pos)
2521 if (prev < endpos)
2522 prev = endpos;
2523 break;
2525 startpos = OVERLAY_POSITION (start);
2526 /* This one ends at or after POS
2527 so its start counts for PREV_PTR if it's before POS. */
2528 if (prev < startpos && startpos < pos)
2529 prev = startpos;
2530 if (endpos == pos)
2531 continue;
2532 if (startpos <= pos)
2534 if (idx == len)
2536 /* The supplied vector is full.
2537 Either make it bigger, or don't store any more in it. */
2538 if (extend)
2540 /* Make it work with an initial len == 0. */
2541 len *= 2;
2542 if (len == 0)
2543 len = 4;
2544 *len_ptr = len;
2545 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2546 *vec_ptr = vec;
2548 else
2549 inhibit_storing = 1;
2552 if (!inhibit_storing)
2553 vec[idx] = overlay;
2554 /* Keep counting overlays even if we can't return them all. */
2555 idx++;
2557 else if (startpos < next)
2558 next = startpos;
2561 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2563 int startpos, endpos;
2565 XSETMISC (overlay, tail);
2567 start = OVERLAY_START (overlay);
2568 end = OVERLAY_END (overlay);
2569 startpos = OVERLAY_POSITION (start);
2570 if (pos < startpos)
2572 if (startpos < next)
2573 next = startpos;
2574 break;
2576 endpos = OVERLAY_POSITION (end);
2577 if (pos < endpos)
2579 if (idx == len)
2581 if (extend)
2583 /* Make it work with an initial len == 0. */
2584 len *= 2;
2585 if (len == 0)
2586 len = 4;
2587 *len_ptr = len;
2588 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2589 *vec_ptr = vec;
2591 else
2592 inhibit_storing = 1;
2595 if (!inhibit_storing)
2596 vec[idx] = overlay;
2597 idx++;
2599 if (startpos < pos && startpos > prev)
2600 prev = startpos;
2602 else if (endpos < pos && endpos > prev)
2603 prev = endpos;
2604 else if (endpos == pos && startpos > prev
2605 && (!change_req || startpos < pos))
2606 prev = startpos;
2609 if (next_ptr)
2610 *next_ptr = next;
2611 if (prev_ptr)
2612 *prev_ptr = prev;
2613 return idx;
2616 /* Find all the overlays in the current buffer that overlap the range BEG-END
2617 or are empty at BEG.
2619 Return the number found, and store them in a vector in *VEC_PTR.
2620 Store in *LEN_PTR the size allocated for the vector.
2621 Store in *NEXT_PTR the next position after POS where an overlay starts,
2622 or ZV if there are no more overlays.
2623 Store in *PREV_PTR the previous position before POS where an overlay ends,
2624 or BEGV if there are no previous overlays.
2625 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2627 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2628 when this function is called.
2630 If EXTEND is non-zero, we make the vector bigger if necessary.
2631 If EXTEND is zero, we never extend the vector,
2632 and we store only as many overlays as will fit.
2633 But we still return the total number of overlays. */
2635 static int
2636 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2637 int beg, end;
2638 int extend;
2639 Lisp_Object **vec_ptr;
2640 int *len_ptr;
2641 int *next_ptr;
2642 int *prev_ptr;
2644 Lisp_Object overlay, ostart, oend;
2645 struct Lisp_Overlay *tail;
2646 int idx = 0;
2647 int len = *len_ptr;
2648 Lisp_Object *vec = *vec_ptr;
2649 int next = ZV;
2650 int prev = BEGV;
2651 int inhibit_storing = 0;
2653 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2655 int startpos, endpos;
2657 XSETMISC (overlay, tail);
2659 ostart = OVERLAY_START (overlay);
2660 oend = OVERLAY_END (overlay);
2661 endpos = OVERLAY_POSITION (oend);
2662 if (endpos < beg)
2664 if (prev < endpos)
2665 prev = endpos;
2666 break;
2668 startpos = OVERLAY_POSITION (ostart);
2669 /* Count an interval if it either overlaps the range
2670 or is empty at the start of the range. */
2671 if ((beg < endpos && startpos < end)
2672 || (startpos == endpos && beg == endpos))
2674 if (idx == len)
2676 /* The supplied vector is full.
2677 Either make it bigger, or don't store any more in it. */
2678 if (extend)
2680 /* Make it work with an initial len == 0. */
2681 len *= 2;
2682 if (len == 0)
2683 len = 4;
2684 *len_ptr = len;
2685 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2686 *vec_ptr = vec;
2688 else
2689 inhibit_storing = 1;
2692 if (!inhibit_storing)
2693 vec[idx] = overlay;
2694 /* Keep counting overlays even if we can't return them all. */
2695 idx++;
2697 else if (startpos < next)
2698 next = startpos;
2701 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2703 int startpos, endpos;
2705 XSETMISC (overlay, tail);
2707 ostart = OVERLAY_START (overlay);
2708 oend = OVERLAY_END (overlay);
2709 startpos = OVERLAY_POSITION (ostart);
2710 if (end < startpos)
2712 if (startpos < next)
2713 next = startpos;
2714 break;
2716 endpos = OVERLAY_POSITION (oend);
2717 /* Count an interval if it either overlaps the range
2718 or is empty at the start of the range. */
2719 if ((beg < endpos && startpos < end)
2720 || (startpos == endpos && beg == endpos))
2722 if (idx == len)
2724 if (extend)
2726 /* Make it work with an initial len == 0. */
2727 len *= 2;
2728 if (len == 0)
2729 len = 4;
2730 *len_ptr = len;
2731 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2732 *vec_ptr = vec;
2734 else
2735 inhibit_storing = 1;
2738 if (!inhibit_storing)
2739 vec[idx] = overlay;
2740 idx++;
2742 else if (endpos < beg && endpos > prev)
2743 prev = endpos;
2746 if (next_ptr)
2747 *next_ptr = next;
2748 if (prev_ptr)
2749 *prev_ptr = prev;
2750 return idx;
2754 /* Return non-zero if there exists an overlay with a non-nil
2755 `mouse-face' property overlapping OVERLAY. */
2758 mouse_face_overlay_overlaps (overlay)
2759 Lisp_Object overlay;
2761 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2762 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2763 int n, i, size;
2764 Lisp_Object *v, tem;
2766 size = 10;
2767 v = (Lisp_Object *) alloca (size * sizeof *v);
2768 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2769 if (n > size)
2771 v = (Lisp_Object *) alloca (n * sizeof *v);
2772 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2775 for (i = 0; i < n; ++i)
2776 if (!EQ (v[i], overlay)
2777 && (tem = Foverlay_get (overlay, Qmouse_face),
2778 !NILP (tem)))
2779 break;
2781 return i < n;
2786 /* Fast function to just test if we're at an overlay boundary. */
2788 overlay_touches_p (pos)
2789 int pos;
2791 Lisp_Object overlay;
2792 struct Lisp_Overlay *tail;
2794 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2796 int endpos;
2798 XSETMISC (overlay ,tail);
2799 if (!GC_OVERLAYP (overlay))
2800 abort ();
2802 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2803 if (endpos < pos)
2804 break;
2805 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2806 return 1;
2809 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2811 int startpos;
2813 XSETMISC (overlay, tail);
2814 if (!GC_OVERLAYP (overlay))
2815 abort ();
2817 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2818 if (pos < startpos)
2819 break;
2820 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2821 return 1;
2823 return 0;
2826 struct sortvec
2828 Lisp_Object overlay;
2829 int beg, end;
2830 int priority;
2833 static int
2834 compare_overlays (v1, v2)
2835 const void *v1, *v2;
2837 const struct sortvec *s1 = (const struct sortvec *) v1;
2838 const struct sortvec *s2 = (const struct sortvec *) v2;
2839 if (s1->priority != s2->priority)
2840 return s1->priority - s2->priority;
2841 if (s1->beg != s2->beg)
2842 return s1->beg - s2->beg;
2843 if (s1->end != s2->end)
2844 return s2->end - s1->end;
2845 return 0;
2848 /* Sort an array of overlays by priority. The array is modified in place.
2849 The return value is the new size; this may be smaller than the original
2850 size if some of the overlays were invalid or were window-specific. */
2852 sort_overlays (overlay_vec, noverlays, w)
2853 Lisp_Object *overlay_vec;
2854 int noverlays;
2855 struct window *w;
2857 int i, j;
2858 struct sortvec *sortvec;
2859 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2861 /* Put the valid and relevant overlays into sortvec. */
2863 for (i = 0, j = 0; i < noverlays; i++)
2865 Lisp_Object tem;
2866 Lisp_Object overlay;
2868 overlay = overlay_vec[i];
2869 if (OVERLAY_VALID (overlay)
2870 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2871 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2873 /* If we're interested in a specific window, then ignore
2874 overlays that are limited to some other window. */
2875 if (w)
2877 Lisp_Object window;
2879 window = Foverlay_get (overlay, Qwindow);
2880 if (WINDOWP (window) && XWINDOW (window) != w)
2881 continue;
2884 /* This overlay is good and counts: put it into sortvec. */
2885 sortvec[j].overlay = overlay;
2886 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2887 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2888 tem = Foverlay_get (overlay, Qpriority);
2889 if (INTEGERP (tem))
2890 sortvec[j].priority = XINT (tem);
2891 else
2892 sortvec[j].priority = 0;
2893 j++;
2896 noverlays = j;
2898 /* Sort the overlays into the proper order: increasing priority. */
2900 if (noverlays > 1)
2901 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2903 for (i = 0; i < noverlays; i++)
2904 overlay_vec[i] = sortvec[i].overlay;
2905 return (noverlays);
2908 struct sortstr
2910 Lisp_Object string, string2;
2911 int size;
2912 int priority;
2915 struct sortstrlist
2917 struct sortstr *buf; /* An array that expands as needed; never freed. */
2918 int size; /* Allocated length of that array. */
2919 int used; /* How much of the array is currently in use. */
2920 int bytes; /* Total length of the strings in buf. */
2923 /* Buffers for storing information about the overlays touching a given
2924 position. These could be automatic variables in overlay_strings, but
2925 it's more efficient to hold onto the memory instead of repeatedly
2926 allocating and freeing it. */
2927 static struct sortstrlist overlay_heads, overlay_tails;
2928 static unsigned char *overlay_str_buf;
2930 /* Allocated length of overlay_str_buf. */
2931 static int overlay_str_len;
2933 /* A comparison function suitable for passing to qsort. */
2934 static int
2935 cmp_for_strings (as1, as2)
2936 char *as1, *as2;
2938 struct sortstr *s1 = (struct sortstr *)as1;
2939 struct sortstr *s2 = (struct sortstr *)as2;
2940 if (s1->size != s2->size)
2941 return s2->size - s1->size;
2942 if (s1->priority != s2->priority)
2943 return s1->priority - s2->priority;
2944 return 0;
2947 static void
2948 record_overlay_string (ssl, str, str2, pri, size)
2949 struct sortstrlist *ssl;
2950 Lisp_Object str, str2, pri;
2951 int size;
2953 int nbytes;
2955 if (ssl->used == ssl->size)
2957 if (ssl->buf)
2958 ssl->size *= 2;
2959 else
2960 ssl->size = 5;
2961 ssl->buf = ((struct sortstr *)
2962 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2964 ssl->buf[ssl->used].string = str;
2965 ssl->buf[ssl->used].string2 = str2;
2966 ssl->buf[ssl->used].size = size;
2967 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2968 ssl->used++;
2970 if (NILP (current_buffer->enable_multibyte_characters))
2971 nbytes = SCHARS (str);
2972 else if (! STRING_MULTIBYTE (str))
2973 nbytes = count_size_as_multibyte (SDATA (str),
2974 SBYTES (str));
2975 else
2976 nbytes = SBYTES (str);
2978 ssl->bytes += nbytes;
2980 if (STRINGP (str2))
2982 if (NILP (current_buffer->enable_multibyte_characters))
2983 nbytes = SCHARS (str2);
2984 else if (! STRING_MULTIBYTE (str2))
2985 nbytes = count_size_as_multibyte (SDATA (str2),
2986 SBYTES (str2));
2987 else
2988 nbytes = SBYTES (str2);
2990 ssl->bytes += nbytes;
2994 /* Return the concatenation of the strings associated with overlays that
2995 begin or end at POS, ignoring overlays that are specific to a window
2996 other than W. The strings are concatenated in the appropriate order:
2997 shorter overlays nest inside longer ones, and higher priority inside
2998 lower. Normally all of the after-strings come first, but zero-sized
2999 overlays have their after-strings ride along with the before-strings
3000 because it would look strange to print them inside-out.
3002 Returns the string length, and stores the contents indirectly through
3003 PSTR, if that variable is non-null. The string may be overwritten by
3004 subsequent calls. */
3007 overlay_strings (pos, w, pstr)
3008 EMACS_INT pos;
3009 struct window *w;
3010 unsigned char **pstr;
3012 Lisp_Object overlay, window, str;
3013 struct Lisp_Overlay *ov;
3014 int startpos, endpos;
3015 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3017 overlay_heads.used = overlay_heads.bytes = 0;
3018 overlay_tails.used = overlay_tails.bytes = 0;
3019 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3021 XSETMISC (overlay, ov);
3022 eassert (OVERLAYP (overlay));
3024 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3025 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3026 if (endpos < pos)
3027 break;
3028 if (endpos != pos && startpos != pos)
3029 continue;
3030 window = Foverlay_get (overlay, Qwindow);
3031 if (WINDOWP (window) && XWINDOW (window) != w)
3032 continue;
3033 if (startpos == pos
3034 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3035 record_overlay_string (&overlay_heads, str,
3036 (startpos == endpos
3037 ? Foverlay_get (overlay, Qafter_string)
3038 : Qnil),
3039 Foverlay_get (overlay, Qpriority),
3040 endpos - startpos);
3041 else if (endpos == pos
3042 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3043 record_overlay_string (&overlay_tails, str, Qnil,
3044 Foverlay_get (overlay, Qpriority),
3045 endpos - startpos);
3047 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3049 XSETMISC (overlay, ov);
3050 eassert (OVERLAYP (overlay));
3052 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3053 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3054 if (startpos > pos)
3055 break;
3056 if (endpos != pos && startpos != pos)
3057 continue;
3058 window = Foverlay_get (overlay, Qwindow);
3059 if (WINDOWP (window) && XWINDOW (window) != w)
3060 continue;
3061 if (startpos == pos
3062 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3063 record_overlay_string (&overlay_heads, str,
3064 (startpos == endpos
3065 ? Foverlay_get (overlay, Qafter_string)
3066 : Qnil),
3067 Foverlay_get (overlay, Qpriority),
3068 endpos - startpos);
3069 else if (endpos == pos
3070 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3071 record_overlay_string (&overlay_tails, str, Qnil,
3072 Foverlay_get (overlay, Qpriority),
3073 endpos - startpos);
3075 if (overlay_tails.used > 1)
3076 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3077 cmp_for_strings);
3078 if (overlay_heads.used > 1)
3079 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3080 cmp_for_strings);
3081 if (overlay_heads.bytes || overlay_tails.bytes)
3083 Lisp_Object tem;
3084 int i;
3085 unsigned char *p;
3086 int total = overlay_heads.bytes + overlay_tails.bytes;
3088 if (total > overlay_str_len)
3090 overlay_str_len = total;
3091 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3092 total);
3094 p = overlay_str_buf;
3095 for (i = overlay_tails.used; --i >= 0;)
3097 int nbytes;
3098 tem = overlay_tails.buf[i].string;
3099 nbytes = copy_text (SDATA (tem), p,
3100 SBYTES (tem),
3101 STRING_MULTIBYTE (tem), multibyte);
3102 p += nbytes;
3104 for (i = 0; i < overlay_heads.used; ++i)
3106 int nbytes;
3107 tem = overlay_heads.buf[i].string;
3108 nbytes = copy_text (SDATA (tem), p,
3109 SBYTES (tem),
3110 STRING_MULTIBYTE (tem), multibyte);
3111 p += nbytes;
3112 tem = overlay_heads.buf[i].string2;
3113 if (STRINGP (tem))
3115 nbytes = copy_text (SDATA (tem), p,
3116 SBYTES (tem),
3117 STRING_MULTIBYTE (tem), multibyte);
3118 p += nbytes;
3121 if (p != overlay_str_buf + total)
3122 abort ();
3123 if (pstr)
3124 *pstr = overlay_str_buf;
3125 return total;
3127 return 0;
3130 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3132 void
3133 recenter_overlay_lists (buf, pos)
3134 struct buffer *buf;
3135 EMACS_INT pos;
3137 Lisp_Object overlay, beg, end;
3138 struct Lisp_Overlay *prev, *tail, *next;
3140 /* See if anything in overlays_before should move to overlays_after. */
3142 /* We don't strictly need prev in this loop; it should always be nil.
3143 But we use it for symmetry and in case that should cease to be true
3144 with some future change. */
3145 prev = NULL;
3146 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3148 next = tail->next;
3149 XSETMISC (overlay, tail);
3151 /* If the overlay is not valid, get rid of it. */
3152 if (!OVERLAY_VALID (overlay))
3153 #if 1
3154 abort ();
3155 #else
3157 /* Splice the cons cell TAIL out of overlays_before. */
3158 if (!NILP (prev))
3159 XCDR (prev) = next;
3160 else
3161 buf->overlays_before = next;
3162 tail = prev;
3163 continue;
3165 #endif
3167 beg = OVERLAY_START (overlay);
3168 end = OVERLAY_END (overlay);
3170 if (OVERLAY_POSITION (end) > pos)
3172 /* OVERLAY needs to be moved. */
3173 int where = OVERLAY_POSITION (beg);
3174 struct Lisp_Overlay *other, *other_prev;
3176 /* Splice the cons cell TAIL out of overlays_before. */
3177 if (prev)
3178 prev->next = next;
3179 else
3180 buf->overlays_before = next;
3182 /* Search thru overlays_after for where to put it. */
3183 other_prev = NULL;
3184 for (other = buf->overlays_after; other;
3185 other_prev = other, other = other->next)
3187 Lisp_Object otherbeg, otheroverlay;
3189 XSETMISC (otheroverlay, other);
3190 eassert (OVERLAY_VALID (otheroverlay));
3192 otherbeg = OVERLAY_START (otheroverlay);
3193 if (OVERLAY_POSITION (otherbeg) >= where)
3194 break;
3197 /* Add TAIL to overlays_after before OTHER. */
3198 tail->next = other;
3199 if (other_prev)
3200 other_prev->next = tail;
3201 else
3202 buf->overlays_after = tail;
3203 tail = prev;
3205 else
3206 /* We've reached the things that should stay in overlays_before.
3207 All the rest of overlays_before must end even earlier,
3208 so stop now. */
3209 break;
3212 /* See if anything in overlays_after should be in overlays_before. */
3213 prev = NULL;
3214 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3216 next = tail->next;
3217 XSETMISC (overlay, tail);
3219 /* If the overlay is not valid, get rid of it. */
3220 if (!OVERLAY_VALID (overlay))
3221 #if 1
3222 abort ();
3223 #else
3225 /* Splice the cons cell TAIL out of overlays_after. */
3226 if (!NILP (prev))
3227 XCDR (prev) = next;
3228 else
3229 buf->overlays_after = next;
3230 tail = prev;
3231 continue;
3233 #endif
3235 beg = OVERLAY_START (overlay);
3236 end = OVERLAY_END (overlay);
3238 /* Stop looking, when we know that nothing further
3239 can possibly end before POS. */
3240 if (OVERLAY_POSITION (beg) > pos)
3241 break;
3243 if (OVERLAY_POSITION (end) <= pos)
3245 /* OVERLAY needs to be moved. */
3246 int where = OVERLAY_POSITION (end);
3247 struct Lisp_Overlay *other, *other_prev;
3249 /* Splice the cons cell TAIL out of overlays_after. */
3250 if (prev)
3251 prev->next = next;
3252 else
3253 buf->overlays_after = next;
3255 /* Search thru overlays_before for where to put it. */
3256 other_prev = NULL;
3257 for (other = buf->overlays_before; other;
3258 other_prev = other, other = other->next)
3260 Lisp_Object otherend, otheroverlay;
3262 XSETMISC (otheroverlay, other);
3263 eassert (OVERLAY_VALID (otheroverlay));
3265 otherend = OVERLAY_END (otheroverlay);
3266 if (OVERLAY_POSITION (otherend) <= where)
3267 break;
3270 /* Add TAIL to overlays_before before OTHER. */
3271 tail->next = other;
3272 if (other_prev)
3273 other_prev->next = tail;
3274 else
3275 buf->overlays_before = tail;
3276 tail = prev;
3280 buf->overlay_center = pos;
3283 void
3284 adjust_overlays_for_insert (pos, length)
3285 EMACS_INT pos;
3286 EMACS_INT length;
3288 /* After an insertion, the lists are still sorted properly,
3289 but we may need to update the value of the overlay center. */
3290 if (current_buffer->overlay_center >= pos)
3291 current_buffer->overlay_center += length;
3294 void
3295 adjust_overlays_for_delete (pos, length)
3296 EMACS_INT pos;
3297 EMACS_INT length;
3299 if (current_buffer->overlay_center < pos)
3300 /* The deletion was to our right. No change needed; the before- and
3301 after-lists are still consistent. */
3303 else if (current_buffer->overlay_center > pos + length)
3304 /* The deletion was to our left. We need to adjust the center value
3305 to account for the change in position, but the lists are consistent
3306 given the new value. */
3307 current_buffer->overlay_center -= length;
3308 else
3309 /* We're right in the middle. There might be things on the after-list
3310 that now belong on the before-list. Recentering will move them,
3311 and also update the center point. */
3312 recenter_overlay_lists (current_buffer, pos);
3315 /* Fix up overlays that were garbled as a result of permuting markers
3316 in the range START through END. Any overlay with at least one
3317 endpoint in this range will need to be unlinked from the overlay
3318 list and reinserted in its proper place.
3319 Such an overlay might even have negative size at this point.
3320 If so, we'll make the overlay empty. */
3321 void
3322 fix_start_end_in_overlays (start, end)
3323 register int start, end;
3325 Lisp_Object overlay;
3326 struct Lisp_Overlay *before_list, *after_list;
3327 /* These are either nil, indicating that before_list or after_list
3328 should be assigned, or the cons cell the cdr of which should be
3329 assigned. */
3330 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3331 /* 'Parent', likewise, indicates a cons cell or
3332 current_buffer->overlays_before or overlays_after, depending
3333 which loop we're in. */
3334 struct Lisp_Overlay *tail, *parent;
3335 int startpos, endpos;
3337 /* This algorithm shifts links around instead of consing and GCing.
3338 The loop invariant is that before_list (resp. after_list) is a
3339 well-formed list except that its last element, the CDR of beforep
3340 (resp. afterp) if beforep (afterp) isn't nil or before_list
3341 (after_list) if it is, is still uninitialized. So it's not a bug
3342 that before_list isn't initialized, although it may look
3343 strange. */
3344 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3346 XSETMISC (overlay, tail);
3348 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3349 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3351 /* If the overlay is backwards, make it empty. */
3352 if (endpos < startpos)
3354 startpos = endpos;
3355 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3356 Qnil);
3359 if (endpos < start)
3360 break;
3362 if (endpos < end
3363 || (startpos >= start && startpos < end))
3365 /* Add it to the end of the wrong list. Later on,
3366 recenter_overlay_lists will move it to the right place. */
3367 if (endpos < current_buffer->overlay_center)
3369 if (!afterp)
3370 after_list = tail;
3371 else
3372 afterp->next = tail;
3373 afterp = tail;
3375 else
3377 if (!beforep)
3378 before_list = tail;
3379 else
3380 beforep->next = tail;
3381 beforep = tail;
3383 if (!parent)
3384 current_buffer->overlays_before = tail->next;
3385 else
3386 parent->next = tail->next;
3387 tail = tail->next;
3389 else
3390 parent = tail, tail = parent->next;
3392 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3394 XSETMISC (overlay, tail);
3396 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3397 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3399 /* If the overlay is backwards, make it empty. */
3400 if (endpos < startpos)
3402 startpos = endpos;
3403 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3404 Qnil);
3407 if (startpos >= end)
3408 break;
3410 if (startpos >= start
3411 || (endpos >= start && endpos < end))
3413 if (endpos < current_buffer->overlay_center)
3415 if (!afterp)
3416 after_list = tail;
3417 else
3418 afterp->next = tail;
3419 afterp = tail;
3421 else
3423 if (!beforep)
3424 before_list = tail;
3425 else
3426 beforep->next = tail;
3427 beforep = tail;
3429 if (!parent)
3430 current_buffer->overlays_after = tail->next;
3431 else
3432 parent->next = tail->next;
3433 tail = tail->next;
3435 else
3436 parent = tail, tail = parent->next;
3439 /* Splice the constructed (wrong) lists into the buffer's lists,
3440 and let the recenter function make it sane again. */
3441 if (beforep)
3443 beforep->next = current_buffer->overlays_before;
3444 current_buffer->overlays_before = before_list;
3446 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3448 if (afterp)
3450 afterp->next = current_buffer->overlays_after;
3451 current_buffer->overlays_after = after_list;
3453 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3456 /* We have two types of overlay: the one whose ending marker is
3457 after-insertion-marker (this is the usual case) and the one whose
3458 ending marker is before-insertion-marker. When `overlays_before'
3459 contains overlays of the latter type and the former type in this
3460 order and both overlays end at inserting position, inserting a text
3461 increases only the ending marker of the latter type, which results
3462 in incorrect ordering of `overlays_before'.
3464 This function fixes ordering of overlays in the slot
3465 `overlays_before' of the buffer *BP. Before the insertion, `point'
3466 was at PREV, and now is at POS. */
3468 void
3469 fix_overlays_before (bp, prev, pos)
3470 struct buffer *bp;
3471 EMACS_INT prev, pos;
3473 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3474 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3475 Lisp_Object tem;
3476 EMACS_INT end;
3478 /* After the insertion, the several overlays may be in incorrect
3479 order. The possibility is that, in the list `overlays_before',
3480 an overlay which ends at POS appears after an overlay which ends
3481 at PREV. Since POS is greater than PREV, we must fix the
3482 ordering of these overlays, by moving overlays ends at POS before
3483 the overlays ends at PREV. */
3485 /* At first, find a place where disordered overlays should be linked
3486 in. It is where an overlay which end before POS exists. (i.e. an
3487 overlay whose ending marker is after-insertion-marker if disorder
3488 exists). */
3489 while (tail
3490 && (XSETMISC (tem, tail),
3491 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3493 parent = tail;
3494 tail = tail->next;
3497 /* If we don't find such an overlay,
3498 or the found one ends before PREV,
3499 or the found one is the last one in the list,
3500 we don't have to fix anything. */
3501 if (!tail || end < prev || !tail->next)
3502 return;
3504 right_pair = parent;
3505 parent = tail;
3506 tail = tail->next;
3508 /* Now, end position of overlays in the list TAIL should be before
3509 or equal to PREV. In the loop, an overlay which ends at POS is
3510 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3511 we found an overlay which ends before PREV, the remaining
3512 overlays are in correct order. */
3513 while (tail)
3515 XSETMISC (tem, tail);
3516 end = OVERLAY_POSITION (OVERLAY_END (tem));
3518 if (end == pos)
3519 { /* This overlay is disordered. */
3520 struct Lisp_Overlay *found = tail;
3522 /* Unlink the found overlay. */
3523 tail = found->next;
3524 parent->next = tail;
3525 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3526 and link it into the right place. */
3527 if (!right_pair)
3529 found->next = bp->overlays_before;
3530 bp->overlays_before = found;
3532 else
3534 found->next = right_pair->next;
3535 right_pair->next = found;
3538 else if (end == prev)
3540 parent = tail;
3541 tail = tail->next;
3543 else /* No more disordered overlay. */
3544 break;
3548 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3549 doc: /* Return t if OBJECT is an overlay. */)
3550 (object)
3551 Lisp_Object object;
3553 return (OVERLAYP (object) ? Qt : Qnil);
3556 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3557 doc: /* Create a new overlay with range BEG to END in BUFFER.
3558 If omitted, BUFFER defaults to the current buffer.
3559 BEG and END may be integers or markers.
3560 The fourth arg FRONT-ADVANCE, if non-nil, makes the
3561 front delimiter advance when text is inserted there.
3562 The fifth arg REAR-ADVANCE, if non-nil, makes the
3563 rear delimiter advance when text is inserted there. */)
3564 (beg, end, buffer, front_advance, rear_advance)
3565 Lisp_Object beg, end, buffer;
3566 Lisp_Object front_advance, rear_advance;
3568 Lisp_Object overlay;
3569 struct buffer *b;
3571 if (NILP (buffer))
3572 XSETBUFFER (buffer, current_buffer);
3573 else
3574 CHECK_BUFFER (buffer);
3575 if (MARKERP (beg)
3576 && ! EQ (Fmarker_buffer (beg), buffer))
3577 error ("Marker points into wrong buffer");
3578 if (MARKERP (end)
3579 && ! EQ (Fmarker_buffer (end), buffer))
3580 error ("Marker points into wrong buffer");
3582 CHECK_NUMBER_COERCE_MARKER (beg);
3583 CHECK_NUMBER_COERCE_MARKER (end);
3585 if (XINT (beg) > XINT (end))
3587 Lisp_Object temp;
3588 temp = beg; beg = end; end = temp;
3591 b = XBUFFER (buffer);
3593 beg = Fset_marker (Fmake_marker (), beg, buffer);
3594 end = Fset_marker (Fmake_marker (), end, buffer);
3596 if (!NILP (front_advance))
3597 XMARKER (beg)->insertion_type = 1;
3598 if (!NILP (rear_advance))
3599 XMARKER (end)->insertion_type = 1;
3601 overlay = allocate_misc ();
3602 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3603 XOVERLAY (overlay)->start = beg;
3604 XOVERLAY (overlay)->end = end;
3605 XOVERLAY (overlay)->plist = Qnil;
3606 XOVERLAY (overlay)->next = NULL;
3608 /* Put the new overlay on the wrong list. */
3609 end = OVERLAY_END (overlay);
3610 if (OVERLAY_POSITION (end) < b->overlay_center)
3612 if (b->overlays_after)
3613 XOVERLAY (overlay)->next = b->overlays_after;
3614 b->overlays_after = XOVERLAY (overlay);
3616 else
3618 if (b->overlays_before)
3619 XOVERLAY (overlay)->next = b->overlays_before;
3620 b->overlays_before = XOVERLAY (overlay);
3623 /* This puts it in the right list, and in the right order. */
3624 recenter_overlay_lists (b, b->overlay_center);
3626 /* We don't need to redisplay the region covered by the overlay, because
3627 the overlay has no properties at the moment. */
3629 return overlay;
3632 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3634 static void
3635 modify_overlay (buf, start, end)
3636 struct buffer *buf;
3637 EMACS_INT start, end;
3639 if (start > end)
3641 int temp = start;
3642 start = end;
3643 end = temp;
3646 BUF_COMPUTE_UNCHANGED (buf, start, end);
3648 /* If this is a buffer not in the selected window,
3649 we must do other windows. */
3650 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3651 windows_or_buffers_changed = 1;
3652 /* If multiple windows show this buffer, we must do other windows. */
3653 else if (buffer_shared > 1)
3654 windows_or_buffers_changed = 1;
3656 ++BUF_OVERLAY_MODIFF (buf);
3660 Lisp_Object Fdelete_overlay ();
3662 static struct Lisp_Overlay *
3663 unchain_overlay (list, overlay)
3664 struct Lisp_Overlay *list, *overlay;
3666 struct Lisp_Overlay *tmp, *prev;
3667 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3668 if (tmp == overlay)
3670 if (prev)
3671 prev->next = tmp->next;
3672 else
3673 list = tmp->next;
3674 overlay->next = NULL;
3675 break;
3677 return list;
3680 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3681 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3682 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3683 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3684 buffer. */)
3685 (overlay, beg, end, buffer)
3686 Lisp_Object overlay, beg, end, buffer;
3688 struct buffer *b, *ob;
3689 Lisp_Object obuffer;
3690 int count = SPECPDL_INDEX ();
3692 CHECK_OVERLAY (overlay);
3693 if (NILP (buffer))
3694 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3695 if (NILP (buffer))
3696 XSETBUFFER (buffer, current_buffer);
3697 CHECK_BUFFER (buffer);
3699 if (MARKERP (beg)
3700 && ! EQ (Fmarker_buffer (beg), buffer))
3701 error ("Marker points into wrong buffer");
3702 if (MARKERP (end)
3703 && ! EQ (Fmarker_buffer (end), buffer))
3704 error ("Marker points into wrong buffer");
3706 CHECK_NUMBER_COERCE_MARKER (beg);
3707 CHECK_NUMBER_COERCE_MARKER (end);
3709 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3710 return Fdelete_overlay (overlay);
3712 if (XINT (beg) > XINT (end))
3714 Lisp_Object temp;
3715 temp = beg; beg = end; end = temp;
3718 specbind (Qinhibit_quit, Qt);
3720 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3721 b = XBUFFER (buffer);
3722 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3724 /* If the overlay has changed buffers, do a thorough redisplay. */
3725 if (!EQ (buffer, obuffer))
3727 /* Redisplay where the overlay was. */
3728 if (!NILP (obuffer))
3730 int o_beg;
3731 int o_end;
3733 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3734 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3736 modify_overlay (ob, o_beg, o_end);
3739 /* Redisplay where the overlay is going to be. */
3740 modify_overlay (b, XINT (beg), XINT (end));
3742 else
3743 /* Redisplay the area the overlay has just left, or just enclosed. */
3745 int o_beg, o_end;
3747 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3748 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3750 if (o_beg == XINT (beg))
3751 modify_overlay (b, o_end, XINT (end));
3752 else if (o_end == XINT (end))
3753 modify_overlay (b, o_beg, XINT (beg));
3754 else
3756 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3757 if (XINT (end) > o_end) o_end = XINT (end);
3758 modify_overlay (b, o_beg, o_end);
3762 if (!NILP (obuffer))
3764 ob->overlays_before
3765 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3766 ob->overlays_after
3767 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3768 eassert (XOVERLAY (overlay)->next == NULL);
3771 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3772 Fset_marker (OVERLAY_END (overlay), end, buffer);
3774 /* Put the overlay on the wrong list. */
3775 end = OVERLAY_END (overlay);
3776 if (OVERLAY_POSITION (end) < b->overlay_center)
3778 XOVERLAY (overlay)->next = b->overlays_after;
3779 b->overlays_after = XOVERLAY (overlay);
3781 else
3783 XOVERLAY (overlay)->next = b->overlays_before;
3784 b->overlays_before = XOVERLAY (overlay);
3787 /* This puts it in the right list, and in the right order. */
3788 recenter_overlay_lists (b, b->overlay_center);
3790 return unbind_to (count, overlay);
3793 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3794 doc: /* Delete the overlay OVERLAY from its buffer. */)
3795 (overlay)
3796 Lisp_Object overlay;
3798 Lisp_Object buffer;
3799 struct buffer *b;
3800 int count = SPECPDL_INDEX ();
3802 CHECK_OVERLAY (overlay);
3804 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3805 if (NILP (buffer))
3806 return Qnil;
3808 b = XBUFFER (buffer);
3809 specbind (Qinhibit_quit, Qt);
3811 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3812 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3813 eassert (XOVERLAY (overlay)->next == NULL);
3814 modify_overlay (b,
3815 marker_position (OVERLAY_START (overlay)),
3816 marker_position (OVERLAY_END (overlay)));
3817 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3818 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3820 /* When deleting an overlay with before or after strings, turn off
3821 display optimizations for the affected buffer, on the basis that
3822 these strings may contain newlines. This is easier to do than to
3823 check for that situation during redisplay. */
3824 if (!windows_or_buffers_changed
3825 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3826 || !NILP (Foverlay_get (overlay, Qafter_string))))
3827 b->prevent_redisplay_optimizations_p = 1;
3829 return unbind_to (count, Qnil);
3832 /* Overlay dissection functions. */
3834 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3835 doc: /* Return the position at which OVERLAY starts. */)
3836 (overlay)
3837 Lisp_Object overlay;
3839 CHECK_OVERLAY (overlay);
3841 return (Fmarker_position (OVERLAY_START (overlay)));
3844 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3845 doc: /* Return the position at which OVERLAY ends. */)
3846 (overlay)
3847 Lisp_Object overlay;
3849 CHECK_OVERLAY (overlay);
3851 return (Fmarker_position (OVERLAY_END (overlay)));
3854 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3855 doc: /* Return the buffer OVERLAY belongs to. */)
3856 (overlay)
3857 Lisp_Object overlay;
3859 CHECK_OVERLAY (overlay);
3861 return Fmarker_buffer (OVERLAY_START (overlay));
3864 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3865 doc: /* Return a list of the properties on OVERLAY.
3866 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3867 OVERLAY. */)
3868 (overlay)
3869 Lisp_Object overlay;
3871 CHECK_OVERLAY (overlay);
3873 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3877 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3878 doc: /* Return a list of the overlays that contain position POS. */)
3879 (pos)
3880 Lisp_Object pos;
3882 int noverlays;
3883 Lisp_Object *overlay_vec;
3884 int len;
3885 Lisp_Object result;
3887 CHECK_NUMBER_COERCE_MARKER (pos);
3889 len = 10;
3890 /* We can't use alloca here because overlays_at can call xrealloc. */
3891 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3893 /* Put all the overlays we want in a vector in overlay_vec.
3894 Store the length in len. */
3895 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3896 (int *) 0, (int *) 0, 0);
3898 /* Make a list of them all. */
3899 result = Flist (noverlays, overlay_vec);
3901 xfree (overlay_vec);
3902 return result;
3905 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3906 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3907 Overlap means that at least one character is contained within the overlay
3908 and also contained within the specified region.
3909 Empty overlays are included in the result if they are located at BEG
3910 or between BEG and END. */)
3911 (beg, end)
3912 Lisp_Object beg, end;
3914 int noverlays;
3915 Lisp_Object *overlay_vec;
3916 int len;
3917 Lisp_Object result;
3919 CHECK_NUMBER_COERCE_MARKER (beg);
3920 CHECK_NUMBER_COERCE_MARKER (end);
3922 len = 10;
3923 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3925 /* Put all the overlays we want in a vector in overlay_vec.
3926 Store the length in len. */
3927 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3928 (int *) 0, (int *) 0);
3930 /* Make a list of them all. */
3931 result = Flist (noverlays, overlay_vec);
3933 xfree (overlay_vec);
3934 return result;
3937 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3938 1, 1, 0,
3939 doc: /* Return the next position after POS where an overlay starts or ends.
3940 If there are no more overlay boundaries after POS, return (point-max). */)
3941 (pos)
3942 Lisp_Object pos;
3944 int noverlays;
3945 int endpos;
3946 Lisp_Object *overlay_vec;
3947 int len;
3948 int i;
3950 CHECK_NUMBER_COERCE_MARKER (pos);
3952 len = 10;
3953 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3955 /* Put all the overlays we want in a vector in overlay_vec.
3956 Store the length in len.
3957 endpos gets the position where the next overlay starts. */
3958 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3959 &endpos, (int *) 0, 1);
3961 /* If any of these overlays ends before endpos,
3962 use its ending point instead. */
3963 for (i = 0; i < noverlays; i++)
3965 Lisp_Object oend;
3966 int oendpos;
3968 oend = OVERLAY_END (overlay_vec[i]);
3969 oendpos = OVERLAY_POSITION (oend);
3970 if (oendpos < endpos)
3971 endpos = oendpos;
3974 xfree (overlay_vec);
3975 return make_number (endpos);
3978 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3979 Sprevious_overlay_change, 1, 1, 0,
3980 doc: /* Return the previous position before POS where an overlay starts or ends.
3981 If there are no more overlay boundaries before POS, return (point-min). */)
3982 (pos)
3983 Lisp_Object pos;
3985 int noverlays;
3986 int prevpos;
3987 Lisp_Object *overlay_vec;
3988 int len;
3990 CHECK_NUMBER_COERCE_MARKER (pos);
3992 /* At beginning of buffer, we know the answer;
3993 avoid bug subtracting 1 below. */
3994 if (XINT (pos) == BEGV)
3995 return pos;
3997 len = 10;
3998 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4000 /* Put all the overlays we want in a vector in overlay_vec.
4001 Store the length in len.
4002 prevpos gets the position of the previous change. */
4003 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4004 (int *) 0, &prevpos, 1);
4006 xfree (overlay_vec);
4007 return make_number (prevpos);
4010 /* These functions are for debugging overlays. */
4012 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4013 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4014 The car has all the overlays before the overlay center;
4015 the cdr has all the overlays after the overlay center.
4016 Recentering overlays moves overlays between these lists.
4017 The lists you get are copies, so that changing them has no effect.
4018 However, the overlays you get are the real objects that the buffer uses. */)
4021 struct Lisp_Overlay *ol;
4022 Lisp_Object before = Qnil, after = Qnil, tmp;
4023 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4025 XSETMISC (tmp, ol);
4026 before = Fcons (tmp, before);
4028 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4030 XSETMISC (tmp, ol);
4031 after = Fcons (tmp, after);
4033 return Fcons (Fnreverse (before), Fnreverse (after));
4036 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4037 doc: /* Recenter the overlays of the current buffer around position POS.
4038 That makes overlay lookup faster for positions near POS (but perhaps slower
4039 for positions far away from POS). */)
4040 (pos)
4041 Lisp_Object pos;
4043 CHECK_NUMBER_COERCE_MARKER (pos);
4045 recenter_overlay_lists (current_buffer, XINT (pos));
4046 return Qnil;
4049 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4050 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4051 (overlay, prop)
4052 Lisp_Object overlay, prop;
4054 CHECK_OVERLAY (overlay);
4055 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4058 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4059 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4060 (overlay, prop, value)
4061 Lisp_Object overlay, prop, value;
4063 Lisp_Object tail, buffer;
4064 int changed;
4066 CHECK_OVERLAY (overlay);
4068 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4070 for (tail = XOVERLAY (overlay)->plist;
4071 CONSP (tail) && CONSP (XCDR (tail));
4072 tail = XCDR (XCDR (tail)))
4073 if (EQ (XCAR (tail), prop))
4075 changed = !EQ (XCAR (XCDR (tail)), value);
4076 XSETCAR (XCDR (tail), value);
4077 goto found;
4079 /* It wasn't in the list, so add it to the front. */
4080 changed = !NILP (value);
4081 XOVERLAY (overlay)->plist
4082 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4083 found:
4084 if (! NILP (buffer))
4086 if (changed)
4087 modify_overlay (XBUFFER (buffer),
4088 marker_position (OVERLAY_START (overlay)),
4089 marker_position (OVERLAY_END (overlay)));
4090 if (EQ (prop, Qevaporate) && ! NILP (value)
4091 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4092 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4093 Fdelete_overlay (overlay);
4095 return value;
4098 /* Subroutine of report_overlay_modification. */
4100 /* Lisp vector holding overlay hook functions to call.
4101 Vector elements come in pairs.
4102 Each even-index element is a list of hook functions.
4103 The following odd-index element is the overlay they came from.
4105 Before the buffer change, we fill in this vector
4106 as we call overlay hook functions.
4107 After the buffer change, we get the functions to call from this vector.
4108 This way we always call the same functions before and after the change. */
4109 static Lisp_Object last_overlay_modification_hooks;
4111 /* Number of elements actually used in last_overlay_modification_hooks. */
4112 static int last_overlay_modification_hooks_used;
4114 /* Add one functionlist/overlay pair
4115 to the end of last_overlay_modification_hooks. */
4117 static void
4118 add_overlay_mod_hooklist (functionlist, overlay)
4119 Lisp_Object functionlist, overlay;
4121 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4123 if (last_overlay_modification_hooks_used == oldsize)
4125 Lisp_Object old;
4126 old = last_overlay_modification_hooks;
4127 last_overlay_modification_hooks
4128 = Fmake_vector (make_number (oldsize * 2), Qnil);
4129 bcopy (XVECTOR (old)->contents,
4130 XVECTOR (last_overlay_modification_hooks)->contents,
4131 sizeof (Lisp_Object) * oldsize);
4133 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4134 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4137 /* Run the modification-hooks of overlays that include
4138 any part of the text in START to END.
4139 If this change is an insertion, also
4140 run the insert-before-hooks of overlay starting at END,
4141 and the insert-after-hooks of overlay ending at START.
4143 This is called both before and after the modification.
4144 AFTER is nonzero when we call after the modification.
4146 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4147 When AFTER is nonzero, they are the start position,
4148 the position after the inserted new text,
4149 and the length of deleted or replaced old text. */
4151 void
4152 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4153 Lisp_Object start, end;
4154 int after;
4155 Lisp_Object arg1, arg2, arg3;
4157 Lisp_Object prop, overlay;
4158 struct Lisp_Overlay *tail;
4159 /* 1 if this change is an insertion. */
4160 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4161 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4163 overlay = Qnil;
4164 tail = NULL;
4166 /* We used to run the functions as soon as we found them and only register
4167 them in last_overlay_modification_hooks for the purpose of the `after'
4168 case. But running elisp code as we traverse the list of overlays is
4169 painful because the list can be modified by the elisp code so we had to
4170 copy at several places. We now simply do a read-only traversal that
4171 only collects the functions to run and we run them afterwards. It's
4172 simpler, especially since all the code was already there. -stef */
4174 if (!after)
4176 /* We are being called before a change.
4177 Scan the overlays to find the functions to call. */
4178 last_overlay_modification_hooks_used = 0;
4179 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4181 int startpos, endpos;
4182 Lisp_Object ostart, oend;
4184 XSETMISC (overlay, tail);
4186 ostart = OVERLAY_START (overlay);
4187 oend = OVERLAY_END (overlay);
4188 endpos = OVERLAY_POSITION (oend);
4189 if (XFASTINT (start) > endpos)
4190 break;
4191 startpos = OVERLAY_POSITION (ostart);
4192 if (insertion && (XFASTINT (start) == startpos
4193 || XFASTINT (end) == startpos))
4195 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4196 if (!NILP (prop))
4197 add_overlay_mod_hooklist (prop, overlay);
4199 if (insertion && (XFASTINT (start) == endpos
4200 || XFASTINT (end) == endpos))
4202 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4203 if (!NILP (prop))
4204 add_overlay_mod_hooklist (prop, overlay);
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))
4212 add_overlay_mod_hooklist (prop, overlay);
4216 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4218 int startpos, endpos;
4219 Lisp_Object ostart, oend;
4221 XSETMISC (overlay, tail);
4223 ostart = OVERLAY_START (overlay);
4224 oend = OVERLAY_END (overlay);
4225 startpos = OVERLAY_POSITION (ostart);
4226 endpos = OVERLAY_POSITION (oend);
4227 if (XFASTINT (end) < startpos)
4228 break;
4229 if (insertion && (XFASTINT (start) == startpos
4230 || XFASTINT (end) == startpos))
4232 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4233 if (!NILP (prop))
4234 add_overlay_mod_hooklist (prop, overlay);
4236 if (insertion && (XFASTINT (start) == endpos
4237 || XFASTINT (end) == endpos))
4239 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4240 if (!NILP (prop))
4241 add_overlay_mod_hooklist (prop, overlay);
4243 /* Test for intersecting intervals. This does the right thing
4244 for both insertion and deletion. */
4245 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4247 prop = Foverlay_get (overlay, Qmodification_hooks);
4248 if (!NILP (prop))
4249 add_overlay_mod_hooklist (prop, overlay);
4254 GCPRO4 (overlay, arg1, arg2, arg3);
4256 /* Call the functions recorded in last_overlay_modification_hooks.
4257 First copy the vector contents, in case some of these hooks
4258 do subsequent modification of the buffer. */
4259 int size = last_overlay_modification_hooks_used;
4260 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4261 int i;
4263 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4264 copy, size * sizeof (Lisp_Object));
4265 gcpro1.var = copy;
4266 gcpro1.nvars = size;
4268 for (i = 0; i < size;)
4270 Lisp_Object prop, overlay;
4271 prop = copy[i++];
4272 overlay = copy[i++];
4273 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4276 UNGCPRO;
4279 static void
4280 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4281 Lisp_Object list, overlay;
4282 int after;
4283 Lisp_Object arg1, arg2, arg3;
4285 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4287 GCPRO4 (list, arg1, arg2, arg3);
4289 while (CONSP (list))
4291 if (NILP (arg3))
4292 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4293 else
4294 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4295 list = XCDR (list);
4297 UNGCPRO;
4300 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4301 property is set. */
4302 void
4303 evaporate_overlays (pos)
4304 EMACS_INT pos;
4306 Lisp_Object overlay, hit_list;
4307 struct Lisp_Overlay *tail;
4309 hit_list = Qnil;
4310 if (pos <= current_buffer->overlay_center)
4311 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4313 int endpos;
4314 XSETMISC (overlay, tail);
4315 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4316 if (endpos < pos)
4317 break;
4318 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4319 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4320 hit_list = Fcons (overlay, hit_list);
4322 else
4323 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4325 int startpos;
4326 XSETMISC (overlay, tail);
4327 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4328 if (startpos > pos)
4329 break;
4330 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4331 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4332 hit_list = Fcons (overlay, hit_list);
4334 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4335 Fdelete_overlay (XCAR (hit_list));
4338 /* Somebody has tried to store a value with an unacceptable type
4339 in the slot with offset OFFSET. */
4341 void
4342 buffer_slot_type_mismatch (offset)
4343 int offset;
4345 Lisp_Object sym;
4346 char *type_name;
4348 switch (XINT (PER_BUFFER_TYPE (offset)))
4350 case Lisp_Int:
4351 type_name = "integers";
4352 break;
4354 case Lisp_String:
4355 type_name = "strings";
4356 break;
4358 case Lisp_Symbol:
4359 type_name = "symbols";
4360 break;
4362 default:
4363 abort ();
4366 sym = PER_BUFFER_SYMBOL (offset);
4367 error ("Only %s should be stored in the buffer-local variable %s",
4368 type_name, SDATA (SYMBOL_NAME (sym)));
4372 /***********************************************************************
4373 Allocation with mmap
4374 ***********************************************************************/
4376 #ifdef USE_MMAP_FOR_BUFFERS
4378 #include <sys/types.h>
4379 #include <sys/mman.h>
4381 #ifndef MAP_ANON
4382 #ifdef MAP_ANONYMOUS
4383 #define MAP_ANON MAP_ANONYMOUS
4384 #else
4385 #define MAP_ANON 0
4386 #endif
4387 #endif
4389 #ifndef MAP_FAILED
4390 #define MAP_FAILED ((void *) -1)
4391 #endif
4393 #include <stdio.h>
4394 #include <errno.h>
4396 #if MAP_ANON == 0
4397 #include <fcntl.h>
4398 #endif
4400 #include "coding.h"
4403 /* Memory is allocated in regions which are mapped using mmap(2).
4404 The current implementation lets the system select mapped
4405 addresses; we're not using MAP_FIXED in general, except when
4406 trying to enlarge regions.
4408 Each mapped region starts with a mmap_region structure, the user
4409 area starts after that structure, aligned to MEM_ALIGN.
4411 +-----------------------+
4412 | struct mmap_info + |
4413 | padding |
4414 +-----------------------+
4415 | user data |
4418 +-----------------------+ */
4420 struct mmap_region
4422 /* User-specified size. */
4423 size_t nbytes_specified;
4425 /* Number of bytes mapped */
4426 size_t nbytes_mapped;
4428 /* Pointer to the location holding the address of the memory
4429 allocated with the mmap'd block. The variable actually points
4430 after this structure. */
4431 POINTER_TYPE **var;
4433 /* Next and previous in list of all mmap'd regions. */
4434 struct mmap_region *next, *prev;
4437 /* Doubly-linked list of mmap'd regions. */
4439 static struct mmap_region *mmap_regions;
4441 /* File descriptor for mmap. If we don't have anonymous mapping,
4442 /dev/zero will be opened on it. */
4444 static int mmap_fd;
4446 /* Temporary storage for mmap_set_vars, see there. */
4448 static struct mmap_region *mmap_regions_1;
4449 static int mmap_fd_1;
4451 /* Page size on this system. */
4453 static int mmap_page_size;
4455 /* 1 means mmap has been intialized. */
4457 static int mmap_initialized_p;
4459 /* Value is X rounded up to the next multiple of N. */
4461 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4463 /* Size of mmap_region structure plus padding. */
4465 #define MMAP_REGION_STRUCT_SIZE \
4466 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4468 /* Given a pointer P to the start of the user-visible part of a mapped
4469 region, return a pointer to the start of the region. */
4471 #define MMAP_REGION(P) \
4472 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4474 /* Given a pointer P to the start of a mapped region, return a pointer
4475 to the start of the user-visible part of the region. */
4477 #define MMAP_USER_AREA(P) \
4478 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4480 #define MEM_ALIGN sizeof (double)
4482 /* Predicate returning true if part of the address range [START .. END]
4483 is currently mapped. Used to prevent overwriting an existing
4484 memory mapping.
4486 Default is to conservativly assume the address range is occupied by
4487 something else. This can be overridden by system configuration
4488 files if system-specific means to determine this exists. */
4490 #ifndef MMAP_ALLOCATED_P
4491 #define MMAP_ALLOCATED_P(start, end) 1
4492 #endif
4494 /* Function prototypes. */
4496 static int mmap_free_1 P_ ((struct mmap_region *));
4497 static int mmap_enlarge P_ ((struct mmap_region *, int));
4498 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4499 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4500 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4501 static void mmap_free P_ ((POINTER_TYPE **ptr));
4502 static void mmap_init P_ ((void));
4505 /* Return a region overlapping address range START...END, or null if
4506 none. END is not including, i.e. the last byte in the range
4507 is at END - 1. */
4509 static struct mmap_region *
4510 mmap_find (start, end)
4511 POINTER_TYPE *start, *end;
4513 struct mmap_region *r;
4514 char *s = (char *) start, *e = (char *) end;
4516 for (r = mmap_regions; r; r = r->next)
4518 char *rstart = (char *) r;
4519 char *rend = rstart + r->nbytes_mapped;
4521 if (/* First byte of range, i.e. START, in this region? */
4522 (s >= rstart && s < rend)
4523 /* Last byte of range, i.e. END - 1, in this region? */
4524 || (e > rstart && e <= rend)
4525 /* First byte of this region in the range? */
4526 || (rstart >= s && rstart < e)
4527 /* Last byte of this region in the range? */
4528 || (rend > s && rend <= e))
4529 break;
4532 return r;
4536 /* Unmap a region. P is a pointer to the start of the user-araa of
4537 the region. Value is non-zero if successful. */
4539 static int
4540 mmap_free_1 (r)
4541 struct mmap_region *r;
4543 if (r->next)
4544 r->next->prev = r->prev;
4545 if (r->prev)
4546 r->prev->next = r->next;
4547 else
4548 mmap_regions = r->next;
4550 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4552 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4553 return 0;
4556 return 1;
4560 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4561 Value is non-zero if successful. */
4563 static int
4564 mmap_enlarge (r, npages)
4565 struct mmap_region *r;
4566 int npages;
4568 char *region_end = (char *) r + r->nbytes_mapped;
4569 size_t nbytes;
4570 int success = 0;
4572 if (npages < 0)
4574 /* Unmap pages at the end of the region. */
4575 nbytes = - npages * mmap_page_size;
4576 if (munmap (region_end - nbytes, nbytes) == -1)
4577 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4578 else
4580 r->nbytes_mapped -= nbytes;
4581 success = 1;
4584 else if (npages > 0)
4586 nbytes = npages * mmap_page_size;
4588 /* Try to map additional pages at the end of the region. We
4589 cannot do this if the address range is already occupied by
4590 something else because mmap deletes any previous mapping.
4591 I'm not sure this is worth doing, let's see. */
4592 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4594 POINTER_TYPE *p;
4596 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4597 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4598 if (p == MAP_FAILED)
4599 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4600 else if (p != (POINTER_TYPE *) region_end)
4602 /* Kernels are free to choose a different address. In
4603 that case, unmap what we've mapped above; we have
4604 no use for it. */
4605 if (munmap (p, nbytes) == -1)
4606 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4608 else
4610 r->nbytes_mapped += nbytes;
4611 success = 1;
4616 return success;
4620 /* Set or reset variables holding references to mapped regions. If
4621 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4622 non-zero, set all variables to the start of the user-areas
4623 of mapped regions.
4625 This function is called from Fdump_emacs to ensure that the dumped
4626 Emacs doesn't contain references to memory that won't be mapped
4627 when Emacs starts. */
4629 void
4630 mmap_set_vars (restore_p)
4631 int restore_p;
4633 struct mmap_region *r;
4635 if (restore_p)
4637 mmap_regions = mmap_regions_1;
4638 mmap_fd = mmap_fd_1;
4639 for (r = mmap_regions; r; r = r->next)
4640 *r->var = MMAP_USER_AREA (r);
4642 else
4644 for (r = mmap_regions; r; r = r->next)
4645 *r->var = NULL;
4646 mmap_regions_1 = mmap_regions;
4647 mmap_regions = NULL;
4648 mmap_fd_1 = mmap_fd;
4649 mmap_fd = -1;
4654 /* Allocate a block of storage large enough to hold NBYTES bytes of
4655 data. A pointer to the data is returned in *VAR. VAR is thus the
4656 address of some variable which will use the data area.
4658 The allocation of 0 bytes is valid.
4660 If we can't allocate the necessary memory, set *VAR to null, and
4661 return null. */
4663 static POINTER_TYPE *
4664 mmap_alloc (var, nbytes)
4665 POINTER_TYPE **var;
4666 size_t nbytes;
4668 void *p;
4669 size_t map;
4671 mmap_init ();
4673 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4674 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4675 mmap_fd, 0);
4677 if (p == MAP_FAILED)
4679 if (errno != ENOMEM)
4680 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4681 p = NULL;
4683 else
4685 struct mmap_region *r = (struct mmap_region *) p;
4687 r->nbytes_specified = nbytes;
4688 r->nbytes_mapped = map;
4689 r->var = var;
4690 r->prev = NULL;
4691 r->next = mmap_regions;
4692 if (r->next)
4693 r->next->prev = r;
4694 mmap_regions = r;
4696 p = MMAP_USER_AREA (p);
4699 return *var = p;
4703 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4704 resize it to size NBYTES. Change *VAR to reflect the new block,
4705 and return this value. If more memory cannot be allocated, then
4706 leave *VAR unchanged, and return null. */
4708 static POINTER_TYPE *
4709 mmap_realloc (var, nbytes)
4710 POINTER_TYPE **var;
4711 size_t nbytes;
4713 POINTER_TYPE *result;
4715 mmap_init ();
4717 if (*var == NULL)
4718 result = mmap_alloc (var, nbytes);
4719 else if (nbytes == 0)
4721 mmap_free (var);
4722 result = mmap_alloc (var, nbytes);
4724 else
4726 struct mmap_region *r = MMAP_REGION (*var);
4727 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4729 if (room < nbytes)
4731 /* Must enlarge. */
4732 POINTER_TYPE *old_ptr = *var;
4734 /* Try to map additional pages at the end of the region.
4735 If that fails, allocate a new region, copy data
4736 from the old region, then free it. */
4737 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4738 / mmap_page_size)))
4740 r->nbytes_specified = nbytes;
4741 *var = result = old_ptr;
4743 else if (mmap_alloc (var, nbytes))
4745 bcopy (old_ptr, *var, r->nbytes_specified);
4746 mmap_free_1 (MMAP_REGION (old_ptr));
4747 result = *var;
4748 r = MMAP_REGION (result);
4749 r->nbytes_specified = nbytes;
4751 else
4753 *var = old_ptr;
4754 result = NULL;
4757 else if (room - nbytes >= mmap_page_size)
4759 /* Shrinking by at least a page. Let's give some
4760 memory back to the system.
4762 The extra parens are to make the division happens first,
4763 on positive values, so we know it will round towards
4764 zero. */
4765 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4766 result = *var;
4767 r->nbytes_specified = nbytes;
4769 else
4771 /* Leave it alone. */
4772 result = *var;
4773 r->nbytes_specified = nbytes;
4777 return result;
4781 /* Free a block of relocatable storage whose data is pointed to by
4782 PTR. Store 0 in *PTR to show there's no block allocated. */
4784 static void
4785 mmap_free (var)
4786 POINTER_TYPE **var;
4788 mmap_init ();
4790 if (*var)
4792 mmap_free_1 (MMAP_REGION (*var));
4793 *var = NULL;
4798 /* Perform necessary intializations for the use of mmap. */
4800 static void
4801 mmap_init ()
4803 #if MAP_ANON == 0
4804 /* The value of mmap_fd is initially 0 in temacs, and -1
4805 in a dumped Emacs. */
4806 if (mmap_fd <= 0)
4808 /* No anonymous mmap -- we need the file descriptor. */
4809 mmap_fd = open ("/dev/zero", O_RDONLY);
4810 if (mmap_fd == -1)
4811 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4813 #endif /* MAP_ANON == 0 */
4815 if (mmap_initialized_p)
4816 return;
4817 mmap_initialized_p = 1;
4819 #if MAP_ANON != 0
4820 mmap_fd = -1;
4821 #endif
4823 mmap_page_size = getpagesize ();
4826 #endif /* USE_MMAP_FOR_BUFFERS */
4830 /***********************************************************************
4831 Buffer-text Allocation
4832 ***********************************************************************/
4834 #ifdef REL_ALLOC
4835 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4836 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4837 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4838 #endif /* REL_ALLOC */
4841 /* Allocate NBYTES bytes for buffer B's text buffer. */
4843 static void
4844 alloc_buffer_text (b, nbytes)
4845 struct buffer *b;
4846 size_t nbytes;
4848 POINTER_TYPE *p;
4850 BLOCK_INPUT;
4851 #if defined USE_MMAP_FOR_BUFFERS
4852 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4853 #elif defined REL_ALLOC
4854 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4855 #else
4856 p = xmalloc (nbytes);
4857 #endif
4859 if (p == NULL)
4861 UNBLOCK_INPUT;
4862 memory_full ();
4865 b->text->beg = (unsigned char *) p;
4866 UNBLOCK_INPUT;
4869 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4870 shrink it. */
4872 void
4873 enlarge_buffer_text (b, delta)
4874 struct buffer *b;
4875 int delta;
4877 POINTER_TYPE *p;
4878 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4879 + delta);
4880 BLOCK_INPUT;
4881 #if defined USE_MMAP_FOR_BUFFERS
4882 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4883 #elif defined REL_ALLOC
4884 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4885 #else
4886 p = xrealloc (b->text->beg, nbytes);
4887 #endif
4889 if (p == NULL)
4891 UNBLOCK_INPUT;
4892 memory_full ();
4895 BUF_BEG_ADDR (b) = (unsigned char *) p;
4896 UNBLOCK_INPUT;
4900 /* Free buffer B's text buffer. */
4902 static void
4903 free_buffer_text (b)
4904 struct buffer *b;
4906 BLOCK_INPUT;
4908 #if defined USE_MMAP_FOR_BUFFERS
4909 mmap_free ((POINTER_TYPE **) &b->text->beg);
4910 #elif defined REL_ALLOC
4911 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4912 #else
4913 xfree (b->text->beg);
4914 #endif
4916 BUF_BEG_ADDR (b) = NULL;
4917 UNBLOCK_INPUT;
4922 /***********************************************************************
4923 Initialization
4924 ***********************************************************************/
4926 void
4927 init_buffer_once ()
4929 int idx;
4931 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4933 /* Make sure all markable slots in buffer_defaults
4934 are initialized reasonably, so mark_buffer won't choke. */
4935 reset_buffer (&buffer_defaults);
4936 reset_buffer_local_variables (&buffer_defaults, 1);
4937 reset_buffer (&buffer_local_symbols);
4938 reset_buffer_local_variables (&buffer_local_symbols, 1);
4939 /* Prevent GC from getting confused. */
4940 buffer_defaults.text = &buffer_defaults.own_text;
4941 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4942 BUF_INTERVALS (&buffer_defaults) = 0;
4943 BUF_INTERVALS (&buffer_local_symbols) = 0;
4944 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4945 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4947 /* Set up the default values of various buffer slots. */
4948 /* Must do these before making the first buffer! */
4950 /* real setup is done in bindings.el */
4951 buffer_defaults.mode_line_format = build_string ("%-");
4952 buffer_defaults.header_line_format = Qnil;
4953 buffer_defaults.abbrev_mode = Qnil;
4954 buffer_defaults.overwrite_mode = Qnil;
4955 buffer_defaults.case_fold_search = Qt;
4956 buffer_defaults.auto_fill_function = Qnil;
4957 buffer_defaults.selective_display = Qnil;
4958 #ifndef old
4959 buffer_defaults.selective_display_ellipses = Qt;
4960 #endif
4961 buffer_defaults.abbrev_table = Qnil;
4962 buffer_defaults.display_table = Qnil;
4963 buffer_defaults.undo_list = Qnil;
4964 buffer_defaults.mark_active = Qnil;
4965 buffer_defaults.file_format = Qnil;
4966 buffer_defaults.auto_save_file_format = Qt;
4967 buffer_defaults.overlays_before = NULL;
4968 buffer_defaults.overlays_after = NULL;
4969 buffer_defaults.overlay_center = BEG;
4971 XSETFASTINT (buffer_defaults.tab_width, 8);
4972 buffer_defaults.truncate_lines = Qnil;
4973 buffer_defaults.ctl_arrow = Qt;
4974 buffer_defaults.direction_reversed = Qnil;
4975 buffer_defaults.cursor_type = Qt;
4976 buffer_defaults.extra_line_spacing = Qnil;
4978 #ifdef DOS_NT
4979 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4980 #endif
4981 buffer_defaults.enable_multibyte_characters = Qt;
4982 buffer_defaults.buffer_file_coding_system = Qnil;
4983 XSETFASTINT (buffer_defaults.fill_column, 70);
4984 XSETFASTINT (buffer_defaults.left_margin, 0);
4985 buffer_defaults.cache_long_line_scans = Qnil;
4986 buffer_defaults.file_truename = Qnil;
4987 XSETFASTINT (buffer_defaults.display_count, 0);
4988 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
4989 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
4990 buffer_defaults.left_fringe_width = Qnil;
4991 buffer_defaults.right_fringe_width = Qnil;
4992 buffer_defaults.fringes_outside_margins = Qnil;
4993 buffer_defaults.scroll_bar_width = Qnil;
4994 buffer_defaults.vertical_scroll_bar_type = Qt;
4995 buffer_defaults.indicate_empty_lines = Qnil;
4996 buffer_defaults.indicate_buffer_boundaries = Qnil;
4997 buffer_defaults.scroll_up_aggressively = Qnil;
4998 buffer_defaults.scroll_down_aggressively = Qnil;
4999 buffer_defaults.display_time = Qnil;
5001 /* Assign the local-flags to the slots that have default values.
5002 The local flag is a bit that is used in the buffer
5003 to say that it has its own local value for the slot.
5004 The local flag bits are in the local_var_flags slot of the buffer. */
5006 /* Nothing can work if this isn't true */
5007 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
5009 /* 0 means not a lisp var, -1 means always local, else mask */
5010 bzero (&buffer_local_flags, sizeof buffer_local_flags);
5011 XSETINT (buffer_local_flags.filename, -1);
5012 XSETINT (buffer_local_flags.directory, -1);
5013 XSETINT (buffer_local_flags.backed_up, -1);
5014 XSETINT (buffer_local_flags.save_length, -1);
5015 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5016 XSETINT (buffer_local_flags.read_only, -1);
5017 XSETINT (buffer_local_flags.major_mode, -1);
5018 XSETINT (buffer_local_flags.mode_name, -1);
5019 XSETINT (buffer_local_flags.undo_list, -1);
5020 XSETINT (buffer_local_flags.mark_active, -1);
5021 XSETINT (buffer_local_flags.point_before_scroll, -1);
5022 XSETINT (buffer_local_flags.file_truename, -1);
5023 XSETINT (buffer_local_flags.invisibility_spec, -1);
5024 XSETINT (buffer_local_flags.file_format, -1);
5025 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5026 XSETINT (buffer_local_flags.display_count, -1);
5027 XSETINT (buffer_local_flags.display_time, -1);
5028 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5030 idx = 1;
5031 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5032 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5033 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5034 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5035 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5036 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5037 #ifndef old
5038 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5039 #endif
5040 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5041 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5042 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5043 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5044 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5045 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5046 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5047 #ifdef DOS_NT
5048 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5049 /* Make this one a permanent local. */
5050 buffer_permanent_local_flags[idx++] = 1;
5051 #endif
5052 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5053 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5054 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5055 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5056 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5057 /* Make this one a permanent local. */
5058 buffer_permanent_local_flags[idx++] = 1;
5059 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5060 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5061 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5062 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5063 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5064 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5065 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5066 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5067 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5068 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5069 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5070 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5071 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5072 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5074 /* Need more room? */
5075 if (idx >= MAX_PER_BUFFER_VARS)
5076 abort ();
5077 last_per_buffer_idx = idx;
5079 Vbuffer_alist = Qnil;
5080 current_buffer = 0;
5081 all_buffers = 0;
5083 QSFundamental = build_string ("Fundamental");
5085 Qfundamental_mode = intern ("fundamental-mode");
5086 buffer_defaults.major_mode = Qfundamental_mode;
5088 Qmode_class = intern ("mode-class");
5090 Qprotected_field = intern ("protected-field");
5092 Qpermanent_local = intern ("permanent-local");
5094 Qkill_buffer_hook = intern ("kill-buffer-hook");
5095 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5097 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5099 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5101 /* super-magic invisible buffer */
5102 Vbuffer_alist = Qnil;
5104 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5106 inhibit_modification_hooks = 0;
5109 void
5110 init_buffer ()
5112 char buf[MAXPATHLEN + 1];
5113 char *pwd;
5114 struct stat dotstat, pwdstat;
5115 Lisp_Object temp;
5116 int rc;
5118 #ifdef USE_MMAP_FOR_BUFFERS
5120 /* When using the ralloc implementation based on mmap(2), buffer
5121 text pointers will have been set to null in the dumped Emacs.
5122 Map new memory. */
5123 struct buffer *b;
5125 for (b = all_buffers; b; b = b->next)
5126 if (b->text->beg == NULL)
5127 enlarge_buffer_text (b, 0);
5129 #endif /* USE_MMAP_FOR_BUFFERS */
5131 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5132 if (NILP (buffer_defaults.enable_multibyte_characters))
5133 Fset_buffer_multibyte (Qnil);
5135 /* If PWD is accurate, use it instead of calling getwd. PWD is
5136 sometimes a nicer name, and using it may avoid a fatal error if a
5137 parent directory is searchable but not readable. */
5138 if ((pwd = getenv ("PWD")) != 0
5139 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5140 && stat (pwd, &pwdstat) == 0
5141 && stat (".", &dotstat) == 0
5142 && dotstat.st_ino == pwdstat.st_ino
5143 && dotstat.st_dev == pwdstat.st_dev
5144 && strlen (pwd) < MAXPATHLEN)
5145 strcpy (buf, pwd);
5146 #ifdef HAVE_GETCWD
5147 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5148 fatal ("`getcwd' failed: %s\n", strerror (errno));
5149 #else
5150 else if (getwd (buf) == 0)
5151 fatal ("`getwd' failed: %s\n", buf);
5152 #endif
5154 #ifndef VMS
5155 /* Maybe this should really use some standard subroutine
5156 whose definition is filename syntax dependent. */
5157 rc = strlen (buf);
5158 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5160 buf[rc] = DIRECTORY_SEP;
5161 buf[rc + 1] = '\0';
5163 #endif /* not VMS */
5165 current_buffer->directory = build_string (buf);
5167 /* Add /: to the front of the name
5168 if it would otherwise be treated as magic. */
5169 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5170 if (! NILP (temp)
5171 /* If the default dir is just /, TEMP is non-nil
5172 because of the ange-ftp completion handler.
5173 However, it is not necessary to turn / into /:/.
5174 So avoid doing that. */
5175 && strcmp ("/", SDATA (current_buffer->directory)))
5176 current_buffer->directory
5177 = concat2 (build_string ("/:"), current_buffer->directory);
5179 temp = get_minibuffer (0);
5180 XBUFFER (temp)->directory = current_buffer->directory;
5183 /* initialize the buffer routines */
5184 void
5185 syms_of_buffer ()
5187 staticpro (&last_overlay_modification_hooks);
5188 last_overlay_modification_hooks
5189 = Fmake_vector (make_number (10), Qnil);
5191 staticpro (&Vbuffer_defaults);
5192 staticpro (&Vbuffer_local_symbols);
5193 staticpro (&Qfundamental_mode);
5194 staticpro (&Qmode_class);
5195 staticpro (&QSFundamental);
5196 staticpro (&Vbuffer_alist);
5197 staticpro (&Qprotected_field);
5198 staticpro (&Qpermanent_local);
5199 staticpro (&Qkill_buffer_hook);
5200 Qoverlayp = intern ("overlayp");
5201 staticpro (&Qoverlayp);
5202 Qevaporate = intern ("evaporate");
5203 staticpro (&Qevaporate);
5204 Qmodification_hooks = intern ("modification-hooks");
5205 staticpro (&Qmodification_hooks);
5206 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5207 staticpro (&Qinsert_in_front_hooks);
5208 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5209 staticpro (&Qinsert_behind_hooks);
5210 Qget_file_buffer = intern ("get-file-buffer");
5211 staticpro (&Qget_file_buffer);
5212 Qpriority = intern ("priority");
5213 staticpro (&Qpriority);
5214 Qwindow = intern ("window");
5215 staticpro (&Qwindow);
5216 Qbefore_string = intern ("before-string");
5217 staticpro (&Qbefore_string);
5218 Qafter_string = intern ("after-string");
5219 staticpro (&Qafter_string);
5220 Qfirst_change_hook = intern ("first-change-hook");
5221 staticpro (&Qfirst_change_hook);
5222 Qbefore_change_functions = intern ("before-change-functions");
5223 staticpro (&Qbefore_change_functions);
5224 Qafter_change_functions = intern ("after-change-functions");
5225 staticpro (&Qafter_change_functions);
5226 staticpro (&Qucs_set_table_for_input);
5228 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5229 staticpro (&Qkill_buffer_query_functions);
5231 Fput (Qprotected_field, Qerror_conditions,
5232 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5233 Fput (Qprotected_field, Qerror_message,
5234 build_string ("Attempt to modify a protected field"));
5236 /* All these use DEFVAR_LISP_NOPRO because the slots in
5237 buffer_defaults will all be marked via Vbuffer_defaults. */
5239 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5240 &buffer_defaults.mode_line_format,
5241 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5242 This is the same as (default-value 'mode-line-format). */);
5244 DEFVAR_LISP_NOPRO ("default-header-line-format",
5245 &buffer_defaults.header_line_format,
5246 doc: /* Default value of `header-line-format' for buffers that don't override it.
5247 This is the same as (default-value 'header-line-format). */);
5249 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5250 doc: /* Default value of `cursor-type' for buffers that don't override it.
5251 This is the same as (default-value 'cursor-type). */);
5253 DEFVAR_LISP_NOPRO ("default-line-spacing",
5254 &buffer_defaults.extra_line_spacing,
5255 doc: /* Default value of `line-spacing' for buffers that don't override it.
5256 This is the same as (default-value 'line-spacing). */);
5258 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5259 &buffer_defaults.abbrev_mode,
5260 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5261 This is the same as (default-value 'abbrev-mode). */);
5263 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5264 &buffer_defaults.ctl_arrow,
5265 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5266 This is the same as (default-value 'ctl-arrow). */);
5268 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5269 &buffer_defaults.direction_reversed,
5270 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5271 This is the same as (default-value 'direction-reversed). */);
5273 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5274 &buffer_defaults.enable_multibyte_characters,
5275 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5276 This is the same as (default-value 'enable-multibyte-characters). */);
5278 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5279 &buffer_defaults.buffer_file_coding_system,
5280 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5281 This is the same as (default-value 'buffer-file-coding-system). */);
5283 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5284 &buffer_defaults.truncate_lines,
5285 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5286 This is the same as (default-value 'truncate-lines). */);
5288 DEFVAR_LISP_NOPRO ("default-fill-column",
5289 &buffer_defaults.fill_column,
5290 doc: /* Default value of `fill-column' for buffers that do not override it.
5291 This is the same as (default-value 'fill-column). */);
5293 DEFVAR_LISP_NOPRO ("default-left-margin",
5294 &buffer_defaults.left_margin,
5295 doc: /* Default value of `left-margin' for buffers that do not override it.
5296 This is the same as (default-value 'left-margin). */);
5298 DEFVAR_LISP_NOPRO ("default-tab-width",
5299 &buffer_defaults.tab_width,
5300 doc: /* Default value of `tab-width' for buffers that do not override it.
5301 This is the same as (default-value 'tab-width). */);
5303 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5304 &buffer_defaults.case_fold_search,
5305 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5306 This is the same as (default-value 'case-fold-search). */);
5308 #ifdef DOS_NT
5309 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5310 &buffer_defaults.buffer_file_type,
5311 doc: /* Default file type for buffers that do not override it.
5312 This is the same as (default-value 'buffer-file-type).
5313 The file type is nil for text, t for binary. */);
5314 #endif
5316 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5317 &buffer_defaults.left_margin_cols,
5318 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5319 This is the same as (default-value 'left-margin-width). */);
5321 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5322 &buffer_defaults.right_margin_cols,
5323 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5324 This is the same as (default-value 'right-margin-width). */);
5326 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5327 &buffer_defaults.left_fringe_width,
5328 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5329 This is the same as (default-value 'left-fringe-width). */);
5331 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5332 &buffer_defaults.right_fringe_width,
5333 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5334 This is the same as (default-value 'right-fringe-width). */);
5336 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5337 &buffer_defaults.fringes_outside_margins,
5338 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5339 This is the same as (default-value 'fringes-outside-margins). */);
5341 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5342 &buffer_defaults.scroll_bar_width,
5343 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5344 This is the same as (default-value 'scroll-bar-width). */);
5346 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5347 &buffer_defaults.vertical_scroll_bar_type,
5348 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5349 This is the same as (default-value 'vertical-scroll-bar). */);
5351 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5352 &buffer_defaults.indicate_empty_lines,
5353 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5354 This is the same as (default-value 'indicate-empty-lines). */);
5356 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5357 &buffer_defaults.indicate_buffer_boundaries,
5358 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5359 This is the same as (default-value 'indicate-buffer-boundaries). */);
5361 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5362 &buffer_defaults.scroll_up_aggressively,
5363 doc: /* Default value of `scroll-up-aggressively'.
5364 This value applies in buffers that don't have their own local values.
5365 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5367 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5368 &buffer_defaults.scroll_down_aggressively,
5369 doc: /* Default value of `scroll-down-aggressively'.
5370 This value applies in buffers that don't have their own local values.
5371 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5373 DEFVAR_PER_BUFFER ("header-line-format",
5374 &current_buffer->header_line_format,
5375 Qnil,
5376 doc: /* Analogous to `mode-line-format', but controls the header line.
5377 The header line appears, optionally, at the top of a window;
5378 the mode line appears at the bottom. */);
5380 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5381 Qnil,
5382 doc: /* Template for displaying mode line for current buffer.
5383 Each buffer has its own value of this variable.
5384 Value may be nil, a string, a symbol or a list or cons cell.
5385 A value of nil means don't display a mode line.
5386 For a symbol, its value is used (but it is ignored if t or nil).
5387 A string appearing directly as the value of a symbol is processed verbatim
5388 in that the %-constructs below are not recognized.
5389 Note that unless the symbol is marked as a `risky-local-variable', all
5390 properties in any strings, as well as all :eval and :propertize forms
5391 in the value of that symbol will be ignored.
5392 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5393 is used as a mode line element. Be careful--FORM should not load any files,
5394 because that can cause an infinite recursion.
5395 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5396 with the specified properties PROPS applied.
5397 For a list whose car is a symbol, the symbol's value is taken,
5398 and if that is non-nil, the cadr of the list is processed recursively.
5399 Otherwise, the caddr of the list (if there is one) is processed.
5400 For a list whose car is a string or list, each element is processed
5401 recursively and the results are effectively concatenated.
5402 For a list whose car is an integer, the cdr of the list is processed
5403 and padded (if the number is positive) or truncated (if negative)
5404 to the width specified by that number.
5405 A string is printed verbatim in the mode line except for %-constructs:
5406 (%-constructs are allowed when the string is the entire mode-line-format
5407 or when it is found in a cons-cell or a list)
5408 %b -- print buffer name. %f -- print visited file name.
5409 %F -- print frame name.
5410 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5411 %& is like %*, but ignore read-only-ness.
5412 % means buffer is read-only and * means it is modified.
5413 For a modified read-only buffer, %* gives % and %+ gives *.
5414 %s -- print process status. %l -- print the current line number.
5415 %c -- print the current column number (this makes editing slower).
5416 To make the column number update correctly in all cases,
5417 `column-number-mode' must be non-nil.
5418 %i -- print the size of the buffer.
5419 %I -- like %i, but use k, M, G, etc., to abbreviate.
5420 %p -- print percent of buffer above top of window, or Top, Bot or All.
5421 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5422 or print Bottom or All.
5423 %m -- print the mode name.
5424 %n -- print Narrow if appropriate.
5425 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5426 %Z -- like %z, but including the end-of-line format.
5427 %[ -- print one [ for each recursive editing level. %] similar.
5428 %% -- print %. %- -- print infinitely many dashes.
5429 Decimal digits after the % specify field width to which to pad. */);
5431 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5432 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5433 nil here means use current buffer's major mode, provided it is not
5434 marked as "special".
5436 When a mode is used by default, `find-file' switches to it
5437 before it reads the contents into the buffer and before
5438 it finishes setting up the buffer. Thus, the mode and
5439 its hooks should not expect certain variables such as
5440 `buffer-read-only' and `buffer-file-coding-system' to be set up. */);
5442 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5443 make_number (Lisp_Symbol),
5444 doc: /* Symbol for current buffer's major mode. */);
5446 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5447 Qnil,
5448 doc: /* Pretty name of current buffer's major mode (a string). */);
5450 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5451 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5453 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5454 Qnil,
5455 doc: /* *Non-nil if searches and matches should ignore case. */);
5457 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5458 make_number (Lisp_Int),
5459 doc: /* *Column beyond which automatic line-wrapping should happen.
5460 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5462 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5463 make_number (Lisp_Int),
5464 doc: /* *Column for the default indent-line-function to indent to.
5465 Linefeed indents to this column in Fundamental mode. */);
5467 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5468 make_number (Lisp_Int),
5469 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5471 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5472 doc: /* *Non-nil means display control chars with uparrow.
5473 A value of nil means use backslash and octal digits.
5474 This variable does not apply to characters whose display is specified
5475 in the current display table (if there is one). */);
5477 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5478 &current_buffer->enable_multibyte_characters,
5479 Qnil,
5480 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5481 Otherwise they are regarded as unibyte. This affects the display,
5482 file I/O and the behavior of various editing commands.
5484 This variable is buffer-local but you cannot set it directly;
5485 use the function `set-buffer-multibyte' to change a buffer's representation.
5486 Changing its default value with `setq-default' is supported.
5487 See also variable `default-enable-multibyte-characters' and Info node
5488 `(elisp)Text Representations'. */);
5489 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5491 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5492 &current_buffer->buffer_file_coding_system, Qnil,
5493 doc: /* Coding system to be used for encoding the buffer contents on saving.
5494 This variable applies to saving the buffer, and also to `write-region'
5495 and other functions that use `write-region'.
5496 It does not apply to sending output to subprocesses, however.
5498 If this is nil, the buffer is saved without any code conversion
5499 unless some coding system is specified in `file-coding-system-alist'
5500 for the buffer file.
5502 If the text to be saved cannot be encoded as specified by this variable,
5503 an alternative encoding is selected by `select-safe-coding-system', which see.
5505 The variable `coding-system-for-write', if non-nil, overrides this variable.
5507 This variable is never applied to a way of decoding a file while reading it. */);
5509 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5510 Qnil,
5511 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5513 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5514 doc: /* *Non-nil means do not display continuation lines.
5515 Instead, give each line of text just one screen line.
5517 Note that this is overridden by the variable
5518 `truncate-partial-width-windows' if that variable is non-nil
5519 and this buffer is not full-frame width. */);
5521 #ifdef DOS_NT
5522 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5523 Qnil,
5524 doc: /* Non-nil if the visited file is a binary file.
5525 This variable is meaningful on MS-DOG and Windows NT.
5526 On those systems, it is automatically local in every buffer.
5527 On other systems, this variable is normally always nil. */);
5528 #endif
5530 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5531 make_number (Lisp_String),
5532 doc: /* Name of default directory of current buffer. Should end with slash.
5533 To interactively change the default directory, use command `cd'. */);
5535 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5536 Qnil,
5537 doc: /* Function called (if non-nil) to perform auto-fill.
5538 It is called after self-inserting any character specified in
5539 the `auto-fill-chars' table.
5540 NOTE: This variable is not a hook;
5541 its value may not be a list of functions. */);
5543 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5544 make_number (Lisp_String),
5545 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5547 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5548 make_number (Lisp_String),
5549 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5550 The truename of a file is calculated by `file-truename'
5551 and then abbreviated with `abbreviate-file-name'. */);
5553 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5554 &current_buffer->auto_save_file_name,
5555 make_number (Lisp_String),
5556 doc: /* Name of file for auto-saving current buffer.
5557 If it is nil, that means don't auto-save this buffer. */);
5559 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5560 doc: /* Non-nil if this buffer is read-only. */);
5562 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5563 doc: /* Non-nil if this buffer's file has been backed up.
5564 Backing up is done before the first time the file is saved. */);
5566 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5567 make_number (Lisp_Int),
5568 doc: /* Length of current buffer when last read in, saved or auto-saved.
5569 0 initially. */);
5571 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5572 Qnil,
5573 doc: /* Non-nil enables selective display.
5574 An Integer N as value means display only lines
5575 that start with less than n columns of space.
5576 A value of t means that the character ^M makes itself and
5577 all the rest of the line invisible; also, when saving the buffer
5578 in a file, save the ^M as a newline. */);
5580 #ifndef old
5581 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5582 &current_buffer->selective_display_ellipses,
5583 Qnil,
5584 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5585 #endif
5587 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5588 doc: /* Non-nil if self-insertion should replace existing text.
5589 The value should be one of `overwrite-mode-textual',
5590 `overwrite-mode-binary', or nil.
5591 If it is `overwrite-mode-textual', self-insertion still
5592 inserts at the end of a line, and inserts when point is before a tab,
5593 until the tab is filled in.
5594 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5596 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5597 Qnil,
5598 doc: /* Display table that controls display of the contents of current buffer.
5600 If this variable is nil, the value of `standard-display-table' is used.
5601 Each window can have its own, overriding display table, see
5602 `set-window-display-table' and `window-display-table'.
5604 The display table is a char-table created with `make-display-table'.
5605 A char-table is an array indexed by character codes. Normal array
5606 primitives `aref' and `aset' can be used to access elements of a char-table.
5608 Each of the char-table elements control how to display the corresponding
5609 text character: the element at index C in the table says how to display
5610 the character whose code is C. Each element should be a vector of
5611 characters or nil. nil means display the character in the default fashion;
5612 otherwise, the characters from the vector are delivered to the screen
5613 instead of the original character.
5615 For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5616 a capital Y instead of each X character.
5618 In addition, a char-table has six extra slots to control the display of:
5620 the end of a truncated screen line (extra-slot 0, a single character);
5621 the end of a continued line (extra-slot 1, a single character);
5622 the escape character used to display character codes in octal
5623 (extra-slot 2, a single character);
5624 the character used as an arrow for control characters (extra-slot 3,
5625 a single character);
5626 the decoration indicating the presence of invisible lines (extra-slot 4,
5627 a vector of characters);
5628 the character used to draw the border between side-by-side windows
5629 (extra-slot 5, a single character).
5631 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5633 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5634 Qnil,
5635 doc: /* *Width of left marginal area for display of a buffer.
5636 A value of nil means no marginal area. */);
5638 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5639 Qnil,
5640 doc: /* *Width of right marginal area for display of a buffer.
5641 A value of nil means no marginal area. */);
5643 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5644 Qnil,
5645 doc: /* *Width of this buffer's left fringe (in pixels).
5646 A value of 0 means no left fringe is shown in this buffer's window.
5647 A value of nil means to use the left fringe width from the window's frame. */);
5649 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5650 Qnil,
5651 doc: /* *Width of this buffer's right fringe (in pixels).
5652 A value of 0 means no right fringe is shown in this buffer's window.
5653 A value of nil means to use the right fringe width from the window's frame. */);
5655 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5656 Qnil,
5657 doc: /* *Non-nil means to display fringes outside display margins.
5658 A value of nil means to display fringes between margins and buffer text. */);
5660 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5661 Qnil,
5662 doc: /* *Width of this buffer's scroll bars in pixels.
5663 A value of nil means to use the scroll bar width from the window's frame. */);
5665 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5666 Qnil,
5667 doc: /* *Position of this buffer's vertical scroll bar.
5668 A value of left or right means to place the vertical scroll bar at that side
5669 of the window; a value of nil means that this window has no vertical scroll bar.
5670 A value of t means to use the vertical scroll bar type from the window's frame. */);
5672 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5673 &current_buffer->indicate_empty_lines, Qnil,
5674 doc: /* *Visually indicate empty lines after the buffer end.
5675 If non-nil, a bitmap is displayed in the left fringe of a window on
5676 window-systems. */);
5678 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5679 &current_buffer->indicate_buffer_boundaries, Qnil,
5680 doc: /* *Visually indicate buffer boundaries and scrolling.
5681 If non-nil, the first and last line of the buffer are marked in the fringe
5682 of a window on window-systems with angle bitmaps, or if the window can be
5683 scrolled, the top and bottom line of the window are marked with up and down
5684 arrow bitmaps.
5686 If value is a symbol `left' or `right', both angle and arrow bitmaps
5687 are displayed in the left or right fringe, resp.
5689 If value is an alist, each element (INDICATOR . POSITION) specifies
5690 the position of one of the indicators. INDICATOR is one of `top',
5691 `bottom', `up', `down', or t, which specifies the default position,
5692 and POSITION is one of `left', `right', or nil, meaning do not show
5693 this indicator.
5695 For example, ((top . left) (t . right)) places the top angle bitmap in
5696 left fringe, the bottom angle bitmap in right fringe, and both arrow
5697 bitmaps in right fringe. To show just the angle bitmaps in the left
5698 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5700 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5701 &current_buffer->scroll_up_aggressively, Qnil,
5702 doc: /* How far to scroll windows upward.
5703 If you move point off the bottom, the window scrolls automatically.
5704 This variable controls how far it scrolls. nil, the default,
5705 means scroll to center point. A fraction means scroll to put point
5706 that fraction of the window's height from the bottom of the window.
5707 When the value is 0.0, point goes at the bottom line, which in the simple
5708 case that you moved off with C-f means scrolling just one line. 1.0 means
5709 point goes at the top, so that in that simple case, the window
5710 window scrolls by a full window height. Meaningful values are
5711 between 0.0 and 1.0, inclusive. */);
5713 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5714 &current_buffer->scroll_down_aggressively, Qnil,
5715 doc: /* How far to scroll windows downward.
5716 If you move point off the top, the window scrolls automatically.
5717 This variable controls how far it scrolls. nil, the default,
5718 means scroll to center point. A fraction means scroll to put point
5719 that fraction of the window's height from the top of the window.
5720 When the value is 0.0, point goes at the top line, which in the simple
5721 case that you moved off with C-b means scrolling just one line. 1.0 means
5722 point goes at the bottom, so that in that simple case, the window
5723 window scrolls by a full window height. Meaningful values are
5724 between 0.0 and 1.0, inclusive. */);
5726 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5727 "Don't ask.");
5730 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5731 doc: /* List of functions to call before each text change.
5732 Two arguments are passed to each function: the positions of
5733 the beginning and end of the range of old text to be changed.
5734 \(For an insertion, the beginning and end are at the same place.)
5735 No information is given about the length of the text after the change.
5737 Buffer changes made while executing the `before-change-functions'
5738 don't call any before-change or after-change functions.
5739 That's because these variables are temporarily set to nil.
5740 As a result, a hook function cannot straightforwardly alter the value of
5741 these variables. See the Emacs Lisp manual for a way of
5742 accomplishing an equivalent result by using other variables.
5744 If an unhandled error happens in running these functions,
5745 the variable's value remains nil. That prevents the error
5746 from happening repeatedly and making Emacs nonfunctional. */);
5747 Vbefore_change_functions = Qnil;
5749 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5750 doc: /* List of functions to call after each text change.
5751 Three arguments are passed to each function: the positions of
5752 the beginning and end of the range of changed text,
5753 and the length in bytes of the pre-change text replaced by that range.
5754 \(For an insertion, the pre-change length is zero;
5755 for a deletion, that length is the number of bytes deleted,
5756 and the post-change beginning and end are at the same place.)
5758 Buffer changes made while executing the `after-change-functions'
5759 don't call any before-change or after-change functions.
5760 That's because these variables are temporarily set to nil.
5761 As a result, a hook function cannot straightforwardly alter the value of
5762 these variables. See the Emacs Lisp manual for a way of
5763 accomplishing an equivalent result by using other variables.
5765 If an unhandled error happens in running these functions,
5766 the variable's value remains nil. That prevents the error
5767 from happening repeatedly and making Emacs nonfunctional. */);
5768 Vafter_change_functions = Qnil;
5770 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5771 doc: /* A list of functions to call before changing a buffer which is unmodified.
5772 The functions are run using the `run-hooks' function. */);
5773 Vfirst_change_hook = Qnil;
5775 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5776 doc: /* List of undo entries in current buffer.
5777 Recent changes come first; older changes follow newer.
5779 An entry (BEG . END) represents an insertion which begins at
5780 position BEG and ends at position END.
5782 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5783 from (abs POSITION). If POSITION is positive, point was at the front
5784 of the text being deleted; if negative, point was at the end.
5786 An entry (t HIGH . LOW) indicates that the buffer previously had
5787 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5788 of the visited file's modification time, as of that time. If the
5789 modification time of the most recent save is different, this entry is
5790 obsolete.
5792 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5793 was modified between BEG and END. PROPERTY is the property name,
5794 and VALUE is the old value.
5796 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5797 was adjusted in position by the offset DISTANCE (an integer).
5799 An entry of the form POSITION indicates that point was at the buffer
5800 location given by the integer. Undoing an entry of this form places
5801 point at POSITION.
5803 nil marks undo boundaries. The undo command treats the changes
5804 between two undo boundaries as a single step to be undone.
5806 If the value of the variable is t, undo information is not recorded. */);
5808 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5809 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5811 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5812 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5814 Normally, the line-motion functions work by scanning the buffer for
5815 newlines. Columnar operations (like `move-to-column' and
5816 `compute-motion') also work by scanning the buffer, summing character
5817 widths as they go. This works well for ordinary text, but if the
5818 buffer's lines are very long (say, more than 500 characters), these
5819 motion functions will take longer to execute. Emacs may also take
5820 longer to update the display.
5822 If `cache-long-line-scans' is non-nil, these motion functions cache the
5823 results of their scans, and consult the cache to avoid rescanning
5824 regions of the buffer until the text is modified. The caches are most
5825 beneficial when they prevent the most searching---that is, when the
5826 buffer contains long lines and large regions of characters with the
5827 same, fixed screen width.
5829 When `cache-long-line-scans' is non-nil, processing short lines will
5830 become slightly slower (because of the overhead of consulting the
5831 cache), and the caches will use memory roughly proportional to the
5832 number of newlines and characters whose screen width varies.
5834 The caches require no explicit maintenance; their accuracy is
5835 maintained internally by the Emacs primitives. Enabling or disabling
5836 the cache should not affect the behavior of any of the motion
5837 functions; it should only affect their performance. */);
5839 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5840 doc: /* Value of point before the last series of scroll operations, or nil. */);
5842 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5843 doc: /* List of formats to use when saving this buffer.
5844 Formats are defined by `format-alist'. This variable is
5845 set when a file is visited. */);
5847 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5848 &current_buffer->auto_save_file_format, Qnil,
5849 doc: /* *Format in which to write auto-save files.
5850 Should be a list of symbols naming formats that are defined in `format-alist'.
5851 If it is t, which is the default, auto-save files are written in the
5852 same format as a regular save would use. */);
5854 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5855 &current_buffer->invisibility_spec, Qnil,
5856 doc: /* Invisibility spec of this buffer.
5857 The default is t, which means that text is invisible
5858 if it has a non-nil `invisible' property.
5859 If the value is a list, a text character is invisible if its `invisible'
5860 property is an element in that list.
5861 If an element is a cons cell of the form (PROP . ELLIPSIS),
5862 then characters with property value PROP are invisible,
5863 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5865 DEFVAR_PER_BUFFER ("buffer-display-count",
5866 &current_buffer->display_count, Qnil,
5867 doc: /* A number incremented each time this buffer is displayed in a window.
5868 The function `set-window-buffer' increments it. */);
5870 DEFVAR_PER_BUFFER ("buffer-display-time",
5871 &current_buffer->display_time, Qnil,
5872 doc: /* Time stamp updated each time this buffer is displayed in a window.
5873 The function `set-window-buffer' updates this variable
5874 to the value obtained by calling `current-time'.
5875 If the buffer has never been shown in a window, the value is nil. */);
5877 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5878 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5879 Non-nil also enables highlighting of the region whenever the mark is active.
5880 The variable `highlight-nonselected-windows' controls whether to highlight
5881 all windows or just the selected window.
5883 If the value is `lambda', that enables Transient Mark mode temporarily
5884 until the next buffer modification. If a command sets the value to `only',
5885 that enables Transient Mark mode for the following command only.
5886 During that following command, the value of `transient-mark-mode'
5887 is `identity'. If it is still `identity' at the end of that command,
5888 it changes to nil. */);
5889 Vtransient_mark_mode = Qnil;
5891 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5892 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5893 If the value is t, disregard `buffer-read-only' and all `read-only'
5894 text properties. If the value is a list, disregard `buffer-read-only'
5895 and disregard a `read-only' text property if the property value
5896 is a member of the list. */);
5897 Vinhibit_read_only = Qnil;
5899 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5900 doc: /* Cursor to use when this buffer is in the selected window.
5901 Values are interpreted as follows:
5903 t use the cursor specified for the frame
5904 nil don't display a cursor
5905 box display a filled box cursor
5906 hollow display a hollow box cursor
5907 bar display a vertical bar cursor with default width
5908 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5909 hbar display a horizontal bar cursor with default width
5910 (hbar . WIDTH) display a horizontal bar cursor with width WIDTH
5911 ANYTHING ELSE display a hollow box cursor.
5913 When the buffer is displayed in a nonselected window,
5914 this variable has no effect; the cursor appears as a hollow box. */);
5916 DEFVAR_PER_BUFFER ("line-spacing",
5917 &current_buffer->extra_line_spacing, Qnil,
5918 doc: /* Additional space to put between lines when displaying a buffer.
5919 The space is measured in pixels, and put below lines on window systems.
5920 If value is a floating point number, it specifies the spacing relative
5921 to the default frame line height. */);
5923 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5924 doc: /* List of functions called with no args to query before killing a buffer. */);
5925 Vkill_buffer_query_functions = Qnil;
5927 defsubr (&Sbuffer_live_p);
5928 defsubr (&Sbuffer_list);
5929 defsubr (&Sget_buffer);
5930 defsubr (&Sget_file_buffer);
5931 defsubr (&Sget_buffer_create);
5932 defsubr (&Smake_indirect_buffer);
5933 defsubr (&Sgenerate_new_buffer_name);
5934 defsubr (&Sbuffer_name);
5935 /*defsubr (&Sbuffer_number);*/
5936 defsubr (&Sbuffer_file_name);
5937 defsubr (&Sbuffer_base_buffer);
5938 defsubr (&Sbuffer_local_value);
5939 defsubr (&Sbuffer_local_variables);
5940 defsubr (&Sbuffer_modified_p);
5941 defsubr (&Sset_buffer_modified_p);
5942 defsubr (&Sbuffer_modified_tick);
5943 defsubr (&Srename_buffer);
5944 defsubr (&Sother_buffer);
5945 defsubr (&Sbuffer_disable_undo);
5946 defsubr (&Sbuffer_enable_undo);
5947 defsubr (&Skill_buffer);
5948 defsubr (&Sset_buffer_major_mode);
5949 defsubr (&Sswitch_to_buffer);
5950 defsubr (&Spop_to_buffer);
5951 defsubr (&Scurrent_buffer);
5952 defsubr (&Sset_buffer);
5953 defsubr (&Sbarf_if_buffer_read_only);
5954 defsubr (&Sbury_buffer);
5955 defsubr (&Serase_buffer);
5956 defsubr (&Sset_buffer_multibyte);
5957 defsubr (&Skill_all_local_variables);
5959 defsubr (&Soverlayp);
5960 defsubr (&Smake_overlay);
5961 defsubr (&Sdelete_overlay);
5962 defsubr (&Smove_overlay);
5963 defsubr (&Soverlay_start);
5964 defsubr (&Soverlay_end);
5965 defsubr (&Soverlay_buffer);
5966 defsubr (&Soverlay_properties);
5967 defsubr (&Soverlays_at);
5968 defsubr (&Soverlays_in);
5969 defsubr (&Snext_overlay_change);
5970 defsubr (&Sprevious_overlay_change);
5971 defsubr (&Soverlay_recenter);
5972 defsubr (&Soverlay_lists);
5973 defsubr (&Soverlay_get);
5974 defsubr (&Soverlay_put);
5975 defsubr (&Srestore_buffer_modified_p);
5978 void
5979 keys_of_buffer ()
5981 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5982 initial_define_key (control_x_map, 'k', "kill-buffer");
5984 /* This must not be in syms_of_buffer, because Qdisabled is not
5985 initialized when that function gets called. */
5986 Fput (intern ("erase-buffer"), Qdisabled, Qt);
5989 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
5990 (do not change this comment) */