(Managing Overlays): overlay-buffer returns nil for deleted overlays.
[emacs.git] / src / buffer.c
blob3394e1dead2abc761aaf8044be4f2b8342dfad6c
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 86, 87, 88, 89, 93, 94, 95, 97, 98, 99,
3 2000, 01, 02, 03, 04, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <sys/param.h>
27 #include <errno.h>
28 #include <stdio.h>
30 #ifndef USE_CRT_DLL
31 extern int errno;
32 #endif
34 #ifndef MAXPATHLEN
35 /* in 4.1 [probably SunOS? -stef] , param.h fails to define this. */
36 #define MAXPATHLEN 1024
37 #endif /* not MAXPATHLEN */
39 #ifdef HAVE_UNISTD_H
40 #include <unistd.h>
41 #endif
43 #include "lisp.h"
44 #include "intervals.h"
45 #include "window.h"
46 #include "commands.h"
47 #include "buffer.h"
48 #include "charset.h"
49 #include "region-cache.h"
50 #include "indent.h"
51 #include "blockinput.h"
52 #include "keyboard.h"
53 #include "keymap.h"
54 #include "frame.h"
56 struct buffer *current_buffer; /* the current buffer */
58 /* First buffer in chain of all buffers (in reverse order of creation).
59 Threaded through ->next. */
61 struct buffer *all_buffers;
63 /* This structure holds the default values of the buffer-local variables
64 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
65 The default value occupies the same slot in this structure
66 as an individual buffer's value occupies in that buffer.
67 Setting the default value also goes through the alist of buffers
68 and stores into each buffer that does not say it has a local value. */
70 DECL_ALIGN (struct buffer, buffer_defaults);
72 /* A Lisp_Object pointer to the above, used for staticpro */
74 static Lisp_Object Vbuffer_defaults;
76 /* This structure marks which slots in a buffer have corresponding
77 default values in buffer_defaults.
78 Each such slot has a nonzero value in this structure.
79 The value has only one nonzero bit.
81 When a buffer has its own local value for a slot,
82 the entry for that slot (found in the same slot in this structure)
83 is turned on in the buffer's local_flags array.
85 If a slot in this structure is -1, then even though there may
86 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
87 and the corresponding slot in buffer_defaults is not used.
89 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
90 but there is a default value which is copied into each buffer.
92 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
93 zero, that is a bug */
95 struct buffer buffer_local_flags;
97 /* This structure holds the names of symbols whose values may be
98 buffer-local. It is indexed and accessed in the same way as the above. */
100 DECL_ALIGN (struct buffer, buffer_local_symbols);
102 /* A Lisp_Object pointer to the above, used for staticpro */
103 static Lisp_Object Vbuffer_local_symbols;
105 /* This structure holds the required types for the values in the
106 buffer-local slots. If a slot contains Qnil, then the
107 corresponding buffer slot may contain a value of any type. If a
108 slot contains an integer, then prospective values' tags must be
109 equal to that integer (except nil is always allowed).
110 When a tag does not match, the function
111 buffer_slot_type_mismatch will signal an error.
113 If a slot here contains -1, the corresponding variable is read-only. */
114 struct buffer buffer_local_types;
116 /* Flags indicating which built-in buffer-local variables
117 are permanent locals. */
118 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
120 /* Number of per-buffer variables used. */
122 int last_per_buffer_idx;
124 Lisp_Object Fset_buffer ();
125 void set_buffer_internal ();
126 void set_buffer_internal_1 ();
127 static void call_overlay_mod_hooks ();
128 static void swap_out_buffer_local_variables ();
129 static void reset_buffer_local_variables ();
131 /* Alist of all buffer names vs the buffers. */
132 /* This used to be a variable, but is no longer,
133 to prevent lossage due to user rplac'ing this alist or its elements. */
134 Lisp_Object Vbuffer_alist;
136 /* Functions to call before and after each text change. */
137 Lisp_Object Vbefore_change_functions;
138 Lisp_Object Vafter_change_functions;
140 Lisp_Object Vtransient_mark_mode;
142 /* t means ignore all read-only text properties.
143 A list means ignore such a property if its value is a member of the list.
144 Any non-nil value means ignore buffer-read-only. */
145 Lisp_Object Vinhibit_read_only;
147 /* List of functions to call that can query about killing a buffer.
148 If any of these functions returns nil, we don't kill it. */
149 Lisp_Object Vkill_buffer_query_functions;
150 Lisp_Object Qkill_buffer_query_functions;
152 /* List of functions to call before changing an unmodified buffer. */
153 Lisp_Object Vfirst_change_hook;
155 Lisp_Object Qfirst_change_hook;
156 Lisp_Object Qbefore_change_functions;
157 Lisp_Object Qafter_change_functions;
158 Lisp_Object Qucs_set_table_for_input;
160 /* If nonzero, all modification hooks are suppressed. */
161 int inhibit_modification_hooks;
163 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
165 Lisp_Object Qprotected_field;
167 Lisp_Object QSFundamental; /* A string "Fundamental" */
169 Lisp_Object Qkill_buffer_hook;
171 Lisp_Object Qget_file_buffer;
173 Lisp_Object Qoverlayp;
175 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
177 Lisp_Object Qmodification_hooks;
178 Lisp_Object Qinsert_in_front_hooks;
179 Lisp_Object Qinsert_behind_hooks;
181 static void alloc_buffer_text P_ ((struct buffer *, size_t));
182 static void free_buffer_text P_ ((struct buffer *b));
183 static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
184 static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
187 /* For debugging; temporary. See set_buffer_internal. */
188 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
190 void
191 nsberror (spec)
192 Lisp_Object spec;
194 if (STRINGP (spec))
195 error ("No buffer named %s", SDATA (spec));
196 error ("Invalid buffer argument");
199 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
200 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
201 Value is nil if OBJECT is not a buffer or if it has been killed. */)
202 (object)
203 Lisp_Object object;
205 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
206 ? Qt : Qnil);
209 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
210 doc: /* Return a list of all existing live buffers.
211 If the optional arg FRAME is a frame, we return the buffer list
212 in the proper order for that frame: the buffers in FRAME's `buffer-list'
213 frame parameter come first, followed by the rest of the buffers. */)
214 (frame)
215 Lisp_Object frame;
217 Lisp_Object framelist, general;
218 general = Fmapcar (Qcdr, Vbuffer_alist);
220 if (FRAMEP (frame))
222 Lisp_Object tail;
224 CHECK_FRAME (frame);
226 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
228 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
229 tail = framelist;
230 while (! NILP (tail))
232 general = Fdelq (XCAR (tail), general);
233 tail = XCDR (tail);
235 return nconc2 (framelist, general);
238 return general;
241 /* Like Fassoc, but use Fstring_equal to compare
242 (which ignores text properties),
243 and don't ever QUIT. */
245 static Lisp_Object
246 assoc_ignore_text_properties (key, list)
247 register Lisp_Object key;
248 Lisp_Object list;
250 register Lisp_Object tail;
251 for (tail = list; CONSP (tail); tail = XCDR (tail))
253 register Lisp_Object elt, tem;
254 elt = XCAR (tail);
255 tem = Fstring_equal (Fcar (elt), key);
256 if (!NILP (tem))
257 return elt;
259 return Qnil;
262 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
263 doc: /* Return the buffer named NAME (a string).
264 If there is no live buffer named NAME, return nil.
265 NAME may also be a buffer; if so, the value is that buffer. */)
266 (name)
267 register Lisp_Object name;
269 if (BUFFERP (name))
270 return name;
271 CHECK_STRING (name);
273 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
276 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
277 doc: /* Return the buffer visiting file FILENAME (a string).
278 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
279 If there is no such live buffer, return nil.
280 See also `find-buffer-visiting'. */)
281 (filename)
282 register Lisp_Object filename;
284 register Lisp_Object tail, buf, tem;
285 Lisp_Object handler;
287 CHECK_STRING (filename);
288 filename = Fexpand_file_name (filename, Qnil);
290 /* If the file name has special constructs in it,
291 call the corresponding file handler. */
292 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
293 if (!NILP (handler))
294 return call2 (handler, Qget_file_buffer, filename);
296 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
298 buf = Fcdr (XCAR (tail));
299 if (!BUFFERP (buf)) continue;
300 if (!STRINGP (XBUFFER (buf)->filename)) continue;
301 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
302 if (!NILP (tem))
303 return buf;
305 return Qnil;
308 Lisp_Object
309 get_truename_buffer (filename)
310 register Lisp_Object filename;
312 register Lisp_Object tail, buf, tem;
314 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
316 buf = Fcdr (XCAR (tail));
317 if (!BUFFERP (buf)) continue;
318 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
319 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
320 if (!NILP (tem))
321 return buf;
323 return Qnil;
326 /* Incremented for each buffer created, to assign the buffer number. */
327 int buffer_count;
329 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
330 doc: /* Return the buffer named NAME, or create such a buffer and return it.
331 A new buffer is created if there is no live buffer named NAME.
332 If NAME starts with a space, the new buffer does not keep undo information.
333 If NAME is a buffer instead of a string, then it is the value returned.
334 The value is never nil. */)
335 (name)
336 register Lisp_Object name;
338 register Lisp_Object buf;
339 register struct buffer *b;
341 buf = Fget_buffer (name);
342 if (!NILP (buf))
343 return buf;
345 if (SCHARS (name) == 0)
346 error ("Empty string for buffer name is not allowed");
348 b = (struct buffer *) allocate_buffer ();
350 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
352 /* An ordinary buffer uses its own struct buffer_text. */
353 b->text = &b->own_text;
354 b->base_buffer = 0;
356 BUF_GAP_SIZE (b) = 20;
357 BLOCK_INPUT;
358 /* We allocate extra 1-byte at the tail and keep it always '\0' for
359 anchoring a search. */
360 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
361 UNBLOCK_INPUT;
362 if (! BUF_BEG_ADDR (b))
363 buffer_memory_full ();
365 BUF_PT (b) = BEG;
366 BUF_GPT (b) = BEG;
367 BUF_BEGV (b) = BEG;
368 BUF_ZV (b) = BEG;
369 BUF_Z (b) = BEG;
370 BUF_PT_BYTE (b) = BEG_BYTE;
371 BUF_GPT_BYTE (b) = BEG_BYTE;
372 BUF_BEGV_BYTE (b) = BEG_BYTE;
373 BUF_ZV_BYTE (b) = BEG_BYTE;
374 BUF_Z_BYTE (b) = BEG_BYTE;
375 BUF_MODIFF (b) = 1;
376 BUF_OVERLAY_MODIFF (b) = 1;
377 BUF_SAVE_MODIFF (b) = 1;
378 BUF_INTERVALS (b) = 0;
379 BUF_UNCHANGED_MODIFIED (b) = 1;
380 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
381 BUF_END_UNCHANGED (b) = 0;
382 BUF_BEG_UNCHANGED (b) = 0;
383 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
385 b->newline_cache = 0;
386 b->width_run_cache = 0;
387 b->width_table = Qnil;
388 b->prevent_redisplay_optimizations_p = 1;
390 /* Put this on the chain of all buffers including killed ones. */
391 b->next = all_buffers;
392 all_buffers = b;
394 /* An ordinary buffer normally doesn't need markers
395 to handle BEGV and ZV. */
396 b->pt_marker = Qnil;
397 b->begv_marker = Qnil;
398 b->zv_marker = Qnil;
400 name = Fcopy_sequence (name);
401 STRING_SET_INTERVALS (name, NULL_INTERVAL);
402 b->name = name;
404 if (SREF (name, 0) != ' ')
405 b->undo_list = Qnil;
406 else
407 b->undo_list = Qt;
409 reset_buffer (b);
410 reset_buffer_local_variables (b, 1);
412 b->mark = Fmake_marker ();
413 BUF_MARKERS (b) = NULL;
414 b->name = name;
416 /* Put this in the alist of all live buffers. */
417 XSETBUFFER (buf, b);
418 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
420 /* An error in calling the function here (should someone redfine it)
421 can lead to infinite regress until you run out of stack. rms
422 says that's not worth protecting against. */
423 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
424 /* buf is on buffer-alist, so no gcpro. */
425 call1 (Qucs_set_table_for_input, buf);
427 return buf;
431 /* Return a list of overlays which is a copy of the overlay list
432 LIST, but for buffer B. */
434 static struct Lisp_Overlay *
435 copy_overlays (b, list)
436 struct buffer *b;
437 struct Lisp_Overlay *list;
439 Lisp_Object buffer;
440 struct Lisp_Overlay *result = NULL, *tail = NULL;
442 XSETBUFFER (buffer, b);
444 for (; list; list = list->next)
446 Lisp_Object overlay, start, end, old_overlay;
447 EMACS_INT charpos;
449 XSETMISC (old_overlay, list);
450 charpos = marker_position (OVERLAY_START (old_overlay));
451 start = Fmake_marker ();
452 Fset_marker (start, make_number (charpos), buffer);
453 XMARKER (start)->insertion_type
454 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
456 charpos = marker_position (OVERLAY_END (old_overlay));
457 end = Fmake_marker ();
458 Fset_marker (end, make_number (charpos), buffer);
459 XMARKER (end)->insertion_type
460 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
462 overlay = allocate_misc ();
463 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
464 OVERLAY_START (overlay) = start;
465 OVERLAY_END (overlay) = end;
466 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
467 XOVERLAY (overlay)->next = NULL;
469 if (tail)
470 tail = tail->next = XOVERLAY (overlay);
471 else
472 result = tail = XOVERLAY (overlay);
475 return result;
479 /* Clone per-buffer values of buffer FROM.
481 Buffer TO gets the same per-buffer values as FROM, with the
482 following exceptions: (1) TO's name is left untouched, (2) markers
483 are copied and made to refer to TO, and (3) overlay lists are
484 copied. */
486 static void
487 clone_per_buffer_values (from, to)
488 struct buffer *from, *to;
490 Lisp_Object to_buffer, tem;
491 int offset;
493 XSETBUFFER (to_buffer, to);
495 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
496 offset < sizeof *to;
497 offset += sizeof (Lisp_Object))
499 Lisp_Object obj;
501 obj = PER_BUFFER_VALUE (from, offset);
502 if (MARKERP (obj))
504 struct Lisp_Marker *m = XMARKER (obj);
505 obj = Fmake_marker ();
506 XMARKER (obj)->insertion_type = m->insertion_type;
507 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
510 PER_BUFFER_VALUE (to, offset) = obj;
513 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
515 to->overlays_before = copy_overlays (to, from->overlays_before);
516 to->overlays_after = copy_overlays (to, from->overlays_after);
518 /* Copy the alist of local variables,
519 and all the alist elements too. */
520 to->local_var_alist
521 = Fcopy_sequence (from->local_var_alist);
522 for (tem = to->local_var_alist; CONSP (tem);
523 tem = XCDR (tem))
524 XSETCAR (tem, Fcons (XCAR (XCAR (tem)), XCDR (XCAR (tem))));
528 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
529 2, 3,
530 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
531 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
532 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
533 NAME should be a string which is not the name of an existing buffer.
534 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
535 such as major and minor modes, in the indirect buffer.
536 CLONE nil means the indirect buffer's state is reset to default values. */)
537 (base_buffer, name, clone)
538 Lisp_Object base_buffer, name, clone;
540 Lisp_Object buf, tem;
541 struct buffer *b;
543 CHECK_STRING (name);
544 buf = Fget_buffer (name);
545 if (!NILP (buf))
546 error ("Buffer name `%s' is in use", SDATA (name));
548 tem = base_buffer;
549 base_buffer = Fget_buffer (base_buffer);
550 if (NILP (base_buffer))
551 error ("No such buffer: `%s'", SDATA (tem));
552 if (NILP (XBUFFER (base_buffer)->name))
553 error ("Base buffer has been killed");
555 if (SCHARS (name) == 0)
556 error ("Empty string for buffer name is not allowed");
558 b = (struct buffer *) allocate_buffer ();
559 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
561 if (XBUFFER (base_buffer)->base_buffer)
562 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
563 else
564 b->base_buffer = XBUFFER (base_buffer);
566 /* Use the base buffer's text object. */
567 b->text = b->base_buffer->text;
569 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
570 BUF_ZV (b) = BUF_ZV (b->base_buffer);
571 BUF_PT (b) = BUF_PT (b->base_buffer);
572 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
573 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
574 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
576 b->newline_cache = 0;
577 b->width_run_cache = 0;
578 b->width_table = Qnil;
580 /* Put this on the chain of all buffers including killed ones. */
581 b->next = all_buffers;
582 all_buffers = b;
584 name = Fcopy_sequence (name);
585 STRING_SET_INTERVALS (name, NULL_INTERVAL);
586 b->name = name;
588 reset_buffer (b);
589 reset_buffer_local_variables (b, 1);
591 /* Put this in the alist of all live buffers. */
592 XSETBUFFER (buf, b);
593 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
595 b->mark = Fmake_marker ();
596 b->name = name;
598 /* The multibyte status belongs to the base buffer. */
599 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
601 /* Make sure the base buffer has markers for its narrowing. */
602 if (NILP (b->base_buffer->pt_marker))
604 b->base_buffer->pt_marker = Fmake_marker ();
605 set_marker_both (b->base_buffer->pt_marker, base_buffer,
606 BUF_PT (b->base_buffer),
607 BUF_PT_BYTE (b->base_buffer));
609 if (NILP (b->base_buffer->begv_marker))
611 b->base_buffer->begv_marker = Fmake_marker ();
612 set_marker_both (b->base_buffer->begv_marker, base_buffer,
613 BUF_BEGV (b->base_buffer),
614 BUF_BEGV_BYTE (b->base_buffer));
616 if (NILP (b->base_buffer->zv_marker))
618 b->base_buffer->zv_marker = Fmake_marker ();
619 set_marker_both (b->base_buffer->zv_marker, base_buffer,
620 BUF_ZV (b->base_buffer),
621 BUF_ZV_BYTE (b->base_buffer));
622 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
625 if (NILP (clone))
627 /* Give the indirect buffer markers for its narrowing. */
628 b->pt_marker = Fmake_marker ();
629 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
630 b->begv_marker = Fmake_marker ();
631 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
632 b->zv_marker = Fmake_marker ();
633 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
634 XMARKER (b->zv_marker)->insertion_type = 1;
636 else
637 clone_per_buffer_values (b->base_buffer, b);
639 return buf;
642 void
643 delete_all_overlays (b)
644 struct buffer *b;
646 Lisp_Object overlay;
648 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
649 have to empty the list, otherwise we end up with overlays that
650 think they belong to this buffer while the buffer doesn't know about
651 them any more. */
652 while (b->overlays_before)
654 XSETMISC (overlay, b->overlays_before);
655 Fdelete_overlay (overlay);
657 while (b->overlays_after)
659 XSETMISC (overlay, b->overlays_after);
660 Fdelete_overlay (overlay);
662 eassert (b->overlays_before == NULL);
663 eassert (b->overlays_after == NULL);
666 /* Reinitialize everything about a buffer except its name and contents
667 and local variables.
668 If called on an already-initialized buffer, the list of overlays
669 should be deleted before calling this function, otherwise we end up
670 with overlays that claim to belong to the buffer but the buffer
671 claims it doesn't belong to it. */
673 void
674 reset_buffer (b)
675 register struct buffer *b;
677 b->filename = Qnil;
678 b->file_truename = Qnil;
679 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
680 b->modtime = 0;
681 XSETFASTINT (b->save_length, 0);
682 b->last_window_start = 1;
683 /* It is more conservative to start out "changed" than "unchanged". */
684 b->clip_changed = 0;
685 b->prevent_redisplay_optimizations_p = 1;
686 b->backed_up = Qnil;
687 b->auto_save_modified = 0;
688 b->auto_save_failure_time = -1;
689 b->auto_save_file_name = Qnil;
690 b->read_only = Qnil;
691 b->overlays_before = NULL;
692 b->overlays_after = NULL;
693 b->overlay_center = BEG;
694 b->mark_active = Qnil;
695 b->point_before_scroll = Qnil;
696 b->file_format = Qnil;
697 b->auto_save_file_format = Qt;
698 b->last_selected_window = Qnil;
699 XSETINT (b->display_count, 0);
700 b->display_time = Qnil;
701 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
702 b->cursor_type = buffer_defaults.cursor_type;
703 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
705 b->display_error_modiff = 0;
708 /* Reset buffer B's local variables info.
709 Don't use this on a buffer that has already been in use;
710 it does not treat permanent locals consistently.
711 Instead, use Fkill_all_local_variables.
713 If PERMANENT_TOO is 1, then we reset permanent built-in
714 buffer-local variables. If PERMANENT_TOO is 0,
715 we preserve those. */
717 static void
718 reset_buffer_local_variables (b, permanent_too)
719 register struct buffer *b;
720 int permanent_too;
722 register int offset;
723 int i;
725 /* Reset the major mode to Fundamental, together with all the
726 things that depend on the major mode.
727 default-major-mode is handled at a higher level.
728 We ignore it here. */
729 b->major_mode = Qfundamental_mode;
730 b->keymap = Qnil;
731 b->mode_name = QSFundamental;
732 b->minor_modes = Qnil;
734 /* If the standard case table has been altered and invalidated,
735 fix up its insides first. */
736 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
737 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
738 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
739 Fset_standard_case_table (Vascii_downcase_table);
741 b->downcase_table = Vascii_downcase_table;
742 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
743 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
744 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
745 b->invisibility_spec = Qt;
746 #ifndef DOS_NT
747 b->buffer_file_type = Qnil;
748 #endif
750 /* Reset all (or most) per-buffer variables to their defaults. */
751 b->local_var_alist = Qnil;
752 for (i = 0; i < last_per_buffer_idx; ++i)
753 if (permanent_too || buffer_permanent_local_flags[i] == 0)
754 SET_PER_BUFFER_VALUE_P (b, i, 0);
756 /* For each slot that has a default value,
757 copy that into the slot. */
759 for (offset = PER_BUFFER_VAR_OFFSET (name);
760 offset < sizeof *b;
761 offset += sizeof (Lisp_Object))
763 int idx = PER_BUFFER_IDX (offset);
764 if ((idx > 0
765 && (permanent_too
766 || buffer_permanent_local_flags[idx] == 0))
767 /* Is -2 used anywhere? */
768 || idx == -2)
769 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
773 /* We split this away from generate-new-buffer, because rename-buffer
774 and set-visited-file-name ought to be able to use this to really
775 rename the buffer properly. */
777 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
778 1, 2, 0,
779 doc: /* Return a string that is the name of no existing buffer based on NAME.
780 If there is no live buffer named NAME, then return NAME.
781 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
782 \(starting at 2) until an unused name is found, and then return that name.
783 Optional second argument IGNORE specifies a name that is okay to use
784 \(if it is in the sequence to be tried)
785 even if a buffer with that name exists. */)
786 (name, ignore)
787 register Lisp_Object name, ignore;
789 register Lisp_Object gentemp, tem;
790 int count;
791 char number[10];
793 CHECK_STRING (name);
795 tem = Fstring_equal (name, ignore);
796 if (!NILP (tem))
797 return name;
798 tem = Fget_buffer (name);
799 if (NILP (tem))
800 return name;
802 count = 1;
803 while (1)
805 sprintf (number, "<%d>", ++count);
806 gentemp = concat2 (name, build_string (number));
807 tem = Fstring_equal (gentemp, ignore);
808 if (!NILP (tem))
809 return gentemp;
810 tem = Fget_buffer (gentemp);
811 if (NILP (tem))
812 return gentemp;
817 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
818 doc: /* Return the name of BUFFER, as a string.
819 With no argument or nil as argument, return the name of the current buffer. */)
820 (buffer)
821 register Lisp_Object buffer;
823 if (NILP (buffer))
824 return current_buffer->name;
825 CHECK_BUFFER (buffer);
826 return XBUFFER (buffer)->name;
829 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
830 doc: /* Return name of file BUFFER is visiting, or nil if none.
831 No argument or nil as argument means use the current buffer. */)
832 (buffer)
833 register Lisp_Object buffer;
835 if (NILP (buffer))
836 return current_buffer->filename;
837 CHECK_BUFFER (buffer);
838 return XBUFFER (buffer)->filename;
841 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
842 0, 1, 0,
843 doc: /* Return the base buffer of indirect buffer BUFFER.
844 If BUFFER is not indirect, return nil.
845 BUFFER defaults to the current buffer. */)
846 (buffer)
847 register Lisp_Object buffer;
849 struct buffer *base;
850 Lisp_Object base_buffer;
852 if (NILP (buffer))
853 base = current_buffer->base_buffer;
854 else
856 CHECK_BUFFER (buffer);
857 base = XBUFFER (buffer)->base_buffer;
860 if (! base)
861 return Qnil;
862 XSETBUFFER (base_buffer, base);
863 return base_buffer;
866 DEFUN ("buffer-local-value", Fbuffer_local_value,
867 Sbuffer_local_value, 2, 2, 0,
868 doc: /* Return the value of VARIABLE in BUFFER.
869 If VARIABLE does not have a buffer-local binding in BUFFER, the value
870 is the default binding of variable. */)
871 (symbol, buffer)
872 register Lisp_Object symbol;
873 register Lisp_Object buffer;
875 register struct buffer *buf;
876 register Lisp_Object result;
878 CHECK_SYMBOL (symbol);
879 CHECK_BUFFER (buffer);
880 buf = XBUFFER (buffer);
882 /* Look in local_var_list */
883 result = Fassoc (symbol, buf->local_var_alist);
884 if (NILP (result))
886 int offset, idx;
887 int found = 0;
889 /* Look in special slots */
890 for (offset = PER_BUFFER_VAR_OFFSET (name);
891 offset < sizeof (struct buffer);
892 /* sizeof EMACS_INT == sizeof Lisp_Object */
893 offset += (sizeof (EMACS_INT)))
895 idx = PER_BUFFER_IDX (offset);
896 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
897 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
898 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
900 result = PER_BUFFER_VALUE (buf, offset);
901 found = 1;
902 break;
906 if (!found)
907 result = Fdefault_value (symbol);
909 else
911 Lisp_Object valcontents;
912 Lisp_Object current_alist_element;
914 /* What binding is loaded right now? */
915 valcontents = SYMBOL_VALUE (symbol);
916 current_alist_element
917 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
919 /* The value of the currently loaded binding is not
920 stored in it, but rather in the realvalue slot.
921 Store that value into the binding it belongs to
922 in case that is the one we are about to use. */
924 Fsetcdr (current_alist_element,
925 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
927 /* Now get the (perhaps updated) value out of the binding. */
928 result = XCDR (result);
931 if (EQ (result, Qunbound))
932 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
934 return result;
937 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
938 Sbuffer_local_variables, 0, 1, 0,
939 doc: /* Return an alist of variables that are buffer-local in BUFFER.
940 Most elements look like (SYMBOL . VALUE), describing one variable.
941 For a symbol that is locally unbound, just the symbol appears in the value.
942 Note that storing new VALUEs in these elements doesn't change the variables.
943 No argument or nil as argument means use current buffer as BUFFER. */)
944 (buffer)
945 register Lisp_Object buffer;
947 register struct buffer *buf;
948 register Lisp_Object result;
950 if (NILP (buffer))
951 buf = current_buffer;
952 else
954 CHECK_BUFFER (buffer);
955 buf = XBUFFER (buffer);
958 result = Qnil;
961 register Lisp_Object tail;
962 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
964 Lisp_Object val, elt;
966 elt = XCAR (tail);
968 /* Reference each variable in the alist in buf.
969 If inquiring about the current buffer, this gets the current values,
970 so store them into the alist so the alist is up to date.
971 If inquiring about some other buffer, this swaps out any values
972 for that buffer, making the alist up to date automatically. */
973 val = find_symbol_value (XCAR (elt));
974 /* Use the current buffer value only if buf is the current buffer. */
975 if (buf != current_buffer)
976 val = XCDR (elt);
978 /* If symbol is unbound, put just the symbol in the list. */
979 if (EQ (val, Qunbound))
980 result = Fcons (XCAR (elt), result);
981 /* Otherwise, put (symbol . value) in the list. */
982 else
983 result = Fcons (Fcons (XCAR (elt), val), result);
987 /* Add on all the variables stored in special slots. */
989 int offset, idx;
991 for (offset = PER_BUFFER_VAR_OFFSET (name);
992 offset < sizeof (struct buffer);
993 /* sizeof EMACS_INT == sizeof Lisp_Object */
994 offset += (sizeof (EMACS_INT)))
996 idx = PER_BUFFER_IDX (offset);
997 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
998 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
999 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1000 PER_BUFFER_VALUE (buf, offset)),
1001 result);
1005 return result;
1009 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1010 0, 1, 0,
1011 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1012 No argument or nil as argument means use current buffer as BUFFER. */)
1013 (buffer)
1014 register Lisp_Object buffer;
1016 register struct buffer *buf;
1017 if (NILP (buffer))
1018 buf = current_buffer;
1019 else
1021 CHECK_BUFFER (buffer);
1022 buf = XBUFFER (buffer);
1025 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1028 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1029 1, 1, 0,
1030 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1031 A non-nil FLAG means mark the buffer modified. */)
1032 (flag)
1033 register Lisp_Object flag;
1035 register int already;
1036 register Lisp_Object fn;
1037 Lisp_Object buffer, window;
1039 #ifdef CLASH_DETECTION
1040 /* If buffer becoming modified, lock the file.
1041 If buffer becoming unmodified, unlock the file. */
1043 fn = current_buffer->file_truename;
1044 /* Test buffer-file-name so that binding it to nil is effective. */
1045 if (!NILP (fn) && ! NILP (current_buffer->filename))
1047 already = SAVE_MODIFF < MODIFF;
1048 if (!already && !NILP (flag))
1049 lock_file (fn);
1050 else if (already && NILP (flag))
1051 unlock_file (fn);
1053 #endif /* CLASH_DETECTION */
1055 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1057 /* Set update_mode_lines only if buffer is displayed in some window.
1058 Packages like jit-lock or lazy-lock preserve a buffer's modified
1059 state by recording/restoring the state around blocks of code.
1060 Setting update_mode_lines makes redisplay consider all windows
1061 (on all frames). Stealth fontification of buffers not displayed
1062 would incur additional redisplay costs if we'd set
1063 update_modes_lines unconditionally.
1065 Ideally, I think there should be another mechanism for fontifying
1066 buffers without "modifying" buffers, or redisplay should be
1067 smarter about updating the `*' in mode lines. --gerd */
1068 XSETBUFFER (buffer, current_buffer);
1069 window = Fget_buffer_window (buffer, Qt);
1070 if (WINDOWP (window))
1072 ++update_mode_lines;
1073 current_buffer->prevent_redisplay_optimizations_p = 1;
1076 return flag;
1079 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1080 Srestore_buffer_modified_p, 1, 1, 0,
1081 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1082 It is not ensured that mode lines will be updated to show the modified
1083 state of the current buffer. Use with care. */)
1084 (flag)
1085 Lisp_Object flag;
1087 #ifdef CLASH_DETECTION
1088 Lisp_Object fn;
1090 /* If buffer becoming modified, lock the file.
1091 If buffer becoming unmodified, unlock the file. */
1093 fn = current_buffer->file_truename;
1094 /* Test buffer-file-name so that binding it to nil is effective. */
1095 if (!NILP (fn) && ! NILP (current_buffer->filename))
1097 int already = SAVE_MODIFF < MODIFF;
1098 if (!already && !NILP (flag))
1099 lock_file (fn);
1100 else if (already && NILP (flag))
1101 unlock_file (fn);
1103 #endif /* CLASH_DETECTION */
1105 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1106 return flag;
1109 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1110 0, 1, 0,
1111 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1112 Each buffer has a tick counter which is incremented each time the text in
1113 that buffer is changed. It wraps around occasionally.
1114 No argument or nil as argument means use current buffer as BUFFER. */)
1115 (buffer)
1116 register Lisp_Object buffer;
1118 register struct buffer *buf;
1119 if (NILP (buffer))
1120 buf = current_buffer;
1121 else
1123 CHECK_BUFFER (buffer);
1124 buf = XBUFFER (buffer);
1127 return make_number (BUF_MODIFF (buf));
1130 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1131 "sRename buffer (to new name): \nP",
1132 doc: /* Change current buffer's name to NEWNAME (a string).
1133 If second arg UNIQUE is nil or omitted, it is an error if a
1134 buffer named NEWNAME already exists.
1135 If UNIQUE is non-nil, come up with a new name using
1136 `generate-new-buffer-name'.
1137 Interactively, you can set UNIQUE with a prefix argument.
1138 We return the name we actually gave the buffer.
1139 This does not change the name of the visited file (if any). */)
1140 (newname, unique)
1141 register Lisp_Object newname, unique;
1143 register Lisp_Object tem, buf;
1145 CHECK_STRING (newname);
1147 if (SCHARS (newname) == 0)
1148 error ("Empty string is invalid as a buffer name");
1150 tem = Fget_buffer (newname);
1151 if (!NILP (tem))
1153 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1154 rename the buffer automatically so you can create another
1155 with the original name. It makes UNIQUE equivalent to
1156 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1157 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1158 return current_buffer->name;
1159 if (!NILP (unique))
1160 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1161 else
1162 error ("Buffer name `%s' is in use", SDATA (newname));
1165 current_buffer->name = newname;
1167 /* Catch redisplay's attention. Unless we do this, the mode lines for
1168 any windows displaying current_buffer will stay unchanged. */
1169 update_mode_lines++;
1171 XSETBUFFER (buf, current_buffer);
1172 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1173 if (NILP (current_buffer->filename)
1174 && !NILP (current_buffer->auto_save_file_name))
1175 call0 (intern ("rename-auto-save-file"));
1176 /* Refetch since that last call may have done GC. */
1177 return current_buffer->name;
1180 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1181 doc: /* Return most recently selected buffer other than BUFFER.
1182 Buffers not visible in windows are preferred to visible buffers,
1183 unless optional second argument VISIBLE-OK is non-nil.
1184 If the optional third argument FRAME is non-nil, use that frame's
1185 buffer list instead of the selected frame's buffer list.
1186 If no other buffer exists, the buffer `*scratch*' is returned.
1187 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1188 (buffer, visible_ok, frame)
1189 register Lisp_Object buffer, visible_ok, frame;
1191 Lisp_Object Fset_buffer_major_mode ();
1192 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1193 notsogood = Qnil;
1195 if (NILP (frame))
1196 frame = selected_frame;
1198 tail = Vbuffer_alist;
1199 pred = frame_buffer_predicate (frame);
1201 /* Consider buffers that have been seen in the selected frame
1202 before other buffers. */
1204 tem = frame_buffer_list (frame);
1205 add_ons = Qnil;
1206 while (CONSP (tem))
1208 if (BUFFERP (XCAR (tem)))
1209 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1210 tem = XCDR (tem);
1212 tail = nconc2 (Fnreverse (add_ons), tail);
1214 for (; CONSP (tail); tail = XCDR (tail))
1216 buf = Fcdr (XCAR (tail));
1217 if (EQ (buf, buffer))
1218 continue;
1219 if (NILP (buf))
1220 continue;
1221 if (NILP (XBUFFER (buf)->name))
1222 continue;
1223 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1224 continue;
1225 /* If the selected frame has a buffer_predicate,
1226 disregard buffers that don't fit the predicate. */
1227 if (!NILP (pred))
1229 tem = call1 (pred, buf);
1230 if (NILP (tem))
1231 continue;
1234 if (NILP (visible_ok))
1235 tem = Fget_buffer_window (buf, Qvisible);
1236 else
1237 tem = Qnil;
1238 if (NILP (tem))
1239 return buf;
1240 if (NILP (notsogood))
1241 notsogood = buf;
1243 if (!NILP (notsogood))
1244 return notsogood;
1245 buf = Fget_buffer (build_string ("*scratch*"));
1246 if (NILP (buf))
1248 buf = Fget_buffer_create (build_string ("*scratch*"));
1249 Fset_buffer_major_mode (buf);
1251 return buf;
1254 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1255 0, 1, "",
1256 doc: /* Start keeping undo information for buffer BUFFER.
1257 No argument or nil as argument means do this for the current buffer. */)
1258 (buffer)
1259 register Lisp_Object buffer;
1261 Lisp_Object real_buffer;
1263 if (NILP (buffer))
1264 XSETBUFFER (real_buffer, current_buffer);
1265 else
1267 real_buffer = Fget_buffer (buffer);
1268 if (NILP (real_buffer))
1269 nsberror (buffer);
1272 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1273 XBUFFER (real_buffer)->undo_list = Qnil;
1275 return Qnil;
1279 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1280 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1281 The buffer being killed will be current while the hook is running.\n\
1282 See `kill-buffer'."
1284 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1285 doc: /* Kill the buffer BUFFER.
1286 The argument may be a buffer or may be the name of a buffer.
1287 An argument of nil means kill the current buffer.
1289 Value is t if the buffer is actually killed, nil if user says no.
1291 The value of `kill-buffer-hook' (which may be local to that buffer),
1292 if not void, is a list of functions to be called, with no arguments,
1293 before the buffer is actually killed. The buffer to be killed is current
1294 when the hook functions are called.
1296 Any processes that have this buffer as the `process-buffer' are killed
1297 with SIGHUP. */)
1298 (buffer)
1299 Lisp_Object buffer;
1301 Lisp_Object buf;
1302 register struct buffer *b;
1303 register Lisp_Object tem;
1304 register struct Lisp_Marker *m;
1305 struct gcpro gcpro1;
1307 if (NILP (buffer))
1308 buf = Fcurrent_buffer ();
1309 else
1310 buf = Fget_buffer (buffer);
1311 if (NILP (buf))
1312 nsberror (buffer);
1314 b = XBUFFER (buf);
1316 /* Avoid trouble for buffer already dead. */
1317 if (NILP (b->name))
1318 return Qnil;
1320 /* Query if the buffer is still modified. */
1321 if (INTERACTIVE && !NILP (b->filename)
1322 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1324 GCPRO1 (buf);
1325 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1326 b->name, make_number (0)));
1327 UNGCPRO;
1328 if (NILP (tem))
1329 return Qnil;
1332 /* Run hooks with the buffer to be killed the current buffer. */
1334 int count = SPECPDL_INDEX ();
1335 Lisp_Object arglist[1];
1337 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1338 set_buffer_internal (b);
1340 /* First run the query functions; if any query is answered no,
1341 don't kill the buffer. */
1342 arglist[0] = Qkill_buffer_query_functions;
1343 if (NILP (Frun_hook_with_args_until_failure (1, arglist)))
1344 return unbind_to (count, Qnil);
1346 /* Then run the hooks. */
1347 Frun_hooks (1, &Qkill_buffer_hook);
1348 unbind_to (count, Qnil);
1351 /* We have no more questions to ask. Verify that it is valid
1352 to kill the buffer. This must be done after the questions
1353 since anything can happen within do_yes_or_no_p. */
1355 /* Don't kill the minibuffer now current. */
1356 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1357 return Qnil;
1359 if (NILP (b->name))
1360 return Qnil;
1362 /* When we kill a base buffer, kill all its indirect buffers.
1363 We do it at this stage so nothing terrible happens if they
1364 ask questions or their hooks get errors. */
1365 if (! b->base_buffer)
1367 struct buffer *other;
1369 GCPRO1 (buf);
1371 for (other = all_buffers; other; other = other->next)
1372 /* all_buffers contains dead buffers too;
1373 don't re-kill them. */
1374 if (other->base_buffer == b && !NILP (other->name))
1376 Lisp_Object buf;
1377 XSETBUFFER (buf, other);
1378 Fkill_buffer (buf);
1381 UNGCPRO;
1384 /* Make this buffer not be current.
1385 In the process, notice if this is the sole visible buffer
1386 and give up if so. */
1387 if (b == current_buffer)
1389 tem = Fother_buffer (buf, Qnil, Qnil);
1390 Fset_buffer (tem);
1391 if (b == current_buffer)
1392 return Qnil;
1395 /* Notice if the buffer to kill is the sole visible buffer
1396 when we're currently in the mini-buffer, and give up if so. */
1397 XSETBUFFER (tem, current_buffer);
1398 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1400 tem = Fother_buffer (buf, Qnil, Qnil);
1401 if (EQ (buf, tem))
1402 return Qnil;
1405 /* Now there is no question: we can kill the buffer. */
1407 #ifdef CLASH_DETECTION
1408 /* Unlock this buffer's file, if it is locked. */
1409 unlock_buffer (b);
1410 #endif /* CLASH_DETECTION */
1412 kill_buffer_processes (buf);
1413 clear_charpos_cache (b);
1415 tem = Vinhibit_quit;
1416 Vinhibit_quit = Qt;
1417 replace_buffer_in_all_windows (buf);
1418 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1419 frames_discard_buffer (buf);
1420 Vinhibit_quit = tem;
1422 /* Delete any auto-save file, if we saved it in this session.
1423 But not if the buffer is modified. */
1424 if (STRINGP (b->auto_save_file_name)
1425 && b->auto_save_modified != 0
1426 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1427 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1428 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1430 Lisp_Object tem;
1431 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1432 if (! NILP (tem))
1433 internal_delete_file (b->auto_save_file_name);
1436 if (b->base_buffer)
1438 /* Unchain all markers that belong to this indirect buffer.
1439 Don't unchain the markers that belong to the base buffer
1440 or its other indirect buffers. */
1441 for (m = BUF_MARKERS (b); m; )
1443 struct Lisp_Marker *next = m->next;
1444 if (m->buffer == b)
1445 unchain_marker (m);
1446 m = next;
1449 else
1451 /* Unchain all markers of this buffer and its indirect buffers.
1452 and leave them pointing nowhere. */
1453 for (m = BUF_MARKERS (b); m; )
1455 struct Lisp_Marker *next = m->next;
1456 m->buffer = 0;
1457 m->next = NULL;
1458 m = next;
1460 BUF_MARKERS (b) = NULL;
1461 BUF_INTERVALS (b) = NULL_INTERVAL;
1463 /* Perhaps we should explicitly free the interval tree here... */
1466 /* Reset the local variables, so that this buffer's local values
1467 won't be protected from GC. They would be protected
1468 if they happened to remain encached in their symbols.
1469 This gets rid of them for certain. */
1470 swap_out_buffer_local_variables (b);
1471 reset_buffer_local_variables (b, 1);
1473 b->name = Qnil;
1475 BLOCK_INPUT;
1476 if (! b->base_buffer)
1477 free_buffer_text (b);
1479 if (b->newline_cache)
1481 free_region_cache (b->newline_cache);
1482 b->newline_cache = 0;
1484 if (b->width_run_cache)
1486 free_region_cache (b->width_run_cache);
1487 b->width_run_cache = 0;
1489 b->width_table = Qnil;
1490 UNBLOCK_INPUT;
1491 b->undo_list = Qnil;
1493 return Qt;
1496 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1497 we do this each time BUF is selected visibly, the more recently
1498 selected buffers are always closer to the front of the list. This
1499 means that other_buffer is more likely to choose a relevant buffer. */
1501 void
1502 record_buffer (buf)
1503 Lisp_Object buf;
1505 register Lisp_Object link, prev;
1506 Lisp_Object frame;
1507 frame = selected_frame;
1509 prev = Qnil;
1510 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1512 if (EQ (XCDR (XCAR (link)), buf))
1513 break;
1514 prev = link;
1517 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1518 we cannot use Fdelq itself here because it allows quitting. */
1520 if (NILP (prev))
1521 Vbuffer_alist = XCDR (Vbuffer_alist);
1522 else
1523 XSETCDR (prev, XCDR (XCDR (prev)));
1525 XSETCDR (link, Vbuffer_alist);
1526 Vbuffer_alist = link;
1528 /* Now move this buffer to the front of frame_buffer_list also. */
1530 prev = Qnil;
1531 for (link = frame_buffer_list (frame); CONSP (link);
1532 link = XCDR (link))
1534 if (EQ (XCAR (link), buf))
1535 break;
1536 prev = link;
1539 /* Effectively do delq. */
1541 if (CONSP (link))
1543 if (NILP (prev))
1544 set_frame_buffer_list (frame,
1545 XCDR (frame_buffer_list (frame)));
1546 else
1547 XSETCDR (prev, XCDR (XCDR (prev)));
1549 XSETCDR (link, frame_buffer_list (frame));
1550 set_frame_buffer_list (frame, link);
1552 else
1553 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1556 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1557 doc: /* Set an appropriate major mode for BUFFER.
1558 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1559 according to `default-major-mode'.
1560 Use this function before selecting the buffer, since it may need to inspect
1561 the current buffer's major mode. */)
1562 (buffer)
1563 Lisp_Object buffer;
1565 int count;
1566 Lisp_Object function;
1568 if (STRINGP (XBUFFER (buffer)->name)
1569 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1570 function = find_symbol_value (intern ("initial-major-mode"));
1571 else
1573 function = buffer_defaults.major_mode;
1574 if (NILP (function)
1575 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1576 function = current_buffer->major_mode;
1579 if (NILP (function) || EQ (function, Qfundamental_mode))
1580 return Qnil;
1582 count = SPECPDL_INDEX ();
1584 /* To select a nonfundamental mode,
1585 select the buffer temporarily and then call the mode function. */
1587 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1589 Fset_buffer (buffer);
1590 call0 (function);
1592 return unbind_to (count, Qnil);
1595 /* If switching buffers in WINDOW would be an error, return
1596 a C string saying what the error would be. */
1598 char *
1599 no_switch_window (window)
1600 Lisp_Object window;
1602 Lisp_Object tem;
1603 if (EQ (minibuf_window, window))
1604 return "Cannot switch buffers in minibuffer window";
1605 tem = Fwindow_dedicated_p (window);
1606 if (EQ (tem, Qt))
1607 return "Cannot switch buffers in a dedicated window";
1608 return NULL;
1611 /* Switch to buffer BUFFER in the selected window.
1612 If NORECORD is non-nil, don't call record_buffer. */
1614 Lisp_Object
1615 switch_to_buffer_1 (buffer, norecord)
1616 Lisp_Object buffer, norecord;
1618 register Lisp_Object buf;
1620 if (NILP (buffer))
1621 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1622 else
1624 buf = Fget_buffer (buffer);
1625 if (NILP (buf))
1627 buf = Fget_buffer_create (buffer);
1628 Fset_buffer_major_mode (buf);
1631 Fset_buffer (buf);
1632 if (NILP (norecord))
1633 record_buffer (buf);
1635 Fset_window_buffer (EQ (selected_window, minibuf_window)
1636 ? Fnext_window (minibuf_window, Qnil, Qnil)
1637 : selected_window,
1638 buf, Qnil);
1640 return buf;
1643 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1644 doc: /* Select buffer BUFFER in the current window.
1645 If BUFFER does not identify an existing buffer,
1646 then this function creates a buffer with that name.
1648 When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1649 or nil. If BUFFER is nil, then this function chooses a buffer
1650 using `other-buffer'.
1651 Optional second arg NORECORD non-nil means
1652 do not put this buffer at the front of the list of recently selected ones.
1653 This function returns the buffer it switched to.
1655 WARNING: This is NOT the way to work on another buffer temporarily
1656 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1657 the window-buffer correspondences. */)
1658 (buffer, norecord)
1659 Lisp_Object buffer, norecord;
1661 char *err;
1663 if (EQ (buffer, Fwindow_buffer (selected_window)))
1664 /* Basically a NOP. Avoid signalling an error if the selected window
1665 is dedicated, or a minibuffer, ... */
1666 return Fset_buffer (buffer);
1668 err = no_switch_window (selected_window);
1669 if (err) error (err);
1671 return switch_to_buffer_1 (buffer, norecord);
1674 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1675 doc: /* Select buffer BUFFER in some window, preferably a different one.
1676 BUFFER may be a buffer, a string \(a buffer name), or nil.
1677 If BUFFER is a string which is not the name of an existing buffer,
1678 then this function creates a buffer with that name.
1679 If BUFFER is nil, then it chooses some other buffer.
1680 If `pop-up-windows' is non-nil, windows can be split to do this.
1681 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1682 window even if BUFFER is already visible in the selected window,
1683 and ignore `same-window-regexps' and `same-window-buffer-names'.
1684 This function returns the buffer it switched to.
1685 This uses the function `display-buffer' as a subroutine; see the documentation
1686 of `display-buffer' for additional customization information.
1688 Optional third arg NORECORD non-nil means
1689 do not put this buffer at the front of the list of recently selected ones. */)
1690 (buffer, other_window, norecord)
1691 Lisp_Object buffer, other_window, norecord;
1693 register Lisp_Object buf;
1694 if (NILP (buffer))
1695 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1696 else
1698 buf = Fget_buffer (buffer);
1699 if (NILP (buf))
1701 buf = Fget_buffer_create (buffer);
1702 Fset_buffer_major_mode (buf);
1705 Fset_buffer (buf);
1706 if (NILP (norecord))
1707 /* Why bother ? Fselect_window will do it for us anyway. -stef */
1708 record_buffer (buf);
1709 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1710 return buf;
1713 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1714 doc: /* Return the current buffer as a Lisp object. */)
1717 register Lisp_Object buf;
1718 XSETBUFFER (buf, current_buffer);
1719 return buf;
1722 /* Set the current buffer to B.
1724 We previously set windows_or_buffers_changed here to invalidate
1725 global unchanged information in beg_unchanged and end_unchanged.
1726 This is no longer necessary because we now compute unchanged
1727 information on a buffer-basis. Every action affecting other
1728 windows than the selected one requires a select_window at some
1729 time, and that increments windows_or_buffers_changed. */
1731 void
1732 set_buffer_internal (b)
1733 register struct buffer *b;
1735 if (current_buffer != b)
1736 set_buffer_internal_1 (b);
1739 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1740 This is used by redisplay. */
1742 void
1743 set_buffer_internal_1 (b)
1744 register struct buffer *b;
1746 register struct buffer *old_buf;
1747 register Lisp_Object tail, valcontents;
1748 Lisp_Object tem;
1750 #ifdef USE_MMAP_FOR_BUFFERS
1751 if (b->text->beg == NULL)
1752 enlarge_buffer_text (b, 0);
1753 #endif /* USE_MMAP_FOR_BUFFERS */
1755 if (current_buffer == b)
1756 return;
1758 old_buf = current_buffer;
1759 current_buffer = b;
1760 last_known_column_point = -1; /* invalidate indentation cache */
1762 if (old_buf)
1764 /* Put the undo list back in the base buffer, so that it appears
1765 that an indirect buffer shares the undo list of its base. */
1766 if (old_buf->base_buffer)
1767 old_buf->base_buffer->undo_list = old_buf->undo_list;
1769 /* If the old current buffer has markers to record PT, BEGV and ZV
1770 when it is not current, update them now. */
1771 if (! NILP (old_buf->pt_marker))
1773 Lisp_Object obuf;
1774 XSETBUFFER (obuf, old_buf);
1775 set_marker_both (old_buf->pt_marker, obuf,
1776 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1778 if (! NILP (old_buf->begv_marker))
1780 Lisp_Object obuf;
1781 XSETBUFFER (obuf, old_buf);
1782 set_marker_both (old_buf->begv_marker, obuf,
1783 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1785 if (! NILP (old_buf->zv_marker))
1787 Lisp_Object obuf;
1788 XSETBUFFER (obuf, old_buf);
1789 set_marker_both (old_buf->zv_marker, obuf,
1790 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1794 /* Get the undo list from the base buffer, so that it appears
1795 that an indirect buffer shares the undo list of its base. */
1796 if (b->base_buffer)
1797 b->undo_list = b->base_buffer->undo_list;
1799 /* If the new current buffer has markers to record PT, BEGV and ZV
1800 when it is not current, fetch them now. */
1801 if (! NILP (b->pt_marker))
1803 BUF_PT (b) = marker_position (b->pt_marker);
1804 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1806 if (! NILP (b->begv_marker))
1808 BUF_BEGV (b) = marker_position (b->begv_marker);
1809 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1811 if (! NILP (b->zv_marker))
1813 BUF_ZV (b) = marker_position (b->zv_marker);
1814 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1817 /* Look down buffer's list of local Lisp variables
1818 to find and update any that forward into C variables. */
1820 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1822 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1823 if ((BUFFER_LOCAL_VALUEP (valcontents)
1824 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1825 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1826 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1827 /* Just reference the variable
1828 to cause it to become set for this buffer. */
1829 Fsymbol_value (XCAR (XCAR (tail)));
1832 /* Do the same with any others that were local to the previous buffer */
1834 if (old_buf)
1835 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1837 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1838 if ((BUFFER_LOCAL_VALUEP (valcontents)
1839 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1840 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1841 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1842 /* Just reference the variable
1843 to cause it to become set for this buffer. */
1844 Fsymbol_value (XCAR (XCAR (tail)));
1848 /* Switch to buffer B temporarily for redisplay purposes.
1849 This avoids certain things that don't need to be done within redisplay. */
1851 void
1852 set_buffer_temp (b)
1853 struct buffer *b;
1855 register struct buffer *old_buf;
1857 if (current_buffer == b)
1858 return;
1860 old_buf = current_buffer;
1861 current_buffer = b;
1863 if (old_buf)
1865 /* If the old current buffer has markers to record PT, BEGV and ZV
1866 when it is not current, update them now. */
1867 if (! NILP (old_buf->pt_marker))
1869 Lisp_Object obuf;
1870 XSETBUFFER (obuf, old_buf);
1871 set_marker_both (old_buf->pt_marker, obuf,
1872 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1874 if (! NILP (old_buf->begv_marker))
1876 Lisp_Object obuf;
1877 XSETBUFFER (obuf, old_buf);
1878 set_marker_both (old_buf->begv_marker, obuf,
1879 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1881 if (! NILP (old_buf->zv_marker))
1883 Lisp_Object obuf;
1884 XSETBUFFER (obuf, old_buf);
1885 set_marker_both (old_buf->zv_marker, obuf,
1886 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1890 /* If the new current buffer has markers to record PT, BEGV and ZV
1891 when it is not current, fetch them now. */
1892 if (! NILP (b->pt_marker))
1894 BUF_PT (b) = marker_position (b->pt_marker);
1895 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1897 if (! NILP (b->begv_marker))
1899 BUF_BEGV (b) = marker_position (b->begv_marker);
1900 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1902 if (! NILP (b->zv_marker))
1904 BUF_ZV (b) = marker_position (b->zv_marker);
1905 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1909 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1910 doc: /* Make the buffer BUFFER current for editing operations.
1911 BUFFER may be a buffer or the name of an existing buffer.
1912 See also `save-excursion' when you want to make a buffer current temporarily.
1913 This function does not display the buffer, so its effect ends
1914 when the current command terminates.
1915 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1916 (buffer)
1917 register Lisp_Object buffer;
1919 register Lisp_Object buf;
1920 buf = Fget_buffer (buffer);
1921 if (NILP (buf))
1922 nsberror (buffer);
1923 if (NILP (XBUFFER (buf)->name))
1924 error ("Selecting deleted buffer");
1925 set_buffer_internal (XBUFFER (buf));
1926 return buf;
1929 /* Set the current buffer to BUFFER provided it is alive. */
1931 Lisp_Object
1932 set_buffer_if_live (buffer)
1933 Lisp_Object buffer;
1935 if (! NILP (XBUFFER (buffer)->name))
1936 Fset_buffer (buffer);
1937 return Qnil;
1940 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1941 Sbarf_if_buffer_read_only, 0, 0, 0,
1942 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1945 if (!NILP (current_buffer->read_only)
1946 && NILP (Vinhibit_read_only))
1947 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1948 return Qnil;
1951 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1952 doc: /* Put BUFFER at the end of the list of all buffers.
1953 There it is the least likely candidate for `other-buffer' to return;
1954 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1955 You can specify a buffer name as BUFFER, or an actual buffer object.
1956 If BUFFER is nil or omitted, bury the current buffer.
1957 Also, if BUFFER is nil or omitted, remove the current buffer from the
1958 selected window if it is displayed there. */)
1959 (buffer)
1960 register Lisp_Object buffer;
1962 /* Figure out what buffer we're going to bury. */
1963 if (NILP (buffer))
1965 Lisp_Object tem;
1966 XSETBUFFER (buffer, current_buffer);
1968 tem = Fwindow_buffer (selected_window);
1969 /* If we're burying the current buffer, unshow it. */
1970 if (EQ (buffer, tem))
1972 if (NILP (Fwindow_dedicated_p (selected_window)))
1973 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1974 else if (NILP (XWINDOW (selected_window)->parent))
1975 Ficonify_frame (Fwindow_frame (selected_window));
1976 else
1977 Fdelete_window (selected_window);
1980 else
1982 Lisp_Object buf1;
1984 buf1 = Fget_buffer (buffer);
1985 if (NILP (buf1))
1986 nsberror (buffer);
1987 buffer = buf1;
1990 /* Move buffer to the end of the buffer list. Do nothing if the
1991 buffer is killed. */
1992 if (!NILP (XBUFFER (buffer)->name))
1994 Lisp_Object aelt, link;
1996 aelt = Frassq (buffer, Vbuffer_alist);
1997 link = Fmemq (aelt, Vbuffer_alist);
1998 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1999 XSETCDR (link, Qnil);
2000 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2002 /* Removing BUFFER from frame-specific lists
2003 has the effect of putting BUFFER at the end
2004 of the combined list in each frame. */
2005 frames_discard_buffer (buffer);
2008 return Qnil;
2011 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2012 doc: /* Delete the entire contents of the current buffer.
2013 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2014 so the buffer is truly empty after this. */)
2017 Fwiden ();
2019 del_range (BEG, Z);
2021 current_buffer->last_window_start = 1;
2022 /* Prevent warnings, or suspension of auto saving, that would happen
2023 if future size is less than past size. Use of erase-buffer
2024 implies that the future text is not really related to the past text. */
2025 XSETFASTINT (current_buffer->save_length, 0);
2026 return Qnil;
2029 void
2030 validate_region (b, e)
2031 register Lisp_Object *b, *e;
2033 CHECK_NUMBER_COERCE_MARKER (*b);
2034 CHECK_NUMBER_COERCE_MARKER (*e);
2036 if (XINT (*b) > XINT (*e))
2038 Lisp_Object tem;
2039 tem = *b; *b = *e; *e = tem;
2042 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2043 && XINT (*e) <= ZV))
2044 args_out_of_range (*b, *e);
2047 /* Advance BYTE_POS up to a character boundary
2048 and return the adjusted position. */
2050 static int
2051 advance_to_char_boundary (byte_pos)
2052 int byte_pos;
2054 int c;
2056 if (byte_pos == BEG)
2057 /* Beginning of buffer is always a character boundary. */
2058 return BEG;
2060 c = FETCH_BYTE (byte_pos);
2061 if (! CHAR_HEAD_P (c))
2063 /* We should advance BYTE_POS only when C is a constituent of a
2064 multibyte sequence. */
2065 int orig_byte_pos = byte_pos;
2069 byte_pos--;
2070 c = FETCH_BYTE (byte_pos);
2072 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2073 INC_POS (byte_pos);
2074 if (byte_pos < orig_byte_pos)
2075 byte_pos = orig_byte_pos;
2076 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2077 surely advance to the correct character boundary. If C is
2078 not, BYTE_POS was unchanged. */
2081 return byte_pos;
2084 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2085 1, 1, 0,
2086 doc: /* Set the multibyte flag of the current buffer to FLAG.
2087 If FLAG is t, this makes the buffer a multibyte buffer.
2088 If FLAG is nil, this makes the buffer a single-byte buffer.
2089 The buffer contents remain unchanged as a sequence of bytes
2090 but the contents viewed as characters do change.
2091 If the multibyte flag was really changed, undo information of the
2092 current buffer is cleared. */)
2093 (flag)
2094 Lisp_Object flag;
2096 struct Lisp_Marker *tail, *markers;
2097 struct buffer *other;
2098 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
2099 int begv, zv;
2100 int narrowed = (BEG != BEGV || Z != ZV);
2101 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2103 if (current_buffer->base_buffer)
2104 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2106 /* Do nothing if nothing actually changes. */
2107 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2108 return flag;
2110 /* It would be better to update the list,
2111 but this is good enough for now. */
2112 if (undo_enabled_p)
2113 current_buffer->undo_list = Qt;
2115 /* If the cached position is for this buffer, clear it out. */
2116 clear_charpos_cache (current_buffer);
2118 if (NILP (flag))
2119 begv = BEGV_BYTE, zv = ZV_BYTE;
2120 else
2121 begv = BEGV, zv = ZV;
2123 if (narrowed)
2124 Fwiden ();
2126 if (NILP (flag))
2128 int pos, stop;
2129 unsigned char *p;
2131 /* Do this first, so it can use CHAR_TO_BYTE
2132 to calculate the old correspondences. */
2133 set_intervals_multibyte (0);
2135 current_buffer->enable_multibyte_characters = Qnil;
2137 Z = Z_BYTE;
2138 BEGV = BEGV_BYTE;
2139 ZV = ZV_BYTE;
2140 GPT = GPT_BYTE;
2141 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2144 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2145 tail->charpos = tail->bytepos;
2147 /* Convert multibyte form of 8-bit characters to unibyte. */
2148 pos = BEG;
2149 stop = GPT;
2150 p = BEG_ADDR;
2151 while (1)
2153 int c, bytes;
2155 if (pos == stop)
2157 if (pos == Z)
2158 break;
2159 p = GAP_END_ADDR;
2160 stop = Z;
2162 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2163 p += bytes, pos += bytes;
2164 else
2166 c = STRING_CHAR (p, stop - pos);
2167 /* Delete all bytes for this 8-bit character but the
2168 last one, and change the last one to the charcter
2169 code. */
2170 bytes--;
2171 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2172 p = GAP_END_ADDR;
2173 *p++ = c;
2174 pos++;
2175 if (begv > pos)
2176 begv -= bytes;
2177 if (zv > pos)
2178 zv -= bytes;
2179 stop = Z;
2182 if (narrowed)
2183 Fnarrow_to_region (make_number (begv), make_number (zv));
2185 else
2187 int pt = PT;
2188 int pos, stop;
2189 unsigned char *p;
2191 /* Be sure not to have a multibyte sequence striding over the GAP.
2192 Ex: We change this: "...abc\201 _GAP_ \241def..."
2193 to: "...abc _GAP_ \201\241def..." */
2195 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2196 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2198 unsigned char *p = GPT_ADDR - 1;
2200 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2201 if (BASE_LEADING_CODE_P (*p))
2203 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2205 move_gap_both (new_gpt, new_gpt);
2209 /* Make the buffer contents valid as multibyte by converting
2210 8-bit characters to multibyte form. */
2211 pos = BEG;
2212 stop = GPT;
2213 p = BEG_ADDR;
2214 while (1)
2216 int bytes;
2218 if (pos == stop)
2220 if (pos == Z)
2221 break;
2222 p = GAP_END_ADDR;
2223 stop = Z;
2226 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2227 p += bytes, pos += bytes;
2228 else
2230 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2232 bytes = CHAR_STRING (*p, tmp);
2233 *p = tmp[0];
2234 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2235 bytes--;
2236 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2237 /* Now the gap is after the just inserted data. */
2238 pos = GPT;
2239 p = GAP_END_ADDR;
2240 if (pos <= begv)
2241 begv += bytes;
2242 if (pos <= zv)
2243 zv += bytes;
2244 if (pos <= pt)
2245 pt += bytes;
2246 stop = Z;
2250 if (pt != PT)
2251 TEMP_SET_PT (pt);
2253 if (narrowed)
2254 Fnarrow_to_region (make_number (begv), make_number (zv));
2256 /* Do this first, so that chars_in_text asks the right question.
2257 set_intervals_multibyte needs it too. */
2258 current_buffer->enable_multibyte_characters = Qt;
2260 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2261 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2263 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2265 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2266 if (BEGV_BYTE > GPT_BYTE)
2267 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2268 else
2269 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2271 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2272 if (ZV_BYTE > GPT_BYTE)
2273 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2274 else
2275 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2278 int pt_byte = advance_to_char_boundary (PT_BYTE);
2279 int pt;
2281 if (pt_byte > GPT_BYTE)
2282 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2283 else
2284 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2285 TEMP_SET_PT_BOTH (pt, pt_byte);
2288 tail = markers = BUF_MARKERS (current_buffer);
2290 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2291 getting confused by the markers that have not yet been updated.
2292 It is also a signal that it should never create a marker. */
2293 BUF_MARKERS (current_buffer) = NULL;
2295 for (; tail; tail = tail->next)
2297 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2298 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2301 /* Make sure no markers were put on the chain
2302 while the chain value was incorrect. */
2303 if (BUF_MARKERS (current_buffer))
2304 abort ();
2306 BUF_MARKERS (current_buffer) = markers;
2308 /* Do this last, so it can calculate the new correspondences
2309 between chars and bytes. */
2310 set_intervals_multibyte (1);
2313 if (undo_enabled_p)
2314 current_buffer->undo_list = Qnil;
2316 /* Changing the multibyteness of a buffer means that all windows
2317 showing that buffer must be updated thoroughly. */
2318 current_buffer->prevent_redisplay_optimizations_p = 1;
2319 ++windows_or_buffers_changed;
2321 /* Copy this buffer's new multibyte status
2322 into all of its indirect buffers. */
2323 for (other = all_buffers; other; other = other->next)
2324 if (other->base_buffer == current_buffer && !NILP (other->name))
2326 other->enable_multibyte_characters
2327 = current_buffer->enable_multibyte_characters;
2328 other->prevent_redisplay_optimizations_p = 1;
2331 /* Restore the modifiedness of the buffer. */
2332 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2333 Fset_buffer_modified_p (Qnil);
2335 #ifdef subprocesses
2336 /* Update coding systems of this buffer's process (if any). */
2338 Lisp_Object process;
2340 process = Fget_buffer_process (Fcurrent_buffer ());
2341 if (PROCESSP (process))
2342 setup_process_coding_systems (process);
2344 #endif /* subprocesses */
2346 return flag;
2349 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2350 0, 0, 0,
2351 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2352 Most local variable bindings are eliminated so that the default values
2353 become effective once more. Also, the syntax table is set from
2354 `standard-syntax-table', the local keymap is set to nil,
2355 and the abbrev table from `fundamental-mode-abbrev-table'.
2356 This function also forces redisplay of the mode line.
2358 Every function to select a new major mode starts by
2359 calling this function.
2361 As a special exception, local variables whose names have
2362 a non-nil `permanent-local' property are not eliminated by this function.
2364 The first thing this function does is run
2365 the normal hook `change-major-mode-hook'. */)
2368 register Lisp_Object alist, sym, tem;
2369 Lisp_Object oalist;
2371 if (!NILP (Vrun_hooks))
2372 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2373 oalist = current_buffer->local_var_alist;
2375 /* Make sure none of the bindings in oalist
2376 remain swapped in, in their symbols. */
2378 swap_out_buffer_local_variables (current_buffer);
2380 /* Actually eliminate all local bindings of this buffer. */
2382 reset_buffer_local_variables (current_buffer, 0);
2384 /* Any which are supposed to be permanent,
2385 make local again, with the same values they had. */
2387 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2389 sym = XCAR (XCAR (alist));
2390 tem = Fget (sym, Qpermanent_local);
2391 if (! NILP (tem))
2393 Fmake_local_variable (sym);
2394 Fset (sym, XCDR (XCAR (alist)));
2398 /* Force mode-line redisplay. Useful here because all major mode
2399 commands call this function. */
2400 update_mode_lines++;
2402 return Qnil;
2405 /* Make sure no local variables remain set up with buffer B
2406 for their current values. */
2408 static void
2409 swap_out_buffer_local_variables (b)
2410 struct buffer *b;
2412 Lisp_Object oalist, alist, sym, tem, buffer;
2414 XSETBUFFER (buffer, b);
2415 oalist = b->local_var_alist;
2417 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2419 sym = XCAR (XCAR (alist));
2421 /* Need not do anything if some other buffer's binding is now encached. */
2422 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2423 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2425 /* Symbol is set up for this buffer's old local value.
2426 Set it up for the current buffer with the default value. */
2428 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2429 /* Store the symbol's current value into the alist entry
2430 it is currently set up for. This is so that, if the
2431 local is marked permanent, and we make it local again
2432 later in Fkill_all_local_variables, we don't lose the value. */
2433 XSETCDR (XCAR (tem),
2434 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2435 /* Switch to the symbol's default-value alist entry. */
2436 XSETCAR (tem, tem);
2437 /* Mark it as current for buffer B. */
2438 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2439 /* Store the current value into any forwarding in the symbol. */
2440 store_symval_forwarding (sym,
2441 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2442 XCDR (tem), NULL);
2447 /* Find all the overlays in the current buffer that contain position POS.
2448 Return the number found, and store them in a vector in *VEC_PTR.
2449 Store in *LEN_PTR the size allocated for the vector.
2450 Store in *NEXT_PTR the next position after POS where an overlay starts,
2451 or ZV if there are no more overlays.
2452 Store in *PREV_PTR the previous position before POS where an overlay ends,
2453 or where an overlay starts which ends at or after POS;
2454 or BEGV if there are no such overlays.
2455 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2457 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2458 when this function is called.
2460 If EXTEND is non-zero, we make the vector bigger if necessary.
2461 If EXTEND is zero, we never extend the vector,
2462 and we store only as many overlays as will fit.
2463 But we still return the total number of overlays.
2465 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2466 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2467 default (BEGV or ZV). */
2470 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2471 EMACS_INT pos;
2472 int extend;
2473 Lisp_Object **vec_ptr;
2474 int *len_ptr;
2475 int *next_ptr;
2476 int *prev_ptr;
2477 int change_req;
2479 Lisp_Object overlay, start, end;
2480 struct Lisp_Overlay *tail;
2481 int idx = 0;
2482 int len = *len_ptr;
2483 Lisp_Object *vec = *vec_ptr;
2484 int next = ZV;
2485 int prev = BEGV;
2486 int inhibit_storing = 0;
2488 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2490 int startpos, endpos;
2492 XSETMISC (overlay, tail);
2494 start = OVERLAY_START (overlay);
2495 end = OVERLAY_END (overlay);
2496 endpos = OVERLAY_POSITION (end);
2497 if (endpos < pos)
2499 if (prev < endpos)
2500 prev = endpos;
2501 break;
2503 startpos = OVERLAY_POSITION (start);
2504 /* This one ends at or after POS
2505 so its start counts for PREV_PTR if it's before POS. */
2506 if (prev < startpos && startpos < pos)
2507 prev = startpos;
2508 if (endpos == pos)
2509 continue;
2510 if (startpos <= pos)
2512 if (idx == len)
2514 /* The supplied vector is full.
2515 Either make it bigger, or don't store any more in it. */
2516 if (extend)
2518 /* Make it work with an initial len == 0. */
2519 len *= 2;
2520 if (len == 0)
2521 len = 4;
2522 *len_ptr = len;
2523 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2524 *vec_ptr = vec;
2526 else
2527 inhibit_storing = 1;
2530 if (!inhibit_storing)
2531 vec[idx] = overlay;
2532 /* Keep counting overlays even if we can't return them all. */
2533 idx++;
2535 else if (startpos < next)
2536 next = startpos;
2539 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2541 int startpos, endpos;
2543 XSETMISC (overlay, tail);
2545 start = OVERLAY_START (overlay);
2546 end = OVERLAY_END (overlay);
2547 startpos = OVERLAY_POSITION (start);
2548 if (pos < startpos)
2550 if (startpos < next)
2551 next = startpos;
2552 break;
2554 endpos = OVERLAY_POSITION (end);
2555 if (pos < endpos)
2557 if (idx == len)
2559 if (extend)
2561 /* Make it work with an initial len == 0. */
2562 len *= 2;
2563 if (len == 0)
2564 len = 4;
2565 *len_ptr = len;
2566 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2567 *vec_ptr = vec;
2569 else
2570 inhibit_storing = 1;
2573 if (!inhibit_storing)
2574 vec[idx] = overlay;
2575 idx++;
2577 if (startpos < pos && startpos > prev)
2578 prev = startpos;
2580 else if (endpos < pos && endpos > prev)
2581 prev = endpos;
2582 else if (endpos == pos && startpos > prev
2583 && (!change_req || startpos < pos))
2584 prev = startpos;
2587 if (next_ptr)
2588 *next_ptr = next;
2589 if (prev_ptr)
2590 *prev_ptr = prev;
2591 return idx;
2594 /* Find all the overlays in the current buffer that overlap the range BEG-END
2595 or are empty at BEG.
2597 Return the number found, and store them in a vector in *VEC_PTR.
2598 Store in *LEN_PTR the size allocated for the vector.
2599 Store in *NEXT_PTR the next position after POS where an overlay starts,
2600 or ZV if there are no more overlays.
2601 Store in *PREV_PTR the previous position before POS where an overlay ends,
2602 or BEGV if there are no previous overlays.
2603 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2605 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2606 when this function is called.
2608 If EXTEND is non-zero, we make the vector bigger if necessary.
2609 If EXTEND is zero, we never extend the vector,
2610 and we store only as many overlays as will fit.
2611 But we still return the total number of overlays. */
2613 static int
2614 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2615 int beg, end;
2616 int extend;
2617 Lisp_Object **vec_ptr;
2618 int *len_ptr;
2619 int *next_ptr;
2620 int *prev_ptr;
2622 Lisp_Object overlay, ostart, oend;
2623 struct Lisp_Overlay *tail;
2624 int idx = 0;
2625 int len = *len_ptr;
2626 Lisp_Object *vec = *vec_ptr;
2627 int next = ZV;
2628 int prev = BEGV;
2629 int inhibit_storing = 0;
2631 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2633 int startpos, endpos;
2635 XSETMISC (overlay, tail);
2637 ostart = OVERLAY_START (overlay);
2638 oend = OVERLAY_END (overlay);
2639 endpos = OVERLAY_POSITION (oend);
2640 if (endpos < beg)
2642 if (prev < endpos)
2643 prev = endpos;
2644 break;
2646 startpos = OVERLAY_POSITION (ostart);
2647 /* Count an interval if it either overlaps the range
2648 or is empty at the start of the range. */
2649 if ((beg < endpos && startpos < end)
2650 || (startpos == endpos && beg == endpos))
2652 if (idx == len)
2654 /* The supplied vector is full.
2655 Either make it bigger, or don't store any more in it. */
2656 if (extend)
2658 /* Make it work with an initial len == 0. */
2659 len *= 2;
2660 if (len == 0)
2661 len = 4;
2662 *len_ptr = len;
2663 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2664 *vec_ptr = vec;
2666 else
2667 inhibit_storing = 1;
2670 if (!inhibit_storing)
2671 vec[idx] = overlay;
2672 /* Keep counting overlays even if we can't return them all. */
2673 idx++;
2675 else if (startpos < next)
2676 next = startpos;
2679 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2681 int startpos, endpos;
2683 XSETMISC (overlay, tail);
2685 ostart = OVERLAY_START (overlay);
2686 oend = OVERLAY_END (overlay);
2687 startpos = OVERLAY_POSITION (ostart);
2688 if (end < startpos)
2690 if (startpos < next)
2691 next = startpos;
2692 break;
2694 endpos = OVERLAY_POSITION (oend);
2695 /* Count an interval if it either overlaps the range
2696 or is empty at the start of the range. */
2697 if ((beg < endpos && startpos < end)
2698 || (startpos == endpos && beg == endpos))
2700 if (idx == len)
2702 if (extend)
2704 /* Make it work with an initial len == 0. */
2705 len *= 2;
2706 if (len == 0)
2707 len = 4;
2708 *len_ptr = len;
2709 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2710 *vec_ptr = vec;
2712 else
2713 inhibit_storing = 1;
2716 if (!inhibit_storing)
2717 vec[idx] = overlay;
2718 idx++;
2720 else if (endpos < beg && endpos > prev)
2721 prev = endpos;
2724 if (next_ptr)
2725 *next_ptr = next;
2726 if (prev_ptr)
2727 *prev_ptr = prev;
2728 return idx;
2732 /* Return non-zero if there exists an overlay with a non-nil
2733 `mouse-face' property overlapping OVERLAY. */
2736 mouse_face_overlay_overlaps (overlay)
2737 Lisp_Object overlay;
2739 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2740 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2741 int n, i, size;
2742 Lisp_Object *v, tem;
2744 size = 10;
2745 v = (Lisp_Object *) alloca (size * sizeof *v);
2746 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2747 if (n > size)
2749 v = (Lisp_Object *) alloca (n * sizeof *v);
2750 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2753 for (i = 0; i < n; ++i)
2754 if (!EQ (v[i], overlay)
2755 && (tem = Foverlay_get (overlay, Qmouse_face),
2756 !NILP (tem)))
2757 break;
2759 return i < n;
2764 /* Fast function to just test if we're at an overlay boundary. */
2766 overlay_touches_p (pos)
2767 int pos;
2769 Lisp_Object overlay;
2770 struct Lisp_Overlay *tail;
2772 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2774 int endpos;
2776 XSETMISC (overlay ,tail);
2777 if (!GC_OVERLAYP (overlay))
2778 abort ();
2780 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2781 if (endpos < pos)
2782 break;
2783 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2784 return 1;
2787 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2789 int startpos;
2791 XSETMISC (overlay, tail);
2792 if (!GC_OVERLAYP (overlay))
2793 abort ();
2795 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2796 if (pos < startpos)
2797 break;
2798 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2799 return 1;
2801 return 0;
2804 struct sortvec
2806 Lisp_Object overlay;
2807 int beg, end;
2808 int priority;
2811 static int
2812 compare_overlays (v1, v2)
2813 const void *v1, *v2;
2815 const struct sortvec *s1 = (const struct sortvec *) v1;
2816 const struct sortvec *s2 = (const struct sortvec *) v2;
2817 if (s1->priority != s2->priority)
2818 return s1->priority - s2->priority;
2819 if (s1->beg != s2->beg)
2820 return s1->beg - s2->beg;
2821 if (s1->end != s2->end)
2822 return s2->end - s1->end;
2823 return 0;
2826 /* Sort an array of overlays by priority. The array is modified in place.
2827 The return value is the new size; this may be smaller than the original
2828 size if some of the overlays were invalid or were window-specific. */
2830 sort_overlays (overlay_vec, noverlays, w)
2831 Lisp_Object *overlay_vec;
2832 int noverlays;
2833 struct window *w;
2835 int i, j;
2836 struct sortvec *sortvec;
2837 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2839 /* Put the valid and relevant overlays into sortvec. */
2841 for (i = 0, j = 0; i < noverlays; i++)
2843 Lisp_Object tem;
2844 Lisp_Object overlay;
2846 overlay = overlay_vec[i];
2847 if (OVERLAY_VALID (overlay)
2848 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2849 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2851 /* If we're interested in a specific window, then ignore
2852 overlays that are limited to some other window. */
2853 if (w)
2855 Lisp_Object window;
2857 window = Foverlay_get (overlay, Qwindow);
2858 if (WINDOWP (window) && XWINDOW (window) != w)
2859 continue;
2862 /* This overlay is good and counts: put it into sortvec. */
2863 sortvec[j].overlay = overlay;
2864 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2865 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2866 tem = Foverlay_get (overlay, Qpriority);
2867 if (INTEGERP (tem))
2868 sortvec[j].priority = XINT (tem);
2869 else
2870 sortvec[j].priority = 0;
2871 j++;
2874 noverlays = j;
2876 /* Sort the overlays into the proper order: increasing priority. */
2878 if (noverlays > 1)
2879 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2881 for (i = 0; i < noverlays; i++)
2882 overlay_vec[i] = sortvec[i].overlay;
2883 return (noverlays);
2886 struct sortstr
2888 Lisp_Object string, string2;
2889 int size;
2890 int priority;
2893 struct sortstrlist
2895 struct sortstr *buf; /* An array that expands as needed; never freed. */
2896 int size; /* Allocated length of that array. */
2897 int used; /* How much of the array is currently in use. */
2898 int bytes; /* Total length of the strings in buf. */
2901 /* Buffers for storing information about the overlays touching a given
2902 position. These could be automatic variables in overlay_strings, but
2903 it's more efficient to hold onto the memory instead of repeatedly
2904 allocating and freeing it. */
2905 static struct sortstrlist overlay_heads, overlay_tails;
2906 static unsigned char *overlay_str_buf;
2908 /* Allocated length of overlay_str_buf. */
2909 static int overlay_str_len;
2911 /* A comparison function suitable for passing to qsort. */
2912 static int
2913 cmp_for_strings (as1, as2)
2914 char *as1, *as2;
2916 struct sortstr *s1 = (struct sortstr *)as1;
2917 struct sortstr *s2 = (struct sortstr *)as2;
2918 if (s1->size != s2->size)
2919 return s2->size - s1->size;
2920 if (s1->priority != s2->priority)
2921 return s1->priority - s2->priority;
2922 return 0;
2925 static void
2926 record_overlay_string (ssl, str, str2, pri, size)
2927 struct sortstrlist *ssl;
2928 Lisp_Object str, str2, pri;
2929 int size;
2931 int nbytes;
2933 if (ssl->used == ssl->size)
2935 if (ssl->buf)
2936 ssl->size *= 2;
2937 else
2938 ssl->size = 5;
2939 ssl->buf = ((struct sortstr *)
2940 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2942 ssl->buf[ssl->used].string = str;
2943 ssl->buf[ssl->used].string2 = str2;
2944 ssl->buf[ssl->used].size = size;
2945 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2946 ssl->used++;
2948 if (NILP (current_buffer->enable_multibyte_characters))
2949 nbytes = SCHARS (str);
2950 else if (! STRING_MULTIBYTE (str))
2951 nbytes = count_size_as_multibyte (SDATA (str),
2952 SBYTES (str));
2953 else
2954 nbytes = SBYTES (str);
2956 ssl->bytes += nbytes;
2958 if (STRINGP (str2))
2960 if (NILP (current_buffer->enable_multibyte_characters))
2961 nbytes = SCHARS (str2);
2962 else if (! STRING_MULTIBYTE (str2))
2963 nbytes = count_size_as_multibyte (SDATA (str2),
2964 SBYTES (str2));
2965 else
2966 nbytes = SBYTES (str2);
2968 ssl->bytes += nbytes;
2972 /* Return the concatenation of the strings associated with overlays that
2973 begin or end at POS, ignoring overlays that are specific to a window
2974 other than W. The strings are concatenated in the appropriate order:
2975 shorter overlays nest inside longer ones, and higher priority inside
2976 lower. Normally all of the after-strings come first, but zero-sized
2977 overlays have their after-strings ride along with the before-strings
2978 because it would look strange to print them inside-out.
2980 Returns the string length, and stores the contents indirectly through
2981 PSTR, if that variable is non-null. The string may be overwritten by
2982 subsequent calls. */
2985 overlay_strings (pos, w, pstr)
2986 EMACS_INT pos;
2987 struct window *w;
2988 unsigned char **pstr;
2990 Lisp_Object overlay, window, str;
2991 struct Lisp_Overlay *ov;
2992 int startpos, endpos;
2993 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
2995 overlay_heads.used = overlay_heads.bytes = 0;
2996 overlay_tails.used = overlay_tails.bytes = 0;
2997 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
2999 XSETMISC (overlay, ov);
3000 eassert (OVERLAYP (overlay));
3002 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3003 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3004 if (endpos < pos)
3005 break;
3006 if (endpos != pos && startpos != pos)
3007 continue;
3008 window = Foverlay_get (overlay, Qwindow);
3009 if (WINDOWP (window) && XWINDOW (window) != w)
3010 continue;
3011 if (startpos == pos
3012 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3013 record_overlay_string (&overlay_heads, str,
3014 (startpos == endpos
3015 ? Foverlay_get (overlay, Qafter_string)
3016 : Qnil),
3017 Foverlay_get (overlay, Qpriority),
3018 endpos - startpos);
3019 else if (endpos == pos
3020 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3021 record_overlay_string (&overlay_tails, str, Qnil,
3022 Foverlay_get (overlay, Qpriority),
3023 endpos - startpos);
3025 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3027 XSETMISC (overlay, ov);
3028 eassert (OVERLAYP (overlay));
3030 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3031 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3032 if (startpos > pos)
3033 break;
3034 if (endpos != pos && startpos != pos)
3035 continue;
3036 window = Foverlay_get (overlay, Qwindow);
3037 if (WINDOWP (window) && XWINDOW (window) != w)
3038 continue;
3039 if (startpos == pos
3040 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3041 record_overlay_string (&overlay_heads, str,
3042 (startpos == endpos
3043 ? Foverlay_get (overlay, Qafter_string)
3044 : Qnil),
3045 Foverlay_get (overlay, Qpriority),
3046 endpos - startpos);
3047 else if (endpos == pos
3048 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3049 record_overlay_string (&overlay_tails, str, Qnil,
3050 Foverlay_get (overlay, Qpriority),
3051 endpos - startpos);
3053 if (overlay_tails.used > 1)
3054 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3055 cmp_for_strings);
3056 if (overlay_heads.used > 1)
3057 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3058 cmp_for_strings);
3059 if (overlay_heads.bytes || overlay_tails.bytes)
3061 Lisp_Object tem;
3062 int i;
3063 unsigned char *p;
3064 int total = overlay_heads.bytes + overlay_tails.bytes;
3066 if (total > overlay_str_len)
3068 overlay_str_len = total;
3069 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3070 total);
3072 p = overlay_str_buf;
3073 for (i = overlay_tails.used; --i >= 0;)
3075 int nbytes;
3076 tem = overlay_tails.buf[i].string;
3077 nbytes = copy_text (SDATA (tem), p,
3078 SBYTES (tem),
3079 STRING_MULTIBYTE (tem), multibyte);
3080 p += nbytes;
3082 for (i = 0; i < overlay_heads.used; ++i)
3084 int nbytes;
3085 tem = overlay_heads.buf[i].string;
3086 nbytes = copy_text (SDATA (tem), p,
3087 SBYTES (tem),
3088 STRING_MULTIBYTE (tem), multibyte);
3089 p += nbytes;
3090 tem = overlay_heads.buf[i].string2;
3091 if (STRINGP (tem))
3093 nbytes = copy_text (SDATA (tem), p,
3094 SBYTES (tem),
3095 STRING_MULTIBYTE (tem), multibyte);
3096 p += nbytes;
3099 if (p != overlay_str_buf + total)
3100 abort ();
3101 if (pstr)
3102 *pstr = overlay_str_buf;
3103 return total;
3105 return 0;
3108 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3110 void
3111 recenter_overlay_lists (buf, pos)
3112 struct buffer *buf;
3113 EMACS_INT pos;
3115 Lisp_Object overlay, beg, end;
3116 struct Lisp_Overlay *prev, *tail, *next;
3118 /* See if anything in overlays_before should move to overlays_after. */
3120 /* We don't strictly need prev in this loop; it should always be nil.
3121 But we use it for symmetry and in case that should cease to be true
3122 with some future change. */
3123 prev = NULL;
3124 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3126 next = tail->next;
3127 XSETMISC (overlay, tail);
3129 /* If the overlay is not valid, get rid of it. */
3130 if (!OVERLAY_VALID (overlay))
3131 #if 1
3132 abort ();
3133 #else
3135 /* Splice the cons cell TAIL out of overlays_before. */
3136 if (!NILP (prev))
3137 XCDR (prev) = next;
3138 else
3139 buf->overlays_before = next;
3140 tail = prev;
3141 continue;
3143 #endif
3145 beg = OVERLAY_START (overlay);
3146 end = OVERLAY_END (overlay);
3148 if (OVERLAY_POSITION (end) > pos)
3150 /* OVERLAY needs to be moved. */
3151 int where = OVERLAY_POSITION (beg);
3152 struct Lisp_Overlay *other, *other_prev;
3154 /* Splice the cons cell TAIL out of overlays_before. */
3155 if (prev)
3156 prev->next = next;
3157 else
3158 buf->overlays_before = next;
3160 /* Search thru overlays_after for where to put it. */
3161 other_prev = NULL;
3162 for (other = buf->overlays_after; other;
3163 other_prev = other, other = other->next)
3165 Lisp_Object otherbeg, otheroverlay;
3167 XSETMISC (otheroverlay, other);
3168 eassert (OVERLAY_VALID (otheroverlay));
3170 otherbeg = OVERLAY_START (otheroverlay);
3171 if (OVERLAY_POSITION (otherbeg) >= where)
3172 break;
3175 /* Add TAIL to overlays_after before OTHER. */
3176 tail->next = other;
3177 if (other_prev)
3178 other_prev->next = tail;
3179 else
3180 buf->overlays_after = tail;
3181 tail = prev;
3183 else
3184 /* We've reached the things that should stay in overlays_before.
3185 All the rest of overlays_before must end even earlier,
3186 so stop now. */
3187 break;
3190 /* See if anything in overlays_after should be in overlays_before. */
3191 prev = NULL;
3192 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3194 next = tail->next;
3195 XSETMISC (overlay, tail);
3197 /* If the overlay is not valid, get rid of it. */
3198 if (!OVERLAY_VALID (overlay))
3199 #if 1
3200 abort ();
3201 #else
3203 /* Splice the cons cell TAIL out of overlays_after. */
3204 if (!NILP (prev))
3205 XCDR (prev) = next;
3206 else
3207 buf->overlays_after = next;
3208 tail = prev;
3209 continue;
3211 #endif
3213 beg = OVERLAY_START (overlay);
3214 end = OVERLAY_END (overlay);
3216 /* Stop looking, when we know that nothing further
3217 can possibly end before POS. */
3218 if (OVERLAY_POSITION (beg) > pos)
3219 break;
3221 if (OVERLAY_POSITION (end) <= pos)
3223 /* OVERLAY needs to be moved. */
3224 int where = OVERLAY_POSITION (end);
3225 struct Lisp_Overlay *other, *other_prev;
3227 /* Splice the cons cell TAIL out of overlays_after. */
3228 if (prev)
3229 prev->next = next;
3230 else
3231 buf->overlays_after = next;
3233 /* Search thru overlays_before for where to put it. */
3234 other_prev = NULL;
3235 for (other = buf->overlays_before; other;
3236 other_prev = other, other = other->next)
3238 Lisp_Object otherend, otheroverlay;
3240 XSETMISC (otheroverlay, other);
3241 eassert (OVERLAY_VALID (otheroverlay));
3243 otherend = OVERLAY_END (otheroverlay);
3244 if (OVERLAY_POSITION (otherend) <= where)
3245 break;
3248 /* Add TAIL to overlays_before before OTHER. */
3249 tail->next = other;
3250 if (other_prev)
3251 other_prev->next = tail;
3252 else
3253 buf->overlays_before = tail;
3254 tail = prev;
3258 buf->overlay_center = pos;
3261 void
3262 adjust_overlays_for_insert (pos, length)
3263 EMACS_INT pos;
3264 EMACS_INT length;
3266 /* After an insertion, the lists are still sorted properly,
3267 but we may need to update the value of the overlay center. */
3268 if (current_buffer->overlay_center >= pos)
3269 current_buffer->overlay_center += length;
3272 void
3273 adjust_overlays_for_delete (pos, length)
3274 EMACS_INT pos;
3275 EMACS_INT length;
3277 if (current_buffer->overlay_center < pos)
3278 /* The deletion was to our right. No change needed; the before- and
3279 after-lists are still consistent. */
3281 else if (current_buffer->overlay_center > pos + length)
3282 /* The deletion was to our left. We need to adjust the center value
3283 to account for the change in position, but the lists are consistent
3284 given the new value. */
3285 current_buffer->overlay_center -= length;
3286 else
3287 /* We're right in the middle. There might be things on the after-list
3288 that now belong on the before-list. Recentering will move them,
3289 and also update the center point. */
3290 recenter_overlay_lists (current_buffer, pos);
3293 /* Fix up overlays that were garbled as a result of permuting markers
3294 in the range START through END. Any overlay with at least one
3295 endpoint in this range will need to be unlinked from the overlay
3296 list and reinserted in its proper place.
3297 Such an overlay might even have negative size at this point.
3298 If so, we'll make the overlay empty. */
3299 void
3300 fix_start_end_in_overlays (start, end)
3301 register int start, end;
3303 Lisp_Object overlay;
3304 struct Lisp_Overlay *before_list, *after_list;
3305 /* These are either nil, indicating that before_list or after_list
3306 should be assigned, or the cons cell the cdr of which should be
3307 assigned. */
3308 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3309 /* 'Parent', likewise, indicates a cons cell or
3310 current_buffer->overlays_before or overlays_after, depending
3311 which loop we're in. */
3312 struct Lisp_Overlay *tail, *parent;
3313 int startpos, endpos;
3315 /* This algorithm shifts links around instead of consing and GCing.
3316 The loop invariant is that before_list (resp. after_list) is a
3317 well-formed list except that its last element, the CDR of beforep
3318 (resp. afterp) if beforep (afterp) isn't nil or before_list
3319 (after_list) if it is, is still uninitialized. So it's not a bug
3320 that before_list isn't initialized, although it may look
3321 strange. */
3322 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3324 XSETMISC (overlay, tail);
3326 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3327 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3329 /* If the overlay is backwards, make it empty. */
3330 if (endpos < startpos)
3332 startpos = endpos;
3333 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3334 Qnil);
3337 if (endpos < start)
3338 break;
3340 if (endpos < end
3341 || (startpos >= start && startpos < end))
3343 /* Add it to the end of the wrong list. Later on,
3344 recenter_overlay_lists will move it to the right place. */
3345 if (endpos < current_buffer->overlay_center)
3347 if (!afterp)
3348 after_list = tail;
3349 else
3350 afterp->next = tail;
3351 afterp = tail;
3353 else
3355 if (!beforep)
3356 before_list = tail;
3357 else
3358 beforep->next = tail;
3359 beforep = tail;
3361 if (!parent)
3362 current_buffer->overlays_before = tail->next;
3363 else
3364 parent->next = tail->next;
3365 tail = tail->next;
3367 else
3368 parent = tail, tail = parent->next;
3370 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3372 XSETMISC (overlay, tail);
3374 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3375 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3377 /* If the overlay is backwards, make it empty. */
3378 if (endpos < startpos)
3380 startpos = endpos;
3381 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3382 Qnil);
3385 if (startpos >= end)
3386 break;
3388 if (startpos >= start
3389 || (endpos >= start && endpos < end))
3391 if (endpos < current_buffer->overlay_center)
3393 if (!afterp)
3394 after_list = tail;
3395 else
3396 afterp->next = tail;
3397 afterp = tail;
3399 else
3401 if (!beforep)
3402 before_list = tail;
3403 else
3404 beforep->next = tail;
3405 beforep = tail;
3407 if (!parent)
3408 current_buffer->overlays_after = tail->next;
3409 else
3410 parent->next = tail->next;
3411 tail = tail->next;
3413 else
3414 parent = tail, tail = parent->next;
3417 /* Splice the constructed (wrong) lists into the buffer's lists,
3418 and let the recenter function make it sane again. */
3419 if (beforep)
3421 beforep->next = current_buffer->overlays_before;
3422 current_buffer->overlays_before = before_list;
3424 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3426 if (afterp)
3428 afterp->next = current_buffer->overlays_after;
3429 current_buffer->overlays_after = after_list;
3431 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3434 /* We have two types of overlay: the one whose ending marker is
3435 after-insertion-marker (this is the usual case) and the one whose
3436 ending marker is before-insertion-marker. When `overlays_before'
3437 contains overlays of the latter type and the former type in this
3438 order and both overlays end at inserting position, inserting a text
3439 increases only the ending marker of the latter type, which results
3440 in incorrect ordering of `overlays_before'.
3442 This function fixes ordering of overlays in the slot
3443 `overlays_before' of the buffer *BP. Before the insertion, `point'
3444 was at PREV, and now is at POS. */
3446 void
3447 fix_overlays_before (bp, prev, pos)
3448 struct buffer *bp;
3449 EMACS_INT prev, pos;
3451 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3452 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3453 Lisp_Object tem;
3454 EMACS_INT end;
3456 /* After the insertion, the several overlays may be in incorrect
3457 order. The possibility is that, in the list `overlays_before',
3458 an overlay which ends at POS appears after an overlay which ends
3459 at PREV. Since POS is greater than PREV, we must fix the
3460 ordering of these overlays, by moving overlays ends at POS before
3461 the overlays ends at PREV. */
3463 /* At first, find a place where disordered overlays should be linked
3464 in. It is where an overlay which end before POS exists. (i.e. an
3465 overlay whose ending marker is after-insertion-marker if disorder
3466 exists). */
3467 while (tail
3468 && (XSETMISC (tem, tail),
3469 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3471 parent = tail;
3472 tail = tail->next;
3475 /* If we don't find such an overlay,
3476 or the found one ends before PREV,
3477 or the found one is the last one in the list,
3478 we don't have to fix anything. */
3479 if (!tail || end < prev || !tail->next)
3480 return;
3482 right_pair = parent;
3483 parent = tail;
3484 tail = tail->next;
3486 /* Now, end position of overlays in the list TAIL should be before
3487 or equal to PREV. In the loop, an overlay which ends at POS is
3488 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3489 we found an overlay which ends before PREV, the remaining
3490 overlays are in correct order. */
3491 while (tail)
3493 XSETMISC (tem, tail);
3494 end = OVERLAY_POSITION (OVERLAY_END (tem));
3496 if (end == pos)
3497 { /* This overlay is disordered. */
3498 struct Lisp_Overlay *found = tail;
3500 /* Unlink the found overlay. */
3501 tail = found->next;
3502 parent->next = tail;
3503 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3504 and link it into the right place. */
3505 if (!right_pair)
3507 found->next = bp->overlays_before;
3508 bp->overlays_before = found;
3510 else
3512 found->next = right_pair->next;
3513 right_pair->next = found;
3516 else if (end == prev)
3518 parent = tail;
3519 tail = tail->next;
3521 else /* No more disordered overlay. */
3522 break;
3526 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3527 doc: /* Return t if OBJECT is an overlay. */)
3528 (object)
3529 Lisp_Object object;
3531 return (OVERLAYP (object) ? Qt : Qnil);
3534 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3535 doc: /* Create a new overlay with range BEG to END in BUFFER.
3536 If omitted, BUFFER defaults to the current buffer.
3537 BEG and END may be integers or markers.
3538 The fourth arg FRONT-ADVANCE, if non-nil, makes the
3539 front delimiter advance when text is inserted there.
3540 The fifth arg REAR-ADVANCE, if non-nil, makes the
3541 rear delimiter advance when text is inserted there. */)
3542 (beg, end, buffer, front_advance, rear_advance)
3543 Lisp_Object beg, end, buffer;
3544 Lisp_Object front_advance, rear_advance;
3546 Lisp_Object overlay;
3547 struct buffer *b;
3549 if (NILP (buffer))
3550 XSETBUFFER (buffer, current_buffer);
3551 else
3552 CHECK_BUFFER (buffer);
3553 if (MARKERP (beg)
3554 && ! EQ (Fmarker_buffer (beg), buffer))
3555 error ("Marker points into wrong buffer");
3556 if (MARKERP (end)
3557 && ! EQ (Fmarker_buffer (end), buffer))
3558 error ("Marker points into wrong buffer");
3560 CHECK_NUMBER_COERCE_MARKER (beg);
3561 CHECK_NUMBER_COERCE_MARKER (end);
3563 if (XINT (beg) > XINT (end))
3565 Lisp_Object temp;
3566 temp = beg; beg = end; end = temp;
3569 b = XBUFFER (buffer);
3571 beg = Fset_marker (Fmake_marker (), beg, buffer);
3572 end = Fset_marker (Fmake_marker (), end, buffer);
3574 if (!NILP (front_advance))
3575 XMARKER (beg)->insertion_type = 1;
3576 if (!NILP (rear_advance))
3577 XMARKER (end)->insertion_type = 1;
3579 overlay = allocate_misc ();
3580 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3581 XOVERLAY (overlay)->start = beg;
3582 XOVERLAY (overlay)->end = end;
3583 XOVERLAY (overlay)->plist = Qnil;
3584 XOVERLAY (overlay)->next = NULL;
3586 /* Put the new overlay on the wrong list. */
3587 end = OVERLAY_END (overlay);
3588 if (OVERLAY_POSITION (end) < b->overlay_center)
3590 if (b->overlays_after)
3591 XOVERLAY (overlay)->next = b->overlays_after;
3592 b->overlays_after = XOVERLAY (overlay);
3594 else
3596 if (b->overlays_before)
3597 XOVERLAY (overlay)->next = b->overlays_before;
3598 b->overlays_before = XOVERLAY (overlay);
3601 /* This puts it in the right list, and in the right order. */
3602 recenter_overlay_lists (b, b->overlay_center);
3604 /* We don't need to redisplay the region covered by the overlay, because
3605 the overlay has no properties at the moment. */
3607 return overlay;
3610 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3612 static void
3613 modify_overlay (buf, start, end)
3614 struct buffer *buf;
3615 EMACS_INT start, end;
3617 if (start > end)
3619 int temp = start;
3620 start = end;
3621 end = temp;
3624 BUF_COMPUTE_UNCHANGED (buf, start, end);
3626 /* If this is a buffer not in the selected window,
3627 we must do other windows. */
3628 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3629 windows_or_buffers_changed = 1;
3630 /* If multiple windows show this buffer, we must do other windows. */
3631 else if (buffer_shared > 1)
3632 windows_or_buffers_changed = 1;
3634 ++BUF_OVERLAY_MODIFF (buf);
3638 Lisp_Object Fdelete_overlay ();
3640 static struct Lisp_Overlay *
3641 unchain_overlay (list, overlay)
3642 struct Lisp_Overlay *list, *overlay;
3644 struct Lisp_Overlay *tmp, *prev;
3645 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3646 if (tmp == overlay)
3648 if (prev)
3649 prev->next = tmp->next;
3650 else
3651 list = tmp->next;
3652 overlay->next = NULL;
3653 break;
3655 return list;
3658 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3659 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3660 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3661 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3662 buffer. */)
3663 (overlay, beg, end, buffer)
3664 Lisp_Object overlay, beg, end, buffer;
3666 struct buffer *b, *ob;
3667 Lisp_Object obuffer;
3668 int count = SPECPDL_INDEX ();
3670 CHECK_OVERLAY (overlay);
3671 if (NILP (buffer))
3672 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3673 if (NILP (buffer))
3674 XSETBUFFER (buffer, current_buffer);
3675 CHECK_BUFFER (buffer);
3677 if (MARKERP (beg)
3678 && ! EQ (Fmarker_buffer (beg), buffer))
3679 error ("Marker points into wrong buffer");
3680 if (MARKERP (end)
3681 && ! EQ (Fmarker_buffer (end), buffer))
3682 error ("Marker points into wrong buffer");
3684 CHECK_NUMBER_COERCE_MARKER (beg);
3685 CHECK_NUMBER_COERCE_MARKER (end);
3687 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3688 return Fdelete_overlay (overlay);
3690 if (XINT (beg) > XINT (end))
3692 Lisp_Object temp;
3693 temp = beg; beg = end; end = temp;
3696 specbind (Qinhibit_quit, Qt);
3698 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3699 b = XBUFFER (buffer);
3700 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3702 /* If the overlay has changed buffers, do a thorough redisplay. */
3703 if (!EQ (buffer, obuffer))
3705 /* Redisplay where the overlay was. */
3706 if (!NILP (obuffer))
3708 int o_beg;
3709 int o_end;
3711 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3712 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3714 modify_overlay (ob, o_beg, o_end);
3717 /* Redisplay where the overlay is going to be. */
3718 modify_overlay (b, XINT (beg), XINT (end));
3720 else
3721 /* Redisplay the area the overlay has just left, or just enclosed. */
3723 int o_beg, o_end;
3725 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3726 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3728 if (o_beg == XINT (beg))
3729 modify_overlay (b, o_end, XINT (end));
3730 else if (o_end == XINT (end))
3731 modify_overlay (b, o_beg, XINT (beg));
3732 else
3734 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3735 if (XINT (end) > o_end) o_end = XINT (end);
3736 modify_overlay (b, o_beg, o_end);
3740 if (!NILP (obuffer))
3742 ob->overlays_before
3743 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3744 ob->overlays_after
3745 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3746 eassert (XOVERLAY (overlay)->next == NULL);
3749 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3750 Fset_marker (OVERLAY_END (overlay), end, buffer);
3752 /* Put the overlay on the wrong list. */
3753 end = OVERLAY_END (overlay);
3754 if (OVERLAY_POSITION (end) < b->overlay_center)
3756 XOVERLAY (overlay)->next = b->overlays_after;
3757 b->overlays_after = XOVERLAY (overlay);
3759 else
3761 XOVERLAY (overlay)->next = b->overlays_before;
3762 b->overlays_before = XOVERLAY (overlay);
3765 /* This puts it in the right list, and in the right order. */
3766 recenter_overlay_lists (b, b->overlay_center);
3768 return unbind_to (count, overlay);
3771 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3772 doc: /* Delete the overlay OVERLAY from its buffer. */)
3773 (overlay)
3774 Lisp_Object overlay;
3776 Lisp_Object buffer;
3777 struct buffer *b;
3778 int count = SPECPDL_INDEX ();
3780 CHECK_OVERLAY (overlay);
3782 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3783 if (NILP (buffer))
3784 return Qnil;
3786 b = XBUFFER (buffer);
3787 specbind (Qinhibit_quit, Qt);
3789 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3790 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3791 eassert (XOVERLAY (overlay)->next == NULL);
3792 modify_overlay (b,
3793 marker_position (OVERLAY_START (overlay)),
3794 marker_position (OVERLAY_END (overlay)));
3795 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3796 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3798 /* When deleting an overlay with before or after strings, turn off
3799 display optimizations for the affected buffer, on the basis that
3800 these strings may contain newlines. This is easier to do than to
3801 check for that situation during redisplay. */
3802 if (!windows_or_buffers_changed
3803 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3804 || !NILP (Foverlay_get (overlay, Qafter_string))))
3805 b->prevent_redisplay_optimizations_p = 1;
3807 return unbind_to (count, Qnil);
3810 /* Overlay dissection functions. */
3812 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3813 doc: /* Return the position at which OVERLAY starts. */)
3814 (overlay)
3815 Lisp_Object overlay;
3817 CHECK_OVERLAY (overlay);
3819 return (Fmarker_position (OVERLAY_START (overlay)));
3822 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3823 doc: /* Return the position at which OVERLAY ends. */)
3824 (overlay)
3825 Lisp_Object overlay;
3827 CHECK_OVERLAY (overlay);
3829 return (Fmarker_position (OVERLAY_END (overlay)));
3832 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3833 doc: /* Return the buffer OVERLAY belongs to.
3834 Return nil if OVERLAY has been deleted. */)
3835 (overlay)
3836 Lisp_Object overlay;
3838 CHECK_OVERLAY (overlay);
3840 return Fmarker_buffer (OVERLAY_START (overlay));
3843 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3844 doc: /* Return a list of the properties on OVERLAY.
3845 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3846 OVERLAY. */)
3847 (overlay)
3848 Lisp_Object overlay;
3850 CHECK_OVERLAY (overlay);
3852 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3856 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3857 doc: /* Return a list of the overlays that contain position POS. */)
3858 (pos)
3859 Lisp_Object pos;
3861 int noverlays;
3862 Lisp_Object *overlay_vec;
3863 int len;
3864 Lisp_Object result;
3866 CHECK_NUMBER_COERCE_MARKER (pos);
3868 len = 10;
3869 /* We can't use alloca here because overlays_at can call xrealloc. */
3870 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3872 /* Put all the overlays we want in a vector in overlay_vec.
3873 Store the length in len. */
3874 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3875 (int *) 0, (int *) 0, 0);
3877 /* Make a list of them all. */
3878 result = Flist (noverlays, overlay_vec);
3880 xfree (overlay_vec);
3881 return result;
3884 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3885 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3886 Overlap means that at least one character is contained within the overlay
3887 and also contained within the specified region.
3888 Empty overlays are included in the result if they are located at BEG
3889 or between BEG and END. */)
3890 (beg, end)
3891 Lisp_Object beg, end;
3893 int noverlays;
3894 Lisp_Object *overlay_vec;
3895 int len;
3896 Lisp_Object result;
3898 CHECK_NUMBER_COERCE_MARKER (beg);
3899 CHECK_NUMBER_COERCE_MARKER (end);
3901 len = 10;
3902 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3904 /* Put all the overlays we want in a vector in overlay_vec.
3905 Store the length in len. */
3906 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3907 (int *) 0, (int *) 0);
3909 /* Make a list of them all. */
3910 result = Flist (noverlays, overlay_vec);
3912 xfree (overlay_vec);
3913 return result;
3916 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3917 1, 1, 0,
3918 doc: /* Return the next position after POS where an overlay starts or ends.
3919 If there are no more overlay boundaries after POS, return (point-max). */)
3920 (pos)
3921 Lisp_Object pos;
3923 int noverlays;
3924 int endpos;
3925 Lisp_Object *overlay_vec;
3926 int len;
3927 int i;
3929 CHECK_NUMBER_COERCE_MARKER (pos);
3931 len = 10;
3932 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3934 /* Put all the overlays we want in a vector in overlay_vec.
3935 Store the length in len.
3936 endpos gets the position where the next overlay starts. */
3937 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3938 &endpos, (int *) 0, 1);
3940 /* If any of these overlays ends before endpos,
3941 use its ending point instead. */
3942 for (i = 0; i < noverlays; i++)
3944 Lisp_Object oend;
3945 int oendpos;
3947 oend = OVERLAY_END (overlay_vec[i]);
3948 oendpos = OVERLAY_POSITION (oend);
3949 if (oendpos < endpos)
3950 endpos = oendpos;
3953 xfree (overlay_vec);
3954 return make_number (endpos);
3957 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3958 Sprevious_overlay_change, 1, 1, 0,
3959 doc: /* Return the previous position before POS where an overlay starts or ends.
3960 If there are no more overlay boundaries before POS, return (point-min). */)
3961 (pos)
3962 Lisp_Object pos;
3964 int noverlays;
3965 int prevpos;
3966 Lisp_Object *overlay_vec;
3967 int len;
3969 CHECK_NUMBER_COERCE_MARKER (pos);
3971 /* At beginning of buffer, we know the answer;
3972 avoid bug subtracting 1 below. */
3973 if (XINT (pos) == BEGV)
3974 return pos;
3976 len = 10;
3977 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3979 /* Put all the overlays we want in a vector in overlay_vec.
3980 Store the length in len.
3981 prevpos gets the position of the previous change. */
3982 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3983 (int *) 0, &prevpos, 1);
3985 xfree (overlay_vec);
3986 return make_number (prevpos);
3989 /* These functions are for debugging overlays. */
3991 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3992 doc: /* Return a pair of lists giving all the overlays of the current buffer.
3993 The car has all the overlays before the overlay center;
3994 the cdr has all the overlays after the overlay center.
3995 Recentering overlays moves overlays between these lists.
3996 The lists you get are copies, so that changing them has no effect.
3997 However, the overlays you get are the real objects that the buffer uses. */)
4000 struct Lisp_Overlay *ol;
4001 Lisp_Object before = Qnil, after = Qnil, tmp;
4002 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4004 XSETMISC (tmp, ol);
4005 before = Fcons (tmp, before);
4007 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4009 XSETMISC (tmp, ol);
4010 after = Fcons (tmp, after);
4012 return Fcons (Fnreverse (before), Fnreverse (after));
4015 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4016 doc: /* Recenter the overlays of the current buffer around position POS.
4017 That makes overlay lookup faster for positions near POS (but perhaps slower
4018 for positions far away from POS). */)
4019 (pos)
4020 Lisp_Object pos;
4022 CHECK_NUMBER_COERCE_MARKER (pos);
4024 recenter_overlay_lists (current_buffer, XINT (pos));
4025 return Qnil;
4028 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4029 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4030 (overlay, prop)
4031 Lisp_Object overlay, prop;
4033 CHECK_OVERLAY (overlay);
4034 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4037 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4038 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4039 (overlay, prop, value)
4040 Lisp_Object overlay, prop, value;
4042 Lisp_Object tail, buffer;
4043 int changed;
4045 CHECK_OVERLAY (overlay);
4047 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4049 for (tail = XOVERLAY (overlay)->plist;
4050 CONSP (tail) && CONSP (XCDR (tail));
4051 tail = XCDR (XCDR (tail)))
4052 if (EQ (XCAR (tail), prop))
4054 changed = !EQ (XCAR (XCDR (tail)), value);
4055 XSETCAR (XCDR (tail), value);
4056 goto found;
4058 /* It wasn't in the list, so add it to the front. */
4059 changed = !NILP (value);
4060 XOVERLAY (overlay)->plist
4061 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4062 found:
4063 if (! NILP (buffer))
4065 if (changed)
4066 modify_overlay (XBUFFER (buffer),
4067 marker_position (OVERLAY_START (overlay)),
4068 marker_position (OVERLAY_END (overlay)));
4069 if (EQ (prop, Qevaporate) && ! NILP (value)
4070 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4071 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4072 Fdelete_overlay (overlay);
4074 return value;
4077 /* Subroutine of report_overlay_modification. */
4079 /* Lisp vector holding overlay hook functions to call.
4080 Vector elements come in pairs.
4081 Each even-index element is a list of hook functions.
4082 The following odd-index element is the overlay they came from.
4084 Before the buffer change, we fill in this vector
4085 as we call overlay hook functions.
4086 After the buffer change, we get the functions to call from this vector.
4087 This way we always call the same functions before and after the change. */
4088 static Lisp_Object last_overlay_modification_hooks;
4090 /* Number of elements actually used in last_overlay_modification_hooks. */
4091 static int last_overlay_modification_hooks_used;
4093 /* Add one functionlist/overlay pair
4094 to the end of last_overlay_modification_hooks. */
4096 static void
4097 add_overlay_mod_hooklist (functionlist, overlay)
4098 Lisp_Object functionlist, overlay;
4100 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4102 if (last_overlay_modification_hooks_used == oldsize)
4104 Lisp_Object old;
4105 old = last_overlay_modification_hooks;
4106 last_overlay_modification_hooks
4107 = Fmake_vector (make_number (oldsize * 2), Qnil);
4108 bcopy (XVECTOR (old)->contents,
4109 XVECTOR (last_overlay_modification_hooks)->contents,
4110 sizeof (Lisp_Object) * oldsize);
4112 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4113 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4116 /* Run the modification-hooks of overlays that include
4117 any part of the text in START to END.
4118 If this change is an insertion, also
4119 run the insert-before-hooks of overlay starting at END,
4120 and the insert-after-hooks of overlay ending at START.
4122 This is called both before and after the modification.
4123 AFTER is nonzero when we call after the modification.
4125 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4126 When AFTER is nonzero, they are the start position,
4127 the position after the inserted new text,
4128 and the length of deleted or replaced old text. */
4130 void
4131 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4132 Lisp_Object start, end;
4133 int after;
4134 Lisp_Object arg1, arg2, arg3;
4136 Lisp_Object prop, overlay;
4137 struct Lisp_Overlay *tail;
4138 /* 1 if this change is an insertion. */
4139 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4140 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4142 overlay = Qnil;
4143 tail = NULL;
4145 /* We used to run the functions as soon as we found them and only register
4146 them in last_overlay_modification_hooks for the purpose of the `after'
4147 case. But running elisp code as we traverse the list of overlays is
4148 painful because the list can be modified by the elisp code so we had to
4149 copy at several places. We now simply do a read-only traversal that
4150 only collects the functions to run and we run them afterwards. It's
4151 simpler, especially since all the code was already there. -stef */
4153 if (!after)
4155 /* We are being called before a change.
4156 Scan the overlays to find the functions to call. */
4157 last_overlay_modification_hooks_used = 0;
4158 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4160 int startpos, endpos;
4161 Lisp_Object ostart, oend;
4163 XSETMISC (overlay, tail);
4165 ostart = OVERLAY_START (overlay);
4166 oend = OVERLAY_END (overlay);
4167 endpos = OVERLAY_POSITION (oend);
4168 if (XFASTINT (start) > endpos)
4169 break;
4170 startpos = OVERLAY_POSITION (ostart);
4171 if (insertion && (XFASTINT (start) == startpos
4172 || XFASTINT (end) == startpos))
4174 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4175 if (!NILP (prop))
4176 add_overlay_mod_hooklist (prop, overlay);
4178 if (insertion && (XFASTINT (start) == endpos
4179 || XFASTINT (end) == endpos))
4181 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4182 if (!NILP (prop))
4183 add_overlay_mod_hooklist (prop, overlay);
4185 /* Test for intersecting intervals. This does the right thing
4186 for both insertion and deletion. */
4187 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4189 prop = Foverlay_get (overlay, Qmodification_hooks);
4190 if (!NILP (prop))
4191 add_overlay_mod_hooklist (prop, overlay);
4195 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4197 int startpos, endpos;
4198 Lisp_Object ostart, oend;
4200 XSETMISC (overlay, tail);
4202 ostart = OVERLAY_START (overlay);
4203 oend = OVERLAY_END (overlay);
4204 startpos = OVERLAY_POSITION (ostart);
4205 endpos = OVERLAY_POSITION (oend);
4206 if (XFASTINT (end) < startpos)
4207 break;
4208 if (insertion && (XFASTINT (start) == startpos
4209 || XFASTINT (end) == startpos))
4211 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4212 if (!NILP (prop))
4213 add_overlay_mod_hooklist (prop, overlay);
4215 if (insertion && (XFASTINT (start) == endpos
4216 || XFASTINT (end) == endpos))
4218 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4219 if (!NILP (prop))
4220 add_overlay_mod_hooklist (prop, overlay);
4222 /* Test for intersecting intervals. This does the right thing
4223 for both insertion and deletion. */
4224 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4226 prop = Foverlay_get (overlay, Qmodification_hooks);
4227 if (!NILP (prop))
4228 add_overlay_mod_hooklist (prop, overlay);
4233 GCPRO4 (overlay, arg1, arg2, arg3);
4235 /* Call the functions recorded in last_overlay_modification_hooks.
4236 First copy the vector contents, in case some of these hooks
4237 do subsequent modification of the buffer. */
4238 int size = last_overlay_modification_hooks_used;
4239 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4240 int i;
4242 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4243 copy, size * sizeof (Lisp_Object));
4244 gcpro1.var = copy;
4245 gcpro1.nvars = size;
4247 for (i = 0; i < size;)
4249 Lisp_Object prop, overlay;
4250 prop = copy[i++];
4251 overlay = copy[i++];
4252 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4255 UNGCPRO;
4258 static void
4259 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4260 Lisp_Object list, overlay;
4261 int after;
4262 Lisp_Object arg1, arg2, arg3;
4264 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4266 GCPRO4 (list, arg1, arg2, arg3);
4268 while (CONSP (list))
4270 if (NILP (arg3))
4271 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4272 else
4273 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4274 list = XCDR (list);
4276 UNGCPRO;
4279 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4280 property is set. */
4281 void
4282 evaporate_overlays (pos)
4283 EMACS_INT pos;
4285 Lisp_Object overlay, hit_list;
4286 struct Lisp_Overlay *tail;
4288 hit_list = Qnil;
4289 if (pos <= current_buffer->overlay_center)
4290 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4292 int endpos;
4293 XSETMISC (overlay, tail);
4294 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4295 if (endpos < pos)
4296 break;
4297 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4298 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4299 hit_list = Fcons (overlay, hit_list);
4301 else
4302 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4304 int startpos;
4305 XSETMISC (overlay, tail);
4306 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4307 if (startpos > pos)
4308 break;
4309 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4310 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4311 hit_list = Fcons (overlay, hit_list);
4313 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4314 Fdelete_overlay (XCAR (hit_list));
4317 /* Somebody has tried to store a value with an unacceptable type
4318 in the slot with offset OFFSET. */
4320 void
4321 buffer_slot_type_mismatch (offset)
4322 int offset;
4324 Lisp_Object sym;
4325 char *type_name;
4327 switch (XINT (PER_BUFFER_TYPE (offset)))
4329 case Lisp_Int:
4330 type_name = "integers";
4331 break;
4333 case Lisp_String:
4334 type_name = "strings";
4335 break;
4337 case Lisp_Symbol:
4338 type_name = "symbols";
4339 break;
4341 default:
4342 abort ();
4345 sym = PER_BUFFER_SYMBOL (offset);
4346 error ("Only %s should be stored in the buffer-local variable %s",
4347 type_name, SDATA (SYMBOL_NAME (sym)));
4351 /***********************************************************************
4352 Allocation with mmap
4353 ***********************************************************************/
4355 #ifdef USE_MMAP_FOR_BUFFERS
4357 #include <sys/types.h>
4358 #include <sys/mman.h>
4360 #ifndef MAP_ANON
4361 #ifdef MAP_ANONYMOUS
4362 #define MAP_ANON MAP_ANONYMOUS
4363 #else
4364 #define MAP_ANON 0
4365 #endif
4366 #endif
4368 #ifndef MAP_FAILED
4369 #define MAP_FAILED ((void *) -1)
4370 #endif
4372 #include <stdio.h>
4373 #include <errno.h>
4375 #if MAP_ANON == 0
4376 #include <fcntl.h>
4377 #endif
4379 #include "coding.h"
4382 /* Memory is allocated in regions which are mapped using mmap(2).
4383 The current implementation lets the system select mapped
4384 addresses; we're not using MAP_FIXED in general, except when
4385 trying to enlarge regions.
4387 Each mapped region starts with a mmap_region structure, the user
4388 area starts after that structure, aligned to MEM_ALIGN.
4390 +-----------------------+
4391 | struct mmap_info + |
4392 | padding |
4393 +-----------------------+
4394 | user data |
4397 +-----------------------+ */
4399 struct mmap_region
4401 /* User-specified size. */
4402 size_t nbytes_specified;
4404 /* Number of bytes mapped */
4405 size_t nbytes_mapped;
4407 /* Pointer to the location holding the address of the memory
4408 allocated with the mmap'd block. The variable actually points
4409 after this structure. */
4410 POINTER_TYPE **var;
4412 /* Next and previous in list of all mmap'd regions. */
4413 struct mmap_region *next, *prev;
4416 /* Doubly-linked list of mmap'd regions. */
4418 static struct mmap_region *mmap_regions;
4420 /* File descriptor for mmap. If we don't have anonymous mapping,
4421 /dev/zero will be opened on it. */
4423 static int mmap_fd;
4425 /* Temporary storage for mmap_set_vars, see there. */
4427 static struct mmap_region *mmap_regions_1;
4428 static int mmap_fd_1;
4430 /* Page size on this system. */
4432 static int mmap_page_size;
4434 /* 1 means mmap has been intialized. */
4436 static int mmap_initialized_p;
4438 /* Value is X rounded up to the next multiple of N. */
4440 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4442 /* Size of mmap_region structure plus padding. */
4444 #define MMAP_REGION_STRUCT_SIZE \
4445 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4447 /* Given a pointer P to the start of the user-visible part of a mapped
4448 region, return a pointer to the start of the region. */
4450 #define MMAP_REGION(P) \
4451 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4453 /* Given a pointer P to the start of a mapped region, return a pointer
4454 to the start of the user-visible part of the region. */
4456 #define MMAP_USER_AREA(P) \
4457 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4459 #define MEM_ALIGN sizeof (double)
4461 /* Predicate returning true if part of the address range [START .. END]
4462 is currently mapped. Used to prevent overwriting an existing
4463 memory mapping.
4465 Default is to conservativly assume the address range is occupied by
4466 something else. This can be overridden by system configuration
4467 files if system-specific means to determine this exists. */
4469 #ifndef MMAP_ALLOCATED_P
4470 #define MMAP_ALLOCATED_P(start, end) 1
4471 #endif
4473 /* Function prototypes. */
4475 static int mmap_free_1 P_ ((struct mmap_region *));
4476 static int mmap_enlarge P_ ((struct mmap_region *, int));
4477 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4478 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4479 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4480 static void mmap_free P_ ((POINTER_TYPE **ptr));
4481 static void mmap_init P_ ((void));
4484 /* Return a region overlapping address range START...END, or null if
4485 none. END is not including, i.e. the last byte in the range
4486 is at END - 1. */
4488 static struct mmap_region *
4489 mmap_find (start, end)
4490 POINTER_TYPE *start, *end;
4492 struct mmap_region *r;
4493 char *s = (char *) start, *e = (char *) end;
4495 for (r = mmap_regions; r; r = r->next)
4497 char *rstart = (char *) r;
4498 char *rend = rstart + r->nbytes_mapped;
4500 if (/* First byte of range, i.e. START, in this region? */
4501 (s >= rstart && s < rend)
4502 /* Last byte of range, i.e. END - 1, in this region? */
4503 || (e > rstart && e <= rend)
4504 /* First byte of this region in the range? */
4505 || (rstart >= s && rstart < e)
4506 /* Last byte of this region in the range? */
4507 || (rend > s && rend <= e))
4508 break;
4511 return r;
4515 /* Unmap a region. P is a pointer to the start of the user-araa of
4516 the region. Value is non-zero if successful. */
4518 static int
4519 mmap_free_1 (r)
4520 struct mmap_region *r;
4522 if (r->next)
4523 r->next->prev = r->prev;
4524 if (r->prev)
4525 r->prev->next = r->next;
4526 else
4527 mmap_regions = r->next;
4529 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4531 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4532 return 0;
4535 return 1;
4539 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4540 Value is non-zero if successful. */
4542 static int
4543 mmap_enlarge (r, npages)
4544 struct mmap_region *r;
4545 int npages;
4547 char *region_end = (char *) r + r->nbytes_mapped;
4548 size_t nbytes;
4549 int success = 0;
4551 if (npages < 0)
4553 /* Unmap pages at the end of the region. */
4554 nbytes = - npages * mmap_page_size;
4555 if (munmap (region_end - nbytes, nbytes) == -1)
4556 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4557 else
4559 r->nbytes_mapped -= nbytes;
4560 success = 1;
4563 else if (npages > 0)
4565 nbytes = npages * mmap_page_size;
4567 /* Try to map additional pages at the end of the region. We
4568 cannot do this if the address range is already occupied by
4569 something else because mmap deletes any previous mapping.
4570 I'm not sure this is worth doing, let's see. */
4571 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4573 POINTER_TYPE *p;
4575 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4576 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4577 if (p == MAP_FAILED)
4578 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4579 else if (p != (POINTER_TYPE *) region_end)
4581 /* Kernels are free to choose a different address. In
4582 that case, unmap what we've mapped above; we have
4583 no use for it. */
4584 if (munmap (p, nbytes) == -1)
4585 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4587 else
4589 r->nbytes_mapped += nbytes;
4590 success = 1;
4595 return success;
4599 /* Set or reset variables holding references to mapped regions. If
4600 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4601 non-zero, set all variables to the start of the user-areas
4602 of mapped regions.
4604 This function is called from Fdump_emacs to ensure that the dumped
4605 Emacs doesn't contain references to memory that won't be mapped
4606 when Emacs starts. */
4608 void
4609 mmap_set_vars (restore_p)
4610 int restore_p;
4612 struct mmap_region *r;
4614 if (restore_p)
4616 mmap_regions = mmap_regions_1;
4617 mmap_fd = mmap_fd_1;
4618 for (r = mmap_regions; r; r = r->next)
4619 *r->var = MMAP_USER_AREA (r);
4621 else
4623 for (r = mmap_regions; r; r = r->next)
4624 *r->var = NULL;
4625 mmap_regions_1 = mmap_regions;
4626 mmap_regions = NULL;
4627 mmap_fd_1 = mmap_fd;
4628 mmap_fd = -1;
4633 /* Allocate a block of storage large enough to hold NBYTES bytes of
4634 data. A pointer to the data is returned in *VAR. VAR is thus the
4635 address of some variable which will use the data area.
4637 The allocation of 0 bytes is valid.
4639 If we can't allocate the necessary memory, set *VAR to null, and
4640 return null. */
4642 static POINTER_TYPE *
4643 mmap_alloc (var, nbytes)
4644 POINTER_TYPE **var;
4645 size_t nbytes;
4647 void *p;
4648 size_t map;
4650 mmap_init ();
4652 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4653 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4654 mmap_fd, 0);
4656 if (p == MAP_FAILED)
4658 if (errno != ENOMEM)
4659 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4660 p = NULL;
4662 else
4664 struct mmap_region *r = (struct mmap_region *) p;
4666 r->nbytes_specified = nbytes;
4667 r->nbytes_mapped = map;
4668 r->var = var;
4669 r->prev = NULL;
4670 r->next = mmap_regions;
4671 if (r->next)
4672 r->next->prev = r;
4673 mmap_regions = r;
4675 p = MMAP_USER_AREA (p);
4678 return *var = p;
4682 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4683 resize it to size NBYTES. Change *VAR to reflect the new block,
4684 and return this value. If more memory cannot be allocated, then
4685 leave *VAR unchanged, and return null. */
4687 static POINTER_TYPE *
4688 mmap_realloc (var, nbytes)
4689 POINTER_TYPE **var;
4690 size_t nbytes;
4692 POINTER_TYPE *result;
4694 mmap_init ();
4696 if (*var == NULL)
4697 result = mmap_alloc (var, nbytes);
4698 else if (nbytes == 0)
4700 mmap_free (var);
4701 result = mmap_alloc (var, nbytes);
4703 else
4705 struct mmap_region *r = MMAP_REGION (*var);
4706 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4708 if (room < nbytes)
4710 /* Must enlarge. */
4711 POINTER_TYPE *old_ptr = *var;
4713 /* Try to map additional pages at the end of the region.
4714 If that fails, allocate a new region, copy data
4715 from the old region, then free it. */
4716 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4717 / mmap_page_size)))
4719 r->nbytes_specified = nbytes;
4720 *var = result = old_ptr;
4722 else if (mmap_alloc (var, nbytes))
4724 bcopy (old_ptr, *var, r->nbytes_specified);
4725 mmap_free_1 (MMAP_REGION (old_ptr));
4726 result = *var;
4727 r = MMAP_REGION (result);
4728 r->nbytes_specified = nbytes;
4730 else
4732 *var = old_ptr;
4733 result = NULL;
4736 else if (room - nbytes >= mmap_page_size)
4738 /* Shrinking by at least a page. Let's give some
4739 memory back to the system.
4741 The extra parens are to make the division happens first,
4742 on positive values, so we know it will round towards
4743 zero. */
4744 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4745 result = *var;
4746 r->nbytes_specified = nbytes;
4748 else
4750 /* Leave it alone. */
4751 result = *var;
4752 r->nbytes_specified = nbytes;
4756 return result;
4760 /* Free a block of relocatable storage whose data is pointed to by
4761 PTR. Store 0 in *PTR to show there's no block allocated. */
4763 static void
4764 mmap_free (var)
4765 POINTER_TYPE **var;
4767 mmap_init ();
4769 if (*var)
4771 mmap_free_1 (MMAP_REGION (*var));
4772 *var = NULL;
4777 /* Perform necessary intializations for the use of mmap. */
4779 static void
4780 mmap_init ()
4782 #if MAP_ANON == 0
4783 /* The value of mmap_fd is initially 0 in temacs, and -1
4784 in a dumped Emacs. */
4785 if (mmap_fd <= 0)
4787 /* No anonymous mmap -- we need the file descriptor. */
4788 mmap_fd = open ("/dev/zero", O_RDONLY);
4789 if (mmap_fd == -1)
4790 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4792 #endif /* MAP_ANON == 0 */
4794 if (mmap_initialized_p)
4795 return;
4796 mmap_initialized_p = 1;
4798 #if MAP_ANON != 0
4799 mmap_fd = -1;
4800 #endif
4802 mmap_page_size = getpagesize ();
4805 #endif /* USE_MMAP_FOR_BUFFERS */
4809 /***********************************************************************
4810 Buffer-text Allocation
4811 ***********************************************************************/
4813 #ifdef REL_ALLOC
4814 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4815 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4816 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4817 #endif /* REL_ALLOC */
4820 /* Allocate NBYTES bytes for buffer B's text buffer. */
4822 static void
4823 alloc_buffer_text (b, nbytes)
4824 struct buffer *b;
4825 size_t nbytes;
4827 POINTER_TYPE *p;
4829 BLOCK_INPUT;
4830 #if defined USE_MMAP_FOR_BUFFERS
4831 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4832 #elif defined REL_ALLOC
4833 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4834 #else
4835 p = xmalloc (nbytes);
4836 #endif
4838 if (p == NULL)
4840 UNBLOCK_INPUT;
4841 memory_full ();
4844 b->text->beg = (unsigned char *) p;
4845 UNBLOCK_INPUT;
4848 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4849 shrink it. */
4851 void
4852 enlarge_buffer_text (b, delta)
4853 struct buffer *b;
4854 int delta;
4856 POINTER_TYPE *p;
4857 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4858 + delta);
4859 BLOCK_INPUT;
4860 #if defined USE_MMAP_FOR_BUFFERS
4861 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4862 #elif defined REL_ALLOC
4863 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4864 #else
4865 p = xrealloc (b->text->beg, nbytes);
4866 #endif
4868 if (p == NULL)
4870 UNBLOCK_INPUT;
4871 memory_full ();
4874 BUF_BEG_ADDR (b) = (unsigned char *) p;
4875 UNBLOCK_INPUT;
4879 /* Free buffer B's text buffer. */
4881 static void
4882 free_buffer_text (b)
4883 struct buffer *b;
4885 BLOCK_INPUT;
4887 #if defined USE_MMAP_FOR_BUFFERS
4888 mmap_free ((POINTER_TYPE **) &b->text->beg);
4889 #elif defined REL_ALLOC
4890 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4891 #else
4892 xfree (b->text->beg);
4893 #endif
4895 BUF_BEG_ADDR (b) = NULL;
4896 UNBLOCK_INPUT;
4901 /***********************************************************************
4902 Initialization
4903 ***********************************************************************/
4905 void
4906 init_buffer_once ()
4908 int idx;
4910 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4912 /* Make sure all markable slots in buffer_defaults
4913 are initialized reasonably, so mark_buffer won't choke. */
4914 reset_buffer (&buffer_defaults);
4915 reset_buffer_local_variables (&buffer_defaults, 1);
4916 reset_buffer (&buffer_local_symbols);
4917 reset_buffer_local_variables (&buffer_local_symbols, 1);
4918 /* Prevent GC from getting confused. */
4919 buffer_defaults.text = &buffer_defaults.own_text;
4920 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4921 BUF_INTERVALS (&buffer_defaults) = 0;
4922 BUF_INTERVALS (&buffer_local_symbols) = 0;
4923 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4924 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4926 /* Set up the default values of various buffer slots. */
4927 /* Must do these before making the first buffer! */
4929 /* real setup is done in bindings.el */
4930 buffer_defaults.mode_line_format = build_string ("%-");
4931 buffer_defaults.header_line_format = Qnil;
4932 buffer_defaults.abbrev_mode = Qnil;
4933 buffer_defaults.overwrite_mode = Qnil;
4934 buffer_defaults.case_fold_search = Qt;
4935 buffer_defaults.auto_fill_function = Qnil;
4936 buffer_defaults.selective_display = Qnil;
4937 #ifndef old
4938 buffer_defaults.selective_display_ellipses = Qt;
4939 #endif
4940 buffer_defaults.abbrev_table = Qnil;
4941 buffer_defaults.display_table = Qnil;
4942 buffer_defaults.undo_list = Qnil;
4943 buffer_defaults.mark_active = Qnil;
4944 buffer_defaults.file_format = Qnil;
4945 buffer_defaults.auto_save_file_format = Qt;
4946 buffer_defaults.overlays_before = NULL;
4947 buffer_defaults.overlays_after = NULL;
4948 buffer_defaults.overlay_center = BEG;
4950 XSETFASTINT (buffer_defaults.tab_width, 8);
4951 buffer_defaults.truncate_lines = Qnil;
4952 buffer_defaults.ctl_arrow = Qt;
4953 buffer_defaults.direction_reversed = Qnil;
4954 buffer_defaults.cursor_type = Qt;
4955 buffer_defaults.extra_line_spacing = Qnil;
4957 #ifdef DOS_NT
4958 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4959 #endif
4960 buffer_defaults.enable_multibyte_characters = Qt;
4961 buffer_defaults.buffer_file_coding_system = Qnil;
4962 XSETFASTINT (buffer_defaults.fill_column, 70);
4963 XSETFASTINT (buffer_defaults.left_margin, 0);
4964 buffer_defaults.cache_long_line_scans = Qnil;
4965 buffer_defaults.file_truename = Qnil;
4966 XSETFASTINT (buffer_defaults.display_count, 0);
4967 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
4968 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
4969 buffer_defaults.left_fringe_width = Qnil;
4970 buffer_defaults.right_fringe_width = Qnil;
4971 buffer_defaults.fringes_outside_margins = Qnil;
4972 buffer_defaults.scroll_bar_width = Qnil;
4973 buffer_defaults.vertical_scroll_bar_type = Qt;
4974 buffer_defaults.indicate_empty_lines = Qnil;
4975 buffer_defaults.indicate_buffer_boundaries = Qnil;
4976 buffer_defaults.scroll_up_aggressively = Qnil;
4977 buffer_defaults.scroll_down_aggressively = Qnil;
4978 buffer_defaults.display_time = Qnil;
4980 /* Assign the local-flags to the slots that have default values.
4981 The local flag is a bit that is used in the buffer
4982 to say that it has its own local value for the slot.
4983 The local flag bits are in the local_var_flags slot of the buffer. */
4985 /* Nothing can work if this isn't true */
4986 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4988 /* 0 means not a lisp var, -1 means always local, else mask */
4989 bzero (&buffer_local_flags, sizeof buffer_local_flags);
4990 XSETINT (buffer_local_flags.filename, -1);
4991 XSETINT (buffer_local_flags.directory, -1);
4992 XSETINT (buffer_local_flags.backed_up, -1);
4993 XSETINT (buffer_local_flags.save_length, -1);
4994 XSETINT (buffer_local_flags.auto_save_file_name, -1);
4995 XSETINT (buffer_local_flags.read_only, -1);
4996 XSETINT (buffer_local_flags.major_mode, -1);
4997 XSETINT (buffer_local_flags.mode_name, -1);
4998 XSETINT (buffer_local_flags.undo_list, -1);
4999 XSETINT (buffer_local_flags.mark_active, -1);
5000 XSETINT (buffer_local_flags.point_before_scroll, -1);
5001 XSETINT (buffer_local_flags.file_truename, -1);
5002 XSETINT (buffer_local_flags.invisibility_spec, -1);
5003 XSETINT (buffer_local_flags.file_format, -1);
5004 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5005 XSETINT (buffer_local_flags.display_count, -1);
5006 XSETINT (buffer_local_flags.display_time, -1);
5007 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5009 idx = 1;
5010 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5011 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5012 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5013 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5014 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5015 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5016 #ifndef old
5017 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5018 #endif
5019 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5020 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5021 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5022 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5023 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5024 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5025 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5026 #ifdef DOS_NT
5027 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5028 /* Make this one a permanent local. */
5029 buffer_permanent_local_flags[idx++] = 1;
5030 #endif
5031 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5032 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5033 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5034 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5035 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5036 /* Make this one a permanent local. */
5037 buffer_permanent_local_flags[idx++] = 1;
5038 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5039 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5040 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5041 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5042 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5043 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5044 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5045 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5046 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5047 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5048 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5049 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5050 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5051 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5053 /* Need more room? */
5054 if (idx >= MAX_PER_BUFFER_VARS)
5055 abort ();
5056 last_per_buffer_idx = idx;
5058 Vbuffer_alist = Qnil;
5059 current_buffer = 0;
5060 all_buffers = 0;
5062 QSFundamental = build_string ("Fundamental");
5064 Qfundamental_mode = intern ("fundamental-mode");
5065 buffer_defaults.major_mode = Qfundamental_mode;
5067 Qmode_class = intern ("mode-class");
5069 Qprotected_field = intern ("protected-field");
5071 Qpermanent_local = intern ("permanent-local");
5073 Qkill_buffer_hook = intern ("kill-buffer-hook");
5074 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5076 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5078 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5080 /* super-magic invisible buffer */
5081 Vbuffer_alist = Qnil;
5083 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5085 inhibit_modification_hooks = 0;
5088 void
5089 init_buffer ()
5091 char buf[MAXPATHLEN + 1];
5092 char *pwd;
5093 struct stat dotstat, pwdstat;
5094 Lisp_Object temp;
5095 int rc;
5097 #ifdef USE_MMAP_FOR_BUFFERS
5099 /* When using the ralloc implementation based on mmap(2), buffer
5100 text pointers will have been set to null in the dumped Emacs.
5101 Map new memory. */
5102 struct buffer *b;
5104 for (b = all_buffers; b; b = b->next)
5105 if (b->text->beg == NULL)
5106 enlarge_buffer_text (b, 0);
5108 #endif /* USE_MMAP_FOR_BUFFERS */
5110 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5111 if (NILP (buffer_defaults.enable_multibyte_characters))
5112 Fset_buffer_multibyte (Qnil);
5114 /* If PWD is accurate, use it instead of calling getwd. PWD is
5115 sometimes a nicer name, and using it may avoid a fatal error if a
5116 parent directory is searchable but not readable. */
5117 if ((pwd = getenv ("PWD")) != 0
5118 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5119 && stat (pwd, &pwdstat) == 0
5120 && stat (".", &dotstat) == 0
5121 && dotstat.st_ino == pwdstat.st_ino
5122 && dotstat.st_dev == pwdstat.st_dev
5123 && strlen (pwd) < MAXPATHLEN)
5124 strcpy (buf, pwd);
5125 #ifdef HAVE_GETCWD
5126 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5127 fatal ("`getcwd' failed: %s\n", strerror (errno));
5128 #else
5129 else if (getwd (buf) == 0)
5130 fatal ("`getwd' failed: %s\n", buf);
5131 #endif
5133 #ifndef VMS
5134 /* Maybe this should really use some standard subroutine
5135 whose definition is filename syntax dependent. */
5136 rc = strlen (buf);
5137 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5139 buf[rc] = DIRECTORY_SEP;
5140 buf[rc + 1] = '\0';
5142 #endif /* not VMS */
5144 current_buffer->directory = make_unibyte_string (buf, strlen (buf));
5145 if (! NILP (buffer_defaults.enable_multibyte_characters))
5146 /* At this momemnt, we still don't know how to decode the
5147 direcotry name. So, we keep the bytes in multibyte form so
5148 that ENCODE_FILE correctly gets the original bytes. */
5149 current_buffer->directory
5150 = string_to_multibyte (current_buffer->directory);
5152 /* Add /: to the front of the name
5153 if it would otherwise be treated as magic. */
5154 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5155 if (! NILP (temp)
5156 /* If the default dir is just /, TEMP is non-nil
5157 because of the ange-ftp completion handler.
5158 However, it is not necessary to turn / into /:/.
5159 So avoid doing that. */
5160 && strcmp ("/", SDATA (current_buffer->directory)))
5161 current_buffer->directory
5162 = concat2 (build_string ("/:"), current_buffer->directory);
5164 temp = get_minibuffer (0);
5165 XBUFFER (temp)->directory = current_buffer->directory;
5168 /* initialize the buffer routines */
5169 void
5170 syms_of_buffer ()
5172 staticpro (&last_overlay_modification_hooks);
5173 last_overlay_modification_hooks
5174 = Fmake_vector (make_number (10), Qnil);
5176 staticpro (&Vbuffer_defaults);
5177 staticpro (&Vbuffer_local_symbols);
5178 staticpro (&Qfundamental_mode);
5179 staticpro (&Qmode_class);
5180 staticpro (&QSFundamental);
5181 staticpro (&Vbuffer_alist);
5182 staticpro (&Qprotected_field);
5183 staticpro (&Qpermanent_local);
5184 staticpro (&Qkill_buffer_hook);
5185 Qoverlayp = intern ("overlayp");
5186 staticpro (&Qoverlayp);
5187 Qevaporate = intern ("evaporate");
5188 staticpro (&Qevaporate);
5189 Qmodification_hooks = intern ("modification-hooks");
5190 staticpro (&Qmodification_hooks);
5191 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5192 staticpro (&Qinsert_in_front_hooks);
5193 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5194 staticpro (&Qinsert_behind_hooks);
5195 Qget_file_buffer = intern ("get-file-buffer");
5196 staticpro (&Qget_file_buffer);
5197 Qpriority = intern ("priority");
5198 staticpro (&Qpriority);
5199 Qwindow = intern ("window");
5200 staticpro (&Qwindow);
5201 Qbefore_string = intern ("before-string");
5202 staticpro (&Qbefore_string);
5203 Qafter_string = intern ("after-string");
5204 staticpro (&Qafter_string);
5205 Qfirst_change_hook = intern ("first-change-hook");
5206 staticpro (&Qfirst_change_hook);
5207 Qbefore_change_functions = intern ("before-change-functions");
5208 staticpro (&Qbefore_change_functions);
5209 Qafter_change_functions = intern ("after-change-functions");
5210 staticpro (&Qafter_change_functions);
5211 staticpro (&Qucs_set_table_for_input);
5213 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5214 staticpro (&Qkill_buffer_query_functions);
5216 Fput (Qprotected_field, Qerror_conditions,
5217 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5218 Fput (Qprotected_field, Qerror_message,
5219 build_string ("Attempt to modify a protected field"));
5221 /* All these use DEFVAR_LISP_NOPRO because the slots in
5222 buffer_defaults will all be marked via Vbuffer_defaults. */
5224 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5225 &buffer_defaults.mode_line_format,
5226 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5227 This is the same as (default-value 'mode-line-format). */);
5229 DEFVAR_LISP_NOPRO ("default-header-line-format",
5230 &buffer_defaults.header_line_format,
5231 doc: /* Default value of `header-line-format' for buffers that don't override it.
5232 This is the same as (default-value 'header-line-format). */);
5234 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5235 doc: /* Default value of `cursor-type' for buffers that don't override it.
5236 This is the same as (default-value 'cursor-type). */);
5238 DEFVAR_LISP_NOPRO ("default-line-spacing",
5239 &buffer_defaults.extra_line_spacing,
5240 doc: /* Default value of `line-spacing' for buffers that don't override it.
5241 This is the same as (default-value 'line-spacing). */);
5243 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5244 &buffer_defaults.abbrev_mode,
5245 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5246 This is the same as (default-value 'abbrev-mode). */);
5248 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5249 &buffer_defaults.ctl_arrow,
5250 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5251 This is the same as (default-value 'ctl-arrow). */);
5253 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5254 &buffer_defaults.direction_reversed,
5255 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5256 This is the same as (default-value 'direction-reversed). */);
5258 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5259 &buffer_defaults.enable_multibyte_characters,
5260 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5261 This is the same as (default-value 'enable-multibyte-characters). */);
5263 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5264 &buffer_defaults.buffer_file_coding_system,
5265 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5266 This is the same as (default-value 'buffer-file-coding-system). */);
5268 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5269 &buffer_defaults.truncate_lines,
5270 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5271 This is the same as (default-value 'truncate-lines). */);
5273 DEFVAR_LISP_NOPRO ("default-fill-column",
5274 &buffer_defaults.fill_column,
5275 doc: /* Default value of `fill-column' for buffers that do not override it.
5276 This is the same as (default-value 'fill-column). */);
5278 DEFVAR_LISP_NOPRO ("default-left-margin",
5279 &buffer_defaults.left_margin,
5280 doc: /* Default value of `left-margin' for buffers that do not override it.
5281 This is the same as (default-value 'left-margin). */);
5283 DEFVAR_LISP_NOPRO ("default-tab-width",
5284 &buffer_defaults.tab_width,
5285 doc: /* Default value of `tab-width' for buffers that do not override it.
5286 This is the same as (default-value 'tab-width). */);
5288 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5289 &buffer_defaults.case_fold_search,
5290 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5291 This is the same as (default-value 'case-fold-search). */);
5293 #ifdef DOS_NT
5294 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5295 &buffer_defaults.buffer_file_type,
5296 doc: /* Default file type for buffers that do not override it.
5297 This is the same as (default-value 'buffer-file-type).
5298 The file type is nil for text, t for binary. */);
5299 #endif
5301 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5302 &buffer_defaults.left_margin_cols,
5303 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5304 This is the same as (default-value 'left-margin-width). */);
5306 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5307 &buffer_defaults.right_margin_cols,
5308 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5309 This is the same as (default-value 'right-margin-width). */);
5311 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5312 &buffer_defaults.left_fringe_width,
5313 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5314 This is the same as (default-value 'left-fringe-width). */);
5316 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5317 &buffer_defaults.right_fringe_width,
5318 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5319 This is the same as (default-value 'right-fringe-width). */);
5321 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5322 &buffer_defaults.fringes_outside_margins,
5323 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5324 This is the same as (default-value 'fringes-outside-margins). */);
5326 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5327 &buffer_defaults.scroll_bar_width,
5328 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5329 This is the same as (default-value 'scroll-bar-width). */);
5331 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5332 &buffer_defaults.vertical_scroll_bar_type,
5333 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5334 This is the same as (default-value 'vertical-scroll-bar). */);
5336 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5337 &buffer_defaults.indicate_empty_lines,
5338 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5339 This is the same as (default-value 'indicate-empty-lines). */);
5341 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5342 &buffer_defaults.indicate_buffer_boundaries,
5343 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5344 This is the same as (default-value 'indicate-buffer-boundaries). */);
5346 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5347 &buffer_defaults.scroll_up_aggressively,
5348 doc: /* Default value of `scroll-up-aggressively'.
5349 This value applies in buffers that don't have their own local values.
5350 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5352 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5353 &buffer_defaults.scroll_down_aggressively,
5354 doc: /* Default value of `scroll-down-aggressively'.
5355 This value applies in buffers that don't have their own local values.
5356 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5358 DEFVAR_PER_BUFFER ("header-line-format",
5359 &current_buffer->header_line_format,
5360 Qnil,
5361 doc: /* Analogous to `mode-line-format', but controls the header line.
5362 The header line appears, optionally, at the top of a window;
5363 the mode line appears at the bottom. */);
5365 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5366 Qnil,
5367 doc: /* Template for displaying mode line for current buffer.
5368 Each buffer has its own value of this variable.
5369 Value may be nil, a string, a symbol or a list or cons cell.
5370 A value of nil means don't display a mode line.
5371 For a symbol, its value is used (but it is ignored if t or nil).
5372 A string appearing directly as the value of a symbol is processed verbatim
5373 in that the %-constructs below are not recognized.
5374 Note that unless the symbol is marked as a `risky-local-variable', all
5375 properties in any strings, as well as all :eval and :propertize forms
5376 in the value of that symbol will be ignored.
5377 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5378 is used as a mode line element. Be careful--FORM should not load any files,
5379 because that can cause an infinite recursion.
5380 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5381 with the specified properties PROPS applied.
5382 For a list whose car is a symbol, the symbol's value is taken,
5383 and if that is non-nil, the cadr of the list is processed recursively.
5384 Otherwise, the caddr of the list (if there is one) is processed.
5385 For a list whose car is a string or list, each element is processed
5386 recursively and the results are effectively concatenated.
5387 For a list whose car is an integer, the cdr of the list is processed
5388 and padded (if the number is positive) or truncated (if negative)
5389 to the width specified by that number.
5390 A string is printed verbatim in the mode line except for %-constructs:
5391 (%-constructs are allowed when the string is the entire mode-line-format
5392 or when it is found in a cons-cell or a list)
5393 %b -- print buffer name. %f -- print visited file name.
5394 %F -- print frame name.
5395 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5396 %& is like %*, but ignore read-only-ness.
5397 % means buffer is read-only and * means it is modified.
5398 For a modified read-only buffer, %* gives % and %+ gives *.
5399 %s -- print process status. %l -- print the current line number.
5400 %c -- print the current column number (this makes editing slower).
5401 To make the column number update correctly in all cases,
5402 `column-number-mode' must be non-nil.
5403 %i -- print the size of the buffer.
5404 %I -- like %i, but use k, M, G, etc., to abbreviate.
5405 %p -- print percent of buffer above top of window, or Top, Bot or All.
5406 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5407 or print Bottom or All.
5408 %m -- print the mode name.
5409 %n -- print Narrow if appropriate.
5410 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5411 %Z -- like %z, but including the end-of-line format.
5412 %[ -- print one [ for each recursive editing level. %] similar.
5413 %% -- print %. %- -- print infinitely many dashes.
5414 Decimal digits after the % specify field width to which to pad. */);
5416 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5417 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5418 nil here means use current buffer's major mode, provided it is not
5419 marked as "special".
5421 When a mode is used by default, `find-file' switches to it
5422 before it reads the contents into the buffer and before
5423 it finishes setting up the buffer. Thus, the mode and
5424 its hooks should not expect certain variables such as
5425 `buffer-read-only' and `buffer-file-coding-system' to be set up. */);
5427 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5428 make_number (Lisp_Symbol),
5429 doc: /* Symbol for current buffer's major mode. */);
5431 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5432 Qnil,
5433 doc: /* Pretty name of current buffer's major mode (a string). */);
5435 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5436 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5438 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5439 Qnil,
5440 doc: /* *Non-nil if searches and matches should ignore case. */);
5442 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5443 make_number (Lisp_Int),
5444 doc: /* *Column beyond which automatic line-wrapping should happen.
5445 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5447 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5448 make_number (Lisp_Int),
5449 doc: /* *Column for the default indent-line-function to indent to.
5450 Linefeed indents to this column in Fundamental mode. */);
5452 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5453 make_number (Lisp_Int),
5454 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5456 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5457 doc: /* *Non-nil means display control chars with uparrow.
5458 A value of nil means use backslash and octal digits.
5459 This variable does not apply to characters whose display is specified
5460 in the current display table (if there is one). */);
5462 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5463 &current_buffer->enable_multibyte_characters,
5464 Qnil,
5465 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5466 Otherwise they are regarded as unibyte. This affects the display,
5467 file I/O and the behavior of various editing commands.
5469 This variable is buffer-local but you cannot set it directly;
5470 use the function `set-buffer-multibyte' to change a buffer's representation.
5471 Changing its default value with `setq-default' is supported.
5472 See also variable `default-enable-multibyte-characters' and Info node
5473 `(elisp)Text Representations'. */);
5474 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5476 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5477 &current_buffer->buffer_file_coding_system, Qnil,
5478 doc: /* Coding system to be used for encoding the buffer contents on saving.
5479 This variable applies to saving the buffer, and also to `write-region'
5480 and other functions that use `write-region'.
5481 It does not apply to sending output to subprocesses, however.
5483 If this is nil, the buffer is saved without any code conversion
5484 unless some coding system is specified in `file-coding-system-alist'
5485 for the buffer file.
5487 If the text to be saved cannot be encoded as specified by this variable,
5488 an alternative encoding is selected by `select-safe-coding-system', which see.
5490 The variable `coding-system-for-write', if non-nil, overrides this variable.
5492 This variable is never applied to a way of decoding a file while reading it. */);
5494 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5495 Qnil,
5496 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5498 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5499 doc: /* *Non-nil means do not display continuation lines.
5500 Instead, give each line of text just one screen line.
5502 Note that this is overridden by the variable
5503 `truncate-partial-width-windows' if that variable is non-nil
5504 and this buffer is not full-frame width. */);
5506 #ifdef DOS_NT
5507 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5508 Qnil,
5509 doc: /* Non-nil if the visited file is a binary file.
5510 This variable is meaningful on MS-DOG and Windows NT.
5511 On those systems, it is automatically local in every buffer.
5512 On other systems, this variable is normally always nil. */);
5513 #endif
5515 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5516 make_number (Lisp_String),
5517 doc: /* Name of default directory of current buffer. Should end with slash.
5518 To interactively change the default directory, use command `cd'. */);
5520 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5521 Qnil,
5522 doc: /* Function called (if non-nil) to perform auto-fill.
5523 It is called after self-inserting any character specified in
5524 the `auto-fill-chars' table.
5525 NOTE: This variable is not a hook;
5526 its value may not be a list of functions. */);
5528 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5529 make_number (Lisp_String),
5530 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5532 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5533 make_number (Lisp_String),
5534 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5535 The truename of a file is calculated by `file-truename'
5536 and then abbreviated with `abbreviate-file-name'. */);
5538 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5539 &current_buffer->auto_save_file_name,
5540 make_number (Lisp_String),
5541 doc: /* Name of file for auto-saving current buffer.
5542 If it is nil, that means don't auto-save this buffer. */);
5544 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5545 doc: /* Non-nil if this buffer is read-only. */);
5547 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5548 doc: /* Non-nil if this buffer's file has been backed up.
5549 Backing up is done before the first time the file is saved. */);
5551 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5552 make_number (Lisp_Int),
5553 doc: /* Length of current buffer when last read in, saved or auto-saved.
5554 0 initially. */);
5556 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5557 Qnil,
5558 doc: /* Non-nil enables selective display.
5559 An Integer N as value means display only lines
5560 that start with less than n columns of space.
5561 A value of t means that the character ^M makes itself and
5562 all the rest of the line invisible; also, when saving the buffer
5563 in a file, save the ^M as a newline. */);
5565 #ifndef old
5566 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5567 &current_buffer->selective_display_ellipses,
5568 Qnil,
5569 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5570 #endif
5572 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5573 doc: /* Non-nil if self-insertion should replace existing text.
5574 The value should be one of `overwrite-mode-textual',
5575 `overwrite-mode-binary', or nil.
5576 If it is `overwrite-mode-textual', self-insertion still
5577 inserts at the end of a line, and inserts when point is before a tab,
5578 until the tab is filled in.
5579 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5581 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5582 Qnil,
5583 doc: /* Display table that controls display of the contents of current buffer.
5585 If this variable is nil, the value of `standard-display-table' is used.
5586 Each window can have its own, overriding display table, see
5587 `set-window-display-table' and `window-display-table'.
5589 The display table is a char-table created with `make-display-table'.
5590 A char-table is an array indexed by character codes. Normal array
5591 primitives `aref' and `aset' can be used to access elements of a char-table.
5593 Each of the char-table elements control how to display the corresponding
5594 text character: the element at index C in the table says how to display
5595 the character whose code is C. Each element should be a vector of
5596 characters or nil. nil means display the character in the default fashion;
5597 otherwise, the characters from the vector are delivered to the screen
5598 instead of the original character.
5600 For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5601 a capital Y instead of each X character.
5603 In addition, a char-table has six extra slots to control the display of:
5605 the end of a truncated screen line (extra-slot 0, a single character);
5606 the end of a continued line (extra-slot 1, a single character);
5607 the escape character used to display character codes in octal
5608 (extra-slot 2, a single character);
5609 the character used as an arrow for control characters (extra-slot 3,
5610 a single character);
5611 the decoration indicating the presence of invisible lines (extra-slot 4,
5612 a vector of characters);
5613 the character used to draw the border between side-by-side windows
5614 (extra-slot 5, a single character).
5616 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5618 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5619 Qnil,
5620 doc: /* *Width of left marginal area for display of a buffer.
5621 A value of nil means no marginal area. */);
5623 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5624 Qnil,
5625 doc: /* *Width of right marginal area for display of a buffer.
5626 A value of nil means no marginal area. */);
5628 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5629 Qnil,
5630 doc: /* *Width of this buffer's left fringe (in pixels).
5631 A value of 0 means no left fringe is shown in this buffer's window.
5632 A value of nil means to use the left fringe width from the window's frame. */);
5634 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5635 Qnil,
5636 doc: /* *Width of this buffer's right fringe (in pixels).
5637 A value of 0 means no right fringe is shown in this buffer's window.
5638 A value of nil means to use the right fringe width from the window's frame. */);
5640 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5641 Qnil,
5642 doc: /* *Non-nil means to display fringes outside display margins.
5643 A value of nil means to display fringes between margins and buffer text. */);
5645 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5646 Qnil,
5647 doc: /* *Width of this buffer's scroll bars in pixels.
5648 A value of nil means to use the scroll bar width from the window's frame. */);
5650 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5651 Qnil,
5652 doc: /* *Position of this buffer's vertical scroll bar.
5653 The value takes effect whenever you tell a window to display this buffer;
5654 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5656 A value of `left' or `right' means put the vertical scroll bar at that side
5657 of the window; a value of nil means don't show any vertical scroll bars.
5658 A value of t (the default) means do whatever the window's frame specifies. */);
5660 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5661 &current_buffer->indicate_empty_lines, Qnil,
5662 doc: /* *Visually indicate empty lines after the buffer end.
5663 If non-nil, a bitmap is displayed in the left fringe of a window on
5664 window-systems. */);
5666 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5667 &current_buffer->indicate_buffer_boundaries, Qnil,
5668 doc: /* *Visually indicate buffer boundaries and scrolling.
5669 If non-nil, the first and last line of the buffer are marked in the fringe
5670 of a window on window-systems with angle bitmaps, or if the window can be
5671 scrolled, the top and bottom line of the window are marked with up and down
5672 arrow bitmaps.
5674 If value is a symbol `left' or `right', both angle and arrow bitmaps
5675 are displayed in the left or right fringe, resp. Any other value
5676 that doesn't look like an alist means displat the angle bitmaps in
5677 the left fringe but no arrows.
5679 You can exercise more precise control by using an alist as the
5680 value. Each alist element (INDICATOR . POSITION) specifies
5681 where to show one of the indicators. INDICATOR is one of `top',
5682 `bottom', `up', `down', or t, which specifies the default position,
5683 and POSITION is one of `left', `right', or nil, meaning do not show
5684 this indicator.
5686 For example, ((top . left) (t . right)) places the top angle bitmap in
5687 left fringe, the bottom angle bitmap in right fringe, and both arrow
5688 bitmaps in right fringe. To show just the angle bitmaps in the left
5689 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5691 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5692 &current_buffer->scroll_up_aggressively, Qnil,
5693 doc: /* How far to scroll windows upward.
5694 If you move point off the bottom, the window scrolls automatically.
5695 This variable controls how far it scrolls. nil, the default,
5696 means scroll to center point. A fraction means scroll to put point
5697 that fraction of the window's height from the bottom of the window.
5698 When the value is 0.0, point goes at the bottom line, which in the simple
5699 case that you moved off with C-f means scrolling just one line. 1.0 means
5700 point goes at the top, so that in that simple case, the window
5701 window scrolls by a full window height. Meaningful values are
5702 between 0.0 and 1.0, inclusive. */);
5704 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5705 &current_buffer->scroll_down_aggressively, Qnil,
5706 doc: /* How far to scroll windows downward.
5707 If you move point off the top, the window scrolls automatically.
5708 This variable controls how far it scrolls. nil, the default,
5709 means scroll to center point. A fraction means scroll to put point
5710 that fraction of the window's height from the top of the window.
5711 When the value is 0.0, point goes at the top line, which in the simple
5712 case that you moved off with C-b means scrolling just one line. 1.0 means
5713 point goes at the bottom, so that in that simple case, the window
5714 window scrolls by a full window height. Meaningful values are
5715 between 0.0 and 1.0, inclusive. */);
5717 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5718 "Don't ask.");
5721 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5722 doc: /* List of functions to call before each text change.
5723 Two arguments are passed to each function: the positions of
5724 the beginning and end of the range of old text to be changed.
5725 \(For an insertion, the beginning and end are at the same place.)
5726 No information is given about the length of the text after the change.
5728 Buffer changes made while executing the `before-change-functions'
5729 don't call any before-change or after-change functions.
5730 That's because these variables are temporarily set to nil.
5731 As a result, a hook function cannot straightforwardly alter the value of
5732 these variables. See the Emacs Lisp manual for a way of
5733 accomplishing an equivalent result by using other variables.
5735 If an unhandled error happens in running these functions,
5736 the variable's value remains nil. That prevents the error
5737 from happening repeatedly and making Emacs nonfunctional. */);
5738 Vbefore_change_functions = Qnil;
5740 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5741 doc: /* List of functions to call after each text change.
5742 Three arguments are passed to each function: the positions of
5743 the beginning and end of the range of changed text,
5744 and the length in bytes of the pre-change text replaced by that range.
5745 \(For an insertion, the pre-change length is zero;
5746 for a deletion, that length is the number of bytes deleted,
5747 and the post-change beginning and end are at the same place.)
5749 Buffer changes made while executing the `after-change-functions'
5750 don't call any before-change or after-change functions.
5751 That's because these variables are temporarily set to nil.
5752 As a result, a hook function cannot straightforwardly alter the value of
5753 these variables. See the Emacs Lisp manual for a way of
5754 accomplishing an equivalent result by using other variables.
5756 If an unhandled error happens in running these functions,
5757 the variable's value remains nil. That prevents the error
5758 from happening repeatedly and making Emacs nonfunctional. */);
5759 Vafter_change_functions = Qnil;
5761 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5762 doc: /* A list of functions to call before changing a buffer which is unmodified.
5763 The functions are run using the `run-hooks' function. */);
5764 Vfirst_change_hook = Qnil;
5766 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5767 doc: /* List of undo entries in current buffer.
5768 Recent changes come first; older changes follow newer.
5770 An entry (BEG . END) represents an insertion which begins at
5771 position BEG and ends at position END.
5773 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5774 from (abs POSITION). If POSITION is positive, point was at the front
5775 of the text being deleted; if negative, point was at the end.
5777 An entry (t HIGH . LOW) indicates that the buffer previously had
5778 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5779 of the visited file's modification time, as of that time. If the
5780 modification time of the most recent save is different, this entry is
5781 obsolete.
5783 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5784 was modified between BEG and END. PROPERTY is the property name,
5785 and VALUE is the old value.
5787 An entry (apply FUN-NAME . ARGS) means undo the change with
5788 \(apply FUN-NAME ARGS).
5790 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5791 in the active region. BEG and END is the range affected by this entry
5792 and DELTA is the number of bytes added or deleted in that range by
5793 this change.
5795 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5796 was adjusted in position by the offset DISTANCE (an integer).
5798 An entry of the form POSITION indicates that point was at the buffer
5799 location given by the integer. Undoing an entry of this form places
5800 point at POSITION.
5802 nil marks undo boundaries. The undo command treats the changes
5803 between two undo boundaries as a single step to be undone.
5805 If the value of the variable is t, undo information is not recorded. */);
5807 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5808 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5810 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5811 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5813 Normally, the line-motion functions work by scanning the buffer for
5814 newlines. Columnar operations (like `move-to-column' and
5815 `compute-motion') also work by scanning the buffer, summing character
5816 widths as they go. This works well for ordinary text, but if the
5817 buffer's lines are very long (say, more than 500 characters), these
5818 motion functions will take longer to execute. Emacs may also take
5819 longer to update the display.
5821 If `cache-long-line-scans' is non-nil, these motion functions cache the
5822 results of their scans, and consult the cache to avoid rescanning
5823 regions of the buffer until the text is modified. The caches are most
5824 beneficial when they prevent the most searching---that is, when the
5825 buffer contains long lines and large regions of characters with the
5826 same, fixed screen width.
5828 When `cache-long-line-scans' is non-nil, processing short lines will
5829 become slightly slower (because of the overhead of consulting the
5830 cache), and the caches will use memory roughly proportional to the
5831 number of newlines and characters whose screen width varies.
5833 The caches require no explicit maintenance; their accuracy is
5834 maintained internally by the Emacs primitives. Enabling or disabling
5835 the cache should not affect the behavior of any of the motion
5836 functions; it should only affect their performance. */);
5838 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5839 doc: /* Value of point before the last series of scroll operations, or nil. */);
5841 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5842 doc: /* List of formats to use when saving this buffer.
5843 Formats are defined by `format-alist'. This variable is
5844 set when a file is visited. */);
5846 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5847 &current_buffer->auto_save_file_format, Qnil,
5848 doc: /* *Format in which to write auto-save files.
5849 Should be a list of symbols naming formats that are defined in `format-alist'.
5850 If it is t, which is the default, auto-save files are written in the
5851 same format as a regular save would use. */);
5853 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5854 &current_buffer->invisibility_spec, Qnil,
5855 doc: /* Invisibility spec of this buffer.
5856 The default is t, which means that text is invisible
5857 if it has a non-nil `invisible' property.
5858 If the value is a list, a text character is invisible if its `invisible'
5859 property is an element in that list.
5860 If an element is a cons cell of the form (PROP . ELLIPSIS),
5861 then characters with property value PROP are invisible,
5862 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5864 DEFVAR_PER_BUFFER ("buffer-display-count",
5865 &current_buffer->display_count, Qnil,
5866 doc: /* A number incremented each time this buffer is displayed in a window.
5867 The function `set-window-buffer' increments it. */);
5869 DEFVAR_PER_BUFFER ("buffer-display-time",
5870 &current_buffer->display_time, Qnil,
5871 doc: /* Time stamp updated each time this buffer is displayed in a window.
5872 The function `set-window-buffer' updates this variable
5873 to the value obtained by calling `current-time'.
5874 If the buffer has never been shown in a window, the value is nil. */);
5876 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5877 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5878 Non-nil also enables highlighting of the region whenever the mark is active.
5879 The variable `highlight-nonselected-windows' controls whether to highlight
5880 all windows or just the selected window.
5882 If the value is `lambda', that enables Transient Mark mode temporarily
5883 until the next buffer modification. If a command sets the value to `only',
5884 that enables Transient Mark mode for the following command only.
5885 During that following command, the value of `transient-mark-mode'
5886 is `identity'. If it is still `identity' at the end of that command,
5887 it changes to nil. */);
5888 Vtransient_mark_mode = Qnil;
5890 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5891 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5892 If the value is t, disregard `buffer-read-only' and all `read-only'
5893 text properties. If the value is a list, disregard `buffer-read-only'
5894 and disregard a `read-only' text property if the property value
5895 is a member of the list. */);
5896 Vinhibit_read_only = Qnil;
5898 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5899 doc: /* Cursor to use when this buffer is in the selected window.
5900 Values are interpreted as follows:
5902 t use the cursor specified for the frame
5903 nil don't display a cursor
5904 box display a filled box cursor
5905 hollow display a hollow box cursor
5906 bar display a vertical bar cursor with default width
5907 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5908 hbar display a horizontal bar cursor with default width
5909 (hbar . WIDTH) display a horizontal bar cursor with width WIDTH
5910 ANYTHING ELSE display a hollow box cursor.
5912 When the buffer is displayed in a nonselected window,
5913 this variable has no effect; the cursor appears as a hollow box. */);
5915 DEFVAR_PER_BUFFER ("line-spacing",
5916 &current_buffer->extra_line_spacing, Qnil,
5917 doc: /* Additional space to put between lines when displaying a buffer.
5918 The space is measured in pixels, and put below lines on window systems.
5919 If value is a floating point number, it specifies the spacing relative
5920 to the default frame line height. */);
5922 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5923 doc: /* List of functions called with no args to query before killing a buffer. */);
5924 Vkill_buffer_query_functions = Qnil;
5926 defsubr (&Sbuffer_live_p);
5927 defsubr (&Sbuffer_list);
5928 defsubr (&Sget_buffer);
5929 defsubr (&Sget_file_buffer);
5930 defsubr (&Sget_buffer_create);
5931 defsubr (&Smake_indirect_buffer);
5932 defsubr (&Sgenerate_new_buffer_name);
5933 defsubr (&Sbuffer_name);
5934 /*defsubr (&Sbuffer_number);*/
5935 defsubr (&Sbuffer_file_name);
5936 defsubr (&Sbuffer_base_buffer);
5937 defsubr (&Sbuffer_local_value);
5938 defsubr (&Sbuffer_local_variables);
5939 defsubr (&Sbuffer_modified_p);
5940 defsubr (&Sset_buffer_modified_p);
5941 defsubr (&Sbuffer_modified_tick);
5942 defsubr (&Srename_buffer);
5943 defsubr (&Sother_buffer);
5944 defsubr (&Sbuffer_enable_undo);
5945 defsubr (&Skill_buffer);
5946 defsubr (&Sset_buffer_major_mode);
5947 defsubr (&Sswitch_to_buffer);
5948 defsubr (&Spop_to_buffer);
5949 defsubr (&Scurrent_buffer);
5950 defsubr (&Sset_buffer);
5951 defsubr (&Sbarf_if_buffer_read_only);
5952 defsubr (&Sbury_buffer);
5953 defsubr (&Serase_buffer);
5954 defsubr (&Sset_buffer_multibyte);
5955 defsubr (&Skill_all_local_variables);
5957 defsubr (&Soverlayp);
5958 defsubr (&Smake_overlay);
5959 defsubr (&Sdelete_overlay);
5960 defsubr (&Smove_overlay);
5961 defsubr (&Soverlay_start);
5962 defsubr (&Soverlay_end);
5963 defsubr (&Soverlay_buffer);
5964 defsubr (&Soverlay_properties);
5965 defsubr (&Soverlays_at);
5966 defsubr (&Soverlays_in);
5967 defsubr (&Snext_overlay_change);
5968 defsubr (&Sprevious_overlay_change);
5969 defsubr (&Soverlay_recenter);
5970 defsubr (&Soverlay_lists);
5971 defsubr (&Soverlay_get);
5972 defsubr (&Soverlay_put);
5973 defsubr (&Srestore_buffer_modified_p);
5976 void
5977 keys_of_buffer ()
5979 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5980 initial_define_key (control_x_map, 'k', "kill-buffer");
5982 /* This must not be in syms_of_buffer, because Qdisabled is not
5983 initialized when that function gets called. */
5984 Fput (intern ("erase-buffer"), Qdisabled, Qt);
5987 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
5988 (do not change this comment) */