(Fpos_visible_in_window_p, Fset_window_hscroll)
[emacs.git] / src / buffer.c
blobf55ae7983f471172e0255adeab8ba692d94ad0e0
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->last_selected_window = Qnil;
698 XSETINT (b->display_count, 0);
699 b->display_time = Qnil;
700 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
701 b->cursor_type = buffer_defaults.cursor_type;
702 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
704 b->display_error_modiff = 0;
707 /* Reset buffer B's local variables info.
708 Don't use this on a buffer that has already been in use;
709 it does not treat permanent locals consistently.
710 Instead, use Fkill_all_local_variables.
712 If PERMANENT_TOO is 1, then we reset permanent built-in
713 buffer-local variables. If PERMANENT_TOO is 0,
714 we preserve those. */
716 static void
717 reset_buffer_local_variables (b, permanent_too)
718 register struct buffer *b;
719 int permanent_too;
721 register int offset;
722 int i;
724 /* Reset the major mode to Fundamental, together with all the
725 things that depend on the major mode.
726 default-major-mode is handled at a higher level.
727 We ignore it here. */
728 b->major_mode = Qfundamental_mode;
729 b->keymap = Qnil;
730 b->mode_name = QSFundamental;
731 b->minor_modes = Qnil;
733 /* If the standard case table has been altered and invalidated,
734 fix up its insides first. */
735 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
736 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
737 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
738 Fset_standard_case_table (Vascii_downcase_table);
740 b->downcase_table = Vascii_downcase_table;
741 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
742 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
743 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
744 b->invisibility_spec = Qt;
745 #ifndef DOS_NT
746 b->buffer_file_type = Qnil;
747 #endif
749 /* Reset all (or most) per-buffer variables to their defaults. */
750 b->local_var_alist = Qnil;
751 for (i = 0; i < last_per_buffer_idx; ++i)
752 if (permanent_too || buffer_permanent_local_flags[i] == 0)
753 SET_PER_BUFFER_VALUE_P (b, i, 0);
755 /* For each slot that has a default value,
756 copy that into the slot. */
758 for (offset = PER_BUFFER_VAR_OFFSET (name);
759 offset < sizeof *b;
760 offset += sizeof (Lisp_Object))
762 int idx = PER_BUFFER_IDX (offset);
763 if ((idx > 0
764 && (permanent_too
765 || buffer_permanent_local_flags[idx] == 0))
766 /* Is -2 used anywhere? */
767 || idx == -2)
768 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
772 /* We split this away from generate-new-buffer, because rename-buffer
773 and set-visited-file-name ought to be able to use this to really
774 rename the buffer properly. */
776 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
777 1, 2, 0,
778 doc: /* Return a string that is the name of no existing buffer based on NAME.
779 If there is no live buffer named NAME, then return NAME.
780 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
781 \(starting at 2) until an unused name is found, and then return that name.
782 Optional second argument IGNORE specifies a name that is okay to use
783 \(if it is in the sequence to be tried)
784 even if a buffer with that name exists. */)
785 (name, ignore)
786 register Lisp_Object name, ignore;
788 register Lisp_Object gentemp, tem;
789 int count;
790 char number[10];
792 CHECK_STRING (name);
794 tem = Fstring_equal (name, ignore);
795 if (!NILP (tem))
796 return name;
797 tem = Fget_buffer (name);
798 if (NILP (tem))
799 return name;
801 count = 1;
802 while (1)
804 sprintf (number, "<%d>", ++count);
805 gentemp = concat2 (name, build_string (number));
806 tem = Fstring_equal (gentemp, ignore);
807 if (!NILP (tem))
808 return gentemp;
809 tem = Fget_buffer (gentemp);
810 if (NILP (tem))
811 return gentemp;
816 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
817 doc: /* Return the name of BUFFER, as a string.
818 With no argument or nil as argument, return the name of the current buffer. */)
819 (buffer)
820 register Lisp_Object buffer;
822 if (NILP (buffer))
823 return current_buffer->name;
824 CHECK_BUFFER (buffer);
825 return XBUFFER (buffer)->name;
828 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
829 doc: /* Return name of file BUFFER is visiting, or nil if none.
830 No argument or nil as argument means use the current buffer. */)
831 (buffer)
832 register Lisp_Object buffer;
834 if (NILP (buffer))
835 return current_buffer->filename;
836 CHECK_BUFFER (buffer);
837 return XBUFFER (buffer)->filename;
840 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
841 0, 1, 0,
842 doc: /* Return the base buffer of indirect buffer BUFFER.
843 If BUFFER is not indirect, return nil.
844 BUFFER defaults to the current buffer. */)
845 (buffer)
846 register Lisp_Object buffer;
848 struct buffer *base;
849 Lisp_Object base_buffer;
851 if (NILP (buffer))
852 base = current_buffer->base_buffer;
853 else
855 CHECK_BUFFER (buffer);
856 base = XBUFFER (buffer)->base_buffer;
859 if (! base)
860 return Qnil;
861 XSETBUFFER (base_buffer, base);
862 return base_buffer;
865 DEFUN ("buffer-local-value", Fbuffer_local_value,
866 Sbuffer_local_value, 2, 2, 0,
867 doc: /* Return the value of VARIABLE in BUFFER.
868 If VARIABLE does not have a buffer-local binding in BUFFER, the value
869 is the default binding of variable. */)
870 (symbol, buffer)
871 register Lisp_Object symbol;
872 register Lisp_Object buffer;
874 register struct buffer *buf;
875 register Lisp_Object result;
877 CHECK_SYMBOL (symbol);
878 CHECK_BUFFER (buffer);
879 buf = XBUFFER (buffer);
881 /* Look in local_var_list */
882 result = Fassoc (symbol, buf->local_var_alist);
883 if (NILP (result))
885 int offset, idx;
886 int found = 0;
888 /* Look in special slots */
889 for (offset = PER_BUFFER_VAR_OFFSET (name);
890 offset < sizeof (struct buffer);
891 /* sizeof EMACS_INT == sizeof Lisp_Object */
892 offset += (sizeof (EMACS_INT)))
894 idx = PER_BUFFER_IDX (offset);
895 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
896 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
897 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
899 result = PER_BUFFER_VALUE (buf, offset);
900 found = 1;
901 break;
905 if (!found)
906 result = Fdefault_value (symbol);
908 else
910 Lisp_Object valcontents;
911 Lisp_Object current_alist_element;
913 /* What binding is loaded right now? */
914 valcontents = SYMBOL_VALUE (symbol);
915 current_alist_element
916 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
918 /* The value of the currently loaded binding is not
919 stored in it, but rather in the realvalue slot.
920 Store that value into the binding it belongs to
921 in case that is the one we are about to use. */
923 Fsetcdr (current_alist_element,
924 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
926 /* Now get the (perhaps updated) value out of the binding. */
927 result = XCDR (result);
930 if (EQ (result, Qunbound))
931 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
933 return result;
936 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
937 Sbuffer_local_variables, 0, 1, 0,
938 doc: /* Return an alist of variables that are buffer-local in BUFFER.
939 Most elements look like (SYMBOL . VALUE), describing one variable.
940 For a symbol that is locally unbound, just the symbol appears in the value.
941 Note that storing new VALUEs in these elements doesn't change the variables.
942 No argument or nil as argument means use current buffer as BUFFER. */)
943 (buffer)
944 register Lisp_Object buffer;
946 register struct buffer *buf;
947 register Lisp_Object result;
949 if (NILP (buffer))
950 buf = current_buffer;
951 else
953 CHECK_BUFFER (buffer);
954 buf = XBUFFER (buffer);
957 result = Qnil;
960 register Lisp_Object tail;
961 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
963 Lisp_Object val, elt;
965 elt = XCAR (tail);
967 /* Reference each variable in the alist in buf.
968 If inquiring about the current buffer, this gets the current values,
969 so store them into the alist so the alist is up to date.
970 If inquiring about some other buffer, this swaps out any values
971 for that buffer, making the alist up to date automatically. */
972 val = find_symbol_value (XCAR (elt));
973 /* Use the current buffer value only if buf is the current buffer. */
974 if (buf != current_buffer)
975 val = XCDR (elt);
977 /* If symbol is unbound, put just the symbol in the list. */
978 if (EQ (val, Qunbound))
979 result = Fcons (XCAR (elt), result);
980 /* Otherwise, put (symbol . value) in the list. */
981 else
982 result = Fcons (Fcons (XCAR (elt), val), result);
986 /* Add on all the variables stored in special slots. */
988 int offset, idx;
990 for (offset = PER_BUFFER_VAR_OFFSET (name);
991 offset < sizeof (struct buffer);
992 /* sizeof EMACS_INT == sizeof Lisp_Object */
993 offset += (sizeof (EMACS_INT)))
995 idx = PER_BUFFER_IDX (offset);
996 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
997 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
998 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
999 PER_BUFFER_VALUE (buf, offset)),
1000 result);
1004 return result;
1008 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1009 0, 1, 0,
1010 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1011 No argument or nil as argument means use current buffer as BUFFER. */)
1012 (buffer)
1013 register Lisp_Object buffer;
1015 register struct buffer *buf;
1016 if (NILP (buffer))
1017 buf = current_buffer;
1018 else
1020 CHECK_BUFFER (buffer);
1021 buf = XBUFFER (buffer);
1024 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1027 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1028 1, 1, 0,
1029 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1030 A non-nil FLAG means mark the buffer modified. */)
1031 (flag)
1032 register Lisp_Object flag;
1034 register int already;
1035 register Lisp_Object fn;
1036 Lisp_Object buffer, window;
1038 #ifdef CLASH_DETECTION
1039 /* If buffer becoming modified, lock the file.
1040 If buffer becoming unmodified, unlock the file. */
1042 fn = current_buffer->file_truename;
1043 /* Test buffer-file-name so that binding it to nil is effective. */
1044 if (!NILP (fn) && ! NILP (current_buffer->filename))
1046 already = SAVE_MODIFF < MODIFF;
1047 if (!already && !NILP (flag))
1048 lock_file (fn);
1049 else if (already && NILP (flag))
1050 unlock_file (fn);
1052 #endif /* CLASH_DETECTION */
1054 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1056 /* Set update_mode_lines only if buffer is displayed in some window.
1057 Packages like jit-lock or lazy-lock preserve a buffer's modified
1058 state by recording/restoring the state around blocks of code.
1059 Setting update_mode_lines makes redisplay consider all windows
1060 (on all frames). Stealth fontification of buffers not displayed
1061 would incur additional redisplay costs if we'd set
1062 update_modes_lines unconditionally.
1064 Ideally, I think there should be another mechanism for fontifying
1065 buffers without "modifying" buffers, or redisplay should be
1066 smarter about updating the `*' in mode lines. --gerd */
1067 XSETBUFFER (buffer, current_buffer);
1068 window = Fget_buffer_window (buffer, Qt);
1069 if (WINDOWP (window))
1071 ++update_mode_lines;
1072 current_buffer->prevent_redisplay_optimizations_p = 1;
1075 return flag;
1078 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1079 Srestore_buffer_modified_p, 1, 1, 0,
1080 doc: /* Like `set-buffer-modified-p', with a differences concerning redisplay.
1081 It is not ensured that mode lines will be updated to show the modified
1082 state of the current buffer. Use with care. */)
1083 (flag)
1084 Lisp_Object flag;
1086 #ifdef CLASH_DETECTION
1087 Lisp_Object fn;
1089 /* If buffer becoming modified, lock the file.
1090 If buffer becoming unmodified, unlock the file. */
1092 fn = current_buffer->file_truename;
1093 /* Test buffer-file-name so that binding it to nil is effective. */
1094 if (!NILP (fn) && ! NILP (current_buffer->filename))
1096 int already = SAVE_MODIFF < MODIFF;
1097 if (!already && !NILP (flag))
1098 lock_file (fn);
1099 else if (already && NILP (flag))
1100 unlock_file (fn);
1102 #endif /* CLASH_DETECTION */
1104 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1105 return flag;
1108 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1109 0, 1, 0,
1110 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1111 Each buffer has a tick counter which is incremented each time the text in
1112 that buffer is changed. It wraps around occasionally.
1113 No argument or nil as argument means use current buffer as BUFFER. */)
1114 (buffer)
1115 register Lisp_Object buffer;
1117 register struct buffer *buf;
1118 if (NILP (buffer))
1119 buf = current_buffer;
1120 else
1122 CHECK_BUFFER (buffer);
1123 buf = XBUFFER (buffer);
1126 return make_number (BUF_MODIFF (buf));
1129 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1130 "sRename buffer (to new name): \nP",
1131 doc: /* Change current buffer's name to NEWNAME (a string).
1132 If second arg UNIQUE is nil or omitted, it is an error if a
1133 buffer named NEWNAME already exists.
1134 If UNIQUE is non-nil, come up with a new name using
1135 `generate-new-buffer-name'.
1136 Interactively, you can set UNIQUE with a prefix argument.
1137 We return the name we actually gave the buffer.
1138 This does not change the name of the visited file (if any). */)
1139 (newname, unique)
1140 register Lisp_Object newname, unique;
1142 register Lisp_Object tem, buf;
1144 CHECK_STRING (newname);
1146 if (SCHARS (newname) == 0)
1147 error ("Empty string is invalid as a buffer name");
1149 tem = Fget_buffer (newname);
1150 if (!NILP (tem))
1152 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1153 rename the buffer automatically so you can create another
1154 with the original name. It makes UNIQUE equivalent to
1155 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1156 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1157 return current_buffer->name;
1158 if (!NILP (unique))
1159 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1160 else
1161 error ("Buffer name `%s' is in use", SDATA (newname));
1164 current_buffer->name = newname;
1166 /* Catch redisplay's attention. Unless we do this, the mode lines for
1167 any windows displaying current_buffer will stay unchanged. */
1168 update_mode_lines++;
1170 XSETBUFFER (buf, current_buffer);
1171 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1172 if (NILP (current_buffer->filename)
1173 && !NILP (current_buffer->auto_save_file_name))
1174 call0 (intern ("rename-auto-save-file"));
1175 /* Refetch since that last call may have done GC. */
1176 return current_buffer->name;
1179 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1180 doc: /* Return most recently selected buffer other than BUFFER.
1181 Buffers not visible in windows are preferred to visible buffers,
1182 unless optional second argument VISIBLE-OK is non-nil.
1183 If the optional third argument FRAME is non-nil, use that frame's
1184 buffer list instead of the selected frame's buffer list.
1185 If no other buffer exists, the buffer `*scratch*' is returned.
1186 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1187 (buffer, visible_ok, frame)
1188 register Lisp_Object buffer, visible_ok, frame;
1190 Lisp_Object Fset_buffer_major_mode ();
1191 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1192 notsogood = Qnil;
1194 if (NILP (frame))
1195 frame = selected_frame;
1197 tail = Vbuffer_alist;
1198 pred = frame_buffer_predicate (frame);
1200 /* Consider buffers that have been seen in the selected frame
1201 before other buffers. */
1203 tem = frame_buffer_list (frame);
1204 add_ons = Qnil;
1205 while (CONSP (tem))
1207 if (BUFFERP (XCAR (tem)))
1208 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1209 tem = XCDR (tem);
1211 tail = nconc2 (Fnreverse (add_ons), tail);
1213 for (; CONSP (tail); tail = XCDR (tail))
1215 buf = Fcdr (XCAR (tail));
1216 if (EQ (buf, buffer))
1217 continue;
1218 if (NILP (buf))
1219 continue;
1220 if (NILP (XBUFFER (buf)->name))
1221 continue;
1222 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1223 continue;
1224 /* If the selected frame has a buffer_predicate,
1225 disregard buffers that don't fit the predicate. */
1226 if (!NILP (pred))
1228 tem = call1 (pred, buf);
1229 if (NILP (tem))
1230 continue;
1233 if (NILP (visible_ok))
1234 tem = Fget_buffer_window (buf, Qvisible);
1235 else
1236 tem = Qnil;
1237 if (NILP (tem))
1238 return buf;
1239 if (NILP (notsogood))
1240 notsogood = buf;
1242 if (!NILP (notsogood))
1243 return notsogood;
1244 buf = Fget_buffer (build_string ("*scratch*"));
1245 if (NILP (buf))
1247 buf = Fget_buffer_create (build_string ("*scratch*"));
1248 Fset_buffer_major_mode (buf);
1250 return buf;
1253 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
1254 0, 1, "",
1255 doc: /* Make BUFFER stop keeping undo information.
1256 No argument or nil as argument means do this for the current buffer. */)
1257 (buffer)
1258 register Lisp_Object buffer;
1260 Lisp_Object real_buffer;
1262 if (NILP (buffer))
1263 XSETBUFFER (real_buffer, current_buffer);
1264 else
1266 real_buffer = Fget_buffer (buffer);
1267 if (NILP (real_buffer))
1268 nsberror (buffer);
1271 XBUFFER (real_buffer)->undo_list = Qt;
1273 return Qnil;
1276 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1277 0, 1, "",
1278 doc: /* Start keeping undo information for buffer BUFFER.
1279 No argument or nil as argument means do this for the current buffer. */)
1280 (buffer)
1281 register Lisp_Object buffer;
1283 Lisp_Object real_buffer;
1285 if (NILP (buffer))
1286 XSETBUFFER (real_buffer, current_buffer);
1287 else
1289 real_buffer = Fget_buffer (buffer);
1290 if (NILP (real_buffer))
1291 nsberror (buffer);
1294 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1295 XBUFFER (real_buffer)->undo_list = Qnil;
1297 return Qnil;
1301 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1302 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1303 The buffer being killed will be current while the hook is running.\n\
1304 See `kill-buffer'."
1306 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1307 doc: /* Kill the buffer BUFFER.
1308 The argument may be a buffer or may be the name of a buffer.
1309 An argument of nil means kill the current buffer.
1311 Value is t if the buffer is actually killed, nil if user says no.
1313 The value of `kill-buffer-hook' (which may be local to that buffer),
1314 if not void, is a list of functions to be called, with no arguments,
1315 before the buffer is actually killed. The buffer to be killed is current
1316 when the hook functions are called.
1318 Any processes that have this buffer as the `process-buffer' are killed
1319 with SIGHUP. */)
1320 (buffer)
1321 Lisp_Object buffer;
1323 Lisp_Object buf;
1324 register struct buffer *b;
1325 register Lisp_Object tem;
1326 register struct Lisp_Marker *m;
1327 struct gcpro gcpro1;
1329 if (NILP (buffer))
1330 buf = Fcurrent_buffer ();
1331 else
1332 buf = Fget_buffer (buffer);
1333 if (NILP (buf))
1334 nsberror (buffer);
1336 b = XBUFFER (buf);
1338 /* Avoid trouble for buffer already dead. */
1339 if (NILP (b->name))
1340 return Qnil;
1342 /* Query if the buffer is still modified. */
1343 if (INTERACTIVE && !NILP (b->filename)
1344 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1346 GCPRO1 (buf);
1347 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1348 b->name, make_number (0)));
1349 UNGCPRO;
1350 if (NILP (tem))
1351 return Qnil;
1354 /* Run hooks with the buffer to be killed the current buffer. */
1356 int count = SPECPDL_INDEX ();
1357 Lisp_Object arglist[1];
1359 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1360 set_buffer_internal (b);
1362 /* First run the query functions; if any query is answered no,
1363 don't kill the buffer. */
1364 arglist[0] = Qkill_buffer_query_functions;
1365 if (NILP (Frun_hook_with_args_until_failure (1, arglist)))
1366 return unbind_to (count, Qnil);
1368 /* Then run the hooks. */
1369 Frun_hooks (1, &Qkill_buffer_hook);
1370 unbind_to (count, Qnil);
1373 /* We have no more questions to ask. Verify that it is valid
1374 to kill the buffer. This must be done after the questions
1375 since anything can happen within do_yes_or_no_p. */
1377 /* Don't kill the minibuffer now current. */
1378 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1379 return Qnil;
1381 if (NILP (b->name))
1382 return Qnil;
1384 /* When we kill a base buffer, kill all its indirect buffers.
1385 We do it at this stage so nothing terrible happens if they
1386 ask questions or their hooks get errors. */
1387 if (! b->base_buffer)
1389 struct buffer *other;
1391 GCPRO1 (buf);
1393 for (other = all_buffers; other; other = other->next)
1394 /* all_buffers contains dead buffers too;
1395 don't re-kill them. */
1396 if (other->base_buffer == b && !NILP (other->name))
1398 Lisp_Object buf;
1399 XSETBUFFER (buf, other);
1400 Fkill_buffer (buf);
1403 UNGCPRO;
1406 /* Make this buffer not be current.
1407 In the process, notice if this is the sole visible buffer
1408 and give up if so. */
1409 if (b == current_buffer)
1411 tem = Fother_buffer (buf, Qnil, Qnil);
1412 Fset_buffer (tem);
1413 if (b == current_buffer)
1414 return Qnil;
1417 /* Notice if the buffer to kill is the sole visible buffer
1418 when we're currently in the mini-buffer, and give up if so. */
1419 XSETBUFFER (tem, current_buffer);
1420 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1422 tem = Fother_buffer (buf, Qnil, Qnil);
1423 if (EQ (buf, tem))
1424 return Qnil;
1427 /* Now there is no question: we can kill the buffer. */
1429 #ifdef CLASH_DETECTION
1430 /* Unlock this buffer's file, if it is locked. */
1431 unlock_buffer (b);
1432 #endif /* CLASH_DETECTION */
1434 kill_buffer_processes (buf);
1435 clear_charpos_cache (b);
1437 tem = Vinhibit_quit;
1438 Vinhibit_quit = Qt;
1439 replace_buffer_in_all_windows (buf);
1440 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1441 frames_discard_buffer (buf);
1442 Vinhibit_quit = tem;
1444 /* Delete any auto-save file, if we saved it in this session.
1445 But not if the buffer is modified. */
1446 if (STRINGP (b->auto_save_file_name)
1447 && b->auto_save_modified != 0
1448 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1449 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1450 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1452 Lisp_Object tem;
1453 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1454 if (! NILP (tem))
1455 internal_delete_file (b->auto_save_file_name);
1458 if (b->base_buffer)
1460 /* Unchain all markers that belong to this indirect buffer.
1461 Don't unchain the markers that belong to the base buffer
1462 or its other indirect buffers. */
1463 for (m = BUF_MARKERS (b); m; )
1465 struct Lisp_Marker *next = m->next;
1466 if (m->buffer == b)
1467 unchain_marker (m);
1468 m = next;
1471 else
1473 /* Unchain all markers of this buffer and its indirect buffers.
1474 and leave them pointing nowhere. */
1475 for (m = BUF_MARKERS (b); m; )
1477 struct Lisp_Marker *next = m->next;
1478 m->buffer = 0;
1479 m->next = NULL;
1480 m = next;
1482 BUF_MARKERS (b) = NULL;
1483 BUF_INTERVALS (b) = NULL_INTERVAL;
1485 /* Perhaps we should explicitly free the interval tree here... */
1488 /* Reset the local variables, so that this buffer's local values
1489 won't be protected from GC. They would be protected
1490 if they happened to remain encached in their symbols.
1491 This gets rid of them for certain. */
1492 swap_out_buffer_local_variables (b);
1493 reset_buffer_local_variables (b, 1);
1495 b->name = Qnil;
1497 BLOCK_INPUT;
1498 if (! b->base_buffer)
1499 free_buffer_text (b);
1501 if (b->newline_cache)
1503 free_region_cache (b->newline_cache);
1504 b->newline_cache = 0;
1506 if (b->width_run_cache)
1508 free_region_cache (b->width_run_cache);
1509 b->width_run_cache = 0;
1511 b->width_table = Qnil;
1512 UNBLOCK_INPUT;
1513 b->undo_list = Qnil;
1515 return Qt;
1518 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1519 we do this each time BUF is selected visibly, the more recently
1520 selected buffers are always closer to the front of the list. This
1521 means that other_buffer is more likely to choose a relevant buffer. */
1523 void
1524 record_buffer (buf)
1525 Lisp_Object buf;
1527 register Lisp_Object link, prev;
1528 Lisp_Object frame;
1529 frame = selected_frame;
1531 prev = Qnil;
1532 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1534 if (EQ (XCDR (XCAR (link)), buf))
1535 break;
1536 prev = link;
1539 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1540 we cannot use Fdelq itself here because it allows quitting. */
1542 if (NILP (prev))
1543 Vbuffer_alist = XCDR (Vbuffer_alist);
1544 else
1545 XSETCDR (prev, XCDR (XCDR (prev)));
1547 XSETCDR (link, Vbuffer_alist);
1548 Vbuffer_alist = link;
1550 /* Now move this buffer to the front of frame_buffer_list also. */
1552 prev = Qnil;
1553 for (link = frame_buffer_list (frame); CONSP (link);
1554 link = XCDR (link))
1556 if (EQ (XCAR (link), buf))
1557 break;
1558 prev = link;
1561 /* Effectively do delq. */
1563 if (CONSP (link))
1565 if (NILP (prev))
1566 set_frame_buffer_list (frame,
1567 XCDR (frame_buffer_list (frame)));
1568 else
1569 XSETCDR (prev, XCDR (XCDR (prev)));
1571 XSETCDR (link, frame_buffer_list (frame));
1572 set_frame_buffer_list (frame, link);
1574 else
1575 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1578 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1579 doc: /* Set an appropriate major mode for BUFFER.
1580 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1581 according to `default-major-mode'.
1582 Use this function before selecting the buffer, since it may need to inspect
1583 the current buffer's major mode. */)
1584 (buffer)
1585 Lisp_Object buffer;
1587 int count;
1588 Lisp_Object function;
1590 if (STRINGP (XBUFFER (buffer)->name)
1591 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1592 function = find_symbol_value (intern ("initial-major-mode"));
1593 else
1595 function = buffer_defaults.major_mode;
1596 if (NILP (function)
1597 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1598 function = current_buffer->major_mode;
1601 if (NILP (function) || EQ (function, Qfundamental_mode))
1602 return Qnil;
1604 count = SPECPDL_INDEX ();
1606 /* To select a nonfundamental mode,
1607 select the buffer temporarily and then call the mode function. */
1609 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1611 Fset_buffer (buffer);
1612 call0 (function);
1614 return unbind_to (count, Qnil);
1617 /* If switching buffers in WINDOW would be an error, return
1618 a C string saying what the error would be. */
1620 char *
1621 no_switch_window (window)
1622 Lisp_Object window;
1624 Lisp_Object tem;
1625 if (EQ (minibuf_window, window))
1626 return "Cannot switch buffers in minibuffer window";
1627 tem = Fwindow_dedicated_p (window);
1628 if (EQ (tem, Qt))
1629 return "Cannot switch buffers in a dedicated window";
1630 return NULL;
1633 /* Switch to buffer BUFFER in the selected window.
1634 If NORECORD is non-nil, don't call record_buffer. */
1636 Lisp_Object
1637 switch_to_buffer_1 (buffer, norecord)
1638 Lisp_Object buffer, norecord;
1640 register Lisp_Object buf;
1642 if (NILP (buffer))
1643 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1644 else
1646 buf = Fget_buffer (buffer);
1647 if (NILP (buf))
1649 buf = Fget_buffer_create (buffer);
1650 Fset_buffer_major_mode (buf);
1653 Fset_buffer (buf);
1654 if (NILP (norecord))
1655 record_buffer (buf);
1657 Fset_window_buffer (EQ (selected_window, minibuf_window)
1658 ? Fnext_window (minibuf_window, Qnil, Qnil)
1659 : selected_window,
1660 buf, Qnil);
1662 return buf;
1665 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1666 doc: /* Select buffer BUFFER in the current window.
1667 If BUFFER does not identify an existing buffer,
1668 then this function creates a buffer with that name.
1670 When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1671 or nil. If BUFFER is nil, then this function chooses a buffer
1672 using `other-buffer'.
1673 Optional second arg NORECORD non-nil means
1674 do not put this buffer at the front of the list of recently selected ones.
1675 This function returns the buffer it switched to.
1677 WARNING: This is NOT the way to work on another buffer temporarily
1678 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1679 the window-buffer correspondences. */)
1680 (buffer, norecord)
1681 Lisp_Object buffer, norecord;
1683 char *err;
1685 if (EQ (buffer, Fwindow_buffer (selected_window)))
1686 /* Basically a NOP. Avoid signalling an error if the selected window
1687 is dedicated, or a minibuffer, ... */
1688 return Fset_buffer (buffer);
1690 err = no_switch_window (selected_window);
1691 if (err) error (err);
1693 return switch_to_buffer_1 (buffer, norecord);
1696 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1697 doc: /* Select buffer BUFFER in some window, preferably a different one.
1698 BUFFER may be a buffer, a string \(a buffer name), or nil.
1699 If BUFFER is a string which is not the name of an existing buffer,
1700 then this function creates a buffer with that name.
1701 If BUFFER is nil, then it chooses some other buffer.
1702 If `pop-up-windows' is non-nil, windows can be split to do this.
1703 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1704 window even if BUFFER is already visible in the selected window,
1705 and ignore `same-window-regexps' and `same-window-buffer-names'.
1706 This function returns the buffer it switched to.
1707 This uses the function `display-buffer' as a subroutine; see the documentation
1708 of `display-buffer' for additional customization information.
1710 Optional third arg NORECORD non-nil means
1711 do not put this buffer at the front of the list of recently selected ones. */)
1712 (buffer, other_window, norecord)
1713 Lisp_Object buffer, other_window, norecord;
1715 register Lisp_Object buf;
1716 if (NILP (buffer))
1717 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1718 else
1720 buf = Fget_buffer (buffer);
1721 if (NILP (buf))
1723 buf = Fget_buffer_create (buffer);
1724 Fset_buffer_major_mode (buf);
1727 Fset_buffer (buf);
1728 if (NILP (norecord))
1729 /* Why bother ? Fselect_window will do it for us anyway. -stef */
1730 record_buffer (buf);
1731 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1732 return buf;
1735 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1736 doc: /* Return the current buffer as a Lisp object. */)
1739 register Lisp_Object buf;
1740 XSETBUFFER (buf, current_buffer);
1741 return buf;
1744 /* Set the current buffer to B.
1746 We previously set windows_or_buffers_changed here to invalidate
1747 global unchanged information in beg_unchanged and end_unchanged.
1748 This is no longer necessary because we now compute unchanged
1749 information on a buffer-basis. Every action affecting other
1750 windows than the selected one requires a select_window at some
1751 time, and that increments windows_or_buffers_changed. */
1753 void
1754 set_buffer_internal (b)
1755 register struct buffer *b;
1757 if (current_buffer != b)
1758 set_buffer_internal_1 (b);
1761 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1762 This is used by redisplay. */
1764 void
1765 set_buffer_internal_1 (b)
1766 register struct buffer *b;
1768 register struct buffer *old_buf;
1769 register Lisp_Object tail, valcontents;
1770 Lisp_Object tem;
1772 #ifdef USE_MMAP_FOR_BUFFERS
1773 if (b->text->beg == NULL)
1774 enlarge_buffer_text (b, 0);
1775 #endif /* USE_MMAP_FOR_BUFFERS */
1777 if (current_buffer == b)
1778 return;
1780 old_buf = current_buffer;
1781 current_buffer = b;
1782 last_known_column_point = -1; /* invalidate indentation cache */
1784 if (old_buf)
1786 /* Put the undo list back in the base buffer, so that it appears
1787 that an indirect buffer shares the undo list of its base. */
1788 if (old_buf->base_buffer)
1789 old_buf->base_buffer->undo_list = old_buf->undo_list;
1791 /* If the old current buffer has markers to record PT, BEGV and ZV
1792 when it is not current, update them now. */
1793 if (! NILP (old_buf->pt_marker))
1795 Lisp_Object obuf;
1796 XSETBUFFER (obuf, old_buf);
1797 set_marker_both (old_buf->pt_marker, obuf,
1798 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1800 if (! NILP (old_buf->begv_marker))
1802 Lisp_Object obuf;
1803 XSETBUFFER (obuf, old_buf);
1804 set_marker_both (old_buf->begv_marker, obuf,
1805 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1807 if (! NILP (old_buf->zv_marker))
1809 Lisp_Object obuf;
1810 XSETBUFFER (obuf, old_buf);
1811 set_marker_both (old_buf->zv_marker, obuf,
1812 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1816 /* Get the undo list from the base buffer, so that it appears
1817 that an indirect buffer shares the undo list of its base. */
1818 if (b->base_buffer)
1819 b->undo_list = b->base_buffer->undo_list;
1821 /* If the new current buffer has markers to record PT, BEGV and ZV
1822 when it is not current, fetch them now. */
1823 if (! NILP (b->pt_marker))
1825 BUF_PT (b) = marker_position (b->pt_marker);
1826 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1828 if (! NILP (b->begv_marker))
1830 BUF_BEGV (b) = marker_position (b->begv_marker);
1831 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1833 if (! NILP (b->zv_marker))
1835 BUF_ZV (b) = marker_position (b->zv_marker);
1836 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1839 /* Look down buffer's list of local Lisp variables
1840 to find and update any that forward into C variables. */
1842 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1844 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1845 if ((BUFFER_LOCAL_VALUEP (valcontents)
1846 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1847 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1848 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1849 /* Just reference the variable
1850 to cause it to become set for this buffer. */
1851 Fsymbol_value (XCAR (XCAR (tail)));
1854 /* Do the same with any others that were local to the previous buffer */
1856 if (old_buf)
1857 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1859 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1860 if ((BUFFER_LOCAL_VALUEP (valcontents)
1861 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1862 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1863 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1864 /* Just reference the variable
1865 to cause it to become set for this buffer. */
1866 Fsymbol_value (XCAR (XCAR (tail)));
1870 /* Switch to buffer B temporarily for redisplay purposes.
1871 This avoids certain things that don't need to be done within redisplay. */
1873 void
1874 set_buffer_temp (b)
1875 struct buffer *b;
1877 register struct buffer *old_buf;
1879 if (current_buffer == b)
1880 return;
1882 old_buf = current_buffer;
1883 current_buffer = b;
1885 if (old_buf)
1887 /* If the old current buffer has markers to record PT, BEGV and ZV
1888 when it is not current, update them now. */
1889 if (! NILP (old_buf->pt_marker))
1891 Lisp_Object obuf;
1892 XSETBUFFER (obuf, old_buf);
1893 set_marker_both (old_buf->pt_marker, obuf,
1894 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1896 if (! NILP (old_buf->begv_marker))
1898 Lisp_Object obuf;
1899 XSETBUFFER (obuf, old_buf);
1900 set_marker_both (old_buf->begv_marker, obuf,
1901 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1903 if (! NILP (old_buf->zv_marker))
1905 Lisp_Object obuf;
1906 XSETBUFFER (obuf, old_buf);
1907 set_marker_both (old_buf->zv_marker, obuf,
1908 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1912 /* If the new current buffer has markers to record PT, BEGV and ZV
1913 when it is not current, fetch them now. */
1914 if (! NILP (b->pt_marker))
1916 BUF_PT (b) = marker_position (b->pt_marker);
1917 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1919 if (! NILP (b->begv_marker))
1921 BUF_BEGV (b) = marker_position (b->begv_marker);
1922 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1924 if (! NILP (b->zv_marker))
1926 BUF_ZV (b) = marker_position (b->zv_marker);
1927 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1931 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1932 doc: /* Make the buffer BUFFER current for editing operations.
1933 BUFFER may be a buffer or the name of an existing buffer.
1934 See also `save-excursion' when you want to make a buffer current temporarily.
1935 This function does not display the buffer, so its effect ends
1936 when the current command terminates.
1937 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1938 (buffer)
1939 register Lisp_Object buffer;
1941 register Lisp_Object buf;
1942 buf = Fget_buffer (buffer);
1943 if (NILP (buf))
1944 nsberror (buffer);
1945 if (NILP (XBUFFER (buf)->name))
1946 error ("Selecting deleted buffer");
1947 set_buffer_internal (XBUFFER (buf));
1948 return buf;
1951 /* Set the current buffer to BUFFER provided it is alive. */
1953 Lisp_Object
1954 set_buffer_if_live (buffer)
1955 Lisp_Object buffer;
1957 if (! NILP (XBUFFER (buffer)->name))
1958 Fset_buffer (buffer);
1959 return Qnil;
1962 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1963 Sbarf_if_buffer_read_only, 0, 0, 0,
1964 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1967 if (!NILP (current_buffer->read_only)
1968 && NILP (Vinhibit_read_only))
1969 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1970 return Qnil;
1973 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1974 doc: /* Put BUFFER at the end of the list of all buffers.
1975 There it is the least likely candidate for `other-buffer' to return;
1976 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1977 If BUFFER is nil or omitted, bury the current buffer.
1978 Also, if BUFFER is nil or omitted, remove the current buffer from the
1979 selected window if it is displayed there. */)
1980 (buffer)
1981 register Lisp_Object buffer;
1983 /* Figure out what buffer we're going to bury. */
1984 if (NILP (buffer))
1986 Lisp_Object tem;
1987 XSETBUFFER (buffer, current_buffer);
1989 tem = Fwindow_buffer (selected_window);
1990 /* If we're burying the current buffer, unshow it. */
1991 if (EQ (buffer, tem))
1993 if (NILP (Fwindow_dedicated_p (selected_window)))
1994 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1995 else if (NILP (XWINDOW (selected_window)->parent))
1996 Ficonify_frame (Fwindow_frame (selected_window));
1997 else
1998 Fdelete_window (selected_window);
2001 else
2003 Lisp_Object buf1;
2005 buf1 = Fget_buffer (buffer);
2006 if (NILP (buf1))
2007 nsberror (buffer);
2008 buffer = buf1;
2011 /* Move buffer to the end of the buffer list. Do nothing if the
2012 buffer is killed. */
2013 if (!NILP (XBUFFER (buffer)->name))
2015 Lisp_Object aelt, link;
2017 aelt = Frassq (buffer, Vbuffer_alist);
2018 link = Fmemq (aelt, Vbuffer_alist);
2019 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2020 XSETCDR (link, Qnil);
2021 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2023 /* Removing BUFFER from frame-specific lists
2024 has the effect of putting BUFFER at the end
2025 of the combined list in each frame. */
2026 frames_discard_buffer (buffer);
2029 return Qnil;
2032 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2033 doc: /* Delete the entire contents of the current buffer.
2034 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2035 so the buffer is truly empty after this. */)
2038 Fwiden ();
2040 del_range (BEG, Z);
2042 current_buffer->last_window_start = 1;
2043 /* Prevent warnings, or suspension of auto saving, that would happen
2044 if future size is less than past size. Use of erase-buffer
2045 implies that the future text is not really related to the past text. */
2046 XSETFASTINT (current_buffer->save_length, 0);
2047 return Qnil;
2050 void
2051 validate_region (b, e)
2052 register Lisp_Object *b, *e;
2054 CHECK_NUMBER_COERCE_MARKER (*b);
2055 CHECK_NUMBER_COERCE_MARKER (*e);
2057 if (XINT (*b) > XINT (*e))
2059 Lisp_Object tem;
2060 tem = *b; *b = *e; *e = tem;
2063 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2064 && XINT (*e) <= ZV))
2065 args_out_of_range (*b, *e);
2068 /* Advance BYTE_POS up to a character boundary
2069 and return the adjusted position. */
2071 static int
2072 advance_to_char_boundary (byte_pos)
2073 int byte_pos;
2075 int c;
2077 if (byte_pos == BEG)
2078 /* Beginning of buffer is always a character boundary. */
2079 return BEG;
2081 c = FETCH_BYTE (byte_pos);
2082 if (! CHAR_HEAD_P (c))
2084 /* We should advance BYTE_POS only when C is a constituent of a
2085 multibyte sequence. */
2086 int orig_byte_pos = byte_pos;
2090 byte_pos--;
2091 c = FETCH_BYTE (byte_pos);
2093 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2094 INC_POS (byte_pos);
2095 if (byte_pos < orig_byte_pos)
2096 byte_pos = orig_byte_pos;
2097 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2098 surely advance to the correct character boundary. If C is
2099 not, BYTE_POS was unchanged. */
2102 return byte_pos;
2105 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2106 1, 1, 0,
2107 doc: /* Set the multibyte flag of the current buffer to FLAG.
2108 If FLAG is t, this makes the buffer a multibyte buffer.
2109 If FLAG is nil, this makes the buffer a single-byte buffer.
2110 The buffer contents remain unchanged as a sequence of bytes
2111 but the contents viewed as characters do change.
2112 If the multibyte flag was really changed, undo information of the
2113 current buffer is cleared. */)
2114 (flag)
2115 Lisp_Object flag;
2117 struct Lisp_Marker *tail, *markers;
2118 struct buffer *other;
2119 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
2120 int begv, zv;
2121 int narrowed = (BEG != BEGV || Z != ZV);
2122 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2124 if (current_buffer->base_buffer)
2125 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2127 /* Do nothing if nothing actually changes. */
2128 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2129 return flag;
2131 /* It would be better to update the list,
2132 but this is good enough for now. */
2133 if (undo_enabled_p)
2134 current_buffer->undo_list = Qt;
2136 /* If the cached position is for this buffer, clear it out. */
2137 clear_charpos_cache (current_buffer);
2139 if (NILP (flag))
2140 begv = BEGV_BYTE, zv = ZV_BYTE;
2141 else
2142 begv = BEGV, zv = ZV;
2144 if (narrowed)
2145 Fwiden ();
2147 if (NILP (flag))
2149 int pos, stop;
2150 unsigned char *p;
2152 /* Do this first, so it can use CHAR_TO_BYTE
2153 to calculate the old correspondences. */
2154 set_intervals_multibyte (0);
2156 current_buffer->enable_multibyte_characters = Qnil;
2158 Z = Z_BYTE;
2159 BEGV = BEGV_BYTE;
2160 ZV = ZV_BYTE;
2161 GPT = GPT_BYTE;
2162 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2165 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2166 tail->charpos = tail->bytepos;
2168 /* Convert multibyte form of 8-bit characters to unibyte. */
2169 pos = BEG;
2170 stop = GPT;
2171 p = BEG_ADDR;
2172 while (1)
2174 int c, bytes;
2176 if (pos == stop)
2178 if (pos == Z)
2179 break;
2180 p = GAP_END_ADDR;
2181 stop = Z;
2183 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2184 p += bytes, pos += bytes;
2185 else
2187 c = STRING_CHAR (p, stop - pos);
2188 /* Delete all bytes for this 8-bit character but the
2189 last one, and change the last one to the charcter
2190 code. */
2191 bytes--;
2192 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2193 p = GAP_END_ADDR;
2194 *p++ = c;
2195 pos++;
2196 if (begv > pos)
2197 begv -= bytes;
2198 if (zv > pos)
2199 zv -= bytes;
2200 stop = Z;
2203 if (narrowed)
2204 Fnarrow_to_region (make_number (begv), make_number (zv));
2206 else
2208 int pt = PT;
2209 int pos, stop;
2210 unsigned char *p;
2212 /* Be sure not to have a multibyte sequence striding over the GAP.
2213 Ex: We change this: "...abc\201 _GAP_ \241def..."
2214 to: "...abc _GAP_ \201\241def..." */
2216 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2217 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2219 unsigned char *p = GPT_ADDR - 1;
2221 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2222 if (BASE_LEADING_CODE_P (*p))
2224 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2226 move_gap_both (new_gpt, new_gpt);
2230 /* Make the buffer contents valid as multibyte by converting
2231 8-bit characters to multibyte form. */
2232 pos = BEG;
2233 stop = GPT;
2234 p = BEG_ADDR;
2235 while (1)
2237 int bytes;
2239 if (pos == stop)
2241 if (pos == Z)
2242 break;
2243 p = GAP_END_ADDR;
2244 stop = Z;
2247 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2248 p += bytes, pos += bytes;
2249 else
2251 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2253 bytes = CHAR_STRING (*p, tmp);
2254 *p = tmp[0];
2255 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2256 bytes--;
2257 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2258 /* Now the gap is after the just inserted data. */
2259 pos = GPT;
2260 p = GAP_END_ADDR;
2261 if (pos <= begv)
2262 begv += bytes;
2263 if (pos <= zv)
2264 zv += bytes;
2265 if (pos <= pt)
2266 pt += bytes;
2267 stop = Z;
2271 if (pt != PT)
2272 TEMP_SET_PT (pt);
2274 if (narrowed)
2275 Fnarrow_to_region (make_number (begv), make_number (zv));
2277 /* Do this first, so that chars_in_text asks the right question.
2278 set_intervals_multibyte needs it too. */
2279 current_buffer->enable_multibyte_characters = Qt;
2281 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2282 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2284 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2286 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2287 if (BEGV_BYTE > GPT_BYTE)
2288 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2289 else
2290 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2292 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2293 if (ZV_BYTE > GPT_BYTE)
2294 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2295 else
2296 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2299 int pt_byte = advance_to_char_boundary (PT_BYTE);
2300 int pt;
2302 if (pt_byte > GPT_BYTE)
2303 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2304 else
2305 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2306 TEMP_SET_PT_BOTH (pt, pt_byte);
2309 tail = markers = BUF_MARKERS (current_buffer);
2311 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2312 getting confused by the markers that have not yet been updated.
2313 It is also a signal that it should never create a marker. */
2314 BUF_MARKERS (current_buffer) = NULL;
2316 for (; tail; tail = tail->next)
2318 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2319 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2322 /* Make sure no markers were put on the chain
2323 while the chain value was incorrect. */
2324 if (BUF_MARKERS (current_buffer))
2325 abort ();
2327 BUF_MARKERS (current_buffer) = markers;
2329 /* Do this last, so it can calculate the new correspondences
2330 between chars and bytes. */
2331 set_intervals_multibyte (1);
2334 if (undo_enabled_p)
2335 current_buffer->undo_list = Qnil;
2337 /* Changing the multibyteness of a buffer means that all windows
2338 showing that buffer must be updated thoroughly. */
2339 current_buffer->prevent_redisplay_optimizations_p = 1;
2340 ++windows_or_buffers_changed;
2342 /* Copy this buffer's new multibyte status
2343 into all of its indirect buffers. */
2344 for (other = all_buffers; other; other = other->next)
2345 if (other->base_buffer == current_buffer && !NILP (other->name))
2347 other->enable_multibyte_characters
2348 = current_buffer->enable_multibyte_characters;
2349 other->prevent_redisplay_optimizations_p = 1;
2352 /* Restore the modifiedness of the buffer. */
2353 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2354 Fset_buffer_modified_p (Qnil);
2356 #ifdef subprocesses
2357 /* Update coding systems of this buffer's process (if any). */
2359 Lisp_Object process;
2361 process = Fget_buffer_process (Fcurrent_buffer ());
2362 if (PROCESSP (process))
2363 setup_process_coding_systems (process);
2365 #endif /* subprocesses */
2367 return flag;
2370 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2371 0, 0, 0,
2372 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2373 Most local variable bindings are eliminated so that the default values
2374 become effective once more. Also, the syntax table is set from
2375 `standard-syntax-table', the local keymap is set to nil,
2376 and the abbrev table from `fundamental-mode-abbrev-table'.
2377 This function also forces redisplay of the mode line.
2379 Every function to select a new major mode starts by
2380 calling this function.
2382 As a special exception, local variables whose names have
2383 a non-nil `permanent-local' property are not eliminated by this function.
2385 The first thing this function does is run
2386 the normal hook `change-major-mode-hook'. */)
2389 register Lisp_Object alist, sym, tem;
2390 Lisp_Object oalist;
2392 if (!NILP (Vrun_hooks))
2393 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2394 oalist = current_buffer->local_var_alist;
2396 /* Make sure none of the bindings in oalist
2397 remain swapped in, in their symbols. */
2399 swap_out_buffer_local_variables (current_buffer);
2401 /* Actually eliminate all local bindings of this buffer. */
2403 reset_buffer_local_variables (current_buffer, 0);
2405 /* Any which are supposed to be permanent,
2406 make local again, with the same values they had. */
2408 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2410 sym = XCAR (XCAR (alist));
2411 tem = Fget (sym, Qpermanent_local);
2412 if (! NILP (tem))
2414 Fmake_local_variable (sym);
2415 Fset (sym, XCDR (XCAR (alist)));
2419 /* Force mode-line redisplay. Useful here because all major mode
2420 commands call this function. */
2421 update_mode_lines++;
2423 return Qnil;
2426 /* Make sure no local variables remain set up with buffer B
2427 for their current values. */
2429 static void
2430 swap_out_buffer_local_variables (b)
2431 struct buffer *b;
2433 Lisp_Object oalist, alist, sym, tem, buffer;
2435 XSETBUFFER (buffer, b);
2436 oalist = b->local_var_alist;
2438 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2440 sym = XCAR (XCAR (alist));
2442 /* Need not do anything if some other buffer's binding is now encached. */
2443 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2444 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2446 /* Symbol is set up for this buffer's old local value.
2447 Set it up for the current buffer with the default value. */
2449 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2450 /* Store the symbol's current value into the alist entry
2451 it is currently set up for. This is so that, if the
2452 local is marked permanent, and we make it local again
2453 later in Fkill_all_local_variables, we don't lose the value. */
2454 XSETCDR (XCAR (tem),
2455 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2456 /* Switch to the symbol's default-value alist entry. */
2457 XSETCAR (tem, tem);
2458 /* Mark it as current for buffer B. */
2459 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2460 /* Store the current value into any forwarding in the symbol. */
2461 store_symval_forwarding (sym,
2462 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2463 XCDR (tem), NULL);
2468 /* Find all the overlays in the current buffer that contain position POS.
2469 Return the number found, and store them in a vector in *VEC_PTR.
2470 Store in *LEN_PTR the size allocated for the vector.
2471 Store in *NEXT_PTR the next position after POS where an overlay starts,
2472 or ZV if there are no more overlays.
2473 Store in *PREV_PTR the previous position before POS where an overlay ends,
2474 or where an overlay starts which ends at or after POS;
2475 or BEGV if there are no such overlays.
2476 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2478 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2479 when this function is called.
2481 If EXTEND is non-zero, we make the vector bigger if necessary.
2482 If EXTEND is zero, we never extend the vector,
2483 and we store only as many overlays as will fit.
2484 But we still return the total number of overlays.
2486 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2487 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2488 default (BEGV or ZV). */
2491 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2492 EMACS_INT pos;
2493 int extend;
2494 Lisp_Object **vec_ptr;
2495 int *len_ptr;
2496 int *next_ptr;
2497 int *prev_ptr;
2498 int change_req;
2500 Lisp_Object overlay, start, end;
2501 struct Lisp_Overlay *tail;
2502 int idx = 0;
2503 int len = *len_ptr;
2504 Lisp_Object *vec = *vec_ptr;
2505 int next = ZV;
2506 int prev = BEGV;
2507 int inhibit_storing = 0;
2509 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2511 int startpos, endpos;
2513 XSETMISC (overlay, tail);
2515 start = OVERLAY_START (overlay);
2516 end = OVERLAY_END (overlay);
2517 endpos = OVERLAY_POSITION (end);
2518 if (endpos < pos)
2520 if (prev < endpos)
2521 prev = endpos;
2522 break;
2524 startpos = OVERLAY_POSITION (start);
2525 /* This one ends at or after POS
2526 so its start counts for PREV_PTR if it's before POS. */
2527 if (prev < startpos && startpos < pos)
2528 prev = startpos;
2529 if (endpos == pos)
2530 continue;
2531 if (startpos <= pos)
2533 if (idx == len)
2535 /* The supplied vector is full.
2536 Either make it bigger, or don't store any more in it. */
2537 if (extend)
2539 /* Make it work with an initial len == 0. */
2540 len *= 2;
2541 if (len == 0)
2542 len = 4;
2543 *len_ptr = len;
2544 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2545 *vec_ptr = vec;
2547 else
2548 inhibit_storing = 1;
2551 if (!inhibit_storing)
2552 vec[idx] = overlay;
2553 /* Keep counting overlays even if we can't return them all. */
2554 idx++;
2556 else if (startpos < next)
2557 next = startpos;
2560 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2562 int startpos, endpos;
2564 XSETMISC (overlay, tail);
2566 start = OVERLAY_START (overlay);
2567 end = OVERLAY_END (overlay);
2568 startpos = OVERLAY_POSITION (start);
2569 if (pos < startpos)
2571 if (startpos < next)
2572 next = startpos;
2573 break;
2575 endpos = OVERLAY_POSITION (end);
2576 if (pos < endpos)
2578 if (idx == len)
2580 if (extend)
2582 /* Make it work with an initial len == 0. */
2583 len *= 2;
2584 if (len == 0)
2585 len = 4;
2586 *len_ptr = len;
2587 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2588 *vec_ptr = vec;
2590 else
2591 inhibit_storing = 1;
2594 if (!inhibit_storing)
2595 vec[idx] = overlay;
2596 idx++;
2598 if (startpos < pos && startpos > prev)
2599 prev = startpos;
2601 else if (endpos < pos && endpos > prev)
2602 prev = endpos;
2603 else if (endpos == pos && startpos > prev
2604 && (!change_req || startpos < pos))
2605 prev = startpos;
2608 if (next_ptr)
2609 *next_ptr = next;
2610 if (prev_ptr)
2611 *prev_ptr = prev;
2612 return idx;
2615 /* Find all the overlays in the current buffer that overlap the range BEG-END
2616 or are empty at BEG.
2618 Return the number found, and store them in a vector in *VEC_PTR.
2619 Store in *LEN_PTR the size allocated for the vector.
2620 Store in *NEXT_PTR the next position after POS where an overlay starts,
2621 or ZV if there are no more overlays.
2622 Store in *PREV_PTR the previous position before POS where an overlay ends,
2623 or BEGV if there are no previous overlays.
2624 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2626 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2627 when this function is called.
2629 If EXTEND is non-zero, we make the vector bigger if necessary.
2630 If EXTEND is zero, we never extend the vector,
2631 and we store only as many overlays as will fit.
2632 But we still return the total number of overlays. */
2634 static int
2635 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2636 int beg, end;
2637 int extend;
2638 Lisp_Object **vec_ptr;
2639 int *len_ptr;
2640 int *next_ptr;
2641 int *prev_ptr;
2643 Lisp_Object overlay, ostart, oend;
2644 struct Lisp_Overlay *tail;
2645 int idx = 0;
2646 int len = *len_ptr;
2647 Lisp_Object *vec = *vec_ptr;
2648 int next = ZV;
2649 int prev = BEGV;
2650 int inhibit_storing = 0;
2652 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2654 int startpos, endpos;
2656 XSETMISC (overlay, tail);
2658 ostart = OVERLAY_START (overlay);
2659 oend = OVERLAY_END (overlay);
2660 endpos = OVERLAY_POSITION (oend);
2661 if (endpos < beg)
2663 if (prev < endpos)
2664 prev = endpos;
2665 break;
2667 startpos = OVERLAY_POSITION (ostart);
2668 /* Count an interval if it either overlaps the range
2669 or is empty at the start of the range. */
2670 if ((beg < endpos && startpos < end)
2671 || (startpos == endpos && beg == endpos))
2673 if (idx == len)
2675 /* The supplied vector is full.
2676 Either make it bigger, or don't store any more in it. */
2677 if (extend)
2679 /* Make it work with an initial len == 0. */
2680 len *= 2;
2681 if (len == 0)
2682 len = 4;
2683 *len_ptr = len;
2684 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2685 *vec_ptr = vec;
2687 else
2688 inhibit_storing = 1;
2691 if (!inhibit_storing)
2692 vec[idx] = overlay;
2693 /* Keep counting overlays even if we can't return them all. */
2694 idx++;
2696 else if (startpos < next)
2697 next = startpos;
2700 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2702 int startpos, endpos;
2704 XSETMISC (overlay, tail);
2706 ostart = OVERLAY_START (overlay);
2707 oend = OVERLAY_END (overlay);
2708 startpos = OVERLAY_POSITION (ostart);
2709 if (end < startpos)
2711 if (startpos < next)
2712 next = startpos;
2713 break;
2715 endpos = OVERLAY_POSITION (oend);
2716 /* Count an interval if it either overlaps the range
2717 or is empty at the start of the range. */
2718 if ((beg < endpos && startpos < end)
2719 || (startpos == endpos && beg == endpos))
2721 if (idx == len)
2723 if (extend)
2725 /* Make it work with an initial len == 0. */
2726 len *= 2;
2727 if (len == 0)
2728 len = 4;
2729 *len_ptr = len;
2730 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2731 *vec_ptr = vec;
2733 else
2734 inhibit_storing = 1;
2737 if (!inhibit_storing)
2738 vec[idx] = overlay;
2739 idx++;
2741 else if (endpos < beg && endpos > prev)
2742 prev = endpos;
2745 if (next_ptr)
2746 *next_ptr = next;
2747 if (prev_ptr)
2748 *prev_ptr = prev;
2749 return idx;
2753 /* Return non-zero if there exists an overlay with a non-nil
2754 `mouse-face' property overlapping OVERLAY. */
2757 mouse_face_overlay_overlaps (overlay)
2758 Lisp_Object overlay;
2760 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2761 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2762 int n, i, size;
2763 Lisp_Object *v, tem;
2765 size = 10;
2766 v = (Lisp_Object *) alloca (size * sizeof *v);
2767 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2768 if (n > size)
2770 v = (Lisp_Object *) alloca (n * sizeof *v);
2771 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2774 for (i = 0; i < n; ++i)
2775 if (!EQ (v[i], overlay)
2776 && (tem = Foverlay_get (overlay, Qmouse_face),
2777 !NILP (tem)))
2778 break;
2780 return i < n;
2785 /* Fast function to just test if we're at an overlay boundary. */
2787 overlay_touches_p (pos)
2788 int pos;
2790 Lisp_Object overlay;
2791 struct Lisp_Overlay *tail;
2793 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2795 int endpos;
2797 XSETMISC (overlay ,tail);
2798 if (!GC_OVERLAYP (overlay))
2799 abort ();
2801 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2802 if (endpos < pos)
2803 break;
2804 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2805 return 1;
2808 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2810 int startpos;
2812 XSETMISC (overlay, tail);
2813 if (!GC_OVERLAYP (overlay))
2814 abort ();
2816 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2817 if (pos < startpos)
2818 break;
2819 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2820 return 1;
2822 return 0;
2825 struct sortvec
2827 Lisp_Object overlay;
2828 int beg, end;
2829 int priority;
2832 static int
2833 compare_overlays (v1, v2)
2834 const void *v1, *v2;
2836 const struct sortvec *s1 = (const struct sortvec *) v1;
2837 const struct sortvec *s2 = (const struct sortvec *) v2;
2838 if (s1->priority != s2->priority)
2839 return s1->priority - s2->priority;
2840 if (s1->beg != s2->beg)
2841 return s1->beg - s2->beg;
2842 if (s1->end != s2->end)
2843 return s2->end - s1->end;
2844 return 0;
2847 /* Sort an array of overlays by priority. The array is modified in place.
2848 The return value is the new size; this may be smaller than the original
2849 size if some of the overlays were invalid or were window-specific. */
2851 sort_overlays (overlay_vec, noverlays, w)
2852 Lisp_Object *overlay_vec;
2853 int noverlays;
2854 struct window *w;
2856 int i, j;
2857 struct sortvec *sortvec;
2858 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2860 /* Put the valid and relevant overlays into sortvec. */
2862 for (i = 0, j = 0; i < noverlays; i++)
2864 Lisp_Object tem;
2865 Lisp_Object overlay;
2867 overlay = overlay_vec[i];
2868 if (OVERLAY_VALID (overlay)
2869 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2870 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2872 /* If we're interested in a specific window, then ignore
2873 overlays that are limited to some other window. */
2874 if (w)
2876 Lisp_Object window;
2878 window = Foverlay_get (overlay, Qwindow);
2879 if (WINDOWP (window) && XWINDOW (window) != w)
2880 continue;
2883 /* This overlay is good and counts: put it into sortvec. */
2884 sortvec[j].overlay = overlay;
2885 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2886 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2887 tem = Foverlay_get (overlay, Qpriority);
2888 if (INTEGERP (tem))
2889 sortvec[j].priority = XINT (tem);
2890 else
2891 sortvec[j].priority = 0;
2892 j++;
2895 noverlays = j;
2897 /* Sort the overlays into the proper order: increasing priority. */
2899 if (noverlays > 1)
2900 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2902 for (i = 0; i < noverlays; i++)
2903 overlay_vec[i] = sortvec[i].overlay;
2904 return (noverlays);
2907 struct sortstr
2909 Lisp_Object string, string2;
2910 int size;
2911 int priority;
2914 struct sortstrlist
2916 struct sortstr *buf; /* An array that expands as needed; never freed. */
2917 int size; /* Allocated length of that array. */
2918 int used; /* How much of the array is currently in use. */
2919 int bytes; /* Total length of the strings in buf. */
2922 /* Buffers for storing information about the overlays touching a given
2923 position. These could be automatic variables in overlay_strings, but
2924 it's more efficient to hold onto the memory instead of repeatedly
2925 allocating and freeing it. */
2926 static struct sortstrlist overlay_heads, overlay_tails;
2927 static unsigned char *overlay_str_buf;
2929 /* Allocated length of overlay_str_buf. */
2930 static int overlay_str_len;
2932 /* A comparison function suitable for passing to qsort. */
2933 static int
2934 cmp_for_strings (as1, as2)
2935 char *as1, *as2;
2937 struct sortstr *s1 = (struct sortstr *)as1;
2938 struct sortstr *s2 = (struct sortstr *)as2;
2939 if (s1->size != s2->size)
2940 return s2->size - s1->size;
2941 if (s1->priority != s2->priority)
2942 return s1->priority - s2->priority;
2943 return 0;
2946 static void
2947 record_overlay_string (ssl, str, str2, pri, size)
2948 struct sortstrlist *ssl;
2949 Lisp_Object str, str2, pri;
2950 int size;
2952 int nbytes;
2954 if (ssl->used == ssl->size)
2956 if (ssl->buf)
2957 ssl->size *= 2;
2958 else
2959 ssl->size = 5;
2960 ssl->buf = ((struct sortstr *)
2961 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2963 ssl->buf[ssl->used].string = str;
2964 ssl->buf[ssl->used].string2 = str2;
2965 ssl->buf[ssl->used].size = size;
2966 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2967 ssl->used++;
2969 if (NILP (current_buffer->enable_multibyte_characters))
2970 nbytes = SCHARS (str);
2971 else if (! STRING_MULTIBYTE (str))
2972 nbytes = count_size_as_multibyte (SDATA (str),
2973 SBYTES (str));
2974 else
2975 nbytes = SBYTES (str);
2977 ssl->bytes += nbytes;
2979 if (STRINGP (str2))
2981 if (NILP (current_buffer->enable_multibyte_characters))
2982 nbytes = SCHARS (str2);
2983 else if (! STRING_MULTIBYTE (str2))
2984 nbytes = count_size_as_multibyte (SDATA (str2),
2985 SBYTES (str2));
2986 else
2987 nbytes = SBYTES (str2);
2989 ssl->bytes += nbytes;
2993 /* Return the concatenation of the strings associated with overlays that
2994 begin or end at POS, ignoring overlays that are specific to a window
2995 other than W. The strings are concatenated in the appropriate order:
2996 shorter overlays nest inside longer ones, and higher priority inside
2997 lower. Normally all of the after-strings come first, but zero-sized
2998 overlays have their after-strings ride along with the before-strings
2999 because it would look strange to print them inside-out.
3001 Returns the string length, and stores the contents indirectly through
3002 PSTR, if that variable is non-null. The string may be overwritten by
3003 subsequent calls. */
3006 overlay_strings (pos, w, pstr)
3007 EMACS_INT pos;
3008 struct window *w;
3009 unsigned char **pstr;
3011 Lisp_Object overlay, window, str;
3012 struct Lisp_Overlay *ov;
3013 int startpos, endpos;
3014 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3016 overlay_heads.used = overlay_heads.bytes = 0;
3017 overlay_tails.used = overlay_tails.bytes = 0;
3018 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3020 XSETMISC (overlay, ov);
3021 eassert (OVERLAYP (overlay));
3023 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3024 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3025 if (endpos < pos)
3026 break;
3027 if (endpos != pos && startpos != pos)
3028 continue;
3029 window = Foverlay_get (overlay, Qwindow);
3030 if (WINDOWP (window) && XWINDOW (window) != w)
3031 continue;
3032 if (startpos == pos
3033 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3034 record_overlay_string (&overlay_heads, str,
3035 (startpos == endpos
3036 ? Foverlay_get (overlay, Qafter_string)
3037 : Qnil),
3038 Foverlay_get (overlay, Qpriority),
3039 endpos - startpos);
3040 else if (endpos == pos
3041 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3042 record_overlay_string (&overlay_tails, str, Qnil,
3043 Foverlay_get (overlay, Qpriority),
3044 endpos - startpos);
3046 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3048 XSETMISC (overlay, ov);
3049 eassert (OVERLAYP (overlay));
3051 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3052 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3053 if (startpos > pos)
3054 break;
3055 if (endpos != pos && startpos != pos)
3056 continue;
3057 window = Foverlay_get (overlay, Qwindow);
3058 if (WINDOWP (window) && XWINDOW (window) != w)
3059 continue;
3060 if (startpos == pos
3061 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3062 record_overlay_string (&overlay_heads, str,
3063 (startpos == endpos
3064 ? Foverlay_get (overlay, Qafter_string)
3065 : Qnil),
3066 Foverlay_get (overlay, Qpriority),
3067 endpos - startpos);
3068 else if (endpos == pos
3069 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3070 record_overlay_string (&overlay_tails, str, Qnil,
3071 Foverlay_get (overlay, Qpriority),
3072 endpos - startpos);
3074 if (overlay_tails.used > 1)
3075 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3076 cmp_for_strings);
3077 if (overlay_heads.used > 1)
3078 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3079 cmp_for_strings);
3080 if (overlay_heads.bytes || overlay_tails.bytes)
3082 Lisp_Object tem;
3083 int i;
3084 unsigned char *p;
3085 int total = overlay_heads.bytes + overlay_tails.bytes;
3087 if (total > overlay_str_len)
3089 overlay_str_len = total;
3090 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3091 total);
3093 p = overlay_str_buf;
3094 for (i = overlay_tails.used; --i >= 0;)
3096 int nbytes;
3097 tem = overlay_tails.buf[i].string;
3098 nbytes = copy_text (SDATA (tem), p,
3099 SBYTES (tem),
3100 STRING_MULTIBYTE (tem), multibyte);
3101 p += nbytes;
3103 for (i = 0; i < overlay_heads.used; ++i)
3105 int nbytes;
3106 tem = overlay_heads.buf[i].string;
3107 nbytes = copy_text (SDATA (tem), p,
3108 SBYTES (tem),
3109 STRING_MULTIBYTE (tem), multibyte);
3110 p += nbytes;
3111 tem = overlay_heads.buf[i].string2;
3112 if (STRINGP (tem))
3114 nbytes = copy_text (SDATA (tem), p,
3115 SBYTES (tem),
3116 STRING_MULTIBYTE (tem), multibyte);
3117 p += nbytes;
3120 if (p != overlay_str_buf + total)
3121 abort ();
3122 if (pstr)
3123 *pstr = overlay_str_buf;
3124 return total;
3126 return 0;
3129 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3131 void
3132 recenter_overlay_lists (buf, pos)
3133 struct buffer *buf;
3134 EMACS_INT pos;
3136 Lisp_Object overlay, beg, end;
3137 struct Lisp_Overlay *prev, *tail, *next;
3139 /* See if anything in overlays_before should move to overlays_after. */
3141 /* We don't strictly need prev in this loop; it should always be nil.
3142 But we use it for symmetry and in case that should cease to be true
3143 with some future change. */
3144 prev = NULL;
3145 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3147 next = tail->next;
3148 XSETMISC (overlay, tail);
3150 /* If the overlay is not valid, get rid of it. */
3151 if (!OVERLAY_VALID (overlay))
3152 #if 1
3153 abort ();
3154 #else
3156 /* Splice the cons cell TAIL out of overlays_before. */
3157 if (!NILP (prev))
3158 XCDR (prev) = next;
3159 else
3160 buf->overlays_before = next;
3161 tail = prev;
3162 continue;
3164 #endif
3166 beg = OVERLAY_START (overlay);
3167 end = OVERLAY_END (overlay);
3169 if (OVERLAY_POSITION (end) > pos)
3171 /* OVERLAY needs to be moved. */
3172 int where = OVERLAY_POSITION (beg);
3173 struct Lisp_Overlay *other, *other_prev;
3175 /* Splice the cons cell TAIL out of overlays_before. */
3176 if (prev)
3177 prev->next = next;
3178 else
3179 buf->overlays_before = next;
3181 /* Search thru overlays_after for where to put it. */
3182 other_prev = NULL;
3183 for (other = buf->overlays_after; other;
3184 other_prev = other, other = other->next)
3186 Lisp_Object otherbeg, otheroverlay;
3188 XSETMISC (otheroverlay, other);
3189 eassert (OVERLAY_VALID (otheroverlay));
3191 otherbeg = OVERLAY_START (otheroverlay);
3192 if (OVERLAY_POSITION (otherbeg) >= where)
3193 break;
3196 /* Add TAIL to overlays_after before OTHER. */
3197 tail->next = other;
3198 if (other_prev)
3199 other_prev->next = tail;
3200 else
3201 buf->overlays_after = tail;
3202 tail = prev;
3204 else
3205 /* We've reached the things that should stay in overlays_before.
3206 All the rest of overlays_before must end even earlier,
3207 so stop now. */
3208 break;
3211 /* See if anything in overlays_after should be in overlays_before. */
3212 prev = NULL;
3213 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3215 next = tail->next;
3216 XSETMISC (overlay, tail);
3218 /* If the overlay is not valid, get rid of it. */
3219 if (!OVERLAY_VALID (overlay))
3220 #if 1
3221 abort ();
3222 #else
3224 /* Splice the cons cell TAIL out of overlays_after. */
3225 if (!NILP (prev))
3226 XCDR (prev) = next;
3227 else
3228 buf->overlays_after = next;
3229 tail = prev;
3230 continue;
3232 #endif
3234 beg = OVERLAY_START (overlay);
3235 end = OVERLAY_END (overlay);
3237 /* Stop looking, when we know that nothing further
3238 can possibly end before POS. */
3239 if (OVERLAY_POSITION (beg) > pos)
3240 break;
3242 if (OVERLAY_POSITION (end) <= pos)
3244 /* OVERLAY needs to be moved. */
3245 int where = OVERLAY_POSITION (end);
3246 struct Lisp_Overlay *other, *other_prev;
3248 /* Splice the cons cell TAIL out of overlays_after. */
3249 if (prev)
3250 prev->next = next;
3251 else
3252 buf->overlays_after = next;
3254 /* Search thru overlays_before for where to put it. */
3255 other_prev = NULL;
3256 for (other = buf->overlays_before; other;
3257 other_prev = other, other = other->next)
3259 Lisp_Object otherend, otheroverlay;
3261 XSETMISC (otheroverlay, other);
3262 eassert (OVERLAY_VALID (otheroverlay));
3264 otherend = OVERLAY_END (otheroverlay);
3265 if (OVERLAY_POSITION (otherend) <= where)
3266 break;
3269 /* Add TAIL to overlays_before before OTHER. */
3270 tail->next = other;
3271 if (other_prev)
3272 other_prev->next = tail;
3273 else
3274 buf->overlays_before = tail;
3275 tail = prev;
3279 buf->overlay_center = pos;
3282 void
3283 adjust_overlays_for_insert (pos, length)
3284 EMACS_INT pos;
3285 EMACS_INT length;
3287 /* After an insertion, the lists are still sorted properly,
3288 but we may need to update the value of the overlay center. */
3289 if (current_buffer->overlay_center >= pos)
3290 current_buffer->overlay_center += length;
3293 void
3294 adjust_overlays_for_delete (pos, length)
3295 EMACS_INT pos;
3296 EMACS_INT length;
3298 if (current_buffer->overlay_center < pos)
3299 /* The deletion was to our right. No change needed; the before- and
3300 after-lists are still consistent. */
3302 else if (current_buffer->overlay_center > pos + length)
3303 /* The deletion was to our left. We need to adjust the center value
3304 to account for the change in position, but the lists are consistent
3305 given the new value. */
3306 current_buffer->overlay_center -= length;
3307 else
3308 /* We're right in the middle. There might be things on the after-list
3309 that now belong on the before-list. Recentering will move them,
3310 and also update the center point. */
3311 recenter_overlay_lists (current_buffer, pos);
3314 /* Fix up overlays that were garbled as a result of permuting markers
3315 in the range START through END. Any overlay with at least one
3316 endpoint in this range will need to be unlinked from the overlay
3317 list and reinserted in its proper place.
3318 Such an overlay might even have negative size at this point.
3319 If so, we'll make the overlay empty. */
3320 void
3321 fix_start_end_in_overlays (start, end)
3322 register int start, end;
3324 Lisp_Object overlay;
3325 struct Lisp_Overlay *before_list, *after_list;
3326 /* These are either nil, indicating that before_list or after_list
3327 should be assigned, or the cons cell the cdr of which should be
3328 assigned. */
3329 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3330 /* 'Parent', likewise, indicates a cons cell or
3331 current_buffer->overlays_before or overlays_after, depending
3332 which loop we're in. */
3333 struct Lisp_Overlay *tail, *parent;
3334 int startpos, endpos;
3336 /* This algorithm shifts links around instead of consing and GCing.
3337 The loop invariant is that before_list (resp. after_list) is a
3338 well-formed list except that its last element, the CDR of beforep
3339 (resp. afterp) if beforep (afterp) isn't nil or before_list
3340 (after_list) if it is, is still uninitialized. So it's not a bug
3341 that before_list isn't initialized, although it may look
3342 strange. */
3343 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3345 XSETMISC (overlay, tail);
3347 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3348 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3350 /* If the overlay is backwards, make it empty. */
3351 if (endpos < startpos)
3353 startpos = endpos;
3354 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3355 Qnil);
3358 if (endpos < start)
3359 break;
3361 if (endpos < end
3362 || (startpos >= start && startpos < end))
3364 /* Add it to the end of the wrong list. Later on,
3365 recenter_overlay_lists will move it to the right place. */
3366 if (endpos < current_buffer->overlay_center)
3368 if (!afterp)
3369 after_list = tail;
3370 else
3371 afterp->next = tail;
3372 afterp = tail;
3374 else
3376 if (!beforep)
3377 before_list = tail;
3378 else
3379 beforep->next = tail;
3380 beforep = tail;
3382 if (!parent)
3383 current_buffer->overlays_before = tail->next;
3384 else
3385 parent->next = tail->next;
3386 tail = tail->next;
3388 else
3389 parent = tail, tail = parent->next;
3391 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3393 XSETMISC (overlay, tail);
3395 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3396 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3398 /* If the overlay is backwards, make it empty. */
3399 if (endpos < startpos)
3401 startpos = endpos;
3402 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3403 Qnil);
3406 if (startpos >= end)
3407 break;
3409 if (startpos >= start
3410 || (endpos >= start && endpos < end))
3412 if (endpos < current_buffer->overlay_center)
3414 if (!afterp)
3415 after_list = tail;
3416 else
3417 afterp->next = tail;
3418 afterp = tail;
3420 else
3422 if (!beforep)
3423 before_list = tail;
3424 else
3425 beforep->next = tail;
3426 beforep = tail;
3428 if (!parent)
3429 current_buffer->overlays_after = tail->next;
3430 else
3431 parent->next = tail->next;
3432 tail = tail->next;
3434 else
3435 parent = tail, tail = parent->next;
3438 /* Splice the constructed (wrong) lists into the buffer's lists,
3439 and let the recenter function make it sane again. */
3440 if (beforep)
3442 beforep->next = current_buffer->overlays_before;
3443 current_buffer->overlays_before = before_list;
3445 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3447 if (afterp)
3449 afterp->next = current_buffer->overlays_after;
3450 current_buffer->overlays_after = after_list;
3452 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3455 /* We have two types of overlay: the one whose ending marker is
3456 after-insertion-marker (this is the usual case) and the one whose
3457 ending marker is before-insertion-marker. When `overlays_before'
3458 contains overlays of the latter type and the former type in this
3459 order and both overlays end at inserting position, inserting a text
3460 increases only the ending marker of the latter type, which results
3461 in incorrect ordering of `overlays_before'.
3463 This function fixes ordering of overlays in the slot
3464 `overlays_before' of the buffer *BP. Before the insertion, `point'
3465 was at PREV, and now is at POS. */
3467 void
3468 fix_overlays_before (bp, prev, pos)
3469 struct buffer *bp;
3470 EMACS_INT prev, pos;
3472 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3473 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3474 Lisp_Object tem;
3475 EMACS_INT end;
3477 /* After the insertion, the several overlays may be in incorrect
3478 order. The possibility is that, in the list `overlays_before',
3479 an overlay which ends at POS appears after an overlay which ends
3480 at PREV. Since POS is greater than PREV, we must fix the
3481 ordering of these overlays, by moving overlays ends at POS before
3482 the overlays ends at PREV. */
3484 /* At first, find a place where disordered overlays should be linked
3485 in. It is where an overlay which end before POS exists. (i.e. an
3486 overlay whose ending marker is after-insertion-marker if disorder
3487 exists). */
3488 while (tail
3489 && (XSETMISC (tem, tail),
3490 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3492 parent = tail;
3493 tail = tail->next;
3496 /* If we don't find such an overlay,
3497 or the found one ends before PREV,
3498 or the found one is the last one in the list,
3499 we don't have to fix anything. */
3500 if (!tail || end < prev || !tail->next)
3501 return;
3503 right_pair = parent;
3504 parent = tail;
3505 tail = tail->next;
3507 /* Now, end position of overlays in the list TAIL should be before
3508 or equal to PREV. In the loop, an overlay which ends at POS is
3509 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3510 we found an overlay which ends before PREV, the remaining
3511 overlays are in correct order. */
3512 while (tail)
3514 XSETMISC (tem, tail);
3515 end = OVERLAY_POSITION (OVERLAY_END (tem));
3517 if (end == pos)
3518 { /* This overlay is disordered. */
3519 struct Lisp_Overlay *found = tail;
3521 /* Unlink the found overlay. */
3522 tail = found->next;
3523 parent->next = tail;
3524 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3525 and link it into the right place. */
3526 if (!right_pair)
3528 found->next = bp->overlays_before;
3529 bp->overlays_before = found;
3531 else
3533 found->next = right_pair->next;
3534 right_pair->next = found;
3537 else if (end == prev)
3539 parent = tail;
3540 tail = tail->next;
3542 else /* No more disordered overlay. */
3543 break;
3547 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3548 doc: /* Return t if OBJECT is an overlay. */)
3549 (object)
3550 Lisp_Object object;
3552 return (OVERLAYP (object) ? Qt : Qnil);
3555 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3556 doc: /* Create a new overlay with range BEG to END in BUFFER.
3557 If omitted, BUFFER defaults to the current buffer.
3558 BEG and END may be integers or markers.
3559 The fourth arg FRONT-ADVANCE, if non-nil, makes the
3560 front delimiter advance when text is inserted there.
3561 The fifth arg REAR-ADVANCE, if non-nil, makes the
3562 rear delimiter advance when text is inserted there. */)
3563 (beg, end, buffer, front_advance, rear_advance)
3564 Lisp_Object beg, end, buffer;
3565 Lisp_Object front_advance, rear_advance;
3567 Lisp_Object overlay;
3568 struct buffer *b;
3570 if (NILP (buffer))
3571 XSETBUFFER (buffer, current_buffer);
3572 else
3573 CHECK_BUFFER (buffer);
3574 if (MARKERP (beg)
3575 && ! EQ (Fmarker_buffer (beg), buffer))
3576 error ("Marker points into wrong buffer");
3577 if (MARKERP (end)
3578 && ! EQ (Fmarker_buffer (end), buffer))
3579 error ("Marker points into wrong buffer");
3581 CHECK_NUMBER_COERCE_MARKER (beg);
3582 CHECK_NUMBER_COERCE_MARKER (end);
3584 if (XINT (beg) > XINT (end))
3586 Lisp_Object temp;
3587 temp = beg; beg = end; end = temp;
3590 b = XBUFFER (buffer);
3592 beg = Fset_marker (Fmake_marker (), beg, buffer);
3593 end = Fset_marker (Fmake_marker (), end, buffer);
3595 if (!NILP (front_advance))
3596 XMARKER (beg)->insertion_type = 1;
3597 if (!NILP (rear_advance))
3598 XMARKER (end)->insertion_type = 1;
3600 overlay = allocate_misc ();
3601 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3602 XOVERLAY (overlay)->start = beg;
3603 XOVERLAY (overlay)->end = end;
3604 XOVERLAY (overlay)->plist = Qnil;
3605 XOVERLAY (overlay)->next = NULL;
3607 /* Put the new overlay on the wrong list. */
3608 end = OVERLAY_END (overlay);
3609 if (OVERLAY_POSITION (end) < b->overlay_center)
3611 if (b->overlays_after)
3612 XOVERLAY (overlay)->next = b->overlays_after;
3613 b->overlays_after = XOVERLAY (overlay);
3615 else
3617 if (b->overlays_before)
3618 XOVERLAY (overlay)->next = b->overlays_before;
3619 b->overlays_before = XOVERLAY (overlay);
3622 /* This puts it in the right list, and in the right order. */
3623 recenter_overlay_lists (b, b->overlay_center);
3625 /* We don't need to redisplay the region covered by the overlay, because
3626 the overlay has no properties at the moment. */
3628 return overlay;
3631 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3633 static void
3634 modify_overlay (buf, start, end)
3635 struct buffer *buf;
3636 EMACS_INT start, end;
3638 if (start > end)
3640 int temp = start;
3641 start = end;
3642 end = temp;
3645 BUF_COMPUTE_UNCHANGED (buf, start, end);
3647 /* If this is a buffer not in the selected window,
3648 we must do other windows. */
3649 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3650 windows_or_buffers_changed = 1;
3651 /* If multiple windows show this buffer, we must do other windows. */
3652 else if (buffer_shared > 1)
3653 windows_or_buffers_changed = 1;
3655 ++BUF_OVERLAY_MODIFF (buf);
3659 Lisp_Object Fdelete_overlay ();
3661 static struct Lisp_Overlay *
3662 unchain_overlay (list, overlay)
3663 struct Lisp_Overlay *list, *overlay;
3665 struct Lisp_Overlay *tmp, *prev;
3666 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3667 if (tmp == overlay)
3669 if (prev)
3670 prev->next = tmp->next;
3671 else
3672 list = tmp->next;
3673 overlay->next = NULL;
3674 break;
3676 return list;
3679 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3680 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3681 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3682 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3683 buffer. */)
3684 (overlay, beg, end, buffer)
3685 Lisp_Object overlay, beg, end, buffer;
3687 struct buffer *b, *ob;
3688 Lisp_Object obuffer;
3689 int count = SPECPDL_INDEX ();
3691 CHECK_OVERLAY (overlay);
3692 if (NILP (buffer))
3693 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3694 if (NILP (buffer))
3695 XSETBUFFER (buffer, current_buffer);
3696 CHECK_BUFFER (buffer);
3698 if (MARKERP (beg)
3699 && ! EQ (Fmarker_buffer (beg), buffer))
3700 error ("Marker points into wrong buffer");
3701 if (MARKERP (end)
3702 && ! EQ (Fmarker_buffer (end), buffer))
3703 error ("Marker points into wrong buffer");
3705 CHECK_NUMBER_COERCE_MARKER (beg);
3706 CHECK_NUMBER_COERCE_MARKER (end);
3708 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3709 return Fdelete_overlay (overlay);
3711 if (XINT (beg) > XINT (end))
3713 Lisp_Object temp;
3714 temp = beg; beg = end; end = temp;
3717 specbind (Qinhibit_quit, Qt);
3719 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3720 b = XBUFFER (buffer);
3721 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3723 /* If the overlay has changed buffers, do a thorough redisplay. */
3724 if (!EQ (buffer, obuffer))
3726 /* Redisplay where the overlay was. */
3727 if (!NILP (obuffer))
3729 int o_beg;
3730 int o_end;
3732 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3733 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3735 modify_overlay (ob, o_beg, o_end);
3738 /* Redisplay where the overlay is going to be. */
3739 modify_overlay (b, XINT (beg), XINT (end));
3741 else
3742 /* Redisplay the area the overlay has just left, or just enclosed. */
3744 int o_beg, o_end;
3746 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3747 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3749 if (o_beg == XINT (beg))
3750 modify_overlay (b, o_end, XINT (end));
3751 else if (o_end == XINT (end))
3752 modify_overlay (b, o_beg, XINT (beg));
3753 else
3755 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3756 if (XINT (end) > o_end) o_end = XINT (end);
3757 modify_overlay (b, o_beg, o_end);
3761 if (!NILP (obuffer))
3763 ob->overlays_before
3764 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3765 ob->overlays_after
3766 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3767 eassert (XOVERLAY (overlay)->next == NULL);
3770 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3771 Fset_marker (OVERLAY_END (overlay), end, buffer);
3773 /* Put the overlay on the wrong list. */
3774 end = OVERLAY_END (overlay);
3775 if (OVERLAY_POSITION (end) < b->overlay_center)
3777 XOVERLAY (overlay)->next = b->overlays_after;
3778 b->overlays_after = XOVERLAY (overlay);
3780 else
3782 XOVERLAY (overlay)->next = b->overlays_before;
3783 b->overlays_before = XOVERLAY (overlay);
3786 /* This puts it in the right list, and in the right order. */
3787 recenter_overlay_lists (b, b->overlay_center);
3789 return unbind_to (count, overlay);
3792 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3793 doc: /* Delete the overlay OVERLAY from its buffer. */)
3794 (overlay)
3795 Lisp_Object overlay;
3797 Lisp_Object buffer;
3798 struct buffer *b;
3799 int count = SPECPDL_INDEX ();
3801 CHECK_OVERLAY (overlay);
3803 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3804 if (NILP (buffer))
3805 return Qnil;
3807 b = XBUFFER (buffer);
3808 specbind (Qinhibit_quit, Qt);
3810 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3811 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3812 eassert (XOVERLAY (overlay)->next == NULL);
3813 modify_overlay (b,
3814 marker_position (OVERLAY_START (overlay)),
3815 marker_position (OVERLAY_END (overlay)));
3816 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3817 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3819 /* When deleting an overlay with before or after strings, turn off
3820 display optimizations for the affected buffer, on the basis that
3821 these strings may contain newlines. This is easier to do than to
3822 check for that situation during redisplay. */
3823 if (!windows_or_buffers_changed
3824 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3825 || !NILP (Foverlay_get (overlay, Qafter_string))))
3826 b->prevent_redisplay_optimizations_p = 1;
3828 return unbind_to (count, Qnil);
3831 /* Overlay dissection functions. */
3833 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3834 doc: /* Return the position at which OVERLAY starts. */)
3835 (overlay)
3836 Lisp_Object overlay;
3838 CHECK_OVERLAY (overlay);
3840 return (Fmarker_position (OVERLAY_START (overlay)));
3843 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3844 doc: /* Return the position at which OVERLAY ends. */)
3845 (overlay)
3846 Lisp_Object overlay;
3848 CHECK_OVERLAY (overlay);
3850 return (Fmarker_position (OVERLAY_END (overlay)));
3853 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3854 doc: /* Return the buffer OVERLAY belongs to. */)
3855 (overlay)
3856 Lisp_Object overlay;
3858 CHECK_OVERLAY (overlay);
3860 return Fmarker_buffer (OVERLAY_START (overlay));
3863 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3864 doc: /* Return a list of the properties on OVERLAY.
3865 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3866 OVERLAY. */)
3867 (overlay)
3868 Lisp_Object overlay;
3870 CHECK_OVERLAY (overlay);
3872 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3876 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3877 doc: /* Return a list of the overlays that contain position POS. */)
3878 (pos)
3879 Lisp_Object pos;
3881 int noverlays;
3882 Lisp_Object *overlay_vec;
3883 int len;
3884 Lisp_Object result;
3886 CHECK_NUMBER_COERCE_MARKER (pos);
3888 len = 10;
3889 /* We can't use alloca here because overlays_at can call xrealloc. */
3890 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3892 /* Put all the overlays we want in a vector in overlay_vec.
3893 Store the length in len. */
3894 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3895 (int *) 0, (int *) 0, 0);
3897 /* Make a list of them all. */
3898 result = Flist (noverlays, overlay_vec);
3900 xfree (overlay_vec);
3901 return result;
3904 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3905 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3906 Overlap means that at least one character is contained within the overlay
3907 and also contained within the specified region.
3908 Empty overlays are included in the result if they are located at BEG
3909 or between BEG and END. */)
3910 (beg, end)
3911 Lisp_Object beg, end;
3913 int noverlays;
3914 Lisp_Object *overlay_vec;
3915 int len;
3916 Lisp_Object result;
3918 CHECK_NUMBER_COERCE_MARKER (beg);
3919 CHECK_NUMBER_COERCE_MARKER (end);
3921 len = 10;
3922 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3924 /* Put all the overlays we want in a vector in overlay_vec.
3925 Store the length in len. */
3926 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3927 (int *) 0, (int *) 0);
3929 /* Make a list of them all. */
3930 result = Flist (noverlays, overlay_vec);
3932 xfree (overlay_vec);
3933 return result;
3936 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3937 1, 1, 0,
3938 doc: /* Return the next position after POS where an overlay starts or ends.
3939 If there are no more overlay boundaries after POS, return (point-max). */)
3940 (pos)
3941 Lisp_Object pos;
3943 int noverlays;
3944 int endpos;
3945 Lisp_Object *overlay_vec;
3946 int len;
3947 int i;
3949 CHECK_NUMBER_COERCE_MARKER (pos);
3951 len = 10;
3952 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3954 /* Put all the overlays we want in a vector in overlay_vec.
3955 Store the length in len.
3956 endpos gets the position where the next overlay starts. */
3957 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3958 &endpos, (int *) 0, 1);
3960 /* If any of these overlays ends before endpos,
3961 use its ending point instead. */
3962 for (i = 0; i < noverlays; i++)
3964 Lisp_Object oend;
3965 int oendpos;
3967 oend = OVERLAY_END (overlay_vec[i]);
3968 oendpos = OVERLAY_POSITION (oend);
3969 if (oendpos < endpos)
3970 endpos = oendpos;
3973 xfree (overlay_vec);
3974 return make_number (endpos);
3977 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3978 Sprevious_overlay_change, 1, 1, 0,
3979 doc: /* Return the previous position before POS where an overlay starts or ends.
3980 If there are no more overlay boundaries before POS, return (point-min). */)
3981 (pos)
3982 Lisp_Object pos;
3984 int noverlays;
3985 int prevpos;
3986 Lisp_Object *overlay_vec;
3987 int len;
3989 CHECK_NUMBER_COERCE_MARKER (pos);
3991 /* At beginning of buffer, we know the answer;
3992 avoid bug subtracting 1 below. */
3993 if (XINT (pos) == BEGV)
3994 return pos;
3996 len = 10;
3997 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3999 /* Put all the overlays we want in a vector in overlay_vec.
4000 Store the length in len.
4001 prevpos gets the position of the previous change. */
4002 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4003 (int *) 0, &prevpos, 1);
4005 xfree (overlay_vec);
4006 return make_number (prevpos);
4009 /* These functions are for debugging overlays. */
4011 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4012 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4013 The car has all the overlays before the overlay center;
4014 the cdr has all the overlays after the overlay center.
4015 Recentering overlays moves overlays between these lists.
4016 The lists you get are copies, so that changing them has no effect.
4017 However, the overlays you get are the real objects that the buffer uses. */)
4020 struct Lisp_Overlay *ol;
4021 Lisp_Object before = Qnil, after = Qnil, tmp;
4022 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4024 XSETMISC (tmp, ol);
4025 before = Fcons (tmp, before);
4027 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4029 XSETMISC (tmp, ol);
4030 after = Fcons (tmp, after);
4032 return Fcons (Fnreverse (before), Fnreverse (after));
4035 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4036 doc: /* Recenter the overlays of the current buffer around position POS.
4037 That makes overlay lookup faster for positions near POS (but perhaps slower
4038 for positions far away from POS). */)
4039 (pos)
4040 Lisp_Object pos;
4042 CHECK_NUMBER_COERCE_MARKER (pos);
4044 recenter_overlay_lists (current_buffer, XINT (pos));
4045 return Qnil;
4048 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4049 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4050 (overlay, prop)
4051 Lisp_Object overlay, prop;
4053 CHECK_OVERLAY (overlay);
4054 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4057 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4058 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4059 (overlay, prop, value)
4060 Lisp_Object overlay, prop, value;
4062 Lisp_Object tail, buffer;
4063 int changed;
4065 CHECK_OVERLAY (overlay);
4067 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4069 for (tail = XOVERLAY (overlay)->plist;
4070 CONSP (tail) && CONSP (XCDR (tail));
4071 tail = XCDR (XCDR (tail)))
4072 if (EQ (XCAR (tail), prop))
4074 changed = !EQ (XCAR (XCDR (tail)), value);
4075 XSETCAR (XCDR (tail), value);
4076 goto found;
4078 /* It wasn't in the list, so add it to the front. */
4079 changed = !NILP (value);
4080 XOVERLAY (overlay)->plist
4081 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4082 found:
4083 if (! NILP (buffer))
4085 if (changed)
4086 modify_overlay (XBUFFER (buffer),
4087 marker_position (OVERLAY_START (overlay)),
4088 marker_position (OVERLAY_END (overlay)));
4089 if (EQ (prop, Qevaporate) && ! NILP (value)
4090 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4091 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4092 Fdelete_overlay (overlay);
4094 return value;
4097 /* Subroutine of report_overlay_modification. */
4099 /* Lisp vector holding overlay hook functions to call.
4100 Vector elements come in pairs.
4101 Each even-index element is a list of hook functions.
4102 The following odd-index element is the overlay they came from.
4104 Before the buffer change, we fill in this vector
4105 as we call overlay hook functions.
4106 After the buffer change, we get the functions to call from this vector.
4107 This way we always call the same functions before and after the change. */
4108 static Lisp_Object last_overlay_modification_hooks;
4110 /* Number of elements actually used in last_overlay_modification_hooks. */
4111 static int last_overlay_modification_hooks_used;
4113 /* Add one functionlist/overlay pair
4114 to the end of last_overlay_modification_hooks. */
4116 static void
4117 add_overlay_mod_hooklist (functionlist, overlay)
4118 Lisp_Object functionlist, overlay;
4120 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4122 if (last_overlay_modification_hooks_used == oldsize)
4124 Lisp_Object old;
4125 old = last_overlay_modification_hooks;
4126 last_overlay_modification_hooks
4127 = Fmake_vector (make_number (oldsize * 2), Qnil);
4128 bcopy (XVECTOR (old)->contents,
4129 XVECTOR (last_overlay_modification_hooks)->contents,
4130 sizeof (Lisp_Object) * oldsize);
4132 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4133 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4136 /* Run the modification-hooks of overlays that include
4137 any part of the text in START to END.
4138 If this change is an insertion, also
4139 run the insert-before-hooks of overlay starting at END,
4140 and the insert-after-hooks of overlay ending at START.
4142 This is called both before and after the modification.
4143 AFTER is nonzero when we call after the modification.
4145 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4146 When AFTER is nonzero, they are the start position,
4147 the position after the inserted new text,
4148 and the length of deleted or replaced old text. */
4150 void
4151 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4152 Lisp_Object start, end;
4153 int after;
4154 Lisp_Object arg1, arg2, arg3;
4156 Lisp_Object prop, overlay;
4157 struct Lisp_Overlay *tail;
4158 /* 1 if this change is an insertion. */
4159 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4160 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4162 overlay = Qnil;
4163 tail = NULL;
4165 /* We used to run the functions as soon as we found them and only register
4166 them in last_overlay_modification_hooks for the purpose of the `after'
4167 case. But running elisp code as we traverse the list of overlays is
4168 painful because the list can be modified by the elisp code so we had to
4169 copy at several places. We now simply do a read-only traversal that
4170 only collects the functions to run and we run them afterwards. It's
4171 simpler, especially since all the code was already there. -stef */
4173 if (!after)
4175 /* We are being called before a change.
4176 Scan the overlays to find the functions to call. */
4177 last_overlay_modification_hooks_used = 0;
4178 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4180 int startpos, endpos;
4181 Lisp_Object ostart, oend;
4183 XSETMISC (overlay, tail);
4185 ostart = OVERLAY_START (overlay);
4186 oend = OVERLAY_END (overlay);
4187 endpos = OVERLAY_POSITION (oend);
4188 if (XFASTINT (start) > endpos)
4189 break;
4190 startpos = OVERLAY_POSITION (ostart);
4191 if (insertion && (XFASTINT (start) == startpos
4192 || XFASTINT (end) == startpos))
4194 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4195 if (!NILP (prop))
4196 add_overlay_mod_hooklist (prop, overlay);
4198 if (insertion && (XFASTINT (start) == endpos
4199 || XFASTINT (end) == endpos))
4201 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4202 if (!NILP (prop))
4203 add_overlay_mod_hooklist (prop, overlay);
4205 /* Test for intersecting intervals. This does the right thing
4206 for both insertion and deletion. */
4207 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4209 prop = Foverlay_get (overlay, Qmodification_hooks);
4210 if (!NILP (prop))
4211 add_overlay_mod_hooklist (prop, overlay);
4215 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4217 int startpos, endpos;
4218 Lisp_Object ostart, oend;
4220 XSETMISC (overlay, tail);
4222 ostart = OVERLAY_START (overlay);
4223 oend = OVERLAY_END (overlay);
4224 startpos = OVERLAY_POSITION (ostart);
4225 endpos = OVERLAY_POSITION (oend);
4226 if (XFASTINT (end) < startpos)
4227 break;
4228 if (insertion && (XFASTINT (start) == startpos
4229 || XFASTINT (end) == startpos))
4231 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4232 if (!NILP (prop))
4233 add_overlay_mod_hooklist (prop, overlay);
4235 if (insertion && (XFASTINT (start) == endpos
4236 || XFASTINT (end) == endpos))
4238 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4239 if (!NILP (prop))
4240 add_overlay_mod_hooklist (prop, overlay);
4242 /* Test for intersecting intervals. This does the right thing
4243 for both insertion and deletion. */
4244 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4246 prop = Foverlay_get (overlay, Qmodification_hooks);
4247 if (!NILP (prop))
4248 add_overlay_mod_hooklist (prop, overlay);
4253 GCPRO4 (overlay, arg1, arg2, arg3);
4255 /* Call the functions recorded in last_overlay_modification_hooks.
4256 First copy the vector contents, in case some of these hooks
4257 do subsequent modification of the buffer. */
4258 int size = last_overlay_modification_hooks_used;
4259 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4260 int i;
4262 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4263 copy, size * sizeof (Lisp_Object));
4264 gcpro1.var = copy;
4265 gcpro1.nvars = size;
4267 for (i = 0; i < size;)
4269 Lisp_Object prop, overlay;
4270 prop = copy[i++];
4271 overlay = copy[i++];
4272 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4275 UNGCPRO;
4278 static void
4279 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4280 Lisp_Object list, overlay;
4281 int after;
4282 Lisp_Object arg1, arg2, arg3;
4284 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4286 GCPRO4 (list, arg1, arg2, arg3);
4288 while (CONSP (list))
4290 if (NILP (arg3))
4291 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4292 else
4293 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4294 list = XCDR (list);
4296 UNGCPRO;
4299 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4300 property is set. */
4301 void
4302 evaporate_overlays (pos)
4303 EMACS_INT pos;
4305 Lisp_Object overlay, hit_list;
4306 struct Lisp_Overlay *tail;
4308 hit_list = Qnil;
4309 if (pos <= current_buffer->overlay_center)
4310 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4312 int endpos;
4313 XSETMISC (overlay, tail);
4314 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4315 if (endpos < pos)
4316 break;
4317 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4318 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4319 hit_list = Fcons (overlay, hit_list);
4321 else
4322 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4324 int startpos;
4325 XSETMISC (overlay, tail);
4326 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4327 if (startpos > pos)
4328 break;
4329 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4330 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4331 hit_list = Fcons (overlay, hit_list);
4333 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4334 Fdelete_overlay (XCAR (hit_list));
4337 /* Somebody has tried to store a value with an unacceptable type
4338 in the slot with offset OFFSET. */
4340 void
4341 buffer_slot_type_mismatch (offset)
4342 int offset;
4344 Lisp_Object sym;
4345 char *type_name;
4347 switch (XINT (PER_BUFFER_TYPE (offset)))
4349 case Lisp_Int:
4350 type_name = "integers";
4351 break;
4353 case Lisp_String:
4354 type_name = "strings";
4355 break;
4357 case Lisp_Symbol:
4358 type_name = "symbols";
4359 break;
4361 default:
4362 abort ();
4365 sym = PER_BUFFER_SYMBOL (offset);
4366 error ("Only %s should be stored in the buffer-local variable %s",
4367 type_name, SDATA (SYMBOL_NAME (sym)));
4371 /***********************************************************************
4372 Allocation with mmap
4373 ***********************************************************************/
4375 #ifdef USE_MMAP_FOR_BUFFERS
4377 #include <sys/types.h>
4378 #include <sys/mman.h>
4380 #ifndef MAP_ANON
4381 #ifdef MAP_ANONYMOUS
4382 #define MAP_ANON MAP_ANONYMOUS
4383 #else
4384 #define MAP_ANON 0
4385 #endif
4386 #endif
4388 #ifndef MAP_FAILED
4389 #define MAP_FAILED ((void *) -1)
4390 #endif
4392 #include <stdio.h>
4393 #include <errno.h>
4395 #if MAP_ANON == 0
4396 #include <fcntl.h>
4397 #endif
4399 #include "coding.h"
4402 /* Memory is allocated in regions which are mapped using mmap(2).
4403 The current implementation lets the system select mapped
4404 addresses; we're not using MAP_FIXED in general, except when
4405 trying to enlarge regions.
4407 Each mapped region starts with a mmap_region structure, the user
4408 area starts after that structure, aligned to MEM_ALIGN.
4410 +-----------------------+
4411 | struct mmap_info + |
4412 | padding |
4413 +-----------------------+
4414 | user data |
4417 +-----------------------+ */
4419 struct mmap_region
4421 /* User-specified size. */
4422 size_t nbytes_specified;
4424 /* Number of bytes mapped */
4425 size_t nbytes_mapped;
4427 /* Pointer to the location holding the address of the memory
4428 allocated with the mmap'd block. The variable actually points
4429 after this structure. */
4430 POINTER_TYPE **var;
4432 /* Next and previous in list of all mmap'd regions. */
4433 struct mmap_region *next, *prev;
4436 /* Doubly-linked list of mmap'd regions. */
4438 static struct mmap_region *mmap_regions;
4440 /* File descriptor for mmap. If we don't have anonymous mapping,
4441 /dev/zero will be opened on it. */
4443 static int mmap_fd;
4445 /* Temporary storage for mmap_set_vars, see there. */
4447 static struct mmap_region *mmap_regions_1;
4448 static int mmap_fd_1;
4450 /* Page size on this system. */
4452 static int mmap_page_size;
4454 /* 1 means mmap has been intialized. */
4456 static int mmap_initialized_p;
4458 /* Value is X rounded up to the next multiple of N. */
4460 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4462 /* Size of mmap_region structure plus padding. */
4464 #define MMAP_REGION_STRUCT_SIZE \
4465 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4467 /* Given a pointer P to the start of the user-visible part of a mapped
4468 region, return a pointer to the start of the region. */
4470 #define MMAP_REGION(P) \
4471 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4473 /* Given a pointer P to the start of a mapped region, return a pointer
4474 to the start of the user-visible part of the region. */
4476 #define MMAP_USER_AREA(P) \
4477 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4479 #define MEM_ALIGN sizeof (double)
4481 /* Predicate returning true if part of the address range [START .. END]
4482 is currently mapped. Used to prevent overwriting an existing
4483 memory mapping.
4485 Default is to conservativly assume the address range is occupied by
4486 something else. This can be overridden by system configuration
4487 files if system-specific means to determine this exists. */
4489 #ifndef MMAP_ALLOCATED_P
4490 #define MMAP_ALLOCATED_P(start, end) 1
4491 #endif
4493 /* Function prototypes. */
4495 static int mmap_free_1 P_ ((struct mmap_region *));
4496 static int mmap_enlarge P_ ((struct mmap_region *, int));
4497 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4498 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4499 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4500 static void mmap_free P_ ((POINTER_TYPE **ptr));
4501 static void mmap_init P_ ((void));
4504 /* Return a region overlapping address range START...END, or null if
4505 none. END is not including, i.e. the last byte in the range
4506 is at END - 1. */
4508 static struct mmap_region *
4509 mmap_find (start, end)
4510 POINTER_TYPE *start, *end;
4512 struct mmap_region *r;
4513 char *s = (char *) start, *e = (char *) end;
4515 for (r = mmap_regions; r; r = r->next)
4517 char *rstart = (char *) r;
4518 char *rend = rstart + r->nbytes_mapped;
4520 if (/* First byte of range, i.e. START, in this region? */
4521 (s >= rstart && s < rend)
4522 /* Last byte of range, i.e. END - 1, in this region? */
4523 || (e > rstart && e <= rend)
4524 /* First byte of this region in the range? */
4525 || (rstart >= s && rstart < e)
4526 /* Last byte of this region in the range? */
4527 || (rend > s && rend <= e))
4528 break;
4531 return r;
4535 /* Unmap a region. P is a pointer to the start of the user-araa of
4536 the region. Value is non-zero if successful. */
4538 static int
4539 mmap_free_1 (r)
4540 struct mmap_region *r;
4542 if (r->next)
4543 r->next->prev = r->prev;
4544 if (r->prev)
4545 r->prev->next = r->next;
4546 else
4547 mmap_regions = r->next;
4549 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4551 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4552 return 0;
4555 return 1;
4559 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4560 Value is non-zero if successful. */
4562 static int
4563 mmap_enlarge (r, npages)
4564 struct mmap_region *r;
4565 int npages;
4567 char *region_end = (char *) r + r->nbytes_mapped;
4568 size_t nbytes;
4569 int success = 0;
4571 if (npages < 0)
4573 /* Unmap pages at the end of the region. */
4574 nbytes = - npages * mmap_page_size;
4575 if (munmap (region_end - nbytes, nbytes) == -1)
4576 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4577 else
4579 r->nbytes_mapped -= nbytes;
4580 success = 1;
4583 else if (npages > 0)
4585 nbytes = npages * mmap_page_size;
4587 /* Try to map additional pages at the end of the region. We
4588 cannot do this if the address range is already occupied by
4589 something else because mmap deletes any previous mapping.
4590 I'm not sure this is worth doing, let's see. */
4591 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4593 POINTER_TYPE *p;
4595 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4596 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4597 if (p == MAP_FAILED)
4598 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4599 else if (p != (POINTER_TYPE *) region_end)
4601 /* Kernels are free to choose a different address. In
4602 that case, unmap what we've mapped above; we have
4603 no use for it. */
4604 if (munmap (p, nbytes) == -1)
4605 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4607 else
4609 r->nbytes_mapped += nbytes;
4610 success = 1;
4615 return success;
4619 /* Set or reset variables holding references to mapped regions. If
4620 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4621 non-zero, set all variables to the start of the user-areas
4622 of mapped regions.
4624 This function is called from Fdump_emacs to ensure that the dumped
4625 Emacs doesn't contain references to memory that won't be mapped
4626 when Emacs starts. */
4628 void
4629 mmap_set_vars (restore_p)
4630 int restore_p;
4632 struct mmap_region *r;
4634 if (restore_p)
4636 mmap_regions = mmap_regions_1;
4637 mmap_fd = mmap_fd_1;
4638 for (r = mmap_regions; r; r = r->next)
4639 *r->var = MMAP_USER_AREA (r);
4641 else
4643 for (r = mmap_regions; r; r = r->next)
4644 *r->var = NULL;
4645 mmap_regions_1 = mmap_regions;
4646 mmap_regions = NULL;
4647 mmap_fd_1 = mmap_fd;
4648 mmap_fd = -1;
4653 /* Allocate a block of storage large enough to hold NBYTES bytes of
4654 data. A pointer to the data is returned in *VAR. VAR is thus the
4655 address of some variable which will use the data area.
4657 The allocation of 0 bytes is valid.
4659 If we can't allocate the necessary memory, set *VAR to null, and
4660 return null. */
4662 static POINTER_TYPE *
4663 mmap_alloc (var, nbytes)
4664 POINTER_TYPE **var;
4665 size_t nbytes;
4667 void *p;
4668 size_t map;
4670 mmap_init ();
4672 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4673 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4674 mmap_fd, 0);
4676 if (p == MAP_FAILED)
4678 if (errno != ENOMEM)
4679 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4680 p = NULL;
4682 else
4684 struct mmap_region *r = (struct mmap_region *) p;
4686 r->nbytes_specified = nbytes;
4687 r->nbytes_mapped = map;
4688 r->var = var;
4689 r->prev = NULL;
4690 r->next = mmap_regions;
4691 if (r->next)
4692 r->next->prev = r;
4693 mmap_regions = r;
4695 p = MMAP_USER_AREA (p);
4698 return *var = p;
4702 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4703 resize it to size NBYTES. Change *VAR to reflect the new block,
4704 and return this value. If more memory cannot be allocated, then
4705 leave *VAR unchanged, and return null. */
4707 static POINTER_TYPE *
4708 mmap_realloc (var, nbytes)
4709 POINTER_TYPE **var;
4710 size_t nbytes;
4712 POINTER_TYPE *result;
4714 mmap_init ();
4716 if (*var == NULL)
4717 result = mmap_alloc (var, nbytes);
4718 else if (nbytes == 0)
4720 mmap_free (var);
4721 result = mmap_alloc (var, nbytes);
4723 else
4725 struct mmap_region *r = MMAP_REGION (*var);
4726 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4728 if (room < nbytes)
4730 /* Must enlarge. */
4731 POINTER_TYPE *old_ptr = *var;
4733 /* Try to map additional pages at the end of the region.
4734 If that fails, allocate a new region, copy data
4735 from the old region, then free it. */
4736 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4737 / mmap_page_size)))
4739 r->nbytes_specified = nbytes;
4740 *var = result = old_ptr;
4742 else if (mmap_alloc (var, nbytes))
4744 bcopy (old_ptr, *var, r->nbytes_specified);
4745 mmap_free_1 (MMAP_REGION (old_ptr));
4746 result = *var;
4747 r = MMAP_REGION (result);
4748 r->nbytes_specified = nbytes;
4750 else
4752 *var = old_ptr;
4753 result = NULL;
4756 else if (room - nbytes >= mmap_page_size)
4758 /* Shrinking by at least a page. Let's give some
4759 memory back to the system.
4761 The extra parens are to make the division happens first,
4762 on positive values, so we know it will round towards
4763 zero. */
4764 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4765 result = *var;
4766 r->nbytes_specified = nbytes;
4768 else
4770 /* Leave it alone. */
4771 result = *var;
4772 r->nbytes_specified = nbytes;
4776 return result;
4780 /* Free a block of relocatable storage whose data is pointed to by
4781 PTR. Store 0 in *PTR to show there's no block allocated. */
4783 static void
4784 mmap_free (var)
4785 POINTER_TYPE **var;
4787 mmap_init ();
4789 if (*var)
4791 mmap_free_1 (MMAP_REGION (*var));
4792 *var = NULL;
4797 /* Perform necessary intializations for the use of mmap. */
4799 static void
4800 mmap_init ()
4802 #if MAP_ANON == 0
4803 /* The value of mmap_fd is initially 0 in temacs, and -1
4804 in a dumped Emacs. */
4805 if (mmap_fd <= 0)
4807 /* No anonymous mmap -- we need the file descriptor. */
4808 mmap_fd = open ("/dev/zero", O_RDONLY);
4809 if (mmap_fd == -1)
4810 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4812 #endif /* MAP_ANON == 0 */
4814 if (mmap_initialized_p)
4815 return;
4816 mmap_initialized_p = 1;
4818 #if MAP_ANON != 0
4819 mmap_fd = -1;
4820 #endif
4822 mmap_page_size = getpagesize ();
4825 #endif /* USE_MMAP_FOR_BUFFERS */
4829 /***********************************************************************
4830 Buffer-text Allocation
4831 ***********************************************************************/
4833 #ifdef REL_ALLOC
4834 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4835 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4836 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4837 #endif /* REL_ALLOC */
4840 /* Allocate NBYTES bytes for buffer B's text buffer. */
4842 static void
4843 alloc_buffer_text (b, nbytes)
4844 struct buffer *b;
4845 size_t nbytes;
4847 POINTER_TYPE *p;
4849 BLOCK_INPUT;
4850 #if defined USE_MMAP_FOR_BUFFERS
4851 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4852 #elif defined REL_ALLOC
4853 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4854 #else
4855 p = xmalloc (nbytes);
4856 #endif
4858 if (p == NULL)
4860 UNBLOCK_INPUT;
4861 memory_full ();
4864 b->text->beg = (unsigned char *) p;
4865 UNBLOCK_INPUT;
4868 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4869 shrink it. */
4871 void
4872 enlarge_buffer_text (b, delta)
4873 struct buffer *b;
4874 int delta;
4876 POINTER_TYPE *p;
4877 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4878 + delta);
4879 BLOCK_INPUT;
4880 #if defined USE_MMAP_FOR_BUFFERS
4881 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4882 #elif defined REL_ALLOC
4883 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4884 #else
4885 p = xrealloc (b->text->beg, nbytes);
4886 #endif
4888 if (p == NULL)
4890 UNBLOCK_INPUT;
4891 memory_full ();
4894 BUF_BEG_ADDR (b) = (unsigned char *) p;
4895 UNBLOCK_INPUT;
4899 /* Free buffer B's text buffer. */
4901 static void
4902 free_buffer_text (b)
4903 struct buffer *b;
4905 BLOCK_INPUT;
4907 #if defined USE_MMAP_FOR_BUFFERS
4908 mmap_free ((POINTER_TYPE **) &b->text->beg);
4909 #elif defined REL_ALLOC
4910 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4911 #else
4912 xfree (b->text->beg);
4913 #endif
4915 BUF_BEG_ADDR (b) = NULL;
4916 UNBLOCK_INPUT;
4921 /***********************************************************************
4922 Initialization
4923 ***********************************************************************/
4925 void
4926 init_buffer_once ()
4928 int idx;
4930 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4932 /* Make sure all markable slots in buffer_defaults
4933 are initialized reasonably, so mark_buffer won't choke. */
4934 reset_buffer (&buffer_defaults);
4935 reset_buffer_local_variables (&buffer_defaults, 1);
4936 reset_buffer (&buffer_local_symbols);
4937 reset_buffer_local_variables (&buffer_local_symbols, 1);
4938 /* Prevent GC from getting confused. */
4939 buffer_defaults.text = &buffer_defaults.own_text;
4940 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4941 BUF_INTERVALS (&buffer_defaults) = 0;
4942 BUF_INTERVALS (&buffer_local_symbols) = 0;
4943 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4944 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4946 /* Set up the default values of various buffer slots. */
4947 /* Must do these before making the first buffer! */
4949 /* real setup is done in bindings.el */
4950 buffer_defaults.mode_line_format = build_string ("%-");
4951 buffer_defaults.header_line_format = Qnil;
4952 buffer_defaults.abbrev_mode = Qnil;
4953 buffer_defaults.overwrite_mode = Qnil;
4954 buffer_defaults.case_fold_search = Qt;
4955 buffer_defaults.auto_fill_function = Qnil;
4956 buffer_defaults.selective_display = Qnil;
4957 #ifndef old
4958 buffer_defaults.selective_display_ellipses = Qt;
4959 #endif
4960 buffer_defaults.abbrev_table = Qnil;
4961 buffer_defaults.display_table = Qnil;
4962 buffer_defaults.undo_list = Qnil;
4963 buffer_defaults.mark_active = Qnil;
4964 buffer_defaults.file_format = Qnil;
4965 buffer_defaults.overlays_before = NULL;
4966 buffer_defaults.overlays_after = NULL;
4967 buffer_defaults.overlay_center = BEG;
4969 XSETFASTINT (buffer_defaults.tab_width, 8);
4970 buffer_defaults.truncate_lines = Qnil;
4971 buffer_defaults.ctl_arrow = Qt;
4972 buffer_defaults.direction_reversed = Qnil;
4973 buffer_defaults.cursor_type = Qt;
4974 buffer_defaults.extra_line_spacing = Qnil;
4976 #ifdef DOS_NT
4977 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4978 #endif
4979 buffer_defaults.enable_multibyte_characters = Qt;
4980 buffer_defaults.buffer_file_coding_system = Qnil;
4981 XSETFASTINT (buffer_defaults.fill_column, 70);
4982 XSETFASTINT (buffer_defaults.left_margin, 0);
4983 buffer_defaults.cache_long_line_scans = Qnil;
4984 buffer_defaults.file_truename = Qnil;
4985 XSETFASTINT (buffer_defaults.display_count, 0);
4986 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
4987 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
4988 buffer_defaults.left_fringe_width = Qnil;
4989 buffer_defaults.right_fringe_width = Qnil;
4990 buffer_defaults.fringes_outside_margins = Qnil;
4991 buffer_defaults.scroll_bar_width = Qnil;
4992 buffer_defaults.vertical_scroll_bar_type = Qt;
4993 buffer_defaults.indicate_empty_lines = Qnil;
4994 buffer_defaults.indicate_buffer_boundaries = Qnil;
4995 buffer_defaults.scroll_up_aggressively = Qnil;
4996 buffer_defaults.scroll_down_aggressively = Qnil;
4997 buffer_defaults.display_time = Qnil;
4999 /* Assign the local-flags to the slots that have default values.
5000 The local flag is a bit that is used in the buffer
5001 to say that it has its own local value for the slot.
5002 The local flag bits are in the local_var_flags slot of the buffer. */
5004 /* Nothing can work if this isn't true */
5005 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
5007 /* 0 means not a lisp var, -1 means always local, else mask */
5008 bzero (&buffer_local_flags, sizeof buffer_local_flags);
5009 XSETINT (buffer_local_flags.filename, -1);
5010 XSETINT (buffer_local_flags.directory, -1);
5011 XSETINT (buffer_local_flags.backed_up, -1);
5012 XSETINT (buffer_local_flags.save_length, -1);
5013 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5014 XSETINT (buffer_local_flags.read_only, -1);
5015 XSETINT (buffer_local_flags.major_mode, -1);
5016 XSETINT (buffer_local_flags.mode_name, -1);
5017 XSETINT (buffer_local_flags.undo_list, -1);
5018 XSETINT (buffer_local_flags.mark_active, -1);
5019 XSETINT (buffer_local_flags.point_before_scroll, -1);
5020 XSETINT (buffer_local_flags.file_truename, -1);
5021 XSETINT (buffer_local_flags.invisibility_spec, -1);
5022 XSETINT (buffer_local_flags.file_format, -1);
5023 XSETINT (buffer_local_flags.display_count, -1);
5024 XSETINT (buffer_local_flags.display_time, -1);
5025 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5027 idx = 1;
5028 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5029 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5030 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5031 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5032 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5033 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5034 #ifndef old
5035 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5036 #endif
5037 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5038 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5039 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5040 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5041 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5042 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5043 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5044 #ifdef DOS_NT
5045 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5046 /* Make this one a permanent local. */
5047 buffer_permanent_local_flags[idx++] = 1;
5048 #endif
5049 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5050 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5051 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5052 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5053 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5054 /* Make this one a permanent local. */
5055 buffer_permanent_local_flags[idx++] = 1;
5056 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5057 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5058 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5059 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5060 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5061 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5062 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5063 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5064 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5065 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5066 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5067 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5068 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5069 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5071 /* Need more room? */
5072 if (idx >= MAX_PER_BUFFER_VARS)
5073 abort ();
5074 last_per_buffer_idx = idx;
5076 Vbuffer_alist = Qnil;
5077 current_buffer = 0;
5078 all_buffers = 0;
5080 QSFundamental = build_string ("Fundamental");
5082 Qfundamental_mode = intern ("fundamental-mode");
5083 buffer_defaults.major_mode = Qfundamental_mode;
5085 Qmode_class = intern ("mode-class");
5087 Qprotected_field = intern ("protected-field");
5089 Qpermanent_local = intern ("permanent-local");
5091 Qkill_buffer_hook = intern ("kill-buffer-hook");
5092 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5094 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5096 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5098 /* super-magic invisible buffer */
5099 Vbuffer_alist = Qnil;
5101 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5103 inhibit_modification_hooks = 0;
5106 void
5107 init_buffer ()
5109 char buf[MAXPATHLEN + 1];
5110 char *pwd;
5111 struct stat dotstat, pwdstat;
5112 Lisp_Object temp;
5113 int rc;
5115 #ifdef USE_MMAP_FOR_BUFFERS
5117 /* When using the ralloc implementation based on mmap(2), buffer
5118 text pointers will have been set to null in the dumped Emacs.
5119 Map new memory. */
5120 struct buffer *b;
5122 for (b = all_buffers; b; b = b->next)
5123 if (b->text->beg == NULL)
5124 enlarge_buffer_text (b, 0);
5126 #endif /* USE_MMAP_FOR_BUFFERS */
5128 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5129 if (NILP (buffer_defaults.enable_multibyte_characters))
5130 Fset_buffer_multibyte (Qnil);
5132 /* If PWD is accurate, use it instead of calling getwd. PWD is
5133 sometimes a nicer name, and using it may avoid a fatal error if a
5134 parent directory is searchable but not readable. */
5135 if ((pwd = getenv ("PWD")) != 0
5136 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5137 && stat (pwd, &pwdstat) == 0
5138 && stat (".", &dotstat) == 0
5139 && dotstat.st_ino == pwdstat.st_ino
5140 && dotstat.st_dev == pwdstat.st_dev
5141 && strlen (pwd) < MAXPATHLEN)
5142 strcpy (buf, pwd);
5143 #ifdef HAVE_GETCWD
5144 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5145 fatal ("`getcwd' failed: %s\n", strerror (errno));
5146 #else
5147 else if (getwd (buf) == 0)
5148 fatal ("`getwd' failed: %s\n", buf);
5149 #endif
5151 #ifndef VMS
5152 /* Maybe this should really use some standard subroutine
5153 whose definition is filename syntax dependent. */
5154 rc = strlen (buf);
5155 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5157 buf[rc] = DIRECTORY_SEP;
5158 buf[rc + 1] = '\0';
5160 #endif /* not VMS */
5162 current_buffer->directory = build_string (buf);
5164 /* Add /: to the front of the name
5165 if it would otherwise be treated as magic. */
5166 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5167 if (! NILP (temp)
5168 /* If the default dir is just /, TEMP is non-nil
5169 because of the ange-ftp completion handler.
5170 However, it is not necessary to turn / into /:/.
5171 So avoid doing that. */
5172 && strcmp ("/", SDATA (current_buffer->directory)))
5173 current_buffer->directory
5174 = concat2 (build_string ("/:"), current_buffer->directory);
5176 temp = get_minibuffer (0);
5177 XBUFFER (temp)->directory = current_buffer->directory;
5180 /* initialize the buffer routines */
5181 void
5182 syms_of_buffer ()
5184 staticpro (&last_overlay_modification_hooks);
5185 last_overlay_modification_hooks
5186 = Fmake_vector (make_number (10), Qnil);
5188 staticpro (&Vbuffer_defaults);
5189 staticpro (&Vbuffer_local_symbols);
5190 staticpro (&Qfundamental_mode);
5191 staticpro (&Qmode_class);
5192 staticpro (&QSFundamental);
5193 staticpro (&Vbuffer_alist);
5194 staticpro (&Qprotected_field);
5195 staticpro (&Qpermanent_local);
5196 staticpro (&Qkill_buffer_hook);
5197 Qoverlayp = intern ("overlayp");
5198 staticpro (&Qoverlayp);
5199 Qevaporate = intern ("evaporate");
5200 staticpro (&Qevaporate);
5201 Qmodification_hooks = intern ("modification-hooks");
5202 staticpro (&Qmodification_hooks);
5203 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5204 staticpro (&Qinsert_in_front_hooks);
5205 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5206 staticpro (&Qinsert_behind_hooks);
5207 Qget_file_buffer = intern ("get-file-buffer");
5208 staticpro (&Qget_file_buffer);
5209 Qpriority = intern ("priority");
5210 staticpro (&Qpriority);
5211 Qwindow = intern ("window");
5212 staticpro (&Qwindow);
5213 Qbefore_string = intern ("before-string");
5214 staticpro (&Qbefore_string);
5215 Qafter_string = intern ("after-string");
5216 staticpro (&Qafter_string);
5217 Qfirst_change_hook = intern ("first-change-hook");
5218 staticpro (&Qfirst_change_hook);
5219 Qbefore_change_functions = intern ("before-change-functions");
5220 staticpro (&Qbefore_change_functions);
5221 Qafter_change_functions = intern ("after-change-functions");
5222 staticpro (&Qafter_change_functions);
5223 staticpro (&Qucs_set_table_for_input);
5225 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5226 staticpro (&Qkill_buffer_query_functions);
5228 Fput (Qprotected_field, Qerror_conditions,
5229 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5230 Fput (Qprotected_field, Qerror_message,
5231 build_string ("Attempt to modify a protected field"));
5233 /* All these use DEFVAR_LISP_NOPRO because the slots in
5234 buffer_defaults will all be marked via Vbuffer_defaults. */
5236 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5237 &buffer_defaults.mode_line_format,
5238 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5239 This is the same as (default-value 'mode-line-format). */);
5241 DEFVAR_LISP_NOPRO ("default-header-line-format",
5242 &buffer_defaults.header_line_format,
5243 doc: /* Default value of `header-line-format' for buffers that don't override it.
5244 This is the same as (default-value 'header-line-format). */);
5246 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5247 doc: /* Default value of `cursor-type' for buffers that don't override it.
5248 This is the same as (default-value 'cursor-type). */);
5250 DEFVAR_LISP_NOPRO ("default-line-spacing",
5251 &buffer_defaults.extra_line_spacing,
5252 doc: /* Default value of `line-spacing' for buffers that don't override it.
5253 This is the same as (default-value 'line-spacing). */);
5255 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5256 &buffer_defaults.abbrev_mode,
5257 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5258 This is the same as (default-value 'abbrev-mode). */);
5260 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5261 &buffer_defaults.ctl_arrow,
5262 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5263 This is the same as (default-value 'ctl-arrow). */);
5265 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5266 &buffer_defaults.direction_reversed,
5267 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5268 This is the same as (default-value 'direction-reversed). */);
5270 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5271 &buffer_defaults.enable_multibyte_characters,
5272 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5273 This is the same as (default-value 'enable-multibyte-characters). */);
5275 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5276 &buffer_defaults.buffer_file_coding_system,
5277 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5278 This is the same as (default-value 'buffer-file-coding-system). */);
5280 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5281 &buffer_defaults.truncate_lines,
5282 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5283 This is the same as (default-value 'truncate-lines). */);
5285 DEFVAR_LISP_NOPRO ("default-fill-column",
5286 &buffer_defaults.fill_column,
5287 doc: /* Default value of `fill-column' for buffers that do not override it.
5288 This is the same as (default-value 'fill-column). */);
5290 DEFVAR_LISP_NOPRO ("default-left-margin",
5291 &buffer_defaults.left_margin,
5292 doc: /* Default value of `left-margin' for buffers that do not override it.
5293 This is the same as (default-value 'left-margin). */);
5295 DEFVAR_LISP_NOPRO ("default-tab-width",
5296 &buffer_defaults.tab_width,
5297 doc: /* Default value of `tab-width' for buffers that do not override it.
5298 This is the same as (default-value 'tab-width). */);
5300 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5301 &buffer_defaults.case_fold_search,
5302 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5303 This is the same as (default-value 'case-fold-search). */);
5305 #ifdef DOS_NT
5306 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5307 &buffer_defaults.buffer_file_type,
5308 doc: /* Default file type for buffers that do not override it.
5309 This is the same as (default-value 'buffer-file-type).
5310 The file type is nil for text, t for binary. */);
5311 #endif
5313 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5314 &buffer_defaults.left_margin_cols,
5315 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5316 This is the same as (default-value 'left-margin-width). */);
5318 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5319 &buffer_defaults.right_margin_cols,
5320 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5321 This is the same as (default-value 'right-margin-width). */);
5323 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5324 &buffer_defaults.left_fringe_width,
5325 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5326 This is the same as (default-value 'left-fringe-width). */);
5328 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5329 &buffer_defaults.right_fringe_width,
5330 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5331 This is the same as (default-value 'right-fringe-width). */);
5333 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5334 &buffer_defaults.fringes_outside_margins,
5335 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5336 This is the same as (default-value 'fringes-outside-margins). */);
5338 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5339 &buffer_defaults.scroll_bar_width,
5340 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5341 This is the same as (default-value 'scroll-bar-width). */);
5343 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5344 &buffer_defaults.vertical_scroll_bar_type,
5345 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5346 This is the same as (default-value 'vertical-scroll-bar). */);
5348 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5349 &buffer_defaults.indicate_empty_lines,
5350 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5351 This is the same as (default-value 'indicate-empty-lines). */);
5353 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5354 &buffer_defaults.indicate_buffer_boundaries,
5355 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5356 This is the same as (default-value 'indicate-buffer-boundaries). */);
5358 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5359 &buffer_defaults.scroll_up_aggressively,
5360 doc: /* Default value of `scroll-up-aggressively'.
5361 This value applies in buffers that don't have their own local values.
5362 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5364 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5365 &buffer_defaults.scroll_down_aggressively,
5366 doc: /* Default value of `scroll-down-aggressively'.
5367 This value applies in buffers that don't have their own local values.
5368 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5370 DEFVAR_PER_BUFFER ("header-line-format",
5371 &current_buffer->header_line_format,
5372 Qnil,
5373 doc: /* Analogous to `mode-line-format', but controls the header line.
5374 The header line appears, optionally, at the top of a window;
5375 the mode line appears at the bottom. */);
5377 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5378 Qnil,
5379 doc: /* Template for displaying mode line for current buffer.
5380 Each buffer has its own value of this variable.
5381 Value may be nil, a string, a symbol or a list or cons cell.
5382 A value of nil means don't display a mode line.
5383 For a symbol, its value is used (but it is ignored if t or nil).
5384 A string appearing directly as the value of a symbol is processed verbatim
5385 in that the %-constructs below are not recognized.
5386 Note that unless the symbol is marked as a `risky-local-variable', all
5387 properties in any strings, as well as all :eval and :propertize forms
5388 in the value of that symbol will be ignored.
5389 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5390 is used as a mode line element. Be careful--FORM should not load any files,
5391 because that can cause an infinite recursion.
5392 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5393 with the specified properties PROPS applied.
5394 For a list whose car is a symbol, the symbol's value is taken,
5395 and if that is non-nil, the cadr of the list is processed recursively.
5396 Otherwise, the caddr of the list (if there is one) is processed.
5397 For a list whose car is a string or list, each element is processed
5398 recursively and the results are effectively concatenated.
5399 For a list whose car is an integer, the cdr of the list is processed
5400 and padded (if the number is positive) or truncated (if negative)
5401 to the width specified by that number.
5402 A string is printed verbatim in the mode line except for %-constructs:
5403 (%-constructs are allowed when the string is the entire mode-line-format
5404 or when it is found in a cons-cell or a list)
5405 %b -- print buffer name. %f -- print visited file name.
5406 %F -- print frame name.
5407 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5408 %& is like %*, but ignore read-only-ness.
5409 % means buffer is read-only and * means it is modified.
5410 For a modified read-only buffer, %* gives % and %+ gives *.
5411 %s -- print process status. %l -- print the current line number.
5412 %c -- print the current column number (this makes editing slower).
5413 To make the column number update correctly in all cases,
5414 `column-number-mode' must be non-nil.
5415 %i -- print the size of the buffer.
5416 %I -- like %i, but use k, M, G, etc., to abbreviate.
5417 %p -- print percent of buffer above top of window, or Top, Bot or All.
5418 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5419 or print Bottom or All.
5420 %m -- print the mode name.
5421 %n -- print Narrow if appropriate.
5422 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5423 %Z -- like %z, but including the end-of-line format.
5424 %[ -- print one [ for each recursive editing level. %] similar.
5425 %% -- print %. %- -- print infinitely many dashes.
5426 Decimal digits after the % specify field width to which to pad. */);
5428 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5429 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5430 nil here means use current buffer's major mode. */);
5432 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5433 make_number (Lisp_Symbol),
5434 doc: /* Symbol for current buffer's major mode. */);
5436 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5437 Qnil,
5438 doc: /* Pretty name of current buffer's major mode (a string). */);
5440 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5441 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5443 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5444 Qnil,
5445 doc: /* *Non-nil if searches and matches should ignore case. */);
5447 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5448 make_number (Lisp_Int),
5449 doc: /* *Column beyond which automatic line-wrapping should happen.
5450 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5452 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5453 make_number (Lisp_Int),
5454 doc: /* *Column for the default indent-line-function to indent to.
5455 Linefeed indents to this column in Fundamental mode. */);
5457 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5458 make_number (Lisp_Int),
5459 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5461 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5462 doc: /* *Non-nil means display control chars with uparrow.
5463 A value of nil means use backslash and octal digits.
5464 This variable does not apply to characters whose display is specified
5465 in the current display table (if there is one). */);
5467 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5468 &current_buffer->enable_multibyte_characters,
5469 Qnil,
5470 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5471 Otherwise they are regarded as unibyte. This affects the display,
5472 file I/O and the behavior of various editing commands.
5474 This variable is buffer-local but you cannot set it directly;
5475 use the function `set-buffer-multibyte' to change a buffer's representation.
5476 Changing its default value with `setq-default' is supported.
5477 See also variable `default-enable-multibyte-characters' and Info node
5478 `(elisp)Text Representations'. */);
5479 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5481 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5482 &current_buffer->buffer_file_coding_system, Qnil,
5483 doc: /* Coding system to be used for encoding the buffer contents on saving.
5484 This variable applies to saving the buffer, and also to `write-region'
5485 and other functions that use `write-region'.
5486 It does not apply to sending output to subprocesses, however.
5488 If this is nil, the buffer is saved without any code conversion
5489 unless some coding system is specified in `file-coding-system-alist'
5490 for the buffer file.
5492 If the text to be saved cannot be encoded as specified by this variable,
5493 an alternative encoding is selected by `select-safe-coding-system', which see.
5495 The variable `coding-system-for-write', if non-nil, overrides this variable.
5497 This variable is never applied to a way of decoding a file while reading it. */);
5499 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5500 Qnil,
5501 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5503 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5504 doc: /* *Non-nil means do not display continuation lines.
5505 Instead, give each line of text just one screen line.
5507 Note that this is overridden by the variable
5508 `truncate-partial-width-windows' if that variable is non-nil
5509 and this buffer is not full-frame width. */);
5511 #ifdef DOS_NT
5512 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5513 Qnil,
5514 doc: /* Non-nil if the visited file is a binary file.
5515 This variable is meaningful on MS-DOG and Windows NT.
5516 On those systems, it is automatically local in every buffer.
5517 On other systems, this variable is normally always nil. */);
5518 #endif
5520 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5521 make_number (Lisp_String),
5522 doc: /* Name of default directory of current buffer. Should end with slash.
5523 To interactively change the default directory, use command `cd'. */);
5525 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5526 Qnil,
5527 doc: /* Function called (if non-nil) to perform auto-fill.
5528 It is called after self-inserting any character specified in
5529 the `auto-fill-chars' table.
5530 NOTE: This variable is not a hook;
5531 its value may not be a list of functions. */);
5533 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5534 make_number (Lisp_String),
5535 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5537 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5538 make_number (Lisp_String),
5539 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5540 The truename of a file is calculated by `file-truename'
5541 and then abbreviated with `abbreviate-file-name'. */);
5543 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5544 &current_buffer->auto_save_file_name,
5545 make_number (Lisp_String),
5546 doc: /* Name of file for auto-saving current buffer.
5547 If it is nil, that means don't auto-save this buffer. */);
5549 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5550 doc: /* Non-nil if this buffer is read-only. */);
5552 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5553 doc: /* Non-nil if this buffer's file has been backed up.
5554 Backing up is done before the first time the file is saved. */);
5556 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5557 make_number (Lisp_Int),
5558 doc: /* Length of current buffer when last read in, saved or auto-saved.
5559 0 initially. */);
5561 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5562 Qnil,
5563 doc: /* Non-nil enables selective display.
5564 An Integer N as value means display only lines
5565 that start with less than n columns of space.
5566 A value of t means that the character ^M makes itself and
5567 all the rest of the line invisible; also, when saving the buffer
5568 in a file, save the ^M as a newline. */);
5570 #ifndef old
5571 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5572 &current_buffer->selective_display_ellipses,
5573 Qnil,
5574 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5575 #endif
5577 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5578 doc: /* Non-nil if self-insertion should replace existing text.
5579 The value should be one of `overwrite-mode-textual',
5580 `overwrite-mode-binary', or nil.
5581 If it is `overwrite-mode-textual', self-insertion still
5582 inserts at the end of a line, and inserts when point is before a tab,
5583 until the tab is filled in.
5584 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5586 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5587 Qnil,
5588 doc: /* Display table that controls display of the contents of current buffer.
5590 If this variable is nil, the value of `standard-display-table' is used.
5591 Each window can have its own, overriding display table, see
5592 `set-window-display-table' and `window-display-table'.
5594 The display table is a char-table created with `make-display-table'.
5595 A char-table is an array indexed by character codes. Normal array
5596 primitives `aref' and `aset' can be used to access elements of a char-table.
5598 Each of the char-table elements control how to display the corresponding
5599 text character: the element at index C in the table says how to display
5600 the character whose code is C. Each element should be a vector of
5601 characters or nil. nil means display the character in the default fashion;
5602 otherwise, the characters from the vector are delivered to the screen
5603 instead of the original character.
5605 For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5606 a capital Y instead of each X character.
5608 In addition, a char-table has six extra slots to control the display of:
5610 the end of a truncated screen line (extra-slot 0, a single character);
5611 the end of a continued line (extra-slot 1, a single character);
5612 the escape character used to display character codes in octal
5613 (extra-slot 2, a single character);
5614 the character used as an arrow for control characters (extra-slot 3,
5615 a single character);
5616 the decoration indicating the presence of invisible lines (extra-slot 4,
5617 a vector of characters);
5618 the character used to draw the border between side-by-side windows
5619 (extra-slot 5, a single character).
5621 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5623 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5624 Qnil,
5625 doc: /* *Width of left marginal area for display of a buffer.
5626 A value of nil means no marginal area. */);
5628 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5629 Qnil,
5630 doc: /* *Width of right marginal area for display of a buffer.
5631 A value of nil means no marginal area. */);
5633 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5634 Qnil,
5635 doc: /* *Width of this buffer's left fringe (in pixels).
5636 A value of 0 means no left fringe is shown in this buffer's window.
5637 A value of nil means to use the left fringe width from the window's frame. */);
5639 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5640 Qnil,
5641 doc: /* *Width of this buffer's right fringe (in pixels).
5642 A value of 0 means no right fringe is shown in this buffer's window.
5643 A value of nil means to use the right fringe width from the window's frame. */);
5645 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5646 Qnil,
5647 doc: /* *Non-nil means to display fringes outside display margins.
5648 A value of nil means to display fringes between margins and buffer text. */);
5650 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5651 Qnil,
5652 doc: /* *Width of this buffer's scroll bars in pixels.
5653 A value of nil means to use the scroll bar width from the window's frame. */);
5655 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5656 Qnil,
5657 doc: /* *Position of this buffer's vertical scroll bar.
5658 A value of left or right means to place the vertical scroll bar at that side
5659 of the window; a value of nil means that this window has no vertical scroll bar.
5660 A value of t means to use the vertical scroll bar type from the window's frame. */);
5662 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5663 &current_buffer->indicate_empty_lines, Qnil,
5664 doc: /* *Visually indicate empty lines after the buffer end.
5665 If non-nil, a bitmap is displayed in the left fringe of a window on
5666 window-systems. */);
5668 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5669 &current_buffer->indicate_buffer_boundaries, Qnil,
5670 doc: /* *Visually indicate buffer boundaries and scrolling.
5671 If non-nil, the first and last line of the buffer are marked in the fringe
5672 of a window on window-systems with angle bitmaps, or if the window can be
5673 scrolled, the top and bottom line of the window are marked with up and down
5674 arrow bitmaps.
5675 If value is `left' or `right', both angle and arrow bitmaps are displayed in
5676 the left or right fringe, resp. Any other non-nil value causes the
5677 bitmap on the top line to be displayed in the left fringe, and the
5678 bitmap on the bottom line in the right fringe.
5679 If value is a cons (ANGLES . ARROWS), the car specifies the position
5680 of the angle bitmaps, and the cdr specifies the position of the arrow
5681 bitmaps. For example, (t . right) places the top angle bitmap in left
5682 fringe, the bottom angle bitmap in right fringe, and both arrow
5683 bitmaps in right fringe. To show just the angle bitmaps in the left
5684 fringe, but no arrow bitmaps, use (left . nil). */);
5686 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5687 &current_buffer->scroll_up_aggressively, Qnil,
5688 doc: /* How far to scroll windows upward.
5689 If you move point off the bottom, the window scrolls automatically.
5690 This variable controls how far it scrolls. nil, the default,
5691 means scroll to center point. A fraction means scroll to put point
5692 that fraction of the window's height from the bottom of the window.
5693 When the value is 0.0, point goes at the bottom line, which in the simple
5694 case that you moved off with C-f means scrolling just one line. 1.0 means
5695 point goes at the top, so that in that simple case, the window
5696 window scrolls by a full window height. Meaningful values are
5697 between 0.0 and 1.0, inclusive. */);
5699 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5700 &current_buffer->scroll_down_aggressively, Qnil,
5701 doc: /* How far to scroll windows downward.
5702 If you move point off the top, the window scrolls automatically.
5703 This variable controls how far it scrolls. nil, the default,
5704 means scroll to center point. A fraction means scroll to put point
5705 that fraction of the window's height from the top of the window.
5706 When the value is 0.0, point goes at the top line, which in the simple
5707 case that you moved off with C-b means scrolling just one line. 1.0 means
5708 point goes at the bottom, so that in that simple case, the window
5709 window scrolls by a full window height. Meaningful values are
5710 between 0.0 and 1.0, inclusive. */);
5712 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5713 "Don't ask.");
5716 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5717 doc: /* List of functions to call before each text change.
5718 Two arguments are passed to each function: the positions of
5719 the beginning and end of the range of old text to be changed.
5720 \(For an insertion, the beginning and end are at the same place.)
5721 No information is given about the length of the text after the change.
5723 Buffer changes made while executing the `before-change-functions'
5724 don't call any before-change or after-change functions.
5725 That's because these variables are temporarily set to nil.
5726 As a result, a hook function cannot straightforwardly alter the value of
5727 these variables. See the Emacs Lisp manual for a way of
5728 accomplishing an equivalent result by using other variables.
5730 If an unhandled error happens in running these functions,
5731 the variable's value remains nil. That prevents the error
5732 from happening repeatedly and making Emacs nonfunctional. */);
5733 Vbefore_change_functions = Qnil;
5735 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5736 doc: /* List of functions to call after each text change.
5737 Three arguments are passed to each function: the positions of
5738 the beginning and end of the range of changed text,
5739 and the length in bytes of the pre-change text replaced by that range.
5740 \(For an insertion, the pre-change length is zero;
5741 for a deletion, that length is the number of bytes deleted,
5742 and the post-change beginning and end are at the same place.)
5744 Buffer changes made while executing the `after-change-functions'
5745 don't call any before-change or after-change functions.
5746 That's because these variables are temporarily set to nil.
5747 As a result, a hook function cannot straightforwardly alter the value of
5748 these variables. See the Emacs Lisp manual for a way of
5749 accomplishing an equivalent result by using other variables.
5751 If an unhandled error happens in running these functions,
5752 the variable's value remains nil. That prevents the error
5753 from happening repeatedly and making Emacs nonfunctional. */);
5754 Vafter_change_functions = Qnil;
5756 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5757 doc: /* A list of functions to call before changing a buffer which is unmodified.
5758 The functions are run using the `run-hooks' function. */);
5759 Vfirst_change_hook = Qnil;
5761 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5762 doc: /* List of undo entries in current buffer.
5763 Recent changes come first; older changes follow newer.
5765 An entry (BEG . END) represents an insertion which begins at
5766 position BEG and ends at position END.
5768 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5769 from (abs POSITION). If POSITION is positive, point was at the front
5770 of the text being deleted; if negative, point was at the end.
5772 An entry (t HIGH . LOW) indicates that the buffer previously had
5773 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5774 of the visited file's modification time, as of that time. If the
5775 modification time of the most recent save is different, this entry is
5776 obsolete.
5778 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5779 was modified between BEG and END. PROPERTY is the property name,
5780 and VALUE is the old value.
5782 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5783 was adjusted in position by the offset DISTANCE (an integer).
5785 An entry of the form POSITION indicates that point was at the buffer
5786 location given by the integer. Undoing an entry of this form places
5787 point at POSITION.
5789 nil marks undo boundaries. The undo command treats the changes
5790 between two undo boundaries as a single step to be undone.
5792 If the value of the variable is t, undo information is not recorded. */);
5794 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5795 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5797 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5798 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5800 Normally, the line-motion functions work by scanning the buffer for
5801 newlines. Columnar operations (like move-to-column and
5802 compute-motion) also work by scanning the buffer, summing character
5803 widths as they go. This works well for ordinary text, but if the
5804 buffer's lines are very long (say, more than 500 characters), these
5805 motion functions will take longer to execute. Emacs may also take
5806 longer to update the display.
5808 If cache-long-line-scans is non-nil, these motion functions cache the
5809 results of their scans, and consult the cache to avoid rescanning
5810 regions of the buffer until the text is modified. The caches are most
5811 beneficial when they prevent the most searching---that is, when the
5812 buffer contains long lines and large regions of characters with the
5813 same, fixed screen width.
5815 When cache-long-line-scans is non-nil, processing short lines will
5816 become slightly slower (because of the overhead of consulting the
5817 cache), and the caches will use memory roughly proportional to the
5818 number of newlines and characters whose screen width varies.
5820 The caches require no explicit maintenance; their accuracy is
5821 maintained internally by the Emacs primitives. Enabling or disabling
5822 the cache should not affect the behavior of any of the motion
5823 functions; it should only affect their performance. */);
5825 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5826 doc: /* Value of point before the last series of scroll operations, or nil. */);
5828 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5829 doc: /* List of formats to use when saving this buffer.
5830 Formats are defined by `format-alist'. This variable is
5831 set when a file is visited. */);
5833 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5834 &current_buffer->invisibility_spec, Qnil,
5835 doc: /* Invisibility spec of this buffer.
5836 The default is t, which means that text is invisible
5837 if it has a non-nil `invisible' property.
5838 If the value is a list, a text character is invisible if its `invisible'
5839 property is an element in that list.
5840 If an element is a cons cell of the form (PROP . ELLIPSIS),
5841 then characters with property value PROP are invisible,
5842 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5844 DEFVAR_PER_BUFFER ("buffer-display-count",
5845 &current_buffer->display_count, Qnil,
5846 doc: /* A number incremented each time this buffer is displayed in a window.
5847 The function `set-window-buffer' increments it. */);
5849 DEFVAR_PER_BUFFER ("buffer-display-time",
5850 &current_buffer->display_time, Qnil,
5851 doc: /* Time stamp updated each time this buffer is displayed in a window.
5852 The function `set-window-buffer' updates this variable
5853 to the value obtained by calling `current-time'.
5854 If the buffer has never been shown in a window, the value is nil. */);
5856 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5857 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5858 Non-nil also enables highlighting of the region whenever the mark is active.
5859 The variable `highlight-nonselected-windows' controls whether to highlight
5860 all windows or just the selected window.
5862 If the value is `lambda', that enables Transient Mark mode temporarily
5863 until the next buffer modification. If a command sets the value to `only',
5864 that enables Transient Mark mode for the following command only.
5865 During that following command, the value of `transient-mark-mode'
5866 is `identity'. If it is still `identity' at the end of that command,
5867 it changes to nil. */);
5868 Vtransient_mark_mode = Qnil;
5870 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5871 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5872 If the value is t, disregard `buffer-read-only' and all `read-only'
5873 text properties. If the value is a list, disregard `buffer-read-only'
5874 and disregard a `read-only' text property if the property value
5875 is a member of the list. */);
5876 Vinhibit_read_only = Qnil;
5878 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5879 doc: /* Cursor to use when this buffer is in the selected window.
5880 Values are interpreted as follows:
5882 t use the cursor specified for the frame
5883 nil don't display a cursor
5884 box display a filled box cursor
5885 hollow display a hollow box cursor
5886 bar display a vertical bar cursor with default width
5887 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5888 hbar display a horisontal bar cursor with default width
5889 (hbar . WIDTH) display a horisontal bar cursor with width WIDTH
5890 ANYTHING ELSE display a hollow box cursor.
5892 When the buffer is displayed in a nonselected window,
5893 this variable has no effect; the cursor appears as a hollow box. */);
5895 DEFVAR_PER_BUFFER ("line-spacing",
5896 &current_buffer->extra_line_spacing, Qnil,
5897 doc: /* Additional space to put between lines when displaying a buffer.
5898 The space is measured in pixels, and put below lines on window systems.
5899 If value is a floating point number, it specifies the spacing relative
5900 to the default frame line height. */);
5902 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5903 doc: /* List of functions called with no args to query before killing a buffer. */);
5904 Vkill_buffer_query_functions = Qnil;
5906 defsubr (&Sbuffer_live_p);
5907 defsubr (&Sbuffer_list);
5908 defsubr (&Sget_buffer);
5909 defsubr (&Sget_file_buffer);
5910 defsubr (&Sget_buffer_create);
5911 defsubr (&Smake_indirect_buffer);
5912 defsubr (&Sgenerate_new_buffer_name);
5913 defsubr (&Sbuffer_name);
5914 /*defsubr (&Sbuffer_number);*/
5915 defsubr (&Sbuffer_file_name);
5916 defsubr (&Sbuffer_base_buffer);
5917 defsubr (&Sbuffer_local_value);
5918 defsubr (&Sbuffer_local_variables);
5919 defsubr (&Sbuffer_modified_p);
5920 defsubr (&Sset_buffer_modified_p);
5921 defsubr (&Sbuffer_modified_tick);
5922 defsubr (&Srename_buffer);
5923 defsubr (&Sother_buffer);
5924 defsubr (&Sbuffer_disable_undo);
5925 defsubr (&Sbuffer_enable_undo);
5926 defsubr (&Skill_buffer);
5927 defsubr (&Sset_buffer_major_mode);
5928 defsubr (&Sswitch_to_buffer);
5929 defsubr (&Spop_to_buffer);
5930 defsubr (&Scurrent_buffer);
5931 defsubr (&Sset_buffer);
5932 defsubr (&Sbarf_if_buffer_read_only);
5933 defsubr (&Sbury_buffer);
5934 defsubr (&Serase_buffer);
5935 defsubr (&Sset_buffer_multibyte);
5936 defsubr (&Skill_all_local_variables);
5938 defsubr (&Soverlayp);
5939 defsubr (&Smake_overlay);
5940 defsubr (&Sdelete_overlay);
5941 defsubr (&Smove_overlay);
5942 defsubr (&Soverlay_start);
5943 defsubr (&Soverlay_end);
5944 defsubr (&Soverlay_buffer);
5945 defsubr (&Soverlay_properties);
5946 defsubr (&Soverlays_at);
5947 defsubr (&Soverlays_in);
5948 defsubr (&Snext_overlay_change);
5949 defsubr (&Sprevious_overlay_change);
5950 defsubr (&Soverlay_recenter);
5951 defsubr (&Soverlay_lists);
5952 defsubr (&Soverlay_get);
5953 defsubr (&Soverlay_put);
5954 defsubr (&Srestore_buffer_modified_p);
5957 void
5958 keys_of_buffer ()
5960 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5961 initial_define_key (control_x_map, 'k', "kill-buffer");
5963 /* This must not be in syms_of_buffer, because Qdisabled is not
5964 initialized when that function gets called. */
5965 Fput (intern ("erase-buffer"), Qdisabled, Qt);
5968 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
5969 (do not change this comment) */