(language-info-custom-alist): New.
[emacs.git] / src / buffer.c
blob6b9c2ca046c06b0ffaa625273cd675daa363597c
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985,86,87,88,89,93,94,95,97,98, 1999, 2000, 2001, 2002
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <sys/param.h>
27 #include <errno.h>
28 #include <stdio.h>
30 #ifndef USE_CRT_DLL
31 extern int errno;
32 #endif
34 #ifndef MAXPATHLEN
35 /* in 4.1, param.h fails to define this. */
36 #define MAXPATHLEN 1024
37 #endif /* not MAXPATHLEN */
39 #ifdef HAVE_UNISTD_H
40 #include <unistd.h>
41 #endif
43 #include "lisp.h"
44 #include "intervals.h"
45 #include "window.h"
46 #include "commands.h"
47 #include "buffer.h"
48 #include "character.h"
49 #include "region-cache.h"
50 #include "indent.h"
51 #include "blockinput.h"
52 #include "keyboard.h"
53 #include "keymap.h"
54 #include "frame.h"
56 struct buffer *current_buffer; /* the current buffer */
58 /* First buffer in chain of all buffers (in reverse order of creation).
59 Threaded through ->next. */
61 struct buffer *all_buffers;
63 /* This structure holds the default values of the buffer-local variables
64 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
65 The default value occupies the same slot in this structure
66 as an individual buffer's value occupies in that buffer.
67 Setting the default value also goes through the alist of buffers
68 and stores into each buffer that does not say it has a local value. */
70 struct buffer buffer_defaults;
72 /* A Lisp_Object pointer to the above, used for staticpro */
74 static Lisp_Object Vbuffer_defaults;
76 /* This structure marks which slots in a buffer have corresponding
77 default values in buffer_defaults.
78 Each such slot has a nonzero value in this structure.
79 The value has only one nonzero bit.
81 When a buffer has its own local value for a slot,
82 the entry for that slot (found in the same slot in this structure)
83 is turned on in the buffer's local_flags array.
85 If a slot in this structure is -1, then even though there may
86 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
87 and the corresponding slot in buffer_defaults is not used.
89 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
90 but there is a default value which is copied into each buffer.
92 If a slot in this structure is negative, then even though there may
93 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
94 and the corresponding slot in buffer_defaults is not used.
96 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
97 zero, that is a bug */
99 struct buffer buffer_local_flags;
101 /* This structure holds the names of symbols whose values may be
102 buffer-local. It is indexed and accessed in the same way as the above. */
104 struct buffer buffer_local_symbols;
105 /* A Lisp_Object pointer to the above, used for staticpro */
106 static Lisp_Object Vbuffer_local_symbols;
108 /* This structure holds the required types for the values in the
109 buffer-local slots. If a slot contains Qnil, then the
110 corresponding buffer slot may contain a value of any type. If a
111 slot contains an integer, then prospective values' tags must be
112 equal to that integer (except nil is always allowed).
113 When a tag does not match, the function
114 buffer_slot_type_mismatch will signal an error.
116 If a slot here contains -1, the corresponding variable is read-only. */
117 struct buffer buffer_local_types;
119 /* Flags indicating which built-in buffer-local variables
120 are permanent locals. */
121 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
123 /* Number of per-buffer variables used. */
125 int last_per_buffer_idx;
127 Lisp_Object Fset_buffer ();
128 void set_buffer_internal ();
129 void set_buffer_internal_1 ();
130 static void call_overlay_mod_hooks ();
131 static void swap_out_buffer_local_variables ();
132 static void reset_buffer_local_variables ();
134 /* Alist of all buffer names vs the buffers. */
135 /* This used to be a variable, but is no longer,
136 to prevent lossage due to user rplac'ing this alist or its elements. */
137 Lisp_Object Vbuffer_alist;
139 /* Functions to call before and after each text change. */
140 Lisp_Object Vbefore_change_functions;
141 Lisp_Object Vafter_change_functions;
143 Lisp_Object Vtransient_mark_mode;
145 /* t means ignore all read-only text properties.
146 A list means ignore such a property if its value is a member of the list.
147 Any non-nil value means ignore buffer-read-only. */
148 Lisp_Object Vinhibit_read_only;
150 /* List of functions to call that can query about killing a buffer.
151 If any of these functions returns nil, we don't kill it. */
152 Lisp_Object Vkill_buffer_query_functions;
154 /* List of functions to call before changing an unmodified buffer. */
155 Lisp_Object Vfirst_change_hook;
157 Lisp_Object Qfirst_change_hook;
158 Lisp_Object Qbefore_change_functions;
159 Lisp_Object Qafter_change_functions;
161 /* If nonzero, all modification hooks are suppressed. */
162 int inhibit_modification_hooks;
164 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
166 Lisp_Object Qprotected_field;
168 Lisp_Object QSFundamental; /* A string "Fundamental" */
170 Lisp_Object Qkill_buffer_hook;
172 Lisp_Object Qget_file_buffer;
174 Lisp_Object Qoverlayp;
176 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
178 Lisp_Object Qmodification_hooks;
179 Lisp_Object Qinsert_in_front_hooks;
180 Lisp_Object Qinsert_behind_hooks;
182 static void alloc_buffer_text P_ ((struct buffer *, size_t));
183 static void free_buffer_text P_ ((struct buffer *b));
184 static Lisp_Object copy_overlays P_ ((struct buffer *, Lisp_Object));
185 static void modify_overlay P_ ((struct buffer *, int, int));
187 extern char * emacs_strerror P_ ((int));
189 /* For debugging; temporary. See set_buffer_internal. */
190 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
192 void
193 nsberror (spec)
194 Lisp_Object spec;
196 if (STRINGP (spec))
197 error ("No buffer named %s", XSTRING (spec)->data);
198 error ("Invalid buffer argument");
201 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
202 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
203 Value is nil if OBJECT is not a buffer or if it has been killed. */)
204 (object)
205 Lisp_Object object;
207 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
208 ? Qt : Qnil);
211 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
212 doc: /* Return a list of all existing live buffers.
213 If the optional arg FRAME is a frame, we return that frame's buffer list. */)
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; !NILP (tail); tail = Fcdr (tail))
253 register Lisp_Object elt, tem;
254 elt = Fcar (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 (XSTRING (name)->size == 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) = 1;
366 BUF_GPT (b) = 1;
367 BUF_BEGV (b) = 1;
368 BUF_ZV (b) = 1;
369 BUF_Z (b) = 1;
370 BUF_PT_BYTE (b) = 1;
371 BUF_GPT_BYTE (b) = 1;
372 BUF_BEGV_BYTE (b) = 1;
373 BUF_ZV_BYTE (b) = 1;
374 BUF_Z_BYTE (b) = 1;
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 XSTRING (name)->intervals = NULL_INTERVAL;
402 b->name = name;
404 if (XSTRING (name)->data[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 /* Put this in the alist of all live buffers. */
413 XSETBUFFER (buf, b);
414 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
416 b->mark = Fmake_marker ();
417 BUF_MARKERS (b) = Qnil;
418 b->name = name;
419 return buf;
423 /* Return a list of overlays which is a copy of the overlay list
424 LIST, but for buffer B. */
426 static Lisp_Object
427 copy_overlays (b, list)
428 struct buffer *b;
429 Lisp_Object list;
431 Lisp_Object result, buffer;
433 XSETBUFFER (buffer, b);
435 for (result = Qnil; CONSP (list); list = XCDR (list))
437 Lisp_Object overlay, start, end, old_overlay;
438 int charpos;
440 old_overlay = XCAR (list);
441 charpos = marker_position (OVERLAY_START (old_overlay));
442 start = Fmake_marker ();
443 Fset_marker (start, make_number (charpos), buffer);
444 XMARKER (start)->insertion_type
445 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
447 charpos = marker_position (OVERLAY_END (old_overlay));
448 end = Fmake_marker ();
449 Fset_marker (end, make_number (charpos), buffer);
450 XMARKER (end)->insertion_type
451 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
453 overlay = allocate_misc ();
454 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
455 OVERLAY_START (overlay) = start;
456 OVERLAY_END (overlay) = end;
457 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
459 result = Fcons (overlay, result);
462 return Fnreverse (result);
466 /* Clone per-buffer values of buffer FROM.
468 Buffer TO gets the same per-buffer values as FROM, with the
469 following exceptions: (1) TO's name is left untouched, (2) markers
470 are copied and made to refer to TO, and (3) overlay lists are
471 copied. */
473 static void
474 clone_per_buffer_values (from, to)
475 struct buffer *from, *to;
477 Lisp_Object to_buffer;
478 int offset;
480 XSETBUFFER (to_buffer, to);
482 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
483 offset < sizeof *to;
484 offset += sizeof (Lisp_Object))
486 Lisp_Object obj;
488 obj = PER_BUFFER_VALUE (from, offset);
489 if (MARKERP (obj))
491 struct Lisp_Marker *m = XMARKER (obj);
492 obj = Fmake_marker ();
493 XMARKER (obj)->insertion_type = m->insertion_type;
494 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
497 PER_BUFFER_VALUE (to, offset) = obj;
500 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
502 to->overlays_before = copy_overlays (to, from->overlays_before);
503 to->overlays_after = copy_overlays (to, from->overlays_after);
507 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
508 2, 3,
509 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
510 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
511 BASE-BUFFER should be an existing buffer (or buffer name).
512 NAME should be a string which is not the name of an existing buffer.
513 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
514 such as major and minor modes, in the indirect buffer.
515 CLONE nil means the indirect buffer's state is reset to default values. */)
516 (base_buffer, name, clone)
517 Lisp_Object base_buffer, name, clone;
519 Lisp_Object buf;
520 struct buffer *b;
522 buf = Fget_buffer (name);
523 if (!NILP (buf))
524 error ("Buffer name `%s' is in use", XSTRING (name)->data);
526 base_buffer = Fget_buffer (base_buffer);
527 if (NILP (base_buffer))
528 error ("No such buffer: `%s'", XSTRING (name)->data);
530 if (XSTRING (name)->size == 0)
531 error ("Empty string for buffer name is not allowed");
533 b = (struct buffer *) allocate_buffer ();
534 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
536 if (XBUFFER (base_buffer)->base_buffer)
537 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
538 else
539 b->base_buffer = XBUFFER (base_buffer);
541 /* Use the base buffer's text object. */
542 b->text = b->base_buffer->text;
544 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
545 BUF_ZV (b) = BUF_ZV (b->base_buffer);
546 BUF_PT (b) = BUF_PT (b->base_buffer);
547 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
548 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
549 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
551 b->newline_cache = 0;
552 b->width_run_cache = 0;
553 b->width_table = Qnil;
555 /* Put this on the chain of all buffers including killed ones. */
556 b->next = all_buffers;
557 all_buffers = b;
559 name = Fcopy_sequence (name);
560 XSTRING (name)->intervals = NULL_INTERVAL;
561 b->name = name;
563 reset_buffer (b);
564 reset_buffer_local_variables (b, 1);
566 /* Put this in the alist of all live buffers. */
567 XSETBUFFER (buf, b);
568 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
570 b->mark = Fmake_marker ();
571 b->name = name;
573 /* The multibyte status belongs to the base buffer. */
574 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
576 /* Make sure the base buffer has markers for its narrowing. */
577 if (NILP (b->base_buffer->pt_marker))
579 b->base_buffer->pt_marker = Fmake_marker ();
580 set_marker_both (b->base_buffer->pt_marker, base_buffer,
581 BUF_PT (b->base_buffer),
582 BUF_PT_BYTE (b->base_buffer));
584 if (NILP (b->base_buffer->begv_marker))
586 b->base_buffer->begv_marker = Fmake_marker ();
587 set_marker_both (b->base_buffer->begv_marker, base_buffer,
588 BUF_BEGV (b->base_buffer),
589 BUF_BEGV_BYTE (b->base_buffer));
591 if (NILP (b->base_buffer->zv_marker))
593 b->base_buffer->zv_marker = Fmake_marker ();
594 set_marker_both (b->base_buffer->zv_marker, base_buffer,
595 BUF_ZV (b->base_buffer),
596 BUF_ZV_BYTE (b->base_buffer));
597 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
600 if (NILP (clone))
602 /* Give the indirect buffer markers for its narrowing. */
603 b->pt_marker = Fmake_marker ();
604 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
605 b->begv_marker = Fmake_marker ();
606 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
607 b->zv_marker = Fmake_marker ();
608 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
609 XMARKER (b->zv_marker)->insertion_type = 1;
611 else
612 clone_per_buffer_values (b->base_buffer, b);
614 return buf;
617 /* Reinitialize everything about a buffer except its name and contents
618 and local variables. */
620 void
621 reset_buffer (b)
622 register struct buffer *b;
624 b->filename = Qnil;
625 b->file_truename = Qnil;
626 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
627 b->modtime = 0;
628 XSETFASTINT (b->save_length, 0);
629 b->last_window_start = 1;
630 /* It is more conservative to start out "changed" than "unchanged". */
631 b->clip_changed = 0;
632 b->prevent_redisplay_optimizations_p = 1;
633 b->backed_up = Qnil;
634 b->auto_save_modified = 0;
635 b->auto_save_failure_time = -1;
636 b->auto_save_file_name = Qnil;
637 b->read_only = Qnil;
638 b->overlays_before = Qnil;
639 b->overlays_after = Qnil;
640 XSETFASTINT (b->overlay_center, 1);
641 b->mark_active = Qnil;
642 b->point_before_scroll = Qnil;
643 b->file_format = Qnil;
644 b->last_selected_window = Qnil;
645 XSETINT (b->display_count, 0);
646 b->display_time = Qnil;
647 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
648 b->cursor_type = buffer_defaults.cursor_type;
649 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
651 b->display_error_modiff = 0;
654 /* Reset buffer B's local variables info.
655 Don't use this on a buffer that has already been in use;
656 it does not treat permanent locals consistently.
657 Instead, use Fkill_all_local_variables.
659 If PERMANENT_TOO is 1, then we reset permanent built-in
660 buffer-local variables. If PERMANENT_TOO is 0,
661 we preserve those. */
663 static void
664 reset_buffer_local_variables (b, permanent_too)
665 register struct buffer *b;
666 int permanent_too;
668 register int offset;
669 int i;
671 /* Reset the major mode to Fundamental, together with all the
672 things that depend on the major mode.
673 default-major-mode is handled at a higher level.
674 We ignore it here. */
675 b->major_mode = Qfundamental_mode;
676 b->keymap = Qnil;
677 b->abbrev_table = Vfundamental_mode_abbrev_table;
678 b->mode_name = QSFundamental;
679 b->minor_modes = Qnil;
681 /* If the standard case table has been altered and invalidated,
682 fix up its insides first. */
683 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
684 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
685 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
686 Fset_standard_case_table (Vascii_downcase_table);
688 b->downcase_table = Vascii_downcase_table;
689 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
690 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
691 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
692 b->invisibility_spec = Qt;
693 #ifndef DOS_NT
694 b->buffer_file_type = Qnil;
695 #endif
697 #if 0
698 b->sort_table = XSTRING (Vascii_sort_table);
699 b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
700 #endif /* 0 */
702 /* Reset all (or most) per-buffer variables to their defaults. */
703 b->local_var_alist = Qnil;
704 for (i = 0; i < last_per_buffer_idx; ++i)
705 if (permanent_too || buffer_permanent_local_flags[i] == 0)
706 SET_PER_BUFFER_VALUE_P (b, i, 0);
708 /* For each slot that has a default value,
709 copy that into the slot. */
711 for (offset = PER_BUFFER_VAR_OFFSET (name);
712 offset < sizeof *b;
713 offset += sizeof (Lisp_Object))
715 int idx = PER_BUFFER_IDX (offset);
716 if ((idx > 0
717 && (permanent_too
718 || buffer_permanent_local_flags[idx] == 0))
719 /* Is -2 used anywhere? */
720 || idx == -2)
721 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
725 /* We split this away from generate-new-buffer, because rename-buffer
726 and set-visited-file-name ought to be able to use this to really
727 rename the buffer properly. */
729 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
730 1, 2, 0,
731 doc: /* Return a string that is the name of no existing buffer based on NAME.
732 If there is no live buffer named NAME, then return NAME.
733 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
734 until an unused name is found, and then return that name.
735 Optional second argument IGNORE specifies a name that is okay to use
736 \(if it is in the sequence to be tried)
737 even if a buffer with that name exists. */)
738 (name, ignore)
739 register Lisp_Object name, ignore;
741 register Lisp_Object gentemp, tem;
742 int count;
743 char number[10];
745 CHECK_STRING (name);
747 tem = Fget_buffer (name);
748 if (NILP (tem))
749 return name;
751 count = 1;
752 while (1)
754 sprintf (number, "<%d>", ++count);
755 gentemp = concat2 (name, build_string (number));
756 tem = Fstring_equal (gentemp, ignore);
757 if (!NILP (tem))
758 return gentemp;
759 tem = Fget_buffer (gentemp);
760 if (NILP (tem))
761 return gentemp;
766 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
767 doc: /* Return the name of BUFFER, as a string.
768 With no argument or nil as argument, return the name of the current buffer. */)
769 (buffer)
770 register Lisp_Object buffer;
772 if (NILP (buffer))
773 return current_buffer->name;
774 CHECK_BUFFER (buffer);
775 return XBUFFER (buffer)->name;
778 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
779 doc: /* Return name of file BUFFER is visiting, or nil if none.
780 No argument or nil as argument means use the current buffer. */)
781 (buffer)
782 register Lisp_Object buffer;
784 if (NILP (buffer))
785 return current_buffer->filename;
786 CHECK_BUFFER (buffer);
787 return XBUFFER (buffer)->filename;
790 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
791 0, 1, 0,
792 doc: /* Return the base buffer of indirect buffer BUFFER.
793 If BUFFER is not indirect, return nil. */)
794 (buffer)
795 register Lisp_Object buffer;
797 struct buffer *base;
798 Lisp_Object base_buffer;
800 if (NILP (buffer))
801 base = current_buffer->base_buffer;
802 else
804 CHECK_BUFFER (buffer);
805 base = XBUFFER (buffer)->base_buffer;
808 if (! base)
809 return Qnil;
810 XSETBUFFER (base_buffer, base);
811 return base_buffer;
814 DEFUN ("buffer-local-value", Fbuffer_local_value,
815 Sbuffer_local_value, 2, 2, 0,
816 doc: /* Return the value of VARIABLE in BUFFER.
817 If VARIABLE does not have a buffer-local binding in BUFFER, the value
818 is the default binding of variable. */)
819 (symbol, buffer)
820 register Lisp_Object symbol;
821 register Lisp_Object buffer;
823 register struct buffer *buf;
824 register Lisp_Object result;
826 CHECK_SYMBOL (symbol);
827 CHECK_BUFFER (buffer);
828 buf = XBUFFER (buffer);
830 /* Look in local_var_list */
831 result = Fassoc (symbol, buf->local_var_alist);
832 if (NILP (result))
834 int offset, idx;
835 int found = 0;
837 /* Look in special slots */
838 for (offset = PER_BUFFER_VAR_OFFSET (name);
839 offset < sizeof (struct buffer);
840 /* sizeof EMACS_INT == sizeof Lisp_Object */
841 offset += (sizeof (EMACS_INT)))
843 idx = PER_BUFFER_IDX (offset);
844 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
845 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
846 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
848 result = PER_BUFFER_VALUE (buf, offset);
849 found = 1;
850 break;
854 if (!found)
855 result = Fdefault_value (symbol);
857 else
858 result = XCDR (result);
860 if (EQ (result, Qunbound))
861 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
863 return result;
866 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
867 Sbuffer_local_variables, 0, 1, 0,
868 doc: /* Return an alist of variables that are buffer-local in BUFFER.
869 Most elements look like (SYMBOL . VALUE), describing one variable.
870 For a symbol that is locally unbound, just the symbol appears in the value.
871 Note that storing new VALUEs in these elements doesn't change the variables.
872 No argument or nil as argument means use current buffer as BUFFER. */)
873 (buffer)
874 register Lisp_Object buffer;
876 register struct buffer *buf;
877 register Lisp_Object result;
879 if (NILP (buffer))
880 buf = current_buffer;
881 else
883 CHECK_BUFFER (buffer);
884 buf = XBUFFER (buffer);
887 result = Qnil;
890 register Lisp_Object tail;
891 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
893 Lisp_Object val, elt;
895 elt = XCAR (tail);
897 /* Reference each variable in the alist in buf.
898 If inquiring about the current buffer, this gets the current values,
899 so store them into the alist so the alist is up to date.
900 If inquiring about some other buffer, this swaps out any values
901 for that buffer, making the alist up to date automatically. */
902 val = find_symbol_value (XCAR (elt));
903 /* Use the current buffer value only if buf is the current buffer. */
904 if (buf != current_buffer)
905 val = XCDR (elt);
907 /* If symbol is unbound, put just the symbol in the list. */
908 if (EQ (val, Qunbound))
909 result = Fcons (XCAR (elt), result);
910 /* Otherwise, put (symbol . value) in the list. */
911 else
912 result = Fcons (Fcons (XCAR (elt), val), result);
916 /* Add on all the variables stored in special slots. */
918 int offset, idx;
920 for (offset = PER_BUFFER_VAR_OFFSET (name);
921 offset < sizeof (struct buffer);
922 /* sizeof EMACS_INT == sizeof Lisp_Object */
923 offset += (sizeof (EMACS_INT)))
925 idx = PER_BUFFER_IDX (offset);
926 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
927 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
928 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
929 PER_BUFFER_VALUE (buf, offset)),
930 result);
934 return result;
938 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
939 0, 1, 0,
940 doc: /* Return t if BUFFER was modified since its file was last read or saved.
941 No argument or nil as argument means use current buffer as BUFFER. */)
942 (buffer)
943 register Lisp_Object buffer;
945 register struct buffer *buf;
946 if (NILP (buffer))
947 buf = current_buffer;
948 else
950 CHECK_BUFFER (buffer);
951 buf = XBUFFER (buffer);
954 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
957 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
958 1, 1, 0,
959 doc: /* Mark current buffer as modified or unmodified according to FLAG.
960 A non-nil FLAG means mark the buffer modified. */)
961 (flag)
962 register Lisp_Object flag;
964 register int already;
965 register Lisp_Object fn;
966 Lisp_Object buffer, window;
968 #ifdef CLASH_DETECTION
969 /* If buffer becoming modified, lock the file.
970 If buffer becoming unmodified, unlock the file. */
972 fn = current_buffer->file_truename;
973 /* Test buffer-file-name so that binding it to nil is effective. */
974 if (!NILP (fn) && ! NILP (current_buffer->filename))
976 already = SAVE_MODIFF < MODIFF;
977 if (!already && !NILP (flag))
978 lock_file (fn);
979 else if (already && NILP (flag))
980 unlock_file (fn);
982 #endif /* CLASH_DETECTION */
984 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
986 /* Set update_mode_lines only if buffer is displayed in some window.
987 Packages like jit-lock or lazy-lock preserve a buffer's modified
988 state by recording/restoring the state around blocks of code.
989 Setting update_mode_lines makes redisplay consider all windows
990 (on all frames). Stealth fontification of buffers not displayed
991 would incur additional redisplay costs if we'd set
992 update_modes_lines unconditionally.
994 Ideally, I think there should be another mechanism for fontifying
995 buffers without "modifying" buffers, or redisplay should be
996 smarter about updating the `*' in mode lines. --gerd */
997 XSETBUFFER (buffer, current_buffer);
998 window = Fget_buffer_window (buffer, Qt);
999 if (WINDOWP (window))
1001 ++update_mode_lines;
1002 current_buffer->prevent_redisplay_optimizations_p = 1;
1005 return flag;
1008 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1009 Srestore_buffer_modified_p, 1, 1, 0,
1010 doc: /* Like `set-buffer-modified-p', with a differences concerning redisplay.
1011 It is not ensured that mode lines will be updated to show the modified
1012 state of the current buffer. Use with care. */)
1013 (flag)
1014 Lisp_Object flag;
1016 #ifdef CLASH_DETECTION
1017 Lisp_Object fn;
1019 /* If buffer becoming modified, lock the file.
1020 If buffer becoming unmodified, unlock the file. */
1022 fn = current_buffer->file_truename;
1023 /* Test buffer-file-name so that binding it to nil is effective. */
1024 if (!NILP (fn) && ! NILP (current_buffer->filename))
1026 int already = SAVE_MODIFF < MODIFF;
1027 if (!already && !NILP (flag))
1028 lock_file (fn);
1029 else if (already && NILP (flag))
1030 unlock_file (fn);
1032 #endif /* CLASH_DETECTION */
1034 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1035 return flag;
1038 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1039 0, 1, 0,
1040 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1041 Each buffer has a tick counter which is incremented each time the text in
1042 that buffer is changed. It wraps around occasionally.
1043 No argument or nil as argument means use current buffer as BUFFER. */)
1044 (buffer)
1045 register Lisp_Object buffer;
1047 register struct buffer *buf;
1048 if (NILP (buffer))
1049 buf = current_buffer;
1050 else
1052 CHECK_BUFFER (buffer);
1053 buf = XBUFFER (buffer);
1056 return make_number (BUF_MODIFF (buf));
1059 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1060 "sRename buffer (to new name): \nP",
1061 doc: /* Change current buffer's name to NEWNAME (a string).
1062 If second arg UNIQUE is nil or omitted, it is an error if a
1063 buffer named NEWNAME already exists.
1064 If UNIQUE is non-nil, come up with a new name using
1065 `generate-new-buffer-name'.
1066 Interactively, you can set UNIQUE with a prefix argument.
1067 We return the name we actually gave the buffer.
1068 This does not change the name of the visited file (if any). */)
1069 (newname, unique)
1070 register Lisp_Object newname, unique;
1072 register Lisp_Object tem, buf;
1074 CHECK_STRING (newname);
1076 if (XSTRING (newname)->size == 0)
1077 error ("Empty string is invalid as a buffer name");
1079 tem = Fget_buffer (newname);
1080 if (!NILP (tem))
1082 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1083 rename the buffer automatically so you can create another
1084 with the original name. It makes UNIQUE equivalent to
1085 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1086 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1087 return current_buffer->name;
1088 if (!NILP (unique))
1089 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1090 else
1091 error ("Buffer name `%s' is in use", XSTRING (newname)->data);
1094 current_buffer->name = newname;
1096 /* Catch redisplay's attention. Unless we do this, the mode lines for
1097 any windows displaying current_buffer will stay unchanged. */
1098 update_mode_lines++;
1100 XSETBUFFER (buf, current_buffer);
1101 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1102 if (NILP (current_buffer->filename)
1103 && !NILP (current_buffer->auto_save_file_name))
1104 call0 (intern ("rename-auto-save-file"));
1105 /* Refetch since that last call may have done GC. */
1106 return current_buffer->name;
1109 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1110 doc: /* Return most recently selected buffer other than BUFFER.
1111 Buffers not visible in windows are preferred to visible buffers,
1112 unless optional second argument VISIBLE-OK is non-nil.
1113 If the optional third argument FRAME is non-nil, use that frame's
1114 buffer list instead of the selected frame's buffer list.
1115 If no other buffer exists, the buffer `*scratch*' is returned.
1116 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1117 (buffer, visible_ok, frame)
1118 register Lisp_Object buffer, visible_ok, frame;
1120 Lisp_Object Fset_buffer_major_mode ();
1121 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1122 notsogood = Qnil;
1124 if (NILP (frame))
1125 frame = selected_frame;
1127 tail = Vbuffer_alist;
1128 pred = frame_buffer_predicate (frame);
1130 /* Consider buffers that have been seen in the selected frame
1131 before other buffers. */
1133 tem = frame_buffer_list (frame);
1134 add_ons = Qnil;
1135 while (CONSP (tem))
1137 if (BUFFERP (XCAR (tem)))
1138 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1139 tem = XCDR (tem);
1141 tail = nconc2 (Fnreverse (add_ons), tail);
1143 for (; !NILP (tail); tail = Fcdr (tail))
1145 buf = Fcdr (Fcar (tail));
1146 if (EQ (buf, buffer))
1147 continue;
1148 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
1149 continue;
1150 /* If the selected frame has a buffer_predicate,
1151 disregard buffers that don't fit the predicate. */
1152 if (!NILP (pred))
1154 tem = call1 (pred, buf);
1155 if (NILP (tem))
1156 continue;
1159 if (NILP (visible_ok))
1160 tem = Fget_buffer_window (buf, Qvisible);
1161 else
1162 tem = Qnil;
1163 if (NILP (tem))
1164 return buf;
1165 if (NILP (notsogood))
1166 notsogood = buf;
1168 if (!NILP (notsogood))
1169 return notsogood;
1170 buf = Fget_buffer (build_string ("*scratch*"));
1171 if (NILP (buf))
1173 buf = Fget_buffer_create (build_string ("*scratch*"));
1174 Fset_buffer_major_mode (buf);
1176 return buf;
1179 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
1180 0, 1, "",
1181 doc: /* Make BUFFER stop keeping undo information.
1182 No argument or nil as argument means do this for the current buffer. */)
1183 (buffer)
1184 register Lisp_Object buffer;
1186 Lisp_Object real_buffer;
1188 if (NILP (buffer))
1189 XSETBUFFER (real_buffer, current_buffer);
1190 else
1192 real_buffer = Fget_buffer (buffer);
1193 if (NILP (real_buffer))
1194 nsberror (buffer);
1197 XBUFFER (real_buffer)->undo_list = Qt;
1199 return Qnil;
1202 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1203 0, 1, "",
1204 doc: /* Start keeping undo information for buffer BUFFER.
1205 No argument or nil as argument means do this for the current buffer. */)
1206 (buffer)
1207 register Lisp_Object buffer;
1209 Lisp_Object real_buffer;
1211 if (NILP (buffer))
1212 XSETBUFFER (real_buffer, current_buffer);
1213 else
1215 real_buffer = Fget_buffer (buffer);
1216 if (NILP (real_buffer))
1217 nsberror (buffer);
1220 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1221 XBUFFER (real_buffer)->undo_list = Qnil;
1223 return Qnil;
1227 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1228 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1229 The buffer being killed will be current while the hook is running.\n\
1230 See `kill-buffer'."
1232 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1233 doc: /* Kill the buffer BUFFER.
1234 The argument may be a buffer or may be the name of a buffer.
1235 An argument of nil means kill the current buffer.
1237 Value is t if the buffer is actually killed, nil if user says no.
1239 The value of `kill-buffer-hook' (which may be local to that buffer),
1240 if not void, is a list of functions to be called, with no arguments,
1241 before the buffer is actually killed. The buffer to be killed is current
1242 when the hook functions are called.
1244 Any processes that have this buffer as the `process-buffer' are killed
1245 with SIGHUP. */)
1246 (buffer)
1247 Lisp_Object buffer;
1249 Lisp_Object buf;
1250 register struct buffer *b;
1251 register Lisp_Object tem;
1252 register struct Lisp_Marker *m;
1253 struct gcpro gcpro1;
1255 if (NILP (buffer))
1256 buf = Fcurrent_buffer ();
1257 else
1258 buf = Fget_buffer (buffer);
1259 if (NILP (buf))
1260 nsberror (buffer);
1262 b = XBUFFER (buf);
1264 /* Avoid trouble for buffer already dead. */
1265 if (NILP (b->name))
1266 return Qnil;
1268 /* Query if the buffer is still modified. */
1269 if (INTERACTIVE && !NILP (b->filename)
1270 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1272 GCPRO1 (buf);
1273 tem = do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
1274 XSTRING (b->name)->data));
1275 UNGCPRO;
1276 if (NILP (tem))
1277 return Qnil;
1280 /* Run hooks with the buffer to be killed the current buffer. */
1282 int count = specpdl_ptr - specpdl;
1283 Lisp_Object list;
1285 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1286 set_buffer_internal (b);
1288 /* First run the query functions; if any query is answered no,
1289 don't kill the buffer. */
1290 for (list = Vkill_buffer_query_functions; !NILP (list); list = Fcdr (list))
1292 tem = call0 (Fcar (list));
1293 if (NILP (tem))
1294 return unbind_to (count, Qnil);
1297 /* Then run the hooks. */
1298 Frun_hooks (1, &Qkill_buffer_hook);
1299 unbind_to (count, Qnil);
1302 /* We have no more questions to ask. Verify that it is valid
1303 to kill the buffer. This must be done after the questions
1304 since anything can happen within do_yes_or_no_p. */
1306 /* Don't kill the minibuffer now current. */
1307 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1308 return Qnil;
1310 if (NILP (b->name))
1311 return Qnil;
1313 /* When we kill a base buffer, kill all its indirect buffers.
1314 We do it at this stage so nothing terrible happens if they
1315 ask questions or their hooks get errors. */
1316 if (! b->base_buffer)
1318 struct buffer *other;
1320 GCPRO1 (buf);
1322 for (other = all_buffers; other; other = other->next)
1323 /* all_buffers contains dead buffers too;
1324 don't re-kill them. */
1325 if (other->base_buffer == b && !NILP (other->name))
1327 Lisp_Object buf;
1328 XSETBUFFER (buf, other);
1329 Fkill_buffer (buf);
1332 UNGCPRO;
1335 /* Make this buffer not be current.
1336 In the process, notice if this is the sole visible buffer
1337 and give up if so. */
1338 if (b == current_buffer)
1340 tem = Fother_buffer (buf, Qnil, Qnil);
1341 Fset_buffer (tem);
1342 if (b == current_buffer)
1343 return Qnil;
1346 /* Notice if the buffer to kill is the sole visible buffer
1347 when we're currently in the mini-buffer, and give up if so. */
1348 XSETBUFFER (tem, current_buffer);
1349 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1351 tem = Fother_buffer (buf, Qnil, Qnil);
1352 if (EQ (buf, tem))
1353 return Qnil;
1356 /* Now there is no question: we can kill the buffer. */
1358 #ifdef CLASH_DETECTION
1359 /* Unlock this buffer's file, if it is locked. */
1360 unlock_buffer (b);
1361 #endif /* CLASH_DETECTION */
1363 kill_buffer_processes (buf);
1365 tem = Vinhibit_quit;
1366 Vinhibit_quit = Qt;
1367 replace_buffer_in_all_windows (buf);
1368 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1369 frames_discard_buffer (buf);
1370 Vinhibit_quit = tem;
1372 /* Delete any auto-save file, if we saved it in this session.
1373 But not if the buffer is modified. */
1374 if (STRINGP (b->auto_save_file_name)
1375 && b->auto_save_modified != 0
1376 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1377 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b))
1379 Lisp_Object tem;
1380 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1381 if (! NILP (tem))
1382 internal_delete_file (b->auto_save_file_name);
1385 if (b->base_buffer)
1387 /* Unchain all markers that belong to this indirect buffer.
1388 Don't unchain the markers that belong to the base buffer
1389 or its other indirect buffers. */
1390 for (tem = BUF_MARKERS (b); !NILP (tem); )
1392 Lisp_Object next;
1393 m = XMARKER (tem);
1394 next = m->chain;
1395 if (m->buffer == b)
1396 unchain_marker (tem);
1397 tem = next;
1400 else
1402 /* Unchain all markers of this buffer and its indirect buffers.
1403 and leave them pointing nowhere. */
1404 for (tem = BUF_MARKERS (b); !NILP (tem); )
1406 m = XMARKER (tem);
1407 m->buffer = 0;
1408 tem = m->chain;
1409 m->chain = Qnil;
1411 BUF_MARKERS (b) = Qnil;
1412 BUF_INTERVALS (b) = NULL_INTERVAL;
1414 /* Perhaps we should explicitly free the interval tree here... */
1417 /* Reset the local variables, so that this buffer's local values
1418 won't be protected from GC. They would be protected
1419 if they happened to remain encached in their symbols.
1420 This gets rid of them for certain. */
1421 swap_out_buffer_local_variables (b);
1422 reset_buffer_local_variables (b, 1);
1424 b->name = Qnil;
1426 BLOCK_INPUT;
1427 if (! b->base_buffer)
1428 free_buffer_text (b);
1430 if (b->newline_cache)
1432 free_region_cache (b->newline_cache);
1433 b->newline_cache = 0;
1435 if (b->width_run_cache)
1437 free_region_cache (b->width_run_cache);
1438 b->width_run_cache = 0;
1440 b->width_table = Qnil;
1441 UNBLOCK_INPUT;
1442 b->undo_list = Qnil;
1444 return Qt;
1447 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1448 we do this each time BUF is selected visibly, the more recently
1449 selected buffers are always closer to the front of the list. This
1450 means that other_buffer is more likely to choose a relevant buffer. */
1452 void
1453 record_buffer (buf)
1454 Lisp_Object buf;
1456 register Lisp_Object link, prev;
1457 Lisp_Object frame;
1458 frame = selected_frame;
1460 prev = Qnil;
1461 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1463 if (EQ (XCDR (XCAR (link)), buf))
1464 break;
1465 prev = link;
1468 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1469 we cannot use Fdelq itself here because it allows quitting. */
1471 if (NILP (prev))
1472 Vbuffer_alist = XCDR (Vbuffer_alist);
1473 else
1474 XSETCDR (prev, XCDR (XCDR (prev)));
1476 XSETCDR (link, Vbuffer_alist);
1477 Vbuffer_alist = link;
1479 /* Now move this buffer to the front of frame_buffer_list also. */
1481 prev = Qnil;
1482 for (link = frame_buffer_list (frame); CONSP (link);
1483 link = XCDR (link))
1485 if (EQ (XCAR (link), buf))
1486 break;
1487 prev = link;
1490 /* Effectively do delq. */
1492 if (CONSP (link))
1494 if (NILP (prev))
1495 set_frame_buffer_list (frame,
1496 XCDR (frame_buffer_list (frame)));
1497 else
1498 XSETCDR (prev, XCDR (XCDR (prev)));
1500 XSETCDR (link, frame_buffer_list (frame));
1501 set_frame_buffer_list (frame, link);
1503 else
1504 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1507 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1508 doc: /* Set an appropriate major mode for BUFFER.
1509 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1510 according to `default-major-mode'.
1511 Use this function before selecting the buffer, since it may need to inspect
1512 the current buffer's major mode. */)
1513 (buffer)
1514 Lisp_Object buffer;
1516 int count;
1517 Lisp_Object function;
1519 if (STRINGP (XBUFFER (buffer)->name)
1520 && strcmp (XSTRING (XBUFFER (buffer)->name)->data, "*scratch*") == 0)
1521 function = find_symbol_value (intern ("initial-major-mode"));
1522 else
1524 function = buffer_defaults.major_mode;
1525 if (NILP (function)
1526 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1527 function = current_buffer->major_mode;
1530 if (NILP (function) || EQ (function, Qfundamental_mode))
1531 return Qnil;
1533 count = specpdl_ptr - specpdl;
1535 /* To select a nonfundamental mode,
1536 select the buffer temporarily and then call the mode function. */
1538 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1540 Fset_buffer (buffer);
1541 call0 (function);
1543 return unbind_to (count, Qnil);
1546 /* If switching buffers in WINDOW would be an error, return
1547 a C string saying what the error would be. */
1549 char *
1550 no_switch_window (window)
1551 Lisp_Object window;
1553 Lisp_Object tem;
1554 if (EQ (minibuf_window, window))
1555 return "Cannot switch buffers in minibuffer window";
1556 tem = Fwindow_dedicated_p (window);
1557 if (!NILP (tem))
1558 return "Cannot switch buffers in a dedicated window";
1559 return NULL;
1562 /* Switch to buffer BUFFER in the selected window.
1563 If NORECORD is non-nil, don't call record_buffer. */
1565 Lisp_Object
1566 switch_to_buffer_1 (buffer, norecord)
1567 Lisp_Object buffer, norecord;
1569 register Lisp_Object buf;
1571 if (NILP (buffer))
1572 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1573 else
1575 buf = Fget_buffer (buffer);
1576 if (NILP (buf))
1578 buf = Fget_buffer_create (buffer);
1579 Fset_buffer_major_mode (buf);
1582 Fset_buffer (buf);
1583 if (NILP (norecord))
1584 record_buffer (buf);
1586 Fset_window_buffer (EQ (selected_window, minibuf_window)
1587 ? Fnext_window (minibuf_window, Qnil, Qnil)
1588 : selected_window,
1589 buf);
1591 return buf;
1594 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1595 doc: /* Select buffer BUFFER in the current window.
1596 BUFFER may be a buffer or a buffer name.
1597 Optional second arg NORECORD non-nil means
1598 do not put this buffer at the front of the list of recently selected ones.
1600 WARNING: This is NOT the way to work on another buffer temporarily
1601 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1602 the window-buffer correspondences. */)
1603 (buffer, norecord)
1604 Lisp_Object buffer, norecord;
1606 char *err;
1608 err = no_switch_window (selected_window);
1609 if (err) error (err);
1611 return switch_to_buffer_1 (buffer, norecord);
1614 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1615 doc: /* Select buffer BUFFER in some window, preferably a different one.
1616 If BUFFER is nil, then some other buffer is chosen.
1617 If `pop-up-windows' is non-nil, windows can be split to do this.
1618 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1619 window even if BUFFER is already visible in the selected window.
1620 This uses the function `display-buffer' as a subroutine; see the documentation
1621 of `display-buffer' for additional customization information.
1623 Optional third arg NORECORD non-nil means
1624 do not put this buffer at the front of the list of recently selected ones. */)
1625 (buffer, other_window, norecord)
1626 Lisp_Object buffer, other_window, norecord;
1628 register Lisp_Object buf;
1629 if (NILP (buffer))
1630 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1631 else
1633 buf = Fget_buffer (buffer);
1634 if (NILP (buf))
1636 buf = Fget_buffer_create (buffer);
1637 Fset_buffer_major_mode (buf);
1640 Fset_buffer (buf);
1641 if (NILP (norecord))
1642 /* This seems bogus since Fselect_window will call record_buffer anyway. */
1643 record_buffer (buf);
1644 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil));
1645 return buf;
1648 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1649 doc: /* Return the current buffer as a Lisp object. */)
1652 register Lisp_Object buf;
1653 XSETBUFFER (buf, current_buffer);
1654 return buf;
1657 /* Set the current buffer to B.
1659 We previously set windows_or_buffers_changed here to invalidate
1660 global unchanged information in beg_unchanged and end_unchanged.
1661 This is no longer necessary because we now compute unchanged
1662 information on a buffer-basis. Every action affecting other
1663 windows than the selected one requires a select_window at some
1664 time, and that increments windows_or_buffers_changed. */
1666 void
1667 set_buffer_internal (b)
1668 register struct buffer *b;
1670 if (current_buffer != b)
1671 set_buffer_internal_1 (b);
1674 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1675 This is used by redisplay. */
1677 void
1678 set_buffer_internal_1 (b)
1679 register struct buffer *b;
1681 register struct buffer *old_buf;
1682 register Lisp_Object tail, valcontents;
1683 Lisp_Object tem;
1685 #ifdef USE_MMAP_FOR_BUFFERS
1686 if (b->text->beg == NULL)
1687 enlarge_buffer_text (b, 0);
1688 #endif /* USE_MMAP_FOR_BUFFERS */
1690 if (current_buffer == b)
1691 return;
1693 old_buf = current_buffer;
1694 current_buffer = b;
1695 last_known_column_point = -1; /* invalidate indentation cache */
1697 if (old_buf)
1699 /* Put the undo list back in the base buffer, so that it appears
1700 that an indirect buffer shares the undo list of its base. */
1701 if (old_buf->base_buffer)
1702 old_buf->base_buffer->undo_list = old_buf->undo_list;
1704 /* If the old current buffer has markers to record PT, BEGV and ZV
1705 when it is not current, update them now. */
1706 if (! NILP (old_buf->pt_marker))
1708 Lisp_Object obuf;
1709 XSETBUFFER (obuf, old_buf);
1710 set_marker_both (old_buf->pt_marker, obuf,
1711 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1713 if (! NILP (old_buf->begv_marker))
1715 Lisp_Object obuf;
1716 XSETBUFFER (obuf, old_buf);
1717 set_marker_both (old_buf->begv_marker, obuf,
1718 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1720 if (! NILP (old_buf->zv_marker))
1722 Lisp_Object obuf;
1723 XSETBUFFER (obuf, old_buf);
1724 set_marker_both (old_buf->zv_marker, obuf,
1725 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1729 /* Get the undo list from the base buffer, so that it appears
1730 that an indirect buffer shares the undo list of its base. */
1731 if (b->base_buffer)
1732 b->undo_list = b->base_buffer->undo_list;
1734 /* If the new current buffer has markers to record PT, BEGV and ZV
1735 when it is not current, fetch them now. */
1736 if (! NILP (b->pt_marker))
1738 BUF_PT (b) = marker_position (b->pt_marker);
1739 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1741 if (! NILP (b->begv_marker))
1743 BUF_BEGV (b) = marker_position (b->begv_marker);
1744 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1746 if (! NILP (b->zv_marker))
1748 BUF_ZV (b) = marker_position (b->zv_marker);
1749 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1752 /* Look down buffer's list of local Lisp variables
1753 to find and update any that forward into C variables. */
1755 for (tail = b->local_var_alist; !NILP (tail); tail = XCDR (tail))
1757 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1758 if ((BUFFER_LOCAL_VALUEP (valcontents)
1759 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1760 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1761 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1762 /* Just reference the variable
1763 to cause it to become set for this buffer. */
1764 Fsymbol_value (XCAR (XCAR (tail)));
1767 /* Do the same with any others that were local to the previous buffer */
1769 if (old_buf)
1770 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCDR (tail))
1772 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1773 if ((BUFFER_LOCAL_VALUEP (valcontents)
1774 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1775 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1776 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1777 /* Just reference the variable
1778 to cause it to become set for this buffer. */
1779 Fsymbol_value (XCAR (XCAR (tail)));
1783 /* Switch to buffer B temporarily for redisplay purposes.
1784 This avoids certain things that don't need to be done within redisplay. */
1786 void
1787 set_buffer_temp (b)
1788 struct buffer *b;
1790 register struct buffer *old_buf;
1792 if (current_buffer == b)
1793 return;
1795 old_buf = current_buffer;
1796 current_buffer = b;
1798 if (old_buf)
1800 /* If the old current buffer has markers to record PT, BEGV and ZV
1801 when it is not current, update them now. */
1802 if (! NILP (old_buf->pt_marker))
1804 Lisp_Object obuf;
1805 XSETBUFFER (obuf, old_buf);
1806 set_marker_both (old_buf->pt_marker, obuf,
1807 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1809 if (! NILP (old_buf->begv_marker))
1811 Lisp_Object obuf;
1812 XSETBUFFER (obuf, old_buf);
1813 set_marker_both (old_buf->begv_marker, obuf,
1814 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1816 if (! NILP (old_buf->zv_marker))
1818 Lisp_Object obuf;
1819 XSETBUFFER (obuf, old_buf);
1820 set_marker_both (old_buf->zv_marker, obuf,
1821 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1825 /* If the new current buffer has markers to record PT, BEGV and ZV
1826 when it is not current, fetch them now. */
1827 if (! NILP (b->pt_marker))
1829 BUF_PT (b) = marker_position (b->pt_marker);
1830 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1832 if (! NILP (b->begv_marker))
1834 BUF_BEGV (b) = marker_position (b->begv_marker);
1835 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1837 if (! NILP (b->zv_marker))
1839 BUF_ZV (b) = marker_position (b->zv_marker);
1840 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1844 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1845 doc: /* Make the buffer BUFFER current for editing operations.
1846 BUFFER may be a buffer or the name of an existing buffer.
1847 See also `save-excursion' when you want to make a buffer current temporarily.
1848 This function does not display the buffer, so its effect ends
1849 when the current command terminates.
1850 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1851 (buffer)
1852 register Lisp_Object buffer;
1854 register Lisp_Object buf;
1855 buf = Fget_buffer (buffer);
1856 if (NILP (buf))
1857 nsberror (buffer);
1858 if (NILP (XBUFFER (buf)->name))
1859 error ("Selecting deleted buffer");
1860 set_buffer_internal (XBUFFER (buf));
1861 return buf;
1864 /* Set the current buffer to BUFFER provided it is alive. */
1866 Lisp_Object
1867 set_buffer_if_live (buffer)
1868 Lisp_Object buffer;
1870 if (! NILP (XBUFFER (buffer)->name))
1871 Fset_buffer (buffer);
1872 return Qnil;
1875 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1876 Sbarf_if_buffer_read_only, 0, 0, 0,
1877 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1880 if (!NILP (current_buffer->read_only)
1881 && NILP (Vinhibit_read_only))
1882 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1883 return Qnil;
1886 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1887 doc: /* Put BUFFER at the end of the list of all buffers.
1888 There it is the least likely candidate for `other-buffer' to return;
1889 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1890 If BUFFER is nil or omitted, bury the current buffer.
1891 Also, if BUFFER is nil or omitted, remove the current buffer from the
1892 selected window if it is displayed there. */)
1893 (buffer)
1894 register Lisp_Object buffer;
1896 /* Figure out what buffer we're going to bury. */
1897 if (NILP (buffer))
1899 Lisp_Object tem;
1900 XSETBUFFER (buffer, current_buffer);
1902 tem = Fwindow_buffer (selected_window);
1903 /* If we're burying the current buffer, unshow it. */
1904 if (EQ (buffer, tem))
1906 if (NILP (Fwindow_dedicated_p (selected_window)))
1907 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1908 else if (NILP (XWINDOW (selected_window)->parent))
1909 Ficonify_frame (Fwindow_frame (selected_window));
1910 else
1911 Fdelete_window (selected_window);
1914 else
1916 Lisp_Object buf1;
1918 buf1 = Fget_buffer (buffer);
1919 if (NILP (buf1))
1920 nsberror (buffer);
1921 buffer = buf1;
1924 /* Move buffer to the end of the buffer list. Do nothing if the
1925 buffer is killed. */
1926 if (!NILP (XBUFFER (buffer)->name))
1928 Lisp_Object aelt, link;
1930 aelt = Frassq (buffer, Vbuffer_alist);
1931 link = Fmemq (aelt, Vbuffer_alist);
1932 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1933 XSETCDR (link, Qnil);
1934 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1936 frames_bury_buffer (buffer);
1939 return Qnil;
1942 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1943 doc: /* Delete the entire contents of the current buffer.
1944 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1945 so the buffer is truly empty after this. */)
1948 Fwiden ();
1950 del_range (BEG, Z);
1952 current_buffer->last_window_start = 1;
1953 /* Prevent warnings, or suspension of auto saving, that would happen
1954 if future size is less than past size. Use of erase-buffer
1955 implies that the future text is not really related to the past text. */
1956 XSETFASTINT (current_buffer->save_length, 0);
1957 return Qnil;
1960 void
1961 validate_region (b, e)
1962 register Lisp_Object *b, *e;
1964 CHECK_NUMBER_COERCE_MARKER (*b);
1965 CHECK_NUMBER_COERCE_MARKER (*e);
1967 if (XINT (*b) > XINT (*e))
1969 Lisp_Object tem;
1970 tem = *b; *b = *e; *e = tem;
1973 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1974 && XINT (*e) <= ZV))
1975 args_out_of_range (*b, *e);
1978 /* Advance BYTE_POS up to a character boundary
1979 and return the adjusted position. */
1981 static int
1982 advance_to_char_boundary (byte_pos)
1983 int byte_pos;
1985 int c;
1987 if (byte_pos == BEG)
1988 /* Beginning of buffer is always a character boundary. */
1989 return 1;
1991 c = FETCH_BYTE (byte_pos);
1992 if (! CHAR_HEAD_P (c))
1994 /* We should advance BYTE_POS only when C is a constituent of a
1995 multibyte sequence. */
1996 int orig_byte_pos = byte_pos;
2000 byte_pos--;
2001 c = FETCH_BYTE (byte_pos);
2003 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2004 INC_POS (byte_pos);
2005 if (byte_pos < orig_byte_pos)
2006 byte_pos = orig_byte_pos;
2007 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2008 surely advance to the correct character boundary. If C is
2009 not, BYTE_POS was unchanged. */
2012 return byte_pos;
2016 /* Symbols used as the 2nd arg of Fset_buffer_multibyte. */
2017 static Lisp_Object Qas, Qmake, Qto;
2020 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2021 1, 2, 0,
2022 doc: /* Set the multibyte flag of the current buffer to FLAG.
2023 If FLAG is t, this makes the buffer a multibyte buffer.
2024 If FLAG is nil, this makes the buffer a unibyte buffer.
2026 Optional second arg METHOD specifies how to convert the byte sequence
2027 of the buffer.
2029 If it is nil or `as', the buffer contents remain unchanged as a
2030 sequence of bytes but the contents viewed as characters do change.
2032 If it is `make', convert each character by unibyte-char-to-multibyte
2033 or multibyte-char-to-unibyte.
2035 If it is `to', convert each character by byte-to-char or
2036 char-to-byte. */)
2037 (flag, method)
2038 Lisp_Object flag, method;
2040 Lisp_Object tail, markers;
2041 struct buffer *other;
2042 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
2043 int begv = BEGV, zv = ZV;
2044 int narrowed = (BEG != begv || Z != zv);
2045 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2047 CHECK_SYMBOL (method);
2048 if (NILP (method))
2049 method = Qas;
2050 else if (! EQ (method, Qas) && ! EQ (method, Qmake) && ! EQ (method, Qto))
2051 error ("Invalid unibyte<->multibyte conversion method: %s",
2052 XSYMBOL (method)->name->data);
2054 if (current_buffer->base_buffer)
2055 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2057 /* Do nothing if nothing actually changes. */
2058 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2059 return flag;
2061 /* It would be better to update the list,
2062 but this is good enough for now. */
2063 if (undo_enabled_p)
2064 current_buffer->undo_list = Qt;
2066 /* If the cached position is for this buffer, clear it out. */
2067 clear_charpos_cache (current_buffer);
2069 if (narrowed)
2070 Fwiden ();
2072 if (NILP (flag))
2074 int pos, stop;
2075 unsigned char *p;
2077 /* Do this first, so it can use CHAR_TO_BYTE
2078 to calculate the old correspondences. */
2079 set_intervals_multibyte (0);
2081 current_buffer->enable_multibyte_characters = Qnil;
2083 Z = Z_BYTE;
2084 BEGV = BEGV_BYTE;
2085 ZV = ZV_BYTE;
2086 GPT = GPT_BYTE;
2087 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2089 tail = BUF_MARKERS (current_buffer);
2090 while (! NILP (tail))
2092 XMARKER (tail)->charpos = XMARKER (tail)->bytepos;
2093 tail = XMARKER (tail)->chain;
2096 /* Convert multibyte form of 8-bit characters to unibyte. */
2097 pos = BEG;
2098 stop = GPT;
2099 p = BEG_ADDR;
2100 while (1)
2102 int c, bytes;
2104 if (pos == stop)
2106 if (pos == Z)
2107 break;
2108 p = GAP_END_ADDR;
2109 stop = Z;
2111 if (ASCII_BYTE_P (*p))
2112 p++, pos++;
2113 else if (CHAR_BYTE8_HEAD_P (*p))
2115 c = STRING_CHAR_AND_LENGTH (p, stop - pos, bytes);
2116 /* Delete all bytes for this 8-bit character but the
2117 last one, and change the last one to the charcter
2118 code. */
2119 bytes--;
2120 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2121 p = GAP_END_ADDR;
2122 *p++ = c;
2123 pos++;
2124 if (begv > pos)
2125 begv -= bytes;
2126 if (zv > pos)
2127 zv -= bytes;
2128 stop = Z;
2130 else if (EQ (method, Qas))
2132 bytes = BYTES_BY_CHAR_HEAD (*p);
2133 p += bytes, pos += bytes;
2135 else
2137 /* Delete all bytes for this character but the last one,
2138 and change the last one to the unibyte code. */
2139 c = STRING_CHAR_AND_LENGTH (p, stop - pos, bytes);
2140 bytes--;
2141 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2142 p = GAP_END_ADDR;
2143 *p++ = CHAR_TO_BYTE (c);
2144 pos++;
2145 if (begv > pos)
2146 begv -= bytes;
2147 if (zv > pos)
2148 zv -= bytes;
2149 stop = Z;
2152 if (narrowed)
2153 Fnarrow_to_region (make_number (begv), make_number (zv));
2155 else
2157 int pt = PT;
2158 int pos, stop;
2159 unsigned char *p, *pend;
2161 /* Be sure not to have a multibyte sequence striding over the GAP.
2162 Ex: We change this: "...abc\302 _GAP_ \241def..."
2163 to: "...abc _GAP_ \302\241def..." */
2165 if (EQ (method, Qas)
2166 && GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2167 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2169 unsigned char *p = GPT_ADDR - 1;
2171 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2172 if (BASE_LEADING_CODE_P (*p))
2174 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2176 move_gap_both (new_gpt, new_gpt);
2180 /* Make the buffer contents valid as multibyte by converting
2181 8-bit characters to multibyte form. */
2182 pos = BEG;
2183 stop = GPT;
2184 p = BEG_ADDR;
2185 pend = GPT_ADDR;
2186 while (1)
2188 int bytes;
2190 if (pos == stop)
2192 if (pos == Z)
2193 break;
2194 p = GAP_END_ADDR;
2195 pend = Z_ADDR;
2196 stop = Z;
2199 if (ASCII_BYTE_P (*p))
2200 p++, pos++;
2201 else if (EQ (method, Qas)
2202 && (bytes = MULTIBYTE_LENGTH (p, pend)) > 0)
2203 p += bytes, pos += bytes;
2204 else
2206 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2207 int c;
2209 if (EQ (method, Qmake))
2210 c = unibyte_char_to_multibyte (*p);
2211 else
2212 c = BYTE8_TO_CHAR (*p);
2214 bytes = CHAR_STRING (c, tmp);
2215 *p = tmp[0];
2216 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2217 bytes--;
2218 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2219 /* Now the gap is after the just inserted data. */
2220 pos = GPT;
2221 p = GAP_END_ADDR;
2222 if (pos <= begv)
2223 begv += bytes;
2224 if (pos <= zv)
2225 zv += bytes;
2226 if (pos <= pt)
2227 pt += bytes;
2228 pend = Z_ADDR;
2229 stop = Z;
2233 if (pt != PT)
2234 TEMP_SET_PT (pt);
2236 if (narrowed)
2237 Fnarrow_to_region (make_number (begv), make_number (zv));
2239 /* Do this first, so that chars_in_text asks the right question.
2240 set_intervals_multibyte needs it too. */
2241 current_buffer->enable_multibyte_characters = Qt;
2243 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2244 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2246 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2248 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2249 if (BEGV_BYTE > GPT_BYTE)
2250 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2251 else
2252 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2254 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2255 if (ZV_BYTE > GPT_BYTE)
2256 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2257 else
2258 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2261 int pt_byte = advance_to_char_boundary (PT_BYTE);
2262 int pt;
2264 if (pt_byte > GPT_BYTE)
2265 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2266 else
2267 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2268 TEMP_SET_PT_BOTH (pt, pt_byte);
2271 tail = markers = BUF_MARKERS (current_buffer);
2273 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2274 getting confused by the markers that have not yet been updated.
2275 It is also a signal that it should never create a marker. */
2276 BUF_MARKERS (current_buffer) = Qnil;
2278 while (! NILP (tail))
2280 XMARKER (tail)->bytepos
2281 = advance_to_char_boundary (XMARKER (tail)->bytepos);
2282 XMARKER (tail)->charpos = BYTE_TO_CHAR (XMARKER (tail)->bytepos);
2284 tail = XMARKER (tail)->chain;
2287 /* Make sure no markers were put on the chain
2288 while the chain value was incorrect. */
2289 if (! EQ (BUF_MARKERS (current_buffer), Qnil))
2290 abort ();
2292 BUF_MARKERS (current_buffer) = markers;
2294 /* Do this last, so it can calculate the new correspondences
2295 between chars and bytes. */
2296 set_intervals_multibyte (1);
2299 if (undo_enabled_p)
2300 current_buffer->undo_list = Qnil;
2302 /* Changing the multibyteness of a buffer means that all windows
2303 showing that buffer must be updated thoroughly. */
2304 current_buffer->prevent_redisplay_optimizations_p = 1;
2305 ++windows_or_buffers_changed;
2307 /* Copy this buffer's new multibyte status
2308 into all of its indirect buffers. */
2309 for (other = all_buffers; other; other = other->next)
2310 if (other->base_buffer == current_buffer && !NILP (other->name))
2312 other->enable_multibyte_characters
2313 = current_buffer->enable_multibyte_characters;
2314 other->prevent_redisplay_optimizations_p = 1;
2317 /* Restore the modifiedness of the buffer. */
2318 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2319 Fset_buffer_modified_p (Qnil);
2321 return flag;
2324 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2325 0, 0, 0,
2326 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2327 Most local variable bindings are eliminated so that the default values
2328 become effective once more. Also, the syntax table is set from
2329 `standard-syntax-table', the local keymap is set to nil,
2330 and the abbrev table from `fundamental-mode-abbrev-table'.
2331 This function also forces redisplay of the mode line.
2333 Every function to select a new major mode starts by
2334 calling this function.
2336 As a special exception, local variables whose names have
2337 a non-nil `permanent-local' property are not eliminated by this function.
2339 The first thing this function does is run
2340 the normal hook `change-major-mode-hook'. */)
2343 register Lisp_Object alist, sym, tem;
2344 Lisp_Object oalist;
2346 if (!NILP (Vrun_hooks))
2347 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2348 oalist = current_buffer->local_var_alist;
2350 /* Make sure none of the bindings in oalist
2351 remain swapped in, in their symbols. */
2353 swap_out_buffer_local_variables (current_buffer);
2355 /* Actually eliminate all local bindings of this buffer. */
2357 reset_buffer_local_variables (current_buffer, 0);
2359 /* Any which are supposed to be permanent,
2360 make local again, with the same values they had. */
2362 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2364 sym = XCAR (XCAR (alist));
2365 tem = Fget (sym, Qpermanent_local);
2366 if (! NILP (tem))
2368 Fmake_local_variable (sym);
2369 Fset (sym, XCDR (XCAR (alist)));
2373 /* Force mode-line redisplay. Useful here because all major mode
2374 commands call this function. */
2375 update_mode_lines++;
2377 return Qnil;
2380 /* Make sure no local variables remain set up with buffer B
2381 for their current values. */
2383 static void
2384 swap_out_buffer_local_variables (b)
2385 struct buffer *b;
2387 Lisp_Object oalist, alist, sym, tem, buffer;
2389 XSETBUFFER (buffer, b);
2390 oalist = b->local_var_alist;
2392 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2394 sym = XCAR (XCAR (alist));
2396 /* Need not do anything if some other buffer's binding is now encached. */
2397 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2398 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2400 /* Symbol is set up for this buffer's old local value.
2401 Set it up for the current buffer with the default value. */
2403 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2404 /* Store the symbol's current value into the alist entry
2405 it is currently set up for. This is so that, if the
2406 local is marked permanent, and we make it local again
2407 later in Fkill_all_local_variables, we don't lose the value. */
2408 XSETCDR (XCAR (tem),
2409 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2410 /* Switch to the symbol's default-value alist entry. */
2411 XSETCAR (tem, tem);
2412 /* Mark it as current for buffer B. */
2413 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2414 /* Store the current value into any forwarding in the symbol. */
2415 store_symval_forwarding (sym,
2416 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2417 XCDR (tem), NULL);
2422 /* Find all the overlays in the current buffer that contain position POS.
2423 Return the number found, and store them in a vector in *VEC_PTR.
2424 Store in *LEN_PTR the size allocated for the vector.
2425 Store in *NEXT_PTR the next position after POS where an overlay starts,
2426 or ZV if there are no more overlays.
2427 Store in *PREV_PTR the previous position before POS where an overlay ends,
2428 or where an overlay starts which ends at or after POS;
2429 or BEGV if there are no such overlays.
2430 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2432 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2433 when this function is called.
2435 If EXTEND is non-zero, we make the vector bigger if necessary.
2436 If EXTEND is zero, we never extend the vector,
2437 and we store only as many overlays as will fit.
2438 But we still return the total number of overlays.
2440 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2441 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2442 default (BEGV or ZV). */
2445 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2446 int pos;
2447 int extend;
2448 Lisp_Object **vec_ptr;
2449 int *len_ptr;
2450 int *next_ptr;
2451 int *prev_ptr;
2452 int change_req;
2454 Lisp_Object tail, overlay, start, end;
2455 int idx = 0;
2456 int len = *len_ptr;
2457 Lisp_Object *vec = *vec_ptr;
2458 int next = ZV;
2459 int prev = BEGV;
2460 int inhibit_storing = 0;
2462 for (tail = current_buffer->overlays_before;
2463 GC_CONSP (tail);
2464 tail = XCDR (tail))
2466 int startpos, endpos;
2468 overlay = XCAR (tail);
2470 start = OVERLAY_START (overlay);
2471 end = OVERLAY_END (overlay);
2472 endpos = OVERLAY_POSITION (end);
2473 if (endpos < pos)
2475 if (prev < endpos)
2476 prev = endpos;
2477 break;
2479 startpos = OVERLAY_POSITION (start);
2480 /* This one ends at or after POS
2481 so its start counts for PREV_PTR if it's before POS. */
2482 if (prev < startpos && startpos < pos)
2483 prev = startpos;
2484 if (endpos == pos)
2485 continue;
2486 if (startpos <= pos)
2488 if (idx == len)
2490 /* The supplied vector is full.
2491 Either make it bigger, or don't store any more in it. */
2492 if (extend)
2494 /* Make it work with an initial len == 0. */
2495 len *= 2;
2496 if (len == 0)
2497 len = 4;
2498 *len_ptr = len;
2499 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2500 *vec_ptr = vec;
2502 else
2503 inhibit_storing = 1;
2506 if (!inhibit_storing)
2507 vec[idx] = overlay;
2508 /* Keep counting overlays even if we can't return them all. */
2509 idx++;
2511 else if (startpos < next)
2512 next = startpos;
2515 for (tail = current_buffer->overlays_after;
2516 GC_CONSP (tail);
2517 tail = XCDR (tail))
2519 int startpos, endpos;
2521 overlay = XCAR (tail);
2523 start = OVERLAY_START (overlay);
2524 end = OVERLAY_END (overlay);
2525 startpos = OVERLAY_POSITION (start);
2526 if (pos < startpos)
2528 if (startpos < next)
2529 next = startpos;
2530 break;
2532 endpos = OVERLAY_POSITION (end);
2533 if (pos < endpos)
2535 if (idx == len)
2537 if (extend)
2539 *len_ptr = len *= 2;
2540 if (len == 0)
2541 len = *len_ptr = 4;
2542 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2543 *vec_ptr = vec;
2545 else
2546 inhibit_storing = 1;
2549 if (!inhibit_storing)
2550 vec[idx] = overlay;
2551 idx++;
2553 if (startpos < pos && startpos > prev)
2554 prev = startpos;
2556 else if (endpos < pos && endpos > prev)
2557 prev = endpos;
2558 else if (endpos == pos && startpos > prev
2559 && (!change_req || startpos < pos))
2560 prev = startpos;
2563 if (next_ptr)
2564 *next_ptr = next;
2565 if (prev_ptr)
2566 *prev_ptr = prev;
2567 return idx;
2570 /* Find all the overlays in the current buffer that overlap the range BEG-END
2571 or are empty at BEG.
2573 Return the number found, and store them in a vector in *VEC_PTR.
2574 Store in *LEN_PTR the size allocated for the vector.
2575 Store in *NEXT_PTR the next position after POS where an overlay starts,
2576 or ZV if there are no more overlays.
2577 Store in *PREV_PTR the previous position before POS where an overlay ends,
2578 or BEGV if there are no previous overlays.
2579 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2581 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2582 when this function is called.
2584 If EXTEND is non-zero, we make the vector bigger if necessary.
2585 If EXTEND is zero, we never extend the vector,
2586 and we store only as many overlays as will fit.
2587 But we still return the total number of overlays. */
2590 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2591 int beg, end;
2592 int extend;
2593 Lisp_Object **vec_ptr;
2594 int *len_ptr;
2595 int *next_ptr;
2596 int *prev_ptr;
2598 Lisp_Object tail, overlay, ostart, oend;
2599 int idx = 0;
2600 int len = *len_ptr;
2601 Lisp_Object *vec = *vec_ptr;
2602 int next = ZV;
2603 int prev = BEGV;
2604 int inhibit_storing = 0;
2606 for (tail = current_buffer->overlays_before;
2607 GC_CONSP (tail);
2608 tail = XCDR (tail))
2610 int startpos, endpos;
2612 overlay = XCAR (tail);
2614 ostart = OVERLAY_START (overlay);
2615 oend = OVERLAY_END (overlay);
2616 endpos = OVERLAY_POSITION (oend);
2617 if (endpos < beg)
2619 if (prev < endpos)
2620 prev = endpos;
2621 break;
2623 startpos = OVERLAY_POSITION (ostart);
2624 /* Count an interval if it either overlaps the range
2625 or is empty at the start of the range. */
2626 if ((beg < endpos && startpos < end)
2627 || (startpos == endpos && beg == endpos))
2629 if (idx == len)
2631 /* The supplied vector is full.
2632 Either make it bigger, or don't store any more in it. */
2633 if (extend)
2635 *len_ptr = len *= 2;
2636 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2637 *vec_ptr = vec;
2639 else
2640 inhibit_storing = 1;
2643 if (!inhibit_storing)
2644 vec[idx] = overlay;
2645 /* Keep counting overlays even if we can't return them all. */
2646 idx++;
2648 else if (startpos < next)
2649 next = startpos;
2652 for (tail = current_buffer->overlays_after;
2653 GC_CONSP (tail);
2654 tail = XCDR (tail))
2656 int startpos, endpos;
2658 overlay = XCAR (tail);
2660 ostart = OVERLAY_START (overlay);
2661 oend = OVERLAY_END (overlay);
2662 startpos = OVERLAY_POSITION (ostart);
2663 if (end < startpos)
2665 if (startpos < next)
2666 next = startpos;
2667 break;
2669 endpos = OVERLAY_POSITION (oend);
2670 /* Count an interval if it either overlaps the range
2671 or is empty at the start of the range. */
2672 if ((beg < endpos && startpos < end)
2673 || (startpos == endpos && beg == endpos))
2675 if (idx == len)
2677 if (extend)
2679 *len_ptr = len *= 2;
2680 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2681 *vec_ptr = vec;
2683 else
2684 inhibit_storing = 1;
2687 if (!inhibit_storing)
2688 vec[idx] = overlay;
2689 idx++;
2691 else if (endpos < beg && endpos > prev)
2692 prev = endpos;
2695 if (next_ptr)
2696 *next_ptr = next;
2697 if (prev_ptr)
2698 *prev_ptr = prev;
2699 return idx;
2703 /* Return non-zero if there exists an overlay with a non-nil
2704 `mouse-face' property overlapping OVERLAY. */
2707 mouse_face_overlay_overlaps (overlay)
2708 Lisp_Object overlay;
2710 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2711 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2712 int n, i, size;
2713 Lisp_Object *v, tem;
2715 size = 10;
2716 v = (Lisp_Object *) alloca (size * sizeof *v);
2717 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2718 if (n > size)
2720 v = (Lisp_Object *) alloca (n * sizeof *v);
2721 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2724 for (i = 0; i < n; ++i)
2725 if (!EQ (v[i], overlay)
2726 && (tem = Foverlay_get (overlay, Qmouse_face),
2727 !NILP (tem)))
2728 break;
2730 return i < n;
2735 /* Fast function to just test if we're at an overlay boundary. */
2737 overlay_touches_p (pos)
2738 int pos;
2740 Lisp_Object tail, overlay;
2742 for (tail = current_buffer->overlays_before; GC_CONSP (tail);
2743 tail = XCDR (tail))
2745 int endpos;
2747 overlay = XCAR (tail);
2748 if (!GC_OVERLAYP (overlay))
2749 abort ();
2751 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2752 if (endpos < pos)
2753 break;
2754 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2755 return 1;
2758 for (tail = current_buffer->overlays_after; GC_CONSP (tail);
2759 tail = XCDR (tail))
2761 int startpos;
2763 overlay = XCAR (tail);
2764 if (!GC_OVERLAYP (overlay))
2765 abort ();
2767 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2768 if (pos < startpos)
2769 break;
2770 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2771 return 1;
2773 return 0;
2776 struct sortvec
2778 Lisp_Object overlay;
2779 int beg, end;
2780 int priority;
2783 static int
2784 compare_overlays (v1, v2)
2785 const void *v1, *v2;
2787 const struct sortvec *s1 = (const struct sortvec *) v1;
2788 const struct sortvec *s2 = (const struct sortvec *) v2;
2789 if (s1->priority != s2->priority)
2790 return s1->priority - s2->priority;
2791 if (s1->beg != s2->beg)
2792 return s1->beg - s2->beg;
2793 if (s1->end != s2->end)
2794 return s2->end - s1->end;
2795 return 0;
2798 /* Sort an array of overlays by priority. The array is modified in place.
2799 The return value is the new size; this may be smaller than the original
2800 size if some of the overlays were invalid or were window-specific. */
2802 sort_overlays (overlay_vec, noverlays, w)
2803 Lisp_Object *overlay_vec;
2804 int noverlays;
2805 struct window *w;
2807 int i, j;
2808 struct sortvec *sortvec;
2809 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2811 /* Put the valid and relevant overlays into sortvec. */
2813 for (i = 0, j = 0; i < noverlays; i++)
2815 Lisp_Object tem;
2816 Lisp_Object overlay;
2818 overlay = overlay_vec[i];
2819 if (OVERLAY_VALID (overlay)
2820 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2821 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2823 /* If we're interested in a specific window, then ignore
2824 overlays that are limited to some other window. */
2825 if (w)
2827 Lisp_Object window;
2829 window = Foverlay_get (overlay, Qwindow);
2830 if (WINDOWP (window) && XWINDOW (window) != w)
2831 continue;
2834 /* This overlay is good and counts: put it into sortvec. */
2835 sortvec[j].overlay = overlay;
2836 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2837 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2838 tem = Foverlay_get (overlay, Qpriority);
2839 if (INTEGERP (tem))
2840 sortvec[j].priority = XINT (tem);
2841 else
2842 sortvec[j].priority = 0;
2843 j++;
2846 noverlays = j;
2848 /* Sort the overlays into the proper order: increasing priority. */
2850 if (noverlays > 1)
2851 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2853 for (i = 0; i < noverlays; i++)
2854 overlay_vec[i] = sortvec[i].overlay;
2855 return (noverlays);
2858 struct sortstr
2860 Lisp_Object string, string2;
2861 int size;
2862 int priority;
2865 struct sortstrlist
2867 struct sortstr *buf; /* An array that expands as needed; never freed. */
2868 int size; /* Allocated length of that array. */
2869 int used; /* How much of the array is currently in use. */
2870 int bytes; /* Total length of the strings in buf. */
2873 /* Buffers for storing information about the overlays touching a given
2874 position. These could be automatic variables in overlay_strings, but
2875 it's more efficient to hold onto the memory instead of repeatedly
2876 allocating and freeing it. */
2877 static struct sortstrlist overlay_heads, overlay_tails;
2878 static unsigned char *overlay_str_buf;
2880 /* Allocated length of overlay_str_buf. */
2881 static int overlay_str_len;
2883 /* A comparison function suitable for passing to qsort. */
2884 static int
2885 cmp_for_strings (as1, as2)
2886 char *as1, *as2;
2888 struct sortstr *s1 = (struct sortstr *)as1;
2889 struct sortstr *s2 = (struct sortstr *)as2;
2890 if (s1->size != s2->size)
2891 return s2->size - s1->size;
2892 if (s1->priority != s2->priority)
2893 return s1->priority - s2->priority;
2894 return 0;
2897 static void
2898 record_overlay_string (ssl, str, str2, pri, size)
2899 struct sortstrlist *ssl;
2900 Lisp_Object str, str2, pri;
2901 int size;
2903 int nbytes;
2905 if (ssl->used == ssl->size)
2907 if (ssl->buf)
2908 ssl->size *= 2;
2909 else
2910 ssl->size = 5;
2911 ssl->buf = ((struct sortstr *)
2912 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2914 ssl->buf[ssl->used].string = str;
2915 ssl->buf[ssl->used].string2 = str2;
2916 ssl->buf[ssl->used].size = size;
2917 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2918 ssl->used++;
2920 if (NILP (current_buffer->enable_multibyte_characters))
2921 nbytes = XSTRING (str)->size;
2922 else if (! STRING_MULTIBYTE (str))
2923 nbytes = count_size_as_multibyte (XSTRING (str)->data,
2924 STRING_BYTES (XSTRING (str)));
2925 else
2926 nbytes = STRING_BYTES (XSTRING (str));
2928 ssl->bytes += nbytes;
2930 if (STRINGP (str2))
2932 if (NILP (current_buffer->enable_multibyte_characters))
2933 nbytes = XSTRING (str2)->size;
2934 else if (! STRING_MULTIBYTE (str2))
2935 nbytes = count_size_as_multibyte (XSTRING (str2)->data,
2936 STRING_BYTES (XSTRING (str2)));
2937 else
2938 nbytes = STRING_BYTES (XSTRING (str2));
2940 ssl->bytes += nbytes;
2944 /* Return the concatenation of the strings associated with overlays that
2945 begin or end at POS, ignoring overlays that are specific to a window
2946 other than W. The strings are concatenated in the appropriate order:
2947 shorter overlays nest inside longer ones, and higher priority inside
2948 lower. Normally all of the after-strings come first, but zero-sized
2949 overlays have their after-strings ride along with the before-strings
2950 because it would look strange to print them inside-out.
2952 Returns the string length, and stores the contents indirectly through
2953 PSTR, if that variable is non-null. The string may be overwritten by
2954 subsequent calls. */
2957 overlay_strings (pos, w, pstr)
2958 int pos;
2959 struct window *w;
2960 unsigned char **pstr;
2962 Lisp_Object ov, overlay, window, str;
2963 int startpos, endpos;
2964 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
2966 overlay_heads.used = overlay_heads.bytes = 0;
2967 overlay_tails.used = overlay_tails.bytes = 0;
2968 for (ov = current_buffer->overlays_before; CONSP (ov); ov = XCDR (ov))
2970 overlay = XCAR (ov);
2971 if (!OVERLAYP (overlay))
2972 abort ();
2974 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2975 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2976 if (endpos < pos)
2977 break;
2978 if (endpos != pos && startpos != pos)
2979 continue;
2980 window = Foverlay_get (overlay, Qwindow);
2981 if (WINDOWP (window) && XWINDOW (window) != w)
2982 continue;
2983 if (startpos == pos
2984 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2985 record_overlay_string (&overlay_heads, str,
2986 (startpos == endpos
2987 ? Foverlay_get (overlay, Qafter_string)
2988 : Qnil),
2989 Foverlay_get (overlay, Qpriority),
2990 endpos - startpos);
2991 else if (endpos == pos
2992 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2993 record_overlay_string (&overlay_tails, str, Qnil,
2994 Foverlay_get (overlay, Qpriority),
2995 endpos - startpos);
2997 for (ov = current_buffer->overlays_after; CONSP (ov); ov = XCDR (ov))
2999 overlay = XCAR (ov);
3000 if (!OVERLAYP (overlay))
3001 abort ();
3003 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3004 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3005 if (startpos > pos)
3006 break;
3007 if (endpos != pos && startpos != pos)
3008 continue;
3009 window = Foverlay_get (overlay, Qwindow);
3010 if (WINDOWP (window) && XWINDOW (window) != w)
3011 continue;
3012 if (startpos == pos
3013 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3014 record_overlay_string (&overlay_heads, str,
3015 (startpos == endpos
3016 ? Foverlay_get (overlay, Qafter_string)
3017 : Qnil),
3018 Foverlay_get (overlay, Qpriority),
3019 endpos - startpos);
3020 else if (endpos == pos
3021 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3022 record_overlay_string (&overlay_tails, str, Qnil,
3023 Foverlay_get (overlay, Qpriority),
3024 endpos - startpos);
3026 if (overlay_tails.used > 1)
3027 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3028 cmp_for_strings);
3029 if (overlay_heads.used > 1)
3030 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3031 cmp_for_strings);
3032 if (overlay_heads.bytes || overlay_tails.bytes)
3034 Lisp_Object tem;
3035 int i;
3036 unsigned char *p;
3037 int total = overlay_heads.bytes + overlay_tails.bytes;
3039 if (total > overlay_str_len)
3041 overlay_str_len = total;
3042 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3043 total);
3045 p = overlay_str_buf;
3046 for (i = overlay_tails.used; --i >= 0;)
3048 int nbytes;
3049 tem = overlay_tails.buf[i].string;
3050 nbytes = copy_text (XSTRING (tem)->data, p,
3051 STRING_BYTES (XSTRING (tem)),
3052 STRING_MULTIBYTE (tem), multibyte);
3053 p += nbytes;
3055 for (i = 0; i < overlay_heads.used; ++i)
3057 int nbytes;
3058 tem = overlay_heads.buf[i].string;
3059 nbytes = copy_text (XSTRING (tem)->data, p,
3060 STRING_BYTES (XSTRING (tem)),
3061 STRING_MULTIBYTE (tem), multibyte);
3062 p += nbytes;
3063 tem = overlay_heads.buf[i].string2;
3064 if (STRINGP (tem))
3066 nbytes = copy_text (XSTRING (tem)->data, p,
3067 STRING_BYTES (XSTRING (tem)),
3068 STRING_MULTIBYTE (tem), multibyte);
3069 p += nbytes;
3072 if (p != overlay_str_buf + total)
3073 abort ();
3074 if (pstr)
3075 *pstr = overlay_str_buf;
3076 return total;
3078 return 0;
3081 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3083 void
3084 recenter_overlay_lists (buf, pos)
3085 struct buffer *buf;
3086 int pos;
3088 Lisp_Object overlay, tail, next, prev, beg, end;
3090 /* See if anything in overlays_before should move to overlays_after. */
3092 /* We don't strictly need prev in this loop; it should always be nil.
3093 But we use it for symmetry and in case that should cease to be true
3094 with some future change. */
3095 prev = Qnil;
3096 for (tail = buf->overlays_before;
3097 CONSP (tail);
3098 prev = tail, tail = next)
3100 next = XCDR (tail);
3101 overlay = XCAR (tail);
3103 /* If the overlay is not valid, get rid of it. */
3104 if (!OVERLAY_VALID (overlay))
3105 #if 1
3106 abort ();
3107 #else
3109 /* Splice the cons cell TAIL out of overlays_before. */
3110 if (!NILP (prev))
3111 XCDR (prev) = next;
3112 else
3113 buf->overlays_before = next;
3114 tail = prev;
3115 continue;
3117 #endif
3119 beg = OVERLAY_START (overlay);
3120 end = OVERLAY_END (overlay);
3122 if (OVERLAY_POSITION (end) > pos)
3124 /* OVERLAY needs to be moved. */
3125 int where = OVERLAY_POSITION (beg);
3126 Lisp_Object other, other_prev;
3128 /* Splice the cons cell TAIL out of overlays_before. */
3129 if (!NILP (prev))
3130 XSETCDR (prev, next);
3131 else
3132 buf->overlays_before = next;
3134 /* Search thru overlays_after for where to put it. */
3135 other_prev = Qnil;
3136 for (other = buf->overlays_after;
3137 CONSP (other);
3138 other_prev = other, other = XCDR (other))
3140 Lisp_Object otherbeg, otheroverlay;
3142 otheroverlay = XCAR (other);
3143 if (! OVERLAY_VALID (otheroverlay))
3144 abort ();
3146 otherbeg = OVERLAY_START (otheroverlay);
3147 if (OVERLAY_POSITION (otherbeg) >= where)
3148 break;
3151 /* Add TAIL to overlays_after before OTHER. */
3152 XSETCDR (tail, other);
3153 if (!NILP (other_prev))
3154 XSETCDR (other_prev, tail);
3155 else
3156 buf->overlays_after = tail;
3157 tail = prev;
3159 else
3160 /* We've reached the things that should stay in overlays_before.
3161 All the rest of overlays_before must end even earlier,
3162 so stop now. */
3163 break;
3166 /* See if anything in overlays_after should be in overlays_before. */
3167 prev = Qnil;
3168 for (tail = buf->overlays_after;
3169 CONSP (tail);
3170 prev = tail, tail = next)
3172 next = XCDR (tail);
3173 overlay = XCAR (tail);
3175 /* If the overlay is not valid, get rid of it. */
3176 if (!OVERLAY_VALID (overlay))
3177 #if 1
3178 abort ();
3179 #else
3181 /* Splice the cons cell TAIL out of overlays_after. */
3182 if (!NILP (prev))
3183 XCDR (prev) = next;
3184 else
3185 buf->overlays_after = next;
3186 tail = prev;
3187 continue;
3189 #endif
3191 beg = OVERLAY_START (overlay);
3192 end = OVERLAY_END (overlay);
3194 /* Stop looking, when we know that nothing further
3195 can possibly end before POS. */
3196 if (OVERLAY_POSITION (beg) > pos)
3197 break;
3199 if (OVERLAY_POSITION (end) <= pos)
3201 /* OVERLAY needs to be moved. */
3202 int where = OVERLAY_POSITION (end);
3203 Lisp_Object other, other_prev;
3205 /* Splice the cons cell TAIL out of overlays_after. */
3206 if (!NILP (prev))
3207 XSETCDR (prev, next);
3208 else
3209 buf->overlays_after = next;
3211 /* Search thru overlays_before for where to put it. */
3212 other_prev = Qnil;
3213 for (other = buf->overlays_before;
3214 CONSP (other);
3215 other_prev = other, other = XCDR (other))
3217 Lisp_Object otherend, otheroverlay;
3219 otheroverlay = XCAR (other);
3220 if (! OVERLAY_VALID (otheroverlay))
3221 abort ();
3223 otherend = OVERLAY_END (otheroverlay);
3224 if (OVERLAY_POSITION (otherend) <= where)
3225 break;
3228 /* Add TAIL to overlays_before before OTHER. */
3229 XSETCDR (tail, other);
3230 if (!NILP (other_prev))
3231 XSETCDR (other_prev, tail);
3232 else
3233 buf->overlays_before = tail;
3234 tail = prev;
3238 XSETFASTINT (buf->overlay_center, pos);
3241 void
3242 adjust_overlays_for_insert (pos, length)
3243 int pos;
3244 int length;
3246 /* After an insertion, the lists are still sorted properly,
3247 but we may need to update the value of the overlay center. */
3248 if (XFASTINT (current_buffer->overlay_center) >= pos)
3249 XSETFASTINT (current_buffer->overlay_center,
3250 XFASTINT (current_buffer->overlay_center) + length);
3253 void
3254 adjust_overlays_for_delete (pos, length)
3255 int pos;
3256 int length;
3258 if (XFASTINT (current_buffer->overlay_center) < pos)
3259 /* The deletion was to our right. No change needed; the before- and
3260 after-lists are still consistent. */
3262 else if (XFASTINT (current_buffer->overlay_center) > pos + length)
3263 /* The deletion was to our left. We need to adjust the center value
3264 to account for the change in position, but the lists are consistent
3265 given the new value. */
3266 XSETFASTINT (current_buffer->overlay_center,
3267 XFASTINT (current_buffer->overlay_center) - length);
3268 else
3269 /* We're right in the middle. There might be things on the after-list
3270 that now belong on the before-list. Recentering will move them,
3271 and also update the center point. */
3272 recenter_overlay_lists (current_buffer, pos);
3275 /* Fix up overlays that were garbled as a result of permuting markers
3276 in the range START through END. Any overlay with at least one
3277 endpoint in this range will need to be unlinked from the overlay
3278 list and reinserted in its proper place.
3279 Such an overlay might even have negative size at this point.
3280 If so, we'll reverse the endpoints. Can you think of anything
3281 better to do in this situation? */
3282 void
3283 fix_overlays_in_range (start, end)
3284 register int start, end;
3286 Lisp_Object overlay;
3287 Lisp_Object before_list, after_list;
3288 Lisp_Object *ptail, *pbefore = &before_list, *pafter = &after_list;
3289 int startpos, endpos;
3291 /* This algorithm shifts links around instead of consing and GCing.
3292 The loop invariant is that before_list (resp. after_list) is a
3293 well-formed list except that its last element, the one that
3294 *pbefore (resp. *pafter) points to, is still uninitialized.
3295 So it's not a bug that before_list isn't initialized, although
3296 it may look strange. */
3297 for (ptail = &current_buffer->overlays_before; CONSP (*ptail);)
3299 overlay = XCAR (*ptail);
3300 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3301 if (endpos < start)
3302 break;
3303 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3304 if (endpos < end
3305 || (startpos >= start && startpos < end))
3307 /* If the overlay is backwards, fix that now. */
3308 if (startpos > endpos)
3310 int tem;
3311 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3312 Qnil);
3313 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3314 Qnil);
3315 tem = startpos; startpos = endpos; endpos = tem;
3317 /* Add it to the end of the wrong list. Later on,
3318 recenter_overlay_lists will move it to the right place. */
3319 if (endpos < XINT (current_buffer->overlay_center))
3321 *pafter = *ptail;
3322 pafter = &XCDR (*ptail);
3324 else
3326 *pbefore = *ptail;
3327 pbefore = &XCDR (*ptail);
3329 *ptail = XCDR (*ptail);
3331 else
3332 ptail = &XCDR (*ptail);
3334 for (ptail = &current_buffer->overlays_after; CONSP (*ptail);)
3336 overlay = XCAR (*ptail);
3337 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3338 if (startpos >= end)
3339 break;
3340 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3341 if (startpos >= start
3342 || (endpos >= start && endpos < end))
3344 if (startpos > endpos)
3346 int tem;
3347 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3348 Qnil);
3349 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3350 Qnil);
3351 tem = startpos; startpos = endpos; endpos = tem;
3353 if (endpos < XINT (current_buffer->overlay_center))
3355 *pafter = *ptail;
3356 pafter = &XCDR (*ptail);
3358 else
3360 *pbefore = *ptail;
3361 pbefore = &XCDR (*ptail);
3363 *ptail = XCDR (*ptail);
3365 else
3366 ptail = &XCDR (*ptail);
3369 /* Splice the constructed (wrong) lists into the buffer's lists,
3370 and let the recenter function make it sane again. */
3371 *pbefore = current_buffer->overlays_before;
3372 current_buffer->overlays_before = before_list;
3373 recenter_overlay_lists (current_buffer,
3374 XINT (current_buffer->overlay_center));
3376 *pafter = current_buffer->overlays_after;
3377 current_buffer->overlays_after = after_list;
3378 recenter_overlay_lists (current_buffer,
3379 XINT (current_buffer->overlay_center));
3382 /* We have two types of overlay: the one whose ending marker is
3383 after-insertion-marker (this is the usual case) and the one whose
3384 ending marker is before-insertion-marker. When `overlays_before'
3385 contains overlays of the latter type and the former type in this
3386 order and both overlays end at inserting position, inserting a text
3387 increases only the ending marker of the latter type, which results
3388 in incorrect ordering of `overlays_before'.
3390 This function fixes ordering of overlays in the slot
3391 `overlays_before' of the buffer *BP. Before the insertion, `point'
3392 was at PREV, and now is at POS. */
3394 void
3395 fix_overlays_before (bp, prev, pos)
3396 struct buffer *bp;
3397 int prev, pos;
3399 Lisp_Object *tailp = &bp->overlays_before;
3400 Lisp_Object *right_place;
3401 int end;
3403 /* After the insertion, the several overlays may be in incorrect
3404 order. The possibility is that, in the list `overlays_before',
3405 an overlay which ends at POS appears after an overlay which ends
3406 at PREV. Since POS is greater than PREV, we must fix the
3407 ordering of these overlays, by moving overlays ends at POS before
3408 the overlays ends at PREV. */
3410 /* At first, find a place where disordered overlays should be linked
3411 in. It is where an overlay which end before POS exists. (i.e. an
3412 overlay whose ending marker is after-insertion-marker if disorder
3413 exists). */
3414 while (!NILP (*tailp)
3415 && ((end = OVERLAY_POSITION (OVERLAY_END (XCAR (*tailp))))
3416 >= pos))
3417 tailp = &XCDR (*tailp);
3419 /* If we don't find such an overlay,
3420 or the found one ends before PREV,
3421 or the found one is the last one in the list,
3422 we don't have to fix anything. */
3423 if (NILP (*tailp)
3424 || end < prev
3425 || NILP (XCDR (*tailp)))
3426 return;
3428 right_place = tailp;
3429 tailp = &XCDR (*tailp);
3431 /* Now, end position of overlays in the list *TAILP should be before
3432 or equal to PREV. In the loop, an overlay which ends at POS is
3433 moved ahead to the place pointed by RIGHT_PLACE. If we found an
3434 overlay which ends before PREV, the remaining overlays are in
3435 correct order. */
3436 while (!NILP (*tailp))
3438 end = OVERLAY_POSITION (OVERLAY_END (XCAR (*tailp)));
3440 if (end == pos)
3441 { /* This overlay is disordered. */
3442 Lisp_Object found = *tailp;
3444 /* Unlink the found overlay. */
3445 *tailp = XCDR (found);
3446 /* Move an overlay at RIGHT_PLACE to the next of the found one. */
3447 XCDR (found) = *right_place;
3448 /* Link it into the right place. */
3449 *right_place = found;
3451 else if (end == prev)
3452 tailp = &XCDR (*tailp);
3453 else /* No more disordered overlay. */
3454 break;
3458 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3459 doc: /* Return t if OBJECT is an overlay. */)
3460 (object)
3461 Lisp_Object object;
3463 return (OVERLAYP (object) ? Qt : Qnil);
3466 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3467 doc: /* Create a new overlay with range BEG to END in BUFFER.
3468 If omitted, BUFFER defaults to the current buffer.
3469 BEG and END may be integers or markers.
3470 The fourth arg FRONT-ADVANCE, if non-nil, makes the
3471 front delimiter advance when text is inserted there.
3472 The fifth arg REAR-ADVANCE, if non-nil, makes the
3473 rear delimiter advance when text is inserted there. */)
3474 (beg, end, buffer, front_advance, rear_advance)
3475 Lisp_Object beg, end, buffer;
3476 Lisp_Object front_advance, rear_advance;
3478 Lisp_Object overlay;
3479 struct buffer *b;
3481 if (NILP (buffer))
3482 XSETBUFFER (buffer, current_buffer);
3483 else
3484 CHECK_BUFFER (buffer);
3485 if (MARKERP (beg)
3486 && ! EQ (Fmarker_buffer (beg), buffer))
3487 error ("Marker points into wrong buffer");
3488 if (MARKERP (end)
3489 && ! EQ (Fmarker_buffer (end), buffer))
3490 error ("Marker points into wrong buffer");
3492 CHECK_NUMBER_COERCE_MARKER (beg);
3493 CHECK_NUMBER_COERCE_MARKER (end);
3495 if (XINT (beg) > XINT (end))
3497 Lisp_Object temp;
3498 temp = beg; beg = end; end = temp;
3501 b = XBUFFER (buffer);
3503 beg = Fset_marker (Fmake_marker (), beg, buffer);
3504 end = Fset_marker (Fmake_marker (), end, buffer);
3506 if (!NILP (front_advance))
3507 XMARKER (beg)->insertion_type = 1;
3508 if (!NILP (rear_advance))
3509 XMARKER (end)->insertion_type = 1;
3511 overlay = allocate_misc ();
3512 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3513 XOVERLAY (overlay)->start = beg;
3514 XOVERLAY (overlay)->end = end;
3515 XOVERLAY (overlay)->plist = Qnil;
3517 /* Put the new overlay on the wrong list. */
3518 end = OVERLAY_END (overlay);
3519 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3520 b->overlays_after = Fcons (overlay, b->overlays_after);
3521 else
3522 b->overlays_before = Fcons (overlay, b->overlays_before);
3524 /* This puts it in the right list, and in the right order. */
3525 recenter_overlay_lists (b, XINT (b->overlay_center));
3527 /* We don't need to redisplay the region covered by the overlay, because
3528 the overlay has no properties at the moment. */
3530 return overlay;
3533 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3535 static void
3536 modify_overlay (buf, start, end)
3537 struct buffer *buf;
3538 int start, end;
3540 if (start > end)
3542 int temp = start;
3543 start = end;
3544 end = temp;
3547 BUF_COMPUTE_UNCHANGED (buf, start, end);
3549 /* If this is a buffer not in the selected window,
3550 we must do other windows. */
3551 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3552 windows_or_buffers_changed = 1;
3553 /* If multiple windows show this buffer, we must do other windows. */
3554 else if (buffer_shared > 1)
3555 windows_or_buffers_changed = 1;
3557 ++BUF_OVERLAY_MODIFF (buf);
3561 Lisp_Object Fdelete_overlay ();
3563 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3564 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3565 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3566 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3567 buffer. */)
3568 (overlay, beg, end, buffer)
3569 Lisp_Object overlay, beg, end, buffer;
3571 struct buffer *b, *ob;
3572 Lisp_Object obuffer;
3573 int count = specpdl_ptr - specpdl;
3575 CHECK_OVERLAY (overlay);
3576 if (NILP (buffer))
3577 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3578 if (NILP (buffer))
3579 XSETBUFFER (buffer, current_buffer);
3580 CHECK_BUFFER (buffer);
3582 if (MARKERP (beg)
3583 && ! EQ (Fmarker_buffer (beg), buffer))
3584 error ("Marker points into wrong buffer");
3585 if (MARKERP (end)
3586 && ! EQ (Fmarker_buffer (end), buffer))
3587 error ("Marker points into wrong buffer");
3589 CHECK_NUMBER_COERCE_MARKER (beg);
3590 CHECK_NUMBER_COERCE_MARKER (end);
3592 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3593 return Fdelete_overlay (overlay);
3595 if (XINT (beg) > XINT (end))
3597 Lisp_Object temp;
3598 temp = beg; beg = end; end = temp;
3601 specbind (Qinhibit_quit, Qt);
3603 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3604 b = XBUFFER (buffer);
3605 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3607 /* If the overlay has changed buffers, do a thorough redisplay. */
3608 if (!EQ (buffer, obuffer))
3610 /* Redisplay where the overlay was. */
3611 if (!NILP (obuffer))
3613 int o_beg;
3614 int o_end;
3616 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3617 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3619 modify_overlay (ob, o_beg, o_end);
3622 /* Redisplay where the overlay is going to be. */
3623 modify_overlay (b, XINT (beg), XINT (end));
3625 else
3626 /* Redisplay the area the overlay has just left, or just enclosed. */
3628 int o_beg, o_end;
3630 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3631 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3633 if (o_beg == XINT (beg))
3634 modify_overlay (b, o_end, XINT (end));
3635 else if (o_end == XINT (end))
3636 modify_overlay (b, o_beg, XINT (beg));
3637 else
3639 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3640 if (XINT (end) > o_end) o_end = XINT (end);
3641 modify_overlay (b, o_beg, o_end);
3645 if (!NILP (obuffer))
3647 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
3648 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
3651 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3652 Fset_marker (OVERLAY_END (overlay), end, buffer);
3654 /* Put the overlay on the wrong list. */
3655 end = OVERLAY_END (overlay);
3656 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
3657 b->overlays_after = Fcons (overlay, b->overlays_after);
3658 else
3659 b->overlays_before = Fcons (overlay, b->overlays_before);
3661 /* This puts it in the right list, and in the right order. */
3662 recenter_overlay_lists (b, XINT (b->overlay_center));
3664 return unbind_to (count, overlay);
3667 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3668 doc: /* Delete the overlay OVERLAY from its buffer. */)
3669 (overlay)
3670 Lisp_Object overlay;
3672 Lisp_Object buffer;
3673 struct buffer *b;
3674 int count = specpdl_ptr - specpdl;
3676 CHECK_OVERLAY (overlay);
3678 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3679 if (NILP (buffer))
3680 return Qnil;
3682 b = XBUFFER (buffer);
3683 specbind (Qinhibit_quit, Qt);
3685 b->overlays_before = Fdelq (overlay, b->overlays_before);
3686 b->overlays_after = Fdelq (overlay, b->overlays_after);
3687 modify_overlay (b,
3688 marker_position (OVERLAY_START (overlay)),
3689 marker_position (OVERLAY_END (overlay)));
3690 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3691 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3693 /* When deleting an overlay with before or after strings, turn off
3694 display optimizations for the affected buffer, on the basis that
3695 these strings may contain newlines. This is easier to do than to
3696 check for that situation during redisplay. */
3697 if (!windows_or_buffers_changed
3698 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3699 || !NILP (Foverlay_get (overlay, Qafter_string))))
3700 b->prevent_redisplay_optimizations_p = 1;
3702 return unbind_to (count, Qnil);
3705 /* Overlay dissection functions. */
3707 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3708 doc: /* Return the position at which OVERLAY starts. */)
3709 (overlay)
3710 Lisp_Object overlay;
3712 CHECK_OVERLAY (overlay);
3714 return (Fmarker_position (OVERLAY_START (overlay)));
3717 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3718 doc: /* Return the position at which OVERLAY ends. */)
3719 (overlay)
3720 Lisp_Object overlay;
3722 CHECK_OVERLAY (overlay);
3724 return (Fmarker_position (OVERLAY_END (overlay)));
3727 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3728 doc: /* Return the buffer OVERLAY belongs to. */)
3729 (overlay)
3730 Lisp_Object overlay;
3732 CHECK_OVERLAY (overlay);
3734 return Fmarker_buffer (OVERLAY_START (overlay));
3737 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3738 doc: /* Return a list of the properties on OVERLAY.
3739 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3740 OVERLAY. */)
3741 (overlay)
3742 Lisp_Object overlay;
3744 CHECK_OVERLAY (overlay);
3746 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3750 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3751 doc: /* Return a list of the overlays that contain position POS. */)
3752 (pos)
3753 Lisp_Object pos;
3755 int noverlays;
3756 Lisp_Object *overlay_vec;
3757 int len;
3758 Lisp_Object result;
3760 CHECK_NUMBER_COERCE_MARKER (pos);
3762 len = 10;
3763 /* We can't use alloca here because overlays_at can call xrealloc. */
3764 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3766 /* Put all the overlays we want in a vector in overlay_vec.
3767 Store the length in len. */
3768 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3769 (int *) 0, (int *) 0, 0);
3771 /* Make a list of them all. */
3772 result = Flist (noverlays, overlay_vec);
3774 xfree (overlay_vec);
3775 return result;
3778 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3779 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3780 Overlap means that at least one character is contained within the overlay
3781 and also contained within the specified region.
3782 Empty overlays are included in the result if they are located at BEG
3783 or between BEG and END. */)
3784 (beg, end)
3785 Lisp_Object beg, end;
3787 int noverlays;
3788 Lisp_Object *overlay_vec;
3789 int len;
3790 Lisp_Object result;
3792 CHECK_NUMBER_COERCE_MARKER (beg);
3793 CHECK_NUMBER_COERCE_MARKER (end);
3795 len = 10;
3796 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3798 /* Put all the overlays we want in a vector in overlay_vec.
3799 Store the length in len. */
3800 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3801 (int *) 0, (int *) 0);
3803 /* Make a list of them all. */
3804 result = Flist (noverlays, overlay_vec);
3806 xfree (overlay_vec);
3807 return result;
3810 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3811 1, 1, 0,
3812 doc: /* Return the next position after POS where an overlay starts or ends.
3813 If there are no more overlay boundaries after POS, return (point-max). */)
3814 (pos)
3815 Lisp_Object pos;
3817 int noverlays;
3818 int endpos;
3819 Lisp_Object *overlay_vec;
3820 int len;
3821 int i;
3823 CHECK_NUMBER_COERCE_MARKER (pos);
3825 len = 10;
3826 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3828 /* Put all the overlays we want in a vector in overlay_vec.
3829 Store the length in len.
3830 endpos gets the position where the next overlay starts. */
3831 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3832 &endpos, (int *) 0, 1);
3834 /* If any of these overlays ends before endpos,
3835 use its ending point instead. */
3836 for (i = 0; i < noverlays; i++)
3838 Lisp_Object oend;
3839 int oendpos;
3841 oend = OVERLAY_END (overlay_vec[i]);
3842 oendpos = OVERLAY_POSITION (oend);
3843 if (oendpos < endpos)
3844 endpos = oendpos;
3847 xfree (overlay_vec);
3848 return make_number (endpos);
3851 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3852 Sprevious_overlay_change, 1, 1, 0,
3853 doc: /* Return the previous position before POS where an overlay starts or ends.
3854 If there are no more overlay boundaries before POS, return (point-min). */)
3855 (pos)
3856 Lisp_Object pos;
3858 int noverlays;
3859 int prevpos;
3860 Lisp_Object *overlay_vec;
3861 int len;
3863 CHECK_NUMBER_COERCE_MARKER (pos);
3865 /* At beginning of buffer, we know the answer;
3866 avoid bug subtracting 1 below. */
3867 if (XINT (pos) == BEGV)
3868 return pos;
3870 len = 10;
3871 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3873 /* Put all the overlays we want in a vector in overlay_vec.
3874 Store the length in len.
3875 prevpos gets the position of the previous change. */
3876 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3877 (int *) 0, &prevpos, 1);
3879 xfree (overlay_vec);
3880 return make_number (prevpos);
3883 /* These functions are for debugging overlays. */
3885 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3886 doc: /* Return a pair of lists giving all the overlays of the current buffer.
3887 The car has all the overlays before the overlay center;
3888 the cdr has all the overlays after the overlay center.
3889 Recentering overlays moves overlays between these lists.
3890 The lists you get are copies, so that changing them has no effect.
3891 However, the overlays you get are the real objects that the buffer uses. */)
3894 Lisp_Object before, after;
3895 before = current_buffer->overlays_before;
3896 if (CONSP (before))
3897 before = Fcopy_sequence (before);
3898 after = current_buffer->overlays_after;
3899 if (CONSP (after))
3900 after = Fcopy_sequence (after);
3902 return Fcons (before, after);
3905 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
3906 doc: /* Recenter the overlays of the current buffer around position POS. */)
3907 (pos)
3908 Lisp_Object pos;
3910 CHECK_NUMBER_COERCE_MARKER (pos);
3912 recenter_overlay_lists (current_buffer, XINT (pos));
3913 return Qnil;
3916 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
3917 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
3918 (overlay, prop)
3919 Lisp_Object overlay, prop;
3921 Lisp_Object plist, fallback;
3923 CHECK_OVERLAY (overlay);
3925 fallback = Qnil;
3927 for (plist = XOVERLAY (overlay)->plist;
3928 CONSP (plist) && CONSP (XCDR (plist));
3929 plist = XCDR (XCDR (plist)))
3931 if (EQ (XCAR (plist), prop))
3932 return XCAR (XCDR (plist));
3933 else if (EQ (XCAR (plist), Qcategory))
3935 Lisp_Object tem;
3936 tem = Fcar (Fcdr (plist));
3937 if (SYMBOLP (tem))
3938 fallback = Fget (tem, prop);
3942 return fallback;
3945 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
3946 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
3947 (overlay, prop, value)
3948 Lisp_Object overlay, prop, value;
3950 Lisp_Object tail, buffer;
3951 int changed;
3953 CHECK_OVERLAY (overlay);
3955 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3957 for (tail = XOVERLAY (overlay)->plist;
3958 CONSP (tail) && CONSP (XCDR (tail));
3959 tail = XCDR (XCDR (tail)))
3960 if (EQ (XCAR (tail), prop))
3962 changed = !EQ (XCAR (XCDR (tail)), value);
3963 XSETCAR (XCDR (tail), value);
3964 goto found;
3966 /* It wasn't in the list, so add it to the front. */
3967 changed = !NILP (value);
3968 XOVERLAY (overlay)->plist
3969 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
3970 found:
3971 if (! NILP (buffer))
3973 if (changed)
3974 modify_overlay (XBUFFER (buffer),
3975 marker_position (OVERLAY_START (overlay)),
3976 marker_position (OVERLAY_END (overlay)));
3977 if (EQ (prop, Qevaporate) && ! NILP (value)
3978 && (OVERLAY_POSITION (OVERLAY_START (overlay))
3979 == OVERLAY_POSITION (OVERLAY_END (overlay))))
3980 Fdelete_overlay (overlay);
3982 return value;
3985 /* Subroutine of report_overlay_modification. */
3987 /* Lisp vector holding overlay hook functions to call.
3988 Vector elements come in pairs.
3989 Each even-index element is a list of hook functions.
3990 The following odd-index element is the overlay they came from.
3992 Before the buffer change, we fill in this vector
3993 as we call overlay hook functions.
3994 After the buffer change, we get the functions to call from this vector.
3995 This way we always call the same functions before and after the change. */
3996 static Lisp_Object last_overlay_modification_hooks;
3998 /* Number of elements actually used in last_overlay_modification_hooks. */
3999 static int last_overlay_modification_hooks_used;
4001 /* Add one functionlist/overlay pair
4002 to the end of last_overlay_modification_hooks. */
4004 static void
4005 add_overlay_mod_hooklist (functionlist, overlay)
4006 Lisp_Object functionlist, overlay;
4008 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4010 if (last_overlay_modification_hooks_used == oldsize)
4012 Lisp_Object old;
4013 old = last_overlay_modification_hooks;
4014 last_overlay_modification_hooks
4015 = Fmake_vector (make_number (oldsize * 2), Qnil);
4016 bcopy (XVECTOR (old)->contents,
4017 XVECTOR (last_overlay_modification_hooks)->contents,
4018 sizeof (Lisp_Object) * oldsize);
4020 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = functionlist;
4021 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = overlay;
4024 /* Run the modification-hooks of overlays that include
4025 any part of the text in START to END.
4026 If this change is an insertion, also
4027 run the insert-before-hooks of overlay starting at END,
4028 and the insert-after-hooks of overlay ending at START.
4030 This is called both before and after the modification.
4031 AFTER is nonzero when we call after the modification.
4033 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4034 When AFTER is nonzero, they are the start position,
4035 the position after the inserted new text,
4036 and the length of deleted or replaced old text. */
4038 void
4039 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4040 Lisp_Object start, end;
4041 int after;
4042 Lisp_Object arg1, arg2, arg3;
4044 Lisp_Object prop, overlay, tail;
4045 /* 1 if this change is an insertion. */
4046 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4047 int tail_copied;
4048 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4050 overlay = Qnil;
4051 tail = Qnil;
4052 GCPRO5 (overlay, tail, arg1, arg2, arg3);
4054 if (after)
4056 /* Call the functions recorded in last_overlay_modification_hooks
4057 rather than scanning the overlays again.
4058 First copy the vector contents, in case some of these hooks
4059 do subsequent modification of the buffer. */
4060 int size = last_overlay_modification_hooks_used;
4061 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4062 int i;
4064 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4065 copy, size * sizeof (Lisp_Object));
4066 gcpro1.var = copy;
4067 gcpro1.nvars = size;
4069 for (i = 0; i < size;)
4071 Lisp_Object prop, overlay;
4072 prop = copy[i++];
4073 overlay = copy[i++];
4074 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4076 UNGCPRO;
4077 return;
4080 /* We are being called before a change.
4081 Scan the overlays to find the functions to call. */
4082 last_overlay_modification_hooks_used = 0;
4083 tail_copied = 0;
4084 for (tail = current_buffer->overlays_before;
4085 CONSP (tail);
4086 tail = XCDR (tail))
4088 int startpos, endpos;
4089 Lisp_Object ostart, oend;
4091 overlay = XCAR (tail);
4093 ostart = OVERLAY_START (overlay);
4094 oend = OVERLAY_END (overlay);
4095 endpos = OVERLAY_POSITION (oend);
4096 if (XFASTINT (start) > endpos)
4097 break;
4098 startpos = OVERLAY_POSITION (ostart);
4099 if (insertion && (XFASTINT (start) == startpos
4100 || XFASTINT (end) == startpos))
4102 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4103 if (!NILP (prop))
4105 /* Copy TAIL in case the hook recenters the overlay lists. */
4106 if (!tail_copied)
4107 tail = Fcopy_sequence (tail);
4108 tail_copied = 1;
4109 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4112 if (insertion && (XFASTINT (start) == endpos
4113 || XFASTINT (end) == endpos))
4115 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4116 if (!NILP (prop))
4118 if (!tail_copied)
4119 tail = Fcopy_sequence (tail);
4120 tail_copied = 1;
4121 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4124 /* Test for intersecting intervals. This does the right thing
4125 for both insertion and deletion. */
4126 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4128 prop = Foverlay_get (overlay, Qmodification_hooks);
4129 if (!NILP (prop))
4131 if (!tail_copied)
4132 tail = Fcopy_sequence (tail);
4133 tail_copied = 1;
4134 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4139 tail_copied = 0;
4140 for (tail = current_buffer->overlays_after;
4141 CONSP (tail);
4142 tail = XCDR (tail))
4144 int startpos, endpos;
4145 Lisp_Object ostart, oend;
4147 overlay = XCAR (tail);
4149 ostart = OVERLAY_START (overlay);
4150 oend = OVERLAY_END (overlay);
4151 startpos = OVERLAY_POSITION (ostart);
4152 endpos = OVERLAY_POSITION (oend);
4153 if (XFASTINT (end) < startpos)
4154 break;
4155 if (insertion && (XFASTINT (start) == startpos
4156 || XFASTINT (end) == startpos))
4158 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4159 if (!NILP (prop))
4161 if (!tail_copied)
4162 tail = Fcopy_sequence (tail);
4163 tail_copied = 1;
4164 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4167 if (insertion && (XFASTINT (start) == endpos
4168 || XFASTINT (end) == endpos))
4170 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4171 if (!NILP (prop))
4173 if (!tail_copied)
4174 tail = Fcopy_sequence (tail);
4175 tail_copied = 1;
4176 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4179 /* Test for intersecting intervals. This does the right thing
4180 for both insertion and deletion. */
4181 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4183 prop = Foverlay_get (overlay, Qmodification_hooks);
4184 if (!NILP (prop))
4186 if (!tail_copied)
4187 tail = Fcopy_sequence (tail);
4188 tail_copied = 1;
4189 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4194 UNGCPRO;
4197 static void
4198 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4199 Lisp_Object list, overlay;
4200 int after;
4201 Lisp_Object arg1, arg2, arg3;
4203 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4205 GCPRO4 (list, arg1, arg2, arg3);
4206 if (! after)
4207 add_overlay_mod_hooklist (list, overlay);
4209 while (!NILP (list))
4211 if (NILP (arg3))
4212 call4 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2);
4213 else
4214 call5 (Fcar (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4215 list = Fcdr (list);
4217 UNGCPRO;
4220 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4221 property is set. */
4222 void
4223 evaporate_overlays (pos)
4224 int pos;
4226 Lisp_Object tail, overlay, hit_list;
4228 hit_list = Qnil;
4229 if (pos <= XFASTINT (current_buffer->overlay_center))
4230 for (tail = current_buffer->overlays_before; CONSP (tail);
4231 tail = XCDR (tail))
4233 int endpos;
4234 overlay = XCAR (tail);
4235 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4236 if (endpos < pos)
4237 break;
4238 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4239 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4240 hit_list = Fcons (overlay, hit_list);
4242 else
4243 for (tail = current_buffer->overlays_after; CONSP (tail);
4244 tail = XCDR (tail))
4246 int startpos;
4247 overlay = XCAR (tail);
4248 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4249 if (startpos > pos)
4250 break;
4251 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4252 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4253 hit_list = Fcons (overlay, hit_list);
4255 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4256 Fdelete_overlay (XCAR (hit_list));
4259 /* Somebody has tried to store a value with an unacceptable type
4260 in the slot with offset OFFSET. */
4262 void
4263 buffer_slot_type_mismatch (offset)
4264 int offset;
4266 Lisp_Object sym;
4267 char *type_name;
4269 switch (XINT (PER_BUFFER_TYPE (offset)))
4271 case Lisp_Int:
4272 type_name = "integers";
4273 break;
4275 case Lisp_String:
4276 type_name = "strings";
4277 break;
4279 case Lisp_Symbol:
4280 type_name = "symbols";
4281 break;
4283 default:
4284 abort ();
4287 sym = PER_BUFFER_SYMBOL (offset);
4288 error ("Only %s should be stored in the buffer-local variable %s",
4289 type_name, XSYMBOL (sym)->name->data);
4293 /***********************************************************************
4294 Allocation with mmap
4295 ***********************************************************************/
4297 #ifdef USE_MMAP_FOR_BUFFERS
4299 #include <sys/types.h>
4300 #include <sys/mman.h>
4302 #ifndef MAP_ANON
4303 #ifdef MAP_ANONYMOUS
4304 #define MAP_ANON MAP_ANONYMOUS
4305 #else
4306 #define MAP_ANON 0
4307 #endif
4308 #endif
4310 #ifndef MAP_FAILED
4311 #define MAP_FAILED ((void *) -1)
4312 #endif
4314 #include <stdio.h>
4315 #include <errno.h>
4317 #if MAP_ANON == 0
4318 #include <fcntl.h>
4319 #endif
4322 /* Memory is allocated in regions which are mapped using mmap(2).
4323 The current implementation lets the system select mapped
4324 addresses; we're not using MAP_FIXED in general, except when
4325 trying to enlarge regions.
4327 Each mapped region starts with a mmap_region structure, the user
4328 area starts after that structure, aligned to MEM_ALIGN.
4330 +-----------------------+
4331 | struct mmap_info + |
4332 | padding |
4333 +-----------------------+
4334 | user data |
4337 +-----------------------+ */
4339 struct mmap_region
4341 /* User-specified size. */
4342 size_t nbytes_specified;
4344 /* Number of bytes mapped */
4345 size_t nbytes_mapped;
4347 /* Pointer to the location holding the address of the memory
4348 allocated with the mmap'd block. The variable actually points
4349 after this structure. */
4350 POINTER_TYPE **var;
4352 /* Next and previous in list of all mmap'd regions. */
4353 struct mmap_region *next, *prev;
4356 /* Doubly-linked list of mmap'd regions. */
4358 static struct mmap_region *mmap_regions;
4360 /* File descriptor for mmap. If we don't have anonymous mapping,
4361 /dev/zero will be opened on it. */
4363 static int mmap_fd;
4365 /* Temporary storage for mmap_set_vars, see there. */
4367 static struct mmap_region *mmap_regions_1;
4368 static int mmap_fd_1;
4370 /* Page size on this system. */
4372 static int mmap_page_size;
4374 /* 1 means mmap has been intialized. */
4376 static int mmap_initialized_p;
4378 /* Value is X rounded up to the next multiple of N. */
4380 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4382 /* Size of mmap_region structure plus padding. */
4384 #define MMAP_REGION_STRUCT_SIZE \
4385 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4387 /* Given a pointer P to the start of the user-visible part of a mapped
4388 region, return a pointer to the start of the region. */
4390 #define MMAP_REGION(P) \
4391 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4393 /* Given a pointer P to the start of a mapped region, return a pointer
4394 to the start of the user-visible part of the region. */
4396 #define MMAP_USER_AREA(P) \
4397 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4399 #define MEM_ALIGN sizeof (double)
4401 /* Predicate returning true if part of the address range [START ..
4402 END[ is currently mapped. Used to prevent overwriting an existing
4403 memory mapping.
4405 Default is to conservativly assume the address range is occupied by
4406 something else. This can be overridden by system configuration
4407 files if system-specific means to determine this exists. */
4409 #ifndef MMAP_ALLOCATED_P
4410 #define MMAP_ALLOCATED_P(start, end) 1
4411 #endif
4413 /* Function prototypes. */
4415 static int mmap_free_1 P_ ((struct mmap_region *));
4416 static int mmap_enlarge P_ ((struct mmap_region *, int));
4417 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4418 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4419 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4420 static void mmap_free P_ ((POINTER_TYPE **ptr));
4421 static void mmap_init P_ ((void));
4424 /* Return a region overlapping address range START...END, or null if
4425 none. END is not including, i.e. the last byte in the range
4426 is at END - 1. */
4428 static struct mmap_region *
4429 mmap_find (start, end)
4430 POINTER_TYPE *start, *end;
4432 struct mmap_region *r;
4433 char *s = (char *) start, *e = (char *) end;
4435 for (r = mmap_regions; r; r = r->next)
4437 char *rstart = (char *) r;
4438 char *rend = rstart + r->nbytes_mapped;
4440 if (/* First byte of range, i.e. START, in this region? */
4441 (s >= rstart && s < rend)
4442 /* Last byte of range, i.e. END - 1, in this region? */
4443 || (e > rstart && e <= rend)
4444 /* First byte of this region in the range? */
4445 || (rstart >= s && rstart < e)
4446 /* Last byte of this region in the range? */
4447 || (rend > s && rend <= e))
4448 break;
4451 return r;
4455 /* Unmap a region. P is a pointer to the start of the user-araa of
4456 the region. Value is non-zero if successful. */
4458 static int
4459 mmap_free_1 (r)
4460 struct mmap_region *r;
4462 if (r->next)
4463 r->next->prev = r->prev;
4464 if (r->prev)
4465 r->prev->next = r->next;
4466 else
4467 mmap_regions = r->next;
4469 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4471 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4472 return 0;
4475 return 1;
4479 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4480 Value is non-zero if successful. */
4482 static int
4483 mmap_enlarge (r, npages)
4484 struct mmap_region *r;
4485 int npages;
4487 char *region_end = (char *) r + r->nbytes_mapped;
4488 size_t nbytes;
4489 int success = 0;
4491 if (npages < 0)
4493 /* Unmap pages at the end of the region. */
4494 nbytes = - npages * mmap_page_size;
4495 if (munmap (region_end - nbytes, nbytes) == -1)
4496 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4497 else
4499 r->nbytes_mapped -= nbytes;
4500 success = 1;
4503 else if (npages > 0)
4505 nbytes = npages * mmap_page_size;
4507 /* Try to map additional pages at the end of the region. We
4508 cannot do this if the address range is already occupied by
4509 something else because mmap deletes any previous mapping.
4510 I'm not sure this is worth doing, let's see. */
4511 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4513 POINTER_TYPE *p;
4515 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4516 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4517 if (p == MAP_FAILED)
4518 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4519 else if (p != (POINTER_TYPE *) region_end)
4521 /* Kernels are free to choose a different address. In
4522 that case, unmap what we've mapped above; we have
4523 no use for it. */
4524 if (munmap (p, nbytes) == -1)
4525 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4527 else
4529 r->nbytes_mapped += nbytes;
4530 success = 1;
4535 return success;
4539 /* Set or reset variables holding references to mapped regions. If
4540 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4541 non-zero, set all variables to the start of the user-areas
4542 of mapped regions.
4544 This function is called from Fdump_emacs to ensure that the dumped
4545 Emacs doesn't contain references to memory that won't be mapped
4546 when Emacs starts. */
4548 void
4549 mmap_set_vars (restore_p)
4550 int restore_p;
4552 struct mmap_region *r;
4554 if (restore_p)
4556 mmap_regions = mmap_regions_1;
4557 mmap_fd = mmap_fd_1;
4558 for (r = mmap_regions; r; r = r->next)
4559 *r->var = MMAP_USER_AREA (r);
4561 else
4563 for (r = mmap_regions; r; r = r->next)
4564 *r->var = NULL;
4565 mmap_regions_1 = mmap_regions;
4566 mmap_regions = NULL;
4567 mmap_fd_1 = mmap_fd;
4568 mmap_fd = -1;
4573 /* Allocate a block of storage large enough to hold NBYTES bytes of
4574 data. A pointer to the data is returned in *VAR. VAR is thus the
4575 address of some variable which will use the data area.
4577 The allocation of 0 bytes is valid.
4579 If we can't allocate the necessary memory, set *VAR to null, and
4580 return null. */
4582 static POINTER_TYPE *
4583 mmap_alloc (var, nbytes)
4584 POINTER_TYPE **var;
4585 size_t nbytes;
4587 void *p;
4588 size_t map;
4590 mmap_init ();
4592 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4593 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4594 mmap_fd, 0);
4596 if (p == MAP_FAILED)
4598 if (errno != ENOMEM)
4599 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4600 p = NULL;
4602 else
4604 struct mmap_region *r = (struct mmap_region *) p;
4606 r->nbytes_specified = nbytes;
4607 r->nbytes_mapped = map;
4608 r->var = var;
4609 r->prev = NULL;
4610 r->next = mmap_regions;
4611 if (r->next)
4612 r->next->prev = r;
4613 mmap_regions = r;
4615 p = MMAP_USER_AREA (p);
4618 return *var = p;
4622 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4623 resize it to size NBYTES. Change *VAR to reflect the new block,
4624 and return this value. If more memory cannot be allocated, then
4625 leave *VAR unchanged, and return null. */
4627 static POINTER_TYPE *
4628 mmap_realloc (var, nbytes)
4629 POINTER_TYPE **var;
4630 size_t nbytes;
4632 POINTER_TYPE *result;
4634 mmap_init ();
4636 if (*var == NULL)
4637 result = mmap_alloc (var, nbytes);
4638 else if (nbytes == 0)
4640 mmap_free (var);
4641 result = mmap_alloc (var, nbytes);
4643 else
4645 struct mmap_region *r = MMAP_REGION (*var);
4646 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4648 if (room < nbytes)
4650 /* Must enlarge. */
4651 POINTER_TYPE *old_ptr = *var;
4653 /* Try to map additional pages at the end of the region.
4654 If that fails, allocate a new region, copy data
4655 from the old region, then free it. */
4656 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4657 / mmap_page_size)))
4659 r->nbytes_specified = nbytes;
4660 *var = result = old_ptr;
4662 else if (mmap_alloc (var, nbytes))
4664 bcopy (old_ptr, *var, r->nbytes_specified);
4665 mmap_free_1 (MMAP_REGION (old_ptr));
4666 result = *var;
4667 r = MMAP_REGION (result);
4668 r->nbytes_specified = nbytes;
4670 else
4672 *var = old_ptr;
4673 result = NULL;
4676 else if (room - nbytes >= mmap_page_size)
4678 /* Shrinking by at least a page. Let's give some
4679 memory back to the system. */
4680 mmap_enlarge (r, - (room - nbytes) / mmap_page_size);
4681 result = *var;
4682 r->nbytes_specified = nbytes;
4684 else
4686 /* Leave it alone. */
4687 result = *var;
4688 r->nbytes_specified = nbytes;
4692 return result;
4696 /* Free a block of relocatable storage whose data is pointed to by
4697 PTR. Store 0 in *PTR to show there's no block allocated. */
4699 static void
4700 mmap_free (var)
4701 POINTER_TYPE **var;
4703 mmap_init ();
4705 if (*var)
4707 mmap_free_1 (MMAP_REGION (*var));
4708 *var = NULL;
4713 /* Perform necessary intializations for the use of mmap. */
4715 static void
4716 mmap_init ()
4718 #if MAP_ANON == 0
4719 /* The value of mmap_fd is initially 0 in temacs, and -1
4720 in a dumped Emacs. */
4721 if (mmap_fd <= 0)
4723 /* No anonymous mmap -- we need the file descriptor. */
4724 mmap_fd = open ("/dev/zero", O_RDONLY);
4725 if (mmap_fd == -1)
4726 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4728 #endif /* MAP_ANON == 0 */
4730 if (mmap_initialized_p)
4731 return;
4732 mmap_initialized_p = 1;
4734 #if MAP_ANON != 0
4735 mmap_fd = -1;
4736 #endif
4738 mmap_page_size = getpagesize ();
4741 #endif /* USE_MMAP_FOR_BUFFERS */
4745 /***********************************************************************
4746 Buffer-text Allocation
4747 ***********************************************************************/
4749 #ifdef REL_ALLOC
4750 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4751 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4752 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4753 #endif /* REL_ALLOC */
4756 /* Allocate NBYTES bytes for buffer B's text buffer. */
4758 static void
4759 alloc_buffer_text (b, nbytes)
4760 struct buffer *b;
4761 size_t nbytes;
4763 POINTER_TYPE *p;
4765 BLOCK_INPUT;
4766 #if defined USE_MMAP_FOR_BUFFERS
4767 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4768 #elif defined REL_ALLOC
4769 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4770 #else
4771 p = xmalloc (nbytes);
4772 #endif
4774 if (p == NULL)
4776 UNBLOCK_INPUT;
4777 memory_full ();
4780 b->text->beg = (unsigned char *) p;
4781 UNBLOCK_INPUT;
4784 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4785 shrink it. */
4787 void
4788 enlarge_buffer_text (b, delta)
4789 struct buffer *b;
4790 int delta;
4792 POINTER_TYPE *p;
4793 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4794 + delta);
4795 BLOCK_INPUT;
4796 #if defined USE_MMAP_FOR_BUFFERS
4797 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4798 #elif defined REL_ALLOC
4799 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4800 #else
4801 p = xrealloc (b->text->beg, nbytes);
4802 #endif
4804 if (p == NULL)
4806 UNBLOCK_INPUT;
4807 memory_full ();
4810 BUF_BEG_ADDR (b) = (unsigned char *) p;
4811 UNBLOCK_INPUT;
4815 /* Free buffer B's text buffer. */
4817 static void
4818 free_buffer_text (b)
4819 struct buffer *b;
4821 BLOCK_INPUT;
4823 #if defined USE_MMAP_FOR_BUFFERS
4824 mmap_free ((POINTER_TYPE **) &b->text->beg);
4825 #elif defined REL_ALLOC
4826 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4827 #else
4828 xfree (b->text->beg);
4829 #endif
4831 BUF_BEG_ADDR (b) = NULL;
4832 UNBLOCK_INPUT;
4837 /***********************************************************************
4838 Initialization
4839 ***********************************************************************/
4841 void
4842 init_buffer_once ()
4844 int idx;
4846 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4848 /* Make sure all markable slots in buffer_defaults
4849 are initialized reasonably, so mark_buffer won't choke. */
4850 reset_buffer (&buffer_defaults);
4851 reset_buffer_local_variables (&buffer_defaults, 1);
4852 reset_buffer (&buffer_local_symbols);
4853 reset_buffer_local_variables (&buffer_local_symbols, 1);
4854 /* Prevent GC from getting confused. */
4855 buffer_defaults.text = &buffer_defaults.own_text;
4856 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4857 BUF_INTERVALS (&buffer_defaults) = 0;
4858 BUF_INTERVALS (&buffer_local_symbols) = 0;
4859 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4860 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4862 /* Set up the default values of various buffer slots. */
4863 /* Must do these before making the first buffer! */
4865 /* real setup is done in bindings.el */
4866 buffer_defaults.mode_line_format = build_string ("%-");
4867 buffer_defaults.header_line_format = Qnil;
4868 buffer_defaults.abbrev_mode = Qnil;
4869 buffer_defaults.overwrite_mode = Qnil;
4870 buffer_defaults.case_fold_search = Qt;
4871 buffer_defaults.auto_fill_function = Qnil;
4872 buffer_defaults.selective_display = Qnil;
4873 #ifndef old
4874 buffer_defaults.selective_display_ellipses = Qt;
4875 #endif
4876 buffer_defaults.abbrev_table = Qnil;
4877 buffer_defaults.display_table = Qnil;
4878 buffer_defaults.undo_list = Qnil;
4879 buffer_defaults.mark_active = Qnil;
4880 buffer_defaults.file_format = Qnil;
4881 buffer_defaults.overlays_before = Qnil;
4882 buffer_defaults.overlays_after = Qnil;
4883 XSETFASTINT (buffer_defaults.overlay_center, BEG);
4885 XSETFASTINT (buffer_defaults.tab_width, 8);
4886 buffer_defaults.truncate_lines = Qnil;
4887 buffer_defaults.ctl_arrow = Qt;
4888 buffer_defaults.direction_reversed = Qnil;
4889 buffer_defaults.cursor_type = Qt;
4890 buffer_defaults.extra_line_spacing = Qnil;
4892 #ifdef DOS_NT
4893 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4894 #endif
4895 buffer_defaults.enable_multibyte_characters = Qt;
4896 buffer_defaults.buffer_file_coding_system = Qnil;
4897 XSETFASTINT (buffer_defaults.fill_column, 70);
4898 XSETFASTINT (buffer_defaults.left_margin, 0);
4899 buffer_defaults.cache_long_line_scans = Qnil;
4900 buffer_defaults.file_truename = Qnil;
4901 XSETFASTINT (buffer_defaults.display_count, 0);
4902 buffer_defaults.indicate_empty_lines = Qnil;
4903 buffer_defaults.scroll_up_aggressively = Qnil;
4904 buffer_defaults.scroll_down_aggressively = Qnil;
4905 buffer_defaults.display_time = Qnil;
4907 /* Assign the local-flags to the slots that have default values.
4908 The local flag is a bit that is used in the buffer
4909 to say that it has its own local value for the slot.
4910 The local flag bits are in the local_var_flags slot of the buffer. */
4912 /* Nothing can work if this isn't true */
4913 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4915 /* 0 means not a lisp var, -1 means always local, else mask */
4916 bzero (&buffer_local_flags, sizeof buffer_local_flags);
4917 XSETINT (buffer_local_flags.filename, -1);
4918 XSETINT (buffer_local_flags.directory, -1);
4919 XSETINT (buffer_local_flags.backed_up, -1);
4920 XSETINT (buffer_local_flags.save_length, -1);
4921 XSETINT (buffer_local_flags.auto_save_file_name, -1);
4922 XSETINT (buffer_local_flags.read_only, -1);
4923 XSETINT (buffer_local_flags.major_mode, -1);
4924 XSETINT (buffer_local_flags.mode_name, -1);
4925 XSETINT (buffer_local_flags.undo_list, -1);
4926 XSETINT (buffer_local_flags.mark_active, -1);
4927 XSETINT (buffer_local_flags.point_before_scroll, -1);
4928 XSETINT (buffer_local_flags.file_truename, -1);
4929 XSETINT (buffer_local_flags.invisibility_spec, -1);
4930 XSETINT (buffer_local_flags.file_format, -1);
4931 XSETINT (buffer_local_flags.display_count, -1);
4932 XSETINT (buffer_local_flags.display_time, -1);
4933 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
4935 idx = 1;
4936 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
4937 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
4938 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
4939 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
4940 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
4941 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
4942 #ifndef old
4943 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
4944 #endif
4945 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
4946 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
4947 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
4948 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
4949 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
4950 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
4951 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
4952 #ifdef DOS_NT
4953 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
4954 /* Make this one a permanent local. */
4955 buffer_permanent_local_flags[idx++] = 1;
4956 #endif
4957 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
4958 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
4959 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
4960 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
4961 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
4962 /* Make this one a permanent local. */
4963 buffer_permanent_local_flags[idx++] = 1;
4964 XSETFASTINT (buffer_local_flags.left_margin_width, idx); ++idx;
4965 XSETFASTINT (buffer_local_flags.right_margin_width, idx); ++idx;
4966 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
4967 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
4968 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
4969 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
4970 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
4971 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
4973 /* Need more room? */
4974 if (idx >= MAX_PER_BUFFER_VARS)
4975 abort ();
4976 last_per_buffer_idx = idx;
4978 Vbuffer_alist = Qnil;
4979 current_buffer = 0;
4980 all_buffers = 0;
4982 QSFundamental = build_string ("Fundamental");
4984 Qfundamental_mode = intern ("fundamental-mode");
4985 buffer_defaults.major_mode = Qfundamental_mode;
4987 Qmode_class = intern ("mode-class");
4989 Qprotected_field = intern ("protected-field");
4991 Qpermanent_local = intern ("permanent-local");
4993 Qkill_buffer_hook = intern ("kill-buffer-hook");
4995 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
4997 /* super-magic invisible buffer */
4998 Vbuffer_alist = Qnil;
5000 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5002 inhibit_modification_hooks = 0;
5005 void
5006 init_buffer ()
5008 char buf[MAXPATHLEN + 1];
5009 char *pwd;
5010 struct stat dotstat, pwdstat;
5011 Lisp_Object temp;
5012 int rc;
5014 #ifdef USE_MMAP_FOR_BUFFERS
5016 /* When using the ralloc implementation based on mmap(2), buffer
5017 text pointers will have been set to null in the dumped Emacs.
5018 Map new memory. */
5019 struct buffer *b;
5021 for (b = all_buffers; b; b = b->next)
5022 if (b->text->beg == NULL)
5023 enlarge_buffer_text (b, 0);
5025 #endif /* USE_MMAP_FOR_BUFFERS */
5027 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5028 if (NILP (buffer_defaults.enable_multibyte_characters))
5029 Fset_buffer_multibyte (Qnil, Qnil);
5031 /* If PWD is accurate, use it instead of calling getwd. PWD is
5032 sometimes a nicer name, and using it may avoid a fatal error if a
5033 parent directory is searchable but not readable. */
5034 if ((pwd = getenv ("PWD")) != 0
5035 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5036 && stat (pwd, &pwdstat) == 0
5037 && stat (".", &dotstat) == 0
5038 && dotstat.st_ino == pwdstat.st_ino
5039 && dotstat.st_dev == pwdstat.st_dev
5040 && strlen (pwd) < MAXPATHLEN)
5041 strcpy (buf, pwd);
5042 #ifdef HAVE_GETCWD
5043 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5044 fatal ("`getcwd' failed: %s\n", strerror (errno));
5045 #else
5046 else if (getwd (buf) == 0)
5047 fatal ("`getwd' failed: %s\n", buf);
5048 #endif
5050 #ifndef VMS
5051 /* Maybe this should really use some standard subroutine
5052 whose definition is filename syntax dependent. */
5053 rc = strlen (buf);
5054 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5056 buf[rc] = DIRECTORY_SEP;
5057 buf[rc + 1] = '\0';
5059 #endif /* not VMS */
5061 current_buffer->directory = build_string (buf);
5063 /* Add /: to the front of the name
5064 if it would otherwise be treated as magic. */
5065 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5066 if (! NILP (temp)
5067 /* If the default dir is just /, TEMP is non-nil
5068 because of the ange-ftp completion handler.
5069 However, it is not necessary to turn / into /:/.
5070 So avoid doing that. */
5071 && strcmp ("/", XSTRING (current_buffer->directory)->data))
5072 current_buffer->directory
5073 = concat2 (build_string ("/:"), current_buffer->directory);
5075 temp = get_minibuffer (0);
5076 XBUFFER (temp)->directory = current_buffer->directory;
5079 /* initialize the buffer routines */
5080 void
5081 syms_of_buffer ()
5083 staticpro (&last_overlay_modification_hooks);
5084 last_overlay_modification_hooks
5085 = Fmake_vector (make_number (10), Qnil);
5087 staticpro (&Vbuffer_defaults);
5088 staticpro (&Vbuffer_local_symbols);
5089 staticpro (&Qfundamental_mode);
5090 staticpro (&Qmode_class);
5091 staticpro (&QSFundamental);
5092 staticpro (&Vbuffer_alist);
5093 staticpro (&Qprotected_field);
5094 staticpro (&Qpermanent_local);
5095 staticpro (&Qkill_buffer_hook);
5096 Qoverlayp = intern ("overlayp");
5097 staticpro (&Qoverlayp);
5098 Qevaporate = intern ("evaporate");
5099 staticpro (&Qevaporate);
5100 Qmodification_hooks = intern ("modification-hooks");
5101 staticpro (&Qmodification_hooks);
5102 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5103 staticpro (&Qinsert_in_front_hooks);
5104 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5105 staticpro (&Qinsert_behind_hooks);
5106 Qget_file_buffer = intern ("get-file-buffer");
5107 staticpro (&Qget_file_buffer);
5108 Qpriority = intern ("priority");
5109 staticpro (&Qpriority);
5110 Qwindow = intern ("window");
5111 staticpro (&Qwindow);
5112 Qbefore_string = intern ("before-string");
5113 staticpro (&Qbefore_string);
5114 Qafter_string = intern ("after-string");
5115 staticpro (&Qafter_string);
5116 Qfirst_change_hook = intern ("first-change-hook");
5117 staticpro (&Qfirst_change_hook);
5118 Qbefore_change_functions = intern ("before-change-functions");
5119 staticpro (&Qbefore_change_functions);
5120 Qafter_change_functions = intern ("after-change-functions");
5121 staticpro (&Qafter_change_functions);
5123 Qas = intern ("as");
5124 staticpro (&Qas);
5125 Qmake = intern ("make");
5126 staticpro (&Qmake);
5127 Qto = intern ("to");
5128 staticpro (&Qto);
5130 Fput (Qprotected_field, Qerror_conditions,
5131 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5132 Fput (Qprotected_field, Qerror_message,
5133 build_string ("Attempt to modify a protected field"));
5135 /* All these use DEFVAR_LISP_NOPRO because the slots in
5136 buffer_defaults will all be marked via Vbuffer_defaults. */
5138 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5139 &buffer_defaults.mode_line_format,
5140 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5141 This is the same as (default-value 'mode-line-format). */);
5143 DEFVAR_LISP_NOPRO ("default-header-line-format",
5144 &buffer_defaults.header_line_format,
5145 doc: /* Default value of `header-line-format' for buffers that don't override it.
5146 This is the same as (default-value 'header-line-format). */);
5148 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5149 doc: /* Default value of `cursor-type' for buffers that don't override it.
5150 This is the same as (default-value 'cursor-type). */);
5152 DEFVAR_LISP_NOPRO ("default-line-spacing",
5153 &buffer_defaults.extra_line_spacing,
5154 doc: /* Default value of `line-spacing' for buffers that don't override it.
5155 This is the same as (default-value 'line-spacing). */);
5157 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5158 &buffer_defaults.abbrev_mode,
5159 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5160 This is the same as (default-value 'abbrev-mode). */);
5162 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5163 &buffer_defaults.ctl_arrow,
5164 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5165 This is the same as (default-value 'ctl-arrow). */);
5167 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5168 &buffer_defaults.direction_reversed,
5169 doc: /* Default value of `direction_reversed' for buffers that do not override it.
5170 This is the same as (default-value 'direction-reversed). */);
5172 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5173 &buffer_defaults.enable_multibyte_characters,
5174 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5175 This is the same as (default-value 'enable-multibyte-characters). */);
5177 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5178 &buffer_defaults.buffer_file_coding_system,
5179 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5180 This is the same as (default-value 'buffer-file-coding-system). */);
5182 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5183 &buffer_defaults.truncate_lines,
5184 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5185 This is the same as (default-value 'truncate-lines). */);
5187 DEFVAR_LISP_NOPRO ("default-fill-column",
5188 &buffer_defaults.fill_column,
5189 doc: /* Default value of `fill-column' for buffers that do not override it.
5190 This is the same as (default-value 'fill-column). */);
5192 DEFVAR_LISP_NOPRO ("default-left-margin",
5193 &buffer_defaults.left_margin,
5194 doc: /* Default value of `left-margin' for buffers that do not override it.
5195 This is the same as (default-value 'left-margin). */);
5197 DEFVAR_LISP_NOPRO ("default-tab-width",
5198 &buffer_defaults.tab_width,
5199 doc: /* Default value of `tab-width' for buffers that do not override it.
5200 This is the same as (default-value 'tab-width). */);
5202 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5203 &buffer_defaults.case_fold_search,
5204 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5205 This is the same as (default-value 'case-fold-search). */);
5207 #ifdef DOS_NT
5208 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5209 &buffer_defaults.buffer_file_type,
5210 doc: /* Default file type for buffers that do not override it.
5211 This is the same as (default-value 'buffer-file-type).
5212 The file type is nil for text, t for binary. */);
5213 #endif
5215 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5216 &buffer_defaults.left_margin_width,
5217 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5218 This is the same as (default-value 'left-margin-width). */);
5220 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5221 &buffer_defaults.right_margin_width,
5222 doc: /* Default value of `right_margin_width' for buffers that don't override it.
5223 This is the same as (default-value 'right-margin-width). */);
5225 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5226 &buffer_defaults.indicate_empty_lines,
5227 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5228 This is the same as (default-value 'indicate-empty-lines). */);
5230 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5231 &buffer_defaults.scroll_up_aggressively,
5232 doc: /* Default value of `scroll-up-aggressively'.
5233 This value applies in buffers that don't have their own local values.
5234 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5236 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5237 &buffer_defaults.scroll_down_aggressively,
5238 doc: /* Default value of `scroll-down-aggressively'.
5239 This value applies in buffers that don't have their own local values.
5240 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5242 DEFVAR_PER_BUFFER ("header-line-format",
5243 &current_buffer->header_line_format,
5244 Qnil,
5245 doc: /* Analogous to `mode-line-format', but controls the header line.
5246 The header line appears, optionally, at the top of a window;
5247 the mode line appears at the bottom. */);
5249 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5250 Qnil,
5251 doc: /* Template for displaying mode line for current buffer.
5252 Each buffer has its own value of this variable.
5253 Value may be nil, a string, a symbol or a list or cons cell.
5254 A value of nil means don't display a mode line.
5255 For a symbol, its value is used (but it is ignored if t or nil).
5256 A string appearing directly as the value of a symbol is processed verbatim
5257 in that the %-constructs below are not recognized.
5258 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5259 is used as a mode line element.
5260 For a list whose car is a symbol, the symbol's value is taken,
5261 and if that is non-nil, the cadr of the list is processed recursively.
5262 Otherwise, the caddr of the list (if there is one) is processed.
5263 For a list whose car is a string or list, each element is processed
5264 recursively and the results are effectively concatenated.
5265 For a list whose car is an integer, the cdr of the list is processed
5266 and padded (if the number is positive) or truncated (if negative)
5267 to the width specified by that number.
5268 A string is printed verbatim in the mode line except for %-constructs:
5269 (%-constructs are allowed when the string is the entire mode-line-format
5270 or when it is found in a cons-cell or a list)
5271 %b -- print buffer name. %f -- print visited file name.
5272 %F -- print frame name.
5273 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5274 %& is like %*, but ignore read-only-ness.
5275 % means buffer is read-only and * means it is modified.
5276 For a modified read-only buffer, %* gives % and %+ gives *.
5277 %s -- print process status. %l -- print the current line number.
5278 %c -- print the current column number (this makes editing slower).
5279 To make the column number update correctly in all cases,
5280 `column-number-mode' must be non-nil.
5281 %p -- print percent of buffer above top of window, or Top, Bot or All.
5282 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5283 or print Bottom or All.
5284 %m -- print the mode name.
5285 %n -- print Narrow if appropriate.
5286 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5287 %Z -- like %z, but including the end-of-line format.
5288 %[ -- print one [ for each recursive editing level. %] similar.
5289 %% -- print %. %- -- print infinitely many dashes.
5290 Decimal digits after the % specify field width to which to pad. */);
5292 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5293 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5294 nil here means use current buffer's major mode. */);
5296 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5297 make_number (Lisp_Symbol),
5298 doc: /* Symbol for current buffer's major mode. */);
5300 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5301 Qnil,
5302 doc: /* Pretty name of current buffer's major mode (a string). */);
5304 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5305 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5307 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5308 Qnil,
5309 doc: /* *Non-nil if searches and matches should ignore case. */);
5311 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5312 make_number (Lisp_Int),
5313 doc: /* *Column beyond which automatic line-wrapping should happen. */);
5315 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5316 make_number (Lisp_Int),
5317 doc: /* *Column for the default indent-line-function to indent to.
5318 Linefeed indents to this column in Fundamental mode. */);
5320 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5321 make_number (Lisp_Int),
5322 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5324 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5325 doc: /* *Non-nil means display control chars with uparrow.
5326 A value of nil means use backslash and octal digits.
5327 This variable does not apply to characters whose display is specified
5328 in the current display table (if there is one). */);
5330 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5331 &current_buffer->enable_multibyte_characters,
5332 make_number (-1),
5333 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5334 Otherwise they are regarded as unibyte. This affects the display,
5335 file I/O and the behavior of various editing commands.
5337 This variable is buffer-local but you cannot set it directly;
5338 use the function `set-buffer-multibyte' to change a buffer's representation.
5339 Changing its default value with `setq-default' is supported.
5340 See also variable `default-enable-multibyte-characters' and Info node
5341 `(elisp)Text Representations'. */);
5343 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5344 &current_buffer->buffer_file_coding_system, Qnil,
5345 doc: /* Coding system to be used for encoding the buffer contents on saving.
5346 This variable applies to saving the buffer, and also to `write-region'
5347 and other functions that use `write-region'.
5348 It does not apply to sending output to subprocesses, however.
5350 If this is nil, the buffer is saved without any code conversion
5351 unless some coding system is specified in `file-coding-system-alist'
5352 for the buffer file.
5354 If the text to be saved cannot be encoded as specified by this variable,
5355 an alternative encoding is selected by `select-safe-coding-system', which see.
5357 The variable `coding-system-for-write', if non-nil, overrides this variable.
5359 This variable is never applied to a way of decoding a file while reading it. */);
5361 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5362 Qnil,
5363 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5365 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5366 doc: /* *Non-nil means do not display continuation lines.
5367 Instead, give each line of text just one screen line.
5369 Note that this is overridden by the variable
5370 `truncate-partial-width-windows' if that variable is non-nil
5371 and this buffer is not full-frame width. */);
5373 #ifdef DOS_NT
5374 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5375 Qnil,
5376 doc: /* Non-nil if the visited file is a binary file.
5377 This variable is meaningful on MS-DOG and Windows NT.
5378 On those systems, it is automatically local in every buffer.
5379 On other systems, this variable is normally always nil. */);
5380 #endif
5382 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5383 make_number (Lisp_String),
5384 doc: /* Name of default directory of current buffer. Should end with slash.
5385 To interactively change the default directory, use command `cd'. */);
5387 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5388 Qnil,
5389 doc: /* Function called (if non-nil) to perform auto-fill.
5390 It is called after self-inserting any character specified in
5391 the `auto-fill-chars' table.
5392 NOTE: This variable is not a hook;
5393 its value may not be a list of functions. */);
5395 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5396 make_number (Lisp_String),
5397 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5399 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5400 make_number (Lisp_String),
5401 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5402 The truename of a file is calculated by `file-truename'
5403 and then abbreviated with `abbreviate-file-name'. */);
5405 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5406 &current_buffer->auto_save_file_name,
5407 make_number (Lisp_String),
5408 doc: /* Name of file for auto-saving current buffer.
5409 If it is nil, that means don't auto-save this buffer. */);
5411 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5412 doc: /* Non-nil if this buffer is read-only. */);
5414 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5415 doc: /* Non-nil if this buffer's file has been backed up.
5416 Backing up is done before the first time the file is saved. */);
5418 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5419 make_number (Lisp_Int),
5420 doc: /* Length of current buffer when last read in, saved or auto-saved.
5421 0 initially. */);
5423 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5424 Qnil,
5425 doc: /* Non-nil enables selective display.
5426 An Integer N as value means display only lines
5427 that start with less than n columns of space.
5428 A value of t means that the character ^M makes itself and
5429 all the rest of the line invisible; also, when saving the buffer
5430 in a file, save the ^M as a newline. */);
5432 #ifndef old
5433 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5434 &current_buffer->selective_display_ellipses,
5435 Qnil,
5436 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5437 #endif
5439 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5440 doc: /* Non-nil if self-insertion should replace existing text.
5441 The value should be one of `overwrite-mode-textual',
5442 `overwrite-mode-binary', or nil.
5443 If it is `overwrite-mode-textual', self-insertion still
5444 inserts at the end of a line, and inserts when point is before a tab,
5445 until the tab is filled in.
5446 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5448 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5449 Qnil,
5450 doc: /* Display table that controls display of the contents of current buffer.
5452 If this variable is nil, the value of `standard-display-table' is used.
5453 Each window can have its own, overriding display table, see
5454 `set-window-display-table' and `window-display-table'.
5456 The display table is a char-table created with `make-display-table'.
5457 A char-table is an array indexed by character codes. Normal array
5458 primitives `aref' and `aset' can be used to access elements of a char-table.
5460 Each of the char-table elements control how to display the corresponding
5461 text character: the element at index C in the table says how to display
5462 the character whose code is C. Each element should be a vector of
5463 characters or nil. nil means display the character in the default fashion;
5464 otherwise, the characters from the vector are delivered to the screen
5465 instead of the original character.
5467 For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5468 a capital Y instead of each X character.
5470 In addition, a char-table has six extra slots to control the display of:
5472 the end of a truncated screen line (extra-slot 0, a single character);
5473 the end of a continued line (extra-slot 1, a single character);
5474 the escape character used to display character codes in octal
5475 (extra-slot 2, a single character);
5476 the character used as an arrow for control characters (extra-slot 3,
5477 a single character);
5478 the decoration indicating the presence of invisible lines (extra-slot 4,
5479 a vector of characters);
5480 the character used to draw the border between side-by-side windows
5481 (extra-slot 5, a single character).
5483 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5485 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_width,
5486 Qnil,
5487 doc: /* *Width of left marginal area for display of a buffer.
5488 A value of nil means no marginal area. */);
5490 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_width,
5491 Qnil,
5492 doc: /* *Width of right marginal area for display of a buffer.
5493 A value of nil means no marginal area. */);
5495 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5496 &current_buffer->indicate_empty_lines, Qnil,
5497 doc: /* *Visually indicate empty lines after the buffer end.
5498 If non-nil, a bitmap is displayed in the left fringe of a window on
5499 window-systems. */);
5501 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5502 &current_buffer->scroll_up_aggressively, Qnil,
5503 doc: /* *If a number, scroll display up aggressively.
5504 If scrolling a window because point is below the window end, choose
5505 a new window start so that point ends up that fraction of the window's
5506 height from the bottom of the window. */);
5508 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5509 &current_buffer->scroll_down_aggressively, Qnil,
5510 doc: /* *If a number, scroll display down aggressively.
5511 If scrolling a window because point is above the window start, choose
5512 a new window start so that point ends up that fraction of the window's
5513 height from the top of the window. */);
5515 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5516 "Don't ask.");
5519 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5520 doc: /* List of functions to call before each text change.
5521 Two arguments are passed to each function: the positions of
5522 the beginning and end of the range of old text to be changed.
5523 \(For an insertion, the beginning and end are at the same place.)
5524 No information is given about the length of the text after the change.
5526 Buffer changes made while executing the `before-change-functions'
5527 don't call any before-change or after-change functions.
5528 That's because these variables are temporarily set to nil.
5529 As a result, a hook function cannot straightforwardly alter the value of
5530 these variables. See the Emacs Lisp manual for a way of
5531 accomplishing an equivalent result by using other variables.
5533 If an unhandled error happens in running these functions,
5534 the variable's value remains nil. That prevents the error
5535 from happening repeatedly and making Emacs nonfunctional. */);
5536 Vbefore_change_functions = Qnil;
5538 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5539 doc: /* List of functions to call after each text change.
5540 Three arguments are passed to each function: the positions of
5541 the beginning and end of the range of changed text,
5542 and the length in bytes of the pre-change text replaced by that range.
5543 \(For an insertion, the pre-change length is zero;
5544 for a deletion, that length is the number of bytes deleted,
5545 and the post-change beginning and end are at the same place.)
5547 Buffer changes made while executing the `after-change-functions'
5548 don't call any before-change or after-change functions.
5549 That's because these variables are temporarily set to nil.
5550 As a result, a hook function cannot straightforwardly alter the value of
5551 these variables. See the Emacs Lisp manual for a way of
5552 accomplishing an equivalent result by using other variables.
5554 If an unhandled error happens in running these functions,
5555 the variable's value remains nil. That prevents the error
5556 from happening repeatedly and making Emacs nonfunctional. */);
5557 Vafter_change_functions = Qnil;
5559 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5560 doc: /* A list of functions to call before changing a buffer which is unmodified.
5561 The functions are run using the `run-hooks' function. */);
5562 Vfirst_change_hook = Qnil;
5564 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5565 doc: /* List of undo entries in current buffer.
5566 Recent changes come first; older changes follow newer.
5568 An entry (BEG . END) represents an insertion which begins at
5569 position BEG and ends at position END.
5571 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5572 from (abs POSITION). If POSITION is positive, point was at the front
5573 of the text being deleted; if negative, point was at the end.
5575 An entry (t HIGH . LOW) indicates that the buffer previously had
5576 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5577 of the visited file's modification time, as of that time. If the
5578 modification time of the most recent save is different, this entry is
5579 obsolete.
5581 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5582 was modified between BEG and END. PROPERTY is the property name,
5583 and VALUE is the old value.
5585 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5586 was adjusted in position by the offset DISTANCE (an integer).
5588 An entry of the form POSITION indicates that point was at the buffer
5589 location given by the integer. Undoing an entry of this form places
5590 point at POSITION.
5592 nil marks undo boundaries. The undo command treats the changes
5593 between two undo boundaries as a single step to be undone.
5595 If the value of the variable is t, undo information is not recorded. */);
5597 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5598 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5600 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5601 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5603 Normally, the line-motion functions work by scanning the buffer for
5604 newlines. Columnar operations (like move-to-column and
5605 compute-motion) also work by scanning the buffer, summing character
5606 widths as they go. This works well for ordinary text, but if the
5607 buffer's lines are very long (say, more than 500 characters), these
5608 motion functions will take longer to execute. Emacs may also take
5609 longer to update the display.
5611 If cache-long-line-scans is non-nil, these motion functions cache the
5612 results of their scans, and consult the cache to avoid rescanning
5613 regions of the buffer until the text is modified. The caches are most
5614 beneficial when they prevent the most searching---that is, when the
5615 buffer contains long lines and large regions of characters with the
5616 same, fixed screen width.
5618 When cache-long-line-scans is non-nil, processing short lines will
5619 become slightly slower (because of the overhead of consulting the
5620 cache), and the caches will use memory roughly proportional to the
5621 number of newlines and characters whose screen width varies.
5623 The caches require no explicit maintenance; their accuracy is
5624 maintained internally by the Emacs primitives. Enabling or disabling
5625 the cache should not affect the behavior of any of the motion
5626 functions; it should only affect their performance. */);
5628 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5629 doc: /* Value of point before the last series of scroll operations, or nil. */);
5631 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5632 doc: /* List of formats to use when saving this buffer.
5633 Formats are defined by `format-alist'. This variable is
5634 set when a file is visited. Automatically local in all buffers. */);
5636 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5637 &current_buffer->invisibility_spec, Qnil,
5638 doc: /* Invisibility spec of this buffer.
5639 The default is t, which means that text is invisible
5640 if it has a non-nil `invisible' property.
5641 If the value is a list, a text character is invisible if its `invisible'
5642 property is an element in that list.
5643 If an element is a cons cell of the form (PROP . ELLIPSIS),
5644 then characters with property value PROP are invisible,
5645 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5647 DEFVAR_PER_BUFFER ("buffer-display-count",
5648 &current_buffer->display_count, Qnil,
5649 doc: /* A number incremented each time this buffer is displayed in a window.
5650 The function `set-window-buffer' increments it. */);
5652 DEFVAR_PER_BUFFER ("buffer-display-time",
5653 &current_buffer->display_time, Qnil,
5654 doc: /* Time stamp updated each time this buffer is displayed in a window.
5655 The function `set-window-buffer' updates this variable
5656 to the value obtained by calling `current-time'.
5657 If the buffer has never been shown in a window, the value is nil. */);
5659 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5660 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5661 Non-nil also enables highlighting of the region whenever the mark is active.
5662 The variable `highlight-nonselected-windows' controls whether to highlight
5663 all windows or just the selected window. */);
5664 Vtransient_mark_mode = Qnil;
5666 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5667 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5668 If the value is t, disregard `buffer-read-only' and all `read-only'
5669 text properties. If the value is a list, disregard `buffer-read-only'
5670 and disregard a `read-only' text property if the property value
5671 is a member of the list. */);
5672 Vinhibit_read_only = Qnil;
5674 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5675 doc: /* Cursor to use in window displaying this buffer.
5676 Values are interpreted as follows:
5678 t use the cursor specified for the frame
5679 nil don't display a cursor
5680 `bar' display a bar cursor with default width
5681 (bar . WIDTH) display a bar cursor with width WIDTH
5682 others display a box cursor. */);
5684 DEFVAR_PER_BUFFER ("line-spacing",
5685 &current_buffer->extra_line_spacing, Qnil,
5686 doc: /* Additional space to put between lines when displaying a buffer.
5687 The space is measured in pixels, and put below lines on window systems. */);
5689 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5690 doc: /* List of functions called with no args to query before killing a buffer. */);
5691 Vkill_buffer_query_functions = Qnil;
5693 defsubr (&Sbuffer_live_p);
5694 defsubr (&Sbuffer_list);
5695 defsubr (&Sget_buffer);
5696 defsubr (&Sget_file_buffer);
5697 defsubr (&Sget_buffer_create);
5698 defsubr (&Smake_indirect_buffer);
5699 defsubr (&Sgenerate_new_buffer_name);
5700 defsubr (&Sbuffer_name);
5701 /*defsubr (&Sbuffer_number);*/
5702 defsubr (&Sbuffer_file_name);
5703 defsubr (&Sbuffer_base_buffer);
5704 defsubr (&Sbuffer_local_value);
5705 defsubr (&Sbuffer_local_variables);
5706 defsubr (&Sbuffer_modified_p);
5707 defsubr (&Sset_buffer_modified_p);
5708 defsubr (&Sbuffer_modified_tick);
5709 defsubr (&Srename_buffer);
5710 defsubr (&Sother_buffer);
5711 defsubr (&Sbuffer_disable_undo);
5712 defsubr (&Sbuffer_enable_undo);
5713 defsubr (&Skill_buffer);
5714 defsubr (&Sset_buffer_major_mode);
5715 defsubr (&Sswitch_to_buffer);
5716 defsubr (&Spop_to_buffer);
5717 defsubr (&Scurrent_buffer);
5718 defsubr (&Sset_buffer);
5719 defsubr (&Sbarf_if_buffer_read_only);
5720 defsubr (&Sbury_buffer);
5721 defsubr (&Serase_buffer);
5722 defsubr (&Sset_buffer_multibyte);
5723 defsubr (&Skill_all_local_variables);
5725 defsubr (&Soverlayp);
5726 defsubr (&Smake_overlay);
5727 defsubr (&Sdelete_overlay);
5728 defsubr (&Smove_overlay);
5729 defsubr (&Soverlay_start);
5730 defsubr (&Soverlay_end);
5731 defsubr (&Soverlay_buffer);
5732 defsubr (&Soverlay_properties);
5733 defsubr (&Soverlays_at);
5734 defsubr (&Soverlays_in);
5735 defsubr (&Snext_overlay_change);
5736 defsubr (&Sprevious_overlay_change);
5737 defsubr (&Soverlay_recenter);
5738 defsubr (&Soverlay_lists);
5739 defsubr (&Soverlay_get);
5740 defsubr (&Soverlay_put);
5741 defsubr (&Srestore_buffer_modified_p);
5744 void
5745 keys_of_buffer ()
5747 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5748 initial_define_key (control_x_map, 'k', "kill-buffer");
5750 /* This must not be in syms_of_buffer, because Qdisabled is not
5751 initialized when that function gets called. */
5752 Fput (intern ("erase-buffer"), Qdisabled, Qt);