*** empty log message ***
[emacs.git] / src / buffer.c
blobaeb64e90d888cf1eae87040039fc4f96df3bc215
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985,86,87,88,89,93,94,95,97,98, 1999, 2000, 2001, 02, 2003
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <sys/param.h>
27 #include <errno.h>
28 #include <stdio.h>
30 #ifndef USE_CRT_DLL
31 extern int errno;
32 #endif
34 #ifndef MAXPATHLEN
35 /* in 4.1 [probably SunOS? -stef] , param.h fails to define this. */
36 #define MAXPATHLEN 1024
37 #endif /* not MAXPATHLEN */
39 #ifdef HAVE_UNISTD_H
40 #include <unistd.h>
41 #endif
43 #include "lisp.h"
44 #include "intervals.h"
45 #include "window.h"
46 #include "commands.h"
47 #include "buffer.h"
48 #include "charset.h"
49 #include "region-cache.h"
50 #include "indent.h"
51 #include "blockinput.h"
52 #include "keyboard.h"
53 #include "keymap.h"
54 #include "frame.h"
56 struct buffer *current_buffer; /* the current buffer */
58 /* First buffer in chain of all buffers (in reverse order of creation).
59 Threaded through ->next. */
61 struct buffer *all_buffers;
63 /* This structure holds the default values of the buffer-local variables
64 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
65 The default value occupies the same slot in this structure
66 as an individual buffer's value occupies in that buffer.
67 Setting the default value also goes through the alist of buffers
68 and stores into each buffer that does not say it has a local value. */
70 struct buffer buffer_defaults;
72 /* A Lisp_Object pointer to the above, used for staticpro */
74 static Lisp_Object Vbuffer_defaults;
76 /* This structure marks which slots in a buffer have corresponding
77 default values in buffer_defaults.
78 Each such slot has a nonzero value in this structure.
79 The value has only one nonzero bit.
81 When a buffer has its own local value for a slot,
82 the entry for that slot (found in the same slot in this structure)
83 is turned on in the buffer's local_flags array.
85 If a slot in this structure is -1, then even though there may
86 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
87 and the corresponding slot in buffer_defaults is not used.
89 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
90 but there is a default value which is copied into each buffer.
92 If a slot in this structure is negative, then even though there may
93 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
94 and the corresponding slot in buffer_defaults is not used.
96 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
97 zero, that is a bug */
99 struct buffer buffer_local_flags;
101 /* This structure holds the names of symbols whose values may be
102 buffer-local. It is indexed and accessed in the same way as the above. */
104 struct buffer buffer_local_symbols;
105 /* A Lisp_Object pointer to the above, used for staticpro */
106 static Lisp_Object Vbuffer_local_symbols;
108 /* This structure holds the required types for the values in the
109 buffer-local slots. If a slot contains Qnil, then the
110 corresponding buffer slot may contain a value of any type. If a
111 slot contains an integer, then prospective values' tags must be
112 equal to that integer (except nil is always allowed).
113 When a tag does not match, the function
114 buffer_slot_type_mismatch will signal an error.
116 If a slot here contains -1, the corresponding variable is read-only. */
117 struct buffer buffer_local_types;
119 /* Flags indicating which built-in buffer-local variables
120 are permanent locals. */
121 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
123 /* Number of per-buffer variables used. */
125 int last_per_buffer_idx;
127 Lisp_Object Fset_buffer ();
128 void set_buffer_internal ();
129 void set_buffer_internal_1 ();
130 static void call_overlay_mod_hooks ();
131 static void swap_out_buffer_local_variables ();
132 static void reset_buffer_local_variables ();
134 /* Alist of all buffer names vs the buffers. */
135 /* This used to be a variable, but is no longer,
136 to prevent lossage due to user rplac'ing this alist or its elements. */
137 Lisp_Object Vbuffer_alist;
139 /* Functions to call before and after each text change. */
140 Lisp_Object Vbefore_change_functions;
141 Lisp_Object Vafter_change_functions;
143 Lisp_Object Vtransient_mark_mode;
145 /* t means ignore all read-only text properties.
146 A list means ignore such a property if its value is a member of the list.
147 Any non-nil value means ignore buffer-read-only. */
148 Lisp_Object Vinhibit_read_only;
150 /* List of functions to call that can query about killing a buffer.
151 If any of these functions returns nil, we don't kill it. */
152 Lisp_Object Vkill_buffer_query_functions;
153 Lisp_Object Qkill_buffer_query_functions;
155 /* List of functions to call before changing an unmodified buffer. */
156 Lisp_Object Vfirst_change_hook;
158 Lisp_Object Qfirst_change_hook;
159 Lisp_Object Qbefore_change_functions;
160 Lisp_Object Qafter_change_functions;
161 Lisp_Object Qucs_set_table_for_input;
163 /* If nonzero, all modification hooks are suppressed. */
164 int inhibit_modification_hooks;
166 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
168 Lisp_Object Qprotected_field;
170 Lisp_Object QSFundamental; /* A string "Fundamental" */
172 Lisp_Object Qkill_buffer_hook;
174 Lisp_Object Qget_file_buffer;
176 Lisp_Object Qoverlayp;
178 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
180 Lisp_Object Qmodification_hooks;
181 Lisp_Object Qinsert_in_front_hooks;
182 Lisp_Object Qinsert_behind_hooks;
184 static void alloc_buffer_text P_ ((struct buffer *, size_t));
185 static void free_buffer_text P_ ((struct buffer *b));
186 static Lisp_Object copy_overlays P_ ((struct buffer *, Lisp_Object));
187 static void modify_overlay P_ ((struct buffer *, int, int));
190 /* For debugging; temporary. See set_buffer_internal. */
191 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
193 void
194 nsberror (spec)
195 Lisp_Object spec;
197 if (STRINGP (spec))
198 error ("No buffer named %s", SDATA (spec));
199 error ("Invalid buffer argument");
202 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
203 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
204 Value is nil if OBJECT is not a buffer or if it has been killed. */)
205 (object)
206 Lisp_Object object;
208 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
209 ? Qt : Qnil);
212 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
213 doc: /* Return a list of all existing live buffers.
214 If the optional arg FRAME is a frame, we return the buffer list
215 in the proper order for that frame: the buffers in FRAME's `buffer-list'
216 frame parameter come first, followed by the rest of the buffers. */)
217 (frame)
218 Lisp_Object frame;
220 Lisp_Object framelist, general;
221 general = Fmapcar (Qcdr, Vbuffer_alist);
223 if (FRAMEP (frame))
225 Lisp_Object tail;
227 CHECK_FRAME (frame);
229 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
231 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
232 tail = framelist;
233 while (! NILP (tail))
235 general = Fdelq (XCAR (tail), general);
236 tail = XCDR (tail);
238 return nconc2 (framelist, general);
241 return general;
244 /* Like Fassoc, but use Fstring_equal to compare
245 (which ignores text properties),
246 and don't ever QUIT. */
248 static Lisp_Object
249 assoc_ignore_text_properties (key, list)
250 register Lisp_Object key;
251 Lisp_Object list;
253 register Lisp_Object tail;
254 for (tail = list; CONSP (tail); tail = XCDR (tail))
256 register Lisp_Object elt, tem;
257 elt = XCAR (tail);
258 tem = Fstring_equal (Fcar (elt), key);
259 if (!NILP (tem))
260 return elt;
262 return Qnil;
265 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
266 doc: /* Return the buffer named NAME (a string).
267 If there is no live buffer named NAME, return nil.
268 NAME may also be a buffer; if so, the value is that buffer. */)
269 (name)
270 register Lisp_Object name;
272 if (BUFFERP (name))
273 return name;
274 CHECK_STRING (name);
276 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
279 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
280 doc: /* Return the buffer visiting file FILENAME (a string).
281 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
282 If there is no such live buffer, return nil.
283 See also `find-buffer-visiting'. */)
284 (filename)
285 register Lisp_Object filename;
287 register Lisp_Object tail, buf, tem;
288 Lisp_Object handler;
290 CHECK_STRING (filename);
291 filename = Fexpand_file_name (filename, Qnil);
293 /* If the file name has special constructs in it,
294 call the corresponding file handler. */
295 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
296 if (!NILP (handler))
297 return call2 (handler, Qget_file_buffer, filename);
299 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
301 buf = Fcdr (XCAR (tail));
302 if (!BUFFERP (buf)) continue;
303 if (!STRINGP (XBUFFER (buf)->filename)) continue;
304 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
305 if (!NILP (tem))
306 return buf;
308 return Qnil;
311 Lisp_Object
312 get_truename_buffer (filename)
313 register Lisp_Object filename;
315 register Lisp_Object tail, buf, tem;
317 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
319 buf = Fcdr (XCAR (tail));
320 if (!BUFFERP (buf)) continue;
321 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
322 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
323 if (!NILP (tem))
324 return buf;
326 return Qnil;
329 /* Incremented for each buffer created, to assign the buffer number. */
330 int buffer_count;
332 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
333 doc: /* Return the buffer named NAME, or create such a buffer and return it.
334 A new buffer is created if there is no live buffer named NAME.
335 If NAME starts with a space, the new buffer does not keep undo information.
336 If NAME is a buffer instead of a string, then it is the value returned.
337 The value is never nil. */)
338 (name)
339 register Lisp_Object name;
341 register Lisp_Object buf;
342 register struct buffer *b;
344 buf = Fget_buffer (name);
345 if (!NILP (buf))
346 return buf;
348 if (SCHARS (name) == 0)
349 error ("Empty string for buffer name is not allowed");
351 b = (struct buffer *) allocate_buffer ();
353 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
355 /* An ordinary buffer uses its own struct buffer_text. */
356 b->text = &b->own_text;
357 b->base_buffer = 0;
359 BUF_GAP_SIZE (b) = 20;
360 BLOCK_INPUT;
361 /* We allocate extra 1-byte at the tail and keep it always '\0' for
362 anchoring a search. */
363 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
364 UNBLOCK_INPUT;
365 if (! BUF_BEG_ADDR (b))
366 buffer_memory_full ();
368 BUF_PT (b) = BEG;
369 BUF_GPT (b) = BEG;
370 BUF_BEGV (b) = BEG;
371 BUF_ZV (b) = BEG;
372 BUF_Z (b) = BEG;
373 BUF_PT_BYTE (b) = BEG_BYTE;
374 BUF_GPT_BYTE (b) = BEG_BYTE;
375 BUF_BEGV_BYTE (b) = BEG_BYTE;
376 BUF_ZV_BYTE (b) = BEG_BYTE;
377 BUF_Z_BYTE (b) = BEG_BYTE;
378 BUF_MODIFF (b) = 1;
379 BUF_OVERLAY_MODIFF (b) = 1;
380 BUF_SAVE_MODIFF (b) = 1;
381 BUF_INTERVALS (b) = 0;
382 BUF_UNCHANGED_MODIFIED (b) = 1;
383 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
384 BUF_END_UNCHANGED (b) = 0;
385 BUF_BEG_UNCHANGED (b) = 0;
386 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
388 b->newline_cache = 0;
389 b->width_run_cache = 0;
390 b->width_table = Qnil;
391 b->prevent_redisplay_optimizations_p = 1;
393 /* Put this on the chain of all buffers including killed ones. */
394 b->next = all_buffers;
395 all_buffers = b;
397 /* An ordinary buffer normally doesn't need markers
398 to handle BEGV and ZV. */
399 b->pt_marker = Qnil;
400 b->begv_marker = Qnil;
401 b->zv_marker = Qnil;
403 name = Fcopy_sequence (name);
404 STRING_SET_INTERVALS (name, NULL_INTERVAL);
405 b->name = name;
407 if (SREF (name, 0) != ' ')
408 b->undo_list = Qnil;
409 else
410 b->undo_list = Qt;
412 reset_buffer (b);
413 reset_buffer_local_variables (b, 1);
415 b->mark = Fmake_marker ();
416 BUF_MARKERS (b) = NULL;
417 b->name = name;
419 /* Put this in the alist of all live buffers. */
420 XSETBUFFER (buf, b);
421 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
423 /* An error in calling the function here (should someone redfine it)
424 can lead to infinite regress until you run out of stack. rms
425 says that's not worth protecting against. */
426 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
427 /* buf is on buffer-alist, so no gcpro. */
428 call1 (Qucs_set_table_for_input, buf);
430 return buf;
434 /* Return a list of overlays which is a copy of the overlay list
435 LIST, but for buffer B. */
437 static Lisp_Object
438 copy_overlays (b, list)
439 struct buffer *b;
440 Lisp_Object list;
442 Lisp_Object result, buffer;
444 XSETBUFFER (buffer, b);
446 for (result = Qnil; CONSP (list); list = XCDR (list))
448 Lisp_Object overlay, start, end, old_overlay;
449 int charpos;
451 old_overlay = XCAR (list);
452 charpos = marker_position (OVERLAY_START (old_overlay));
453 start = Fmake_marker ();
454 Fset_marker (start, make_number (charpos), buffer);
455 XMARKER (start)->insertion_type
456 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
458 charpos = marker_position (OVERLAY_END (old_overlay));
459 end = Fmake_marker ();
460 Fset_marker (end, make_number (charpos), buffer);
461 XMARKER (end)->insertion_type
462 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
464 overlay = allocate_misc ();
465 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
466 OVERLAY_START (overlay) = start;
467 OVERLAY_END (overlay) = end;
468 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
470 result = Fcons (overlay, result);
473 return Fnreverse (result);
477 /* Clone per-buffer values of buffer FROM.
479 Buffer TO gets the same per-buffer values as FROM, with the
480 following exceptions: (1) TO's name is left untouched, (2) markers
481 are copied and made to refer to TO, and (3) overlay lists are
482 copied. */
484 static void
485 clone_per_buffer_values (from, to)
486 struct buffer *from, *to;
488 Lisp_Object to_buffer;
489 int offset;
491 XSETBUFFER (to_buffer, to);
493 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
494 offset < sizeof *to;
495 offset += sizeof (Lisp_Object))
497 Lisp_Object obj;
499 obj = PER_BUFFER_VALUE (from, offset);
500 if (MARKERP (obj))
502 struct Lisp_Marker *m = XMARKER (obj);
503 obj = Fmake_marker ();
504 XMARKER (obj)->insertion_type = m->insertion_type;
505 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
508 PER_BUFFER_VALUE (to, offset) = obj;
511 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
513 to->overlays_before = copy_overlays (to, from->overlays_before);
514 to->overlays_after = copy_overlays (to, from->overlays_after);
518 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
519 2, 3,
520 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
521 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
522 BASE-BUFFER should be an existing buffer (or buffer name).
523 NAME should be a string which is not the name of an existing buffer.
524 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
525 such as major and minor modes, in the indirect buffer.
526 CLONE nil means the indirect buffer's state is reset to default values. */)
527 (base_buffer, name, clone)
528 Lisp_Object base_buffer, name, clone;
530 Lisp_Object buf;
531 struct buffer *b;
533 buf = Fget_buffer (name);
534 if (!NILP (buf))
535 error ("Buffer name `%s' is in use", SDATA (name));
537 base_buffer = Fget_buffer (base_buffer);
538 if (NILP (base_buffer))
539 error ("No such buffer: `%s'", SDATA (name));
541 if (SCHARS (name) == 0)
542 error ("Empty string for buffer name is not allowed");
544 b = (struct buffer *) allocate_buffer ();
545 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
547 if (XBUFFER (base_buffer)->base_buffer)
548 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
549 else
550 b->base_buffer = XBUFFER (base_buffer);
552 /* Use the base buffer's text object. */
553 b->text = b->base_buffer->text;
555 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
556 BUF_ZV (b) = BUF_ZV (b->base_buffer);
557 BUF_PT (b) = BUF_PT (b->base_buffer);
558 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
559 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
560 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
562 b->newline_cache = 0;
563 b->width_run_cache = 0;
564 b->width_table = Qnil;
566 /* Put this on the chain of all buffers including killed ones. */
567 b->next = all_buffers;
568 all_buffers = b;
570 name = Fcopy_sequence (name);
571 STRING_SET_INTERVALS (name, NULL_INTERVAL);
572 b->name = name;
574 reset_buffer (b);
575 reset_buffer_local_variables (b, 1);
577 /* Put this in the alist of all live buffers. */
578 XSETBUFFER (buf, b);
579 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
581 b->mark = Fmake_marker ();
582 b->name = name;
584 /* The multibyte status belongs to the base buffer. */
585 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
587 /* Make sure the base buffer has markers for its narrowing. */
588 if (NILP (b->base_buffer->pt_marker))
590 b->base_buffer->pt_marker = Fmake_marker ();
591 set_marker_both (b->base_buffer->pt_marker, base_buffer,
592 BUF_PT (b->base_buffer),
593 BUF_PT_BYTE (b->base_buffer));
595 if (NILP (b->base_buffer->begv_marker))
597 b->base_buffer->begv_marker = Fmake_marker ();
598 set_marker_both (b->base_buffer->begv_marker, base_buffer,
599 BUF_BEGV (b->base_buffer),
600 BUF_BEGV_BYTE (b->base_buffer));
602 if (NILP (b->base_buffer->zv_marker))
604 b->base_buffer->zv_marker = Fmake_marker ();
605 set_marker_both (b->base_buffer->zv_marker, base_buffer,
606 BUF_ZV (b->base_buffer),
607 BUF_ZV_BYTE (b->base_buffer));
608 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
611 if (NILP (clone))
613 /* Give the indirect buffer markers for its narrowing. */
614 b->pt_marker = Fmake_marker ();
615 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
616 b->begv_marker = Fmake_marker ();
617 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
618 b->zv_marker = Fmake_marker ();
619 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
620 XMARKER (b->zv_marker)->insertion_type = 1;
622 else
623 clone_per_buffer_values (b->base_buffer, b);
625 return buf;
628 /* Reinitialize everything about a buffer except its name and contents
629 and local variables. */
631 void
632 reset_buffer (b)
633 register struct buffer *b;
635 b->filename = Qnil;
636 b->file_truename = Qnil;
637 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
638 b->modtime = 0;
639 XSETFASTINT (b->save_length, 0);
640 b->last_window_start = 1;
641 /* It is more conservative to start out "changed" than "unchanged". */
642 b->clip_changed = 0;
643 b->prevent_redisplay_optimizations_p = 1;
644 b->backed_up = Qnil;
645 b->auto_save_modified = 0;
646 b->auto_save_failure_time = -1;
647 b->auto_save_file_name = Qnil;
648 b->read_only = Qnil;
649 b->overlays_before = Qnil;
650 b->overlays_after = Qnil;
651 b->overlay_center = BEG;
652 b->mark_active = Qnil;
653 b->point_before_scroll = Qnil;
654 b->file_format = Qnil;
655 b->last_selected_window = Qnil;
656 XSETINT (b->display_count, 0);
657 b->display_time = Qnil;
658 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
659 b->cursor_type = buffer_defaults.cursor_type;
660 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
662 b->display_error_modiff = 0;
665 /* Reset buffer B's local variables info.
666 Don't use this on a buffer that has already been in use;
667 it does not treat permanent locals consistently.
668 Instead, use Fkill_all_local_variables.
670 If PERMANENT_TOO is 1, then we reset permanent built-in
671 buffer-local variables. If PERMANENT_TOO is 0,
672 we preserve those. */
674 static void
675 reset_buffer_local_variables (b, permanent_too)
676 register struct buffer *b;
677 int permanent_too;
679 register int offset;
680 int i;
682 /* Reset the major mode to Fundamental, together with all the
683 things that depend on the major mode.
684 default-major-mode is handled at a higher level.
685 We ignore it here. */
686 b->major_mode = Qfundamental_mode;
687 b->keymap = Qnil;
688 b->mode_name = QSFundamental;
689 b->minor_modes = Qnil;
691 /* If the standard case table has been altered and invalidated,
692 fix up its insides first. */
693 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
694 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
695 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
696 Fset_standard_case_table (Vascii_downcase_table);
698 b->downcase_table = Vascii_downcase_table;
699 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
700 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
701 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
702 b->invisibility_spec = Qt;
703 #ifndef DOS_NT
704 b->buffer_file_type = Qnil;
705 #endif
707 /* Reset all (or most) per-buffer variables to their defaults. */
708 b->local_var_alist = Qnil;
709 for (i = 0; i < last_per_buffer_idx; ++i)
710 if (permanent_too || buffer_permanent_local_flags[i] == 0)
711 SET_PER_BUFFER_VALUE_P (b, i, 0);
713 /* For each slot that has a default value,
714 copy that into the slot. */
716 for (offset = PER_BUFFER_VAR_OFFSET (name);
717 offset < sizeof *b;
718 offset += sizeof (Lisp_Object))
720 int idx = PER_BUFFER_IDX (offset);
721 if ((idx > 0
722 && (permanent_too
723 || buffer_permanent_local_flags[idx] == 0))
724 /* Is -2 used anywhere? */
725 || idx == -2)
726 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
730 /* We split this away from generate-new-buffer, because rename-buffer
731 and set-visited-file-name ought to be able to use this to really
732 rename the buffer properly. */
734 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
735 1, 2, 0,
736 doc: /* Return a string that is the name of no existing buffer based on NAME.
737 If there is no live buffer named NAME, then return NAME.
738 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
739 until an unused name is found, and then return that name.
740 Optional second argument IGNORE specifies a name that is okay to use
741 \(if it is in the sequence to be tried)
742 even if a buffer with that name exists. */)
743 (name, ignore)
744 register Lisp_Object name, ignore;
746 register Lisp_Object gentemp, tem;
747 int count;
748 char number[10];
750 CHECK_STRING (name);
752 tem = Fget_buffer (name);
753 if (NILP (tem))
754 return name;
756 count = 1;
757 while (1)
759 sprintf (number, "<%d>", ++count);
760 gentemp = concat2 (name, build_string (number));
761 tem = Fstring_equal (gentemp, ignore);
762 if (!NILP (tem))
763 return gentemp;
764 tem = Fget_buffer (gentemp);
765 if (NILP (tem))
766 return gentemp;
771 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
772 doc: /* Return the name of BUFFER, as a string.
773 With no argument or nil as argument, return the name of the current buffer. */)
774 (buffer)
775 register Lisp_Object buffer;
777 if (NILP (buffer))
778 return current_buffer->name;
779 CHECK_BUFFER (buffer);
780 return XBUFFER (buffer)->name;
783 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
784 doc: /* Return name of file BUFFER is visiting, or nil if none.
785 No argument or nil as argument means use the current buffer. */)
786 (buffer)
787 register Lisp_Object buffer;
789 if (NILP (buffer))
790 return current_buffer->filename;
791 CHECK_BUFFER (buffer);
792 return XBUFFER (buffer)->filename;
795 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
796 0, 1, 0,
797 doc: /* Return the base buffer of indirect buffer BUFFER.
798 If BUFFER is not indirect, return nil. */)
799 (buffer)
800 register Lisp_Object buffer;
802 struct buffer *base;
803 Lisp_Object base_buffer;
805 if (NILP (buffer))
806 base = current_buffer->base_buffer;
807 else
809 CHECK_BUFFER (buffer);
810 base = XBUFFER (buffer)->base_buffer;
813 if (! base)
814 return Qnil;
815 XSETBUFFER (base_buffer, base);
816 return base_buffer;
819 DEFUN ("buffer-local-value", Fbuffer_local_value,
820 Sbuffer_local_value, 2, 2, 0,
821 doc: /* Return the value of VARIABLE in BUFFER.
822 If VARIABLE does not have a buffer-local binding in BUFFER, the value
823 is the default binding of variable. */)
824 (symbol, buffer)
825 register Lisp_Object symbol;
826 register Lisp_Object buffer;
828 register struct buffer *buf;
829 register Lisp_Object result;
831 CHECK_SYMBOL (symbol);
832 CHECK_BUFFER (buffer);
833 buf = XBUFFER (buffer);
835 /* Look in local_var_list */
836 result = Fassoc (symbol, buf->local_var_alist);
837 if (NILP (result))
839 int offset, idx;
840 int found = 0;
842 /* Look in special slots */
843 for (offset = PER_BUFFER_VAR_OFFSET (name);
844 offset < sizeof (struct buffer);
845 /* sizeof EMACS_INT == sizeof Lisp_Object */
846 offset += (sizeof (EMACS_INT)))
848 idx = PER_BUFFER_IDX (offset);
849 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
850 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
851 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
853 result = PER_BUFFER_VALUE (buf, offset);
854 found = 1;
855 break;
859 if (!found)
860 result = Fdefault_value (symbol);
862 else
864 Lisp_Object valcontents;
865 Lisp_Object current_alist_element;
867 /* What binding is loaded right now? */
868 valcontents = SYMBOL_VALUE (symbol);
869 current_alist_element
870 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
872 /* The value of the currently loaded binding is not
873 stored in it, but rather in the realvalue slot.
874 Store that value into the binding it belongs to
875 in case that is the one we are about to use. */
877 Fsetcdr (current_alist_element,
878 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
880 /* Now get the (perhaps updated) value out of the binding. */
881 result = XCDR (result);
884 if (EQ (result, Qunbound))
885 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
887 return result;
890 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
891 Sbuffer_local_variables, 0, 1, 0,
892 doc: /* Return an alist of variables that are buffer-local in BUFFER.
893 Most elements look like (SYMBOL . VALUE), describing one variable.
894 For a symbol that is locally unbound, just the symbol appears in the value.
895 Note that storing new VALUEs in these elements doesn't change the variables.
896 No argument or nil as argument means use current buffer as BUFFER. */)
897 (buffer)
898 register Lisp_Object buffer;
900 register struct buffer *buf;
901 register Lisp_Object result;
903 if (NILP (buffer))
904 buf = current_buffer;
905 else
907 CHECK_BUFFER (buffer);
908 buf = XBUFFER (buffer);
911 result = Qnil;
914 register Lisp_Object tail;
915 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
917 Lisp_Object val, elt;
919 elt = XCAR (tail);
921 /* Reference each variable in the alist in buf.
922 If inquiring about the current buffer, this gets the current values,
923 so store them into the alist so the alist is up to date.
924 If inquiring about some other buffer, this swaps out any values
925 for that buffer, making the alist up to date automatically. */
926 val = find_symbol_value (XCAR (elt));
927 /* Use the current buffer value only if buf is the current buffer. */
928 if (buf != current_buffer)
929 val = XCDR (elt);
931 /* If symbol is unbound, put just the symbol in the list. */
932 if (EQ (val, Qunbound))
933 result = Fcons (XCAR (elt), result);
934 /* Otherwise, put (symbol . value) in the list. */
935 else
936 result = Fcons (Fcons (XCAR (elt), val), result);
940 /* Add on all the variables stored in special slots. */
942 int offset, idx;
944 for (offset = PER_BUFFER_VAR_OFFSET (name);
945 offset < sizeof (struct buffer);
946 /* sizeof EMACS_INT == sizeof Lisp_Object */
947 offset += (sizeof (EMACS_INT)))
949 idx = PER_BUFFER_IDX (offset);
950 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
951 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
952 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
953 PER_BUFFER_VALUE (buf, offset)),
954 result);
958 return result;
962 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
963 0, 1, 0,
964 doc: /* Return t if BUFFER was modified since its file was last read or saved.
965 No argument or nil as argument means use current buffer as BUFFER. */)
966 (buffer)
967 register Lisp_Object buffer;
969 register struct buffer *buf;
970 if (NILP (buffer))
971 buf = current_buffer;
972 else
974 CHECK_BUFFER (buffer);
975 buf = XBUFFER (buffer);
978 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
981 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
982 1, 1, 0,
983 doc: /* Mark current buffer as modified or unmodified according to FLAG.
984 A non-nil FLAG means mark the buffer modified. */)
985 (flag)
986 register Lisp_Object flag;
988 register int already;
989 register Lisp_Object fn;
990 Lisp_Object buffer, window;
992 #ifdef CLASH_DETECTION
993 /* If buffer becoming modified, lock the file.
994 If buffer becoming unmodified, unlock the file. */
996 fn = current_buffer->file_truename;
997 /* Test buffer-file-name so that binding it to nil is effective. */
998 if (!NILP (fn) && ! NILP (current_buffer->filename))
1000 already = SAVE_MODIFF < MODIFF;
1001 if (!already && !NILP (flag))
1002 lock_file (fn);
1003 else if (already && NILP (flag))
1004 unlock_file (fn);
1006 #endif /* CLASH_DETECTION */
1008 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1010 /* Set update_mode_lines only if buffer is displayed in some window.
1011 Packages like jit-lock or lazy-lock preserve a buffer's modified
1012 state by recording/restoring the state around blocks of code.
1013 Setting update_mode_lines makes redisplay consider all windows
1014 (on all frames). Stealth fontification of buffers not displayed
1015 would incur additional redisplay costs if we'd set
1016 update_modes_lines unconditionally.
1018 Ideally, I think there should be another mechanism for fontifying
1019 buffers without "modifying" buffers, or redisplay should be
1020 smarter about updating the `*' in mode lines. --gerd */
1021 XSETBUFFER (buffer, current_buffer);
1022 window = Fget_buffer_window (buffer, Qt);
1023 if (WINDOWP (window))
1025 ++update_mode_lines;
1026 current_buffer->prevent_redisplay_optimizations_p = 1;
1029 return flag;
1032 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1033 Srestore_buffer_modified_p, 1, 1, 0,
1034 doc: /* Like `set-buffer-modified-p', with a differences concerning redisplay.
1035 It is not ensured that mode lines will be updated to show the modified
1036 state of the current buffer. Use with care. */)
1037 (flag)
1038 Lisp_Object flag;
1040 #ifdef CLASH_DETECTION
1041 Lisp_Object fn;
1043 /* If buffer becoming modified, lock the file.
1044 If buffer becoming unmodified, unlock the file. */
1046 fn = current_buffer->file_truename;
1047 /* Test buffer-file-name so that binding it to nil is effective. */
1048 if (!NILP (fn) && ! NILP (current_buffer->filename))
1050 int already = SAVE_MODIFF < MODIFF;
1051 if (!already && !NILP (flag))
1052 lock_file (fn);
1053 else if (already && NILP (flag))
1054 unlock_file (fn);
1056 #endif /* CLASH_DETECTION */
1058 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1059 return flag;
1062 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1063 0, 1, 0,
1064 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1065 Each buffer has a tick counter which is incremented each time the text in
1066 that buffer is changed. It wraps around occasionally.
1067 No argument or nil as argument means use current buffer as BUFFER. */)
1068 (buffer)
1069 register Lisp_Object buffer;
1071 register struct buffer *buf;
1072 if (NILP (buffer))
1073 buf = current_buffer;
1074 else
1076 CHECK_BUFFER (buffer);
1077 buf = XBUFFER (buffer);
1080 return make_number (BUF_MODIFF (buf));
1083 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1084 "sRename buffer (to new name): \nP",
1085 doc: /* Change current buffer's name to NEWNAME (a string).
1086 If second arg UNIQUE is nil or omitted, it is an error if a
1087 buffer named NEWNAME already exists.
1088 If UNIQUE is non-nil, come up with a new name using
1089 `generate-new-buffer-name'.
1090 Interactively, you can set UNIQUE with a prefix argument.
1091 We return the name we actually gave the buffer.
1092 This does not change the name of the visited file (if any). */)
1093 (newname, unique)
1094 register Lisp_Object newname, unique;
1096 register Lisp_Object tem, buf;
1098 CHECK_STRING (newname);
1100 if (SCHARS (newname) == 0)
1101 error ("Empty string is invalid as a buffer name");
1103 tem = Fget_buffer (newname);
1104 if (!NILP (tem))
1106 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1107 rename the buffer automatically so you can create another
1108 with the original name. It makes UNIQUE equivalent to
1109 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1110 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1111 return current_buffer->name;
1112 if (!NILP (unique))
1113 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1114 else
1115 error ("Buffer name `%s' is in use", SDATA (newname));
1118 current_buffer->name = newname;
1120 /* Catch redisplay's attention. Unless we do this, the mode lines for
1121 any windows displaying current_buffer will stay unchanged. */
1122 update_mode_lines++;
1124 XSETBUFFER (buf, current_buffer);
1125 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1126 if (NILP (current_buffer->filename)
1127 && !NILP (current_buffer->auto_save_file_name))
1128 call0 (intern ("rename-auto-save-file"));
1129 /* Refetch since that last call may have done GC. */
1130 return current_buffer->name;
1133 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1134 doc: /* Return most recently selected buffer other than BUFFER.
1135 Buffers not visible in windows are preferred to visible buffers,
1136 unless optional second argument VISIBLE-OK is non-nil.
1137 If the optional third argument FRAME is non-nil, use that frame's
1138 buffer list instead of the selected frame's buffer list.
1139 If no other buffer exists, the buffer `*scratch*' is returned.
1140 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1141 (buffer, visible_ok, frame)
1142 register Lisp_Object buffer, visible_ok, frame;
1144 Lisp_Object Fset_buffer_major_mode ();
1145 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1146 notsogood = Qnil;
1148 if (NILP (frame))
1149 frame = selected_frame;
1151 tail = Vbuffer_alist;
1152 pred = frame_buffer_predicate (frame);
1154 /* Consider buffers that have been seen in the selected frame
1155 before other buffers. */
1157 tem = frame_buffer_list (frame);
1158 add_ons = Qnil;
1159 while (CONSP (tem))
1161 if (BUFFERP (XCAR (tem)))
1162 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1163 tem = XCDR (tem);
1165 tail = nconc2 (Fnreverse (add_ons), tail);
1167 for (; CONSP (tail); tail = XCDR (tail))
1169 buf = Fcdr (XCAR (tail));
1170 if (EQ (buf, buffer))
1171 continue;
1172 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1173 continue;
1174 /* If the selected frame has a buffer_predicate,
1175 disregard buffers that don't fit the predicate. */
1176 if (!NILP (pred))
1178 tem = call1 (pred, buf);
1179 if (NILP (tem))
1180 continue;
1183 if (NILP (visible_ok))
1184 tem = Fget_buffer_window (buf, Qvisible);
1185 else
1186 tem = Qnil;
1187 if (NILP (tem))
1188 return buf;
1189 if (NILP (notsogood))
1190 notsogood = buf;
1192 if (!NILP (notsogood))
1193 return notsogood;
1194 buf = Fget_buffer (build_string ("*scratch*"));
1195 if (NILP (buf))
1197 buf = Fget_buffer_create (build_string ("*scratch*"));
1198 Fset_buffer_major_mode (buf);
1200 return buf;
1203 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo,
1204 0, 1, "",
1205 doc: /* Make BUFFER stop keeping undo information.
1206 No argument or nil as argument means do this for the current buffer. */)
1207 (buffer)
1208 register Lisp_Object buffer;
1210 Lisp_Object real_buffer;
1212 if (NILP (buffer))
1213 XSETBUFFER (real_buffer, current_buffer);
1214 else
1216 real_buffer = Fget_buffer (buffer);
1217 if (NILP (real_buffer))
1218 nsberror (buffer);
1221 XBUFFER (real_buffer)->undo_list = Qt;
1223 return Qnil;
1226 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1227 0, 1, "",
1228 doc: /* Start keeping undo information for buffer BUFFER.
1229 No argument or nil as argument means do this for the current buffer. */)
1230 (buffer)
1231 register Lisp_Object buffer;
1233 Lisp_Object real_buffer;
1235 if (NILP (buffer))
1236 XSETBUFFER (real_buffer, current_buffer);
1237 else
1239 real_buffer = Fget_buffer (buffer);
1240 if (NILP (real_buffer))
1241 nsberror (buffer);
1244 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1245 XBUFFER (real_buffer)->undo_list = Qnil;
1247 return Qnil;
1251 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1252 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1253 The buffer being killed will be current while the hook is running.\n\
1254 See `kill-buffer'."
1256 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1257 doc: /* Kill the buffer BUFFER.
1258 The argument may be a buffer or may be the name of a buffer.
1259 An argument of nil means kill the current buffer.
1261 Value is t if the buffer is actually killed, nil if user says no.
1263 The value of `kill-buffer-hook' (which may be local to that buffer),
1264 if not void, is a list of functions to be called, with no arguments,
1265 before the buffer is actually killed. The buffer to be killed is current
1266 when the hook functions are called.
1268 Any processes that have this buffer as the `process-buffer' are killed
1269 with SIGHUP. */)
1270 (buffer)
1271 Lisp_Object buffer;
1273 Lisp_Object buf;
1274 register struct buffer *b;
1275 register Lisp_Object tem;
1276 register struct Lisp_Marker *m;
1277 struct gcpro gcpro1;
1279 if (NILP (buffer))
1280 buf = Fcurrent_buffer ();
1281 else
1282 buf = Fget_buffer (buffer);
1283 if (NILP (buf))
1284 nsberror (buffer);
1286 b = XBUFFER (buf);
1288 /* Avoid trouble for buffer already dead. */
1289 if (NILP (b->name))
1290 return Qnil;
1292 /* Query if the buffer is still modified. */
1293 if (INTERACTIVE && !NILP (b->filename)
1294 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1296 GCPRO1 (buf);
1297 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1298 b->name, make_number (0)));
1299 UNGCPRO;
1300 if (NILP (tem))
1301 return Qnil;
1304 /* Run hooks with the buffer to be killed the current buffer. */
1306 int count = SPECPDL_INDEX ();
1307 Lisp_Object arglist[1];
1309 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1310 set_buffer_internal (b);
1312 /* First run the query functions; if any query is answered no,
1313 don't kill the buffer. */
1314 arglist[0] = Qkill_buffer_query_functions;
1315 if (NILP (Frun_hook_with_args_until_failure (1, arglist)))
1316 return unbind_to (count, Qnil);
1318 /* Then run the hooks. */
1319 Frun_hooks (1, &Qkill_buffer_hook);
1320 unbind_to (count, Qnil);
1323 /* We have no more questions to ask. Verify that it is valid
1324 to kill the buffer. This must be done after the questions
1325 since anything can happen within do_yes_or_no_p. */
1327 /* Don't kill the minibuffer now current. */
1328 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1329 return Qnil;
1331 if (NILP (b->name))
1332 return Qnil;
1334 /* When we kill a base buffer, kill all its indirect buffers.
1335 We do it at this stage so nothing terrible happens if they
1336 ask questions or their hooks get errors. */
1337 if (! b->base_buffer)
1339 struct buffer *other;
1341 GCPRO1 (buf);
1343 for (other = all_buffers; other; other = other->next)
1344 /* all_buffers contains dead buffers too;
1345 don't re-kill them. */
1346 if (other->base_buffer == b && !NILP (other->name))
1348 Lisp_Object buf;
1349 XSETBUFFER (buf, other);
1350 Fkill_buffer (buf);
1353 UNGCPRO;
1356 /* Make this buffer not be current.
1357 In the process, notice if this is the sole visible buffer
1358 and give up if so. */
1359 if (b == current_buffer)
1361 tem = Fother_buffer (buf, Qnil, Qnil);
1362 Fset_buffer (tem);
1363 if (b == current_buffer)
1364 return Qnil;
1367 /* Notice if the buffer to kill is the sole visible buffer
1368 when we're currently in the mini-buffer, and give up if so. */
1369 XSETBUFFER (tem, current_buffer);
1370 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1372 tem = Fother_buffer (buf, Qnil, Qnil);
1373 if (EQ (buf, tem))
1374 return Qnil;
1377 /* Now there is no question: we can kill the buffer. */
1379 #ifdef CLASH_DETECTION
1380 /* Unlock this buffer's file, if it is locked. */
1381 unlock_buffer (b);
1382 #endif /* CLASH_DETECTION */
1384 kill_buffer_processes (buf);
1385 clear_charpos_cache (b);
1387 tem = Vinhibit_quit;
1388 Vinhibit_quit = Qt;
1389 replace_buffer_in_all_windows (buf);
1390 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1391 frames_discard_buffer (buf);
1392 Vinhibit_quit = tem;
1394 /* Delete any auto-save file, if we saved it in this session.
1395 But not if the buffer is modified. */
1396 if (STRINGP (b->auto_save_file_name)
1397 && b->auto_save_modified != 0
1398 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1399 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b))
1401 Lisp_Object tem;
1402 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1403 if (! NILP (tem))
1404 internal_delete_file (b->auto_save_file_name);
1407 if (b->base_buffer)
1409 /* Unchain all markers that belong to this indirect buffer.
1410 Don't unchain the markers that belong to the base buffer
1411 or its other indirect buffers. */
1412 for (m = BUF_MARKERS (b); m; )
1414 struct Lisp_Marker *next = m->next;
1415 if (m->buffer == b)
1416 unchain_marker (m);
1417 m = next;
1420 else
1422 /* Unchain all markers of this buffer and its indirect buffers.
1423 and leave them pointing nowhere. */
1424 for (m = BUF_MARKERS (b); m; )
1426 struct Lisp_Marker *next = m->next;
1427 m->buffer = 0;
1428 m->next = NULL;
1429 m = next;
1431 BUF_MARKERS (b) = NULL;
1432 BUF_INTERVALS (b) = NULL_INTERVAL;
1434 /* Perhaps we should explicitly free the interval tree here... */
1437 /* Reset the local variables, so that this buffer's local values
1438 won't be protected from GC. They would be protected
1439 if they happened to remain encached in their symbols.
1440 This gets rid of them for certain. */
1441 swap_out_buffer_local_variables (b);
1442 reset_buffer_local_variables (b, 1);
1444 b->name = Qnil;
1446 BLOCK_INPUT;
1447 if (! b->base_buffer)
1448 free_buffer_text (b);
1450 if (b->newline_cache)
1452 free_region_cache (b->newline_cache);
1453 b->newline_cache = 0;
1455 if (b->width_run_cache)
1457 free_region_cache (b->width_run_cache);
1458 b->width_run_cache = 0;
1460 b->width_table = Qnil;
1461 UNBLOCK_INPUT;
1462 b->undo_list = Qnil;
1464 return Qt;
1467 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1468 we do this each time BUF is selected visibly, the more recently
1469 selected buffers are always closer to the front of the list. This
1470 means that other_buffer is more likely to choose a relevant buffer. */
1472 void
1473 record_buffer (buf)
1474 Lisp_Object buf;
1476 register Lisp_Object link, prev;
1477 Lisp_Object frame;
1478 frame = selected_frame;
1480 prev = Qnil;
1481 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1483 if (EQ (XCDR (XCAR (link)), buf))
1484 break;
1485 prev = link;
1488 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1489 we cannot use Fdelq itself here because it allows quitting. */
1491 if (NILP (prev))
1492 Vbuffer_alist = XCDR (Vbuffer_alist);
1493 else
1494 XSETCDR (prev, XCDR (XCDR (prev)));
1496 XSETCDR (link, Vbuffer_alist);
1497 Vbuffer_alist = link;
1499 /* Now move this buffer to the front of frame_buffer_list also. */
1501 prev = Qnil;
1502 for (link = frame_buffer_list (frame); CONSP (link);
1503 link = XCDR (link))
1505 if (EQ (XCAR (link), buf))
1506 break;
1507 prev = link;
1510 /* Effectively do delq. */
1512 if (CONSP (link))
1514 if (NILP (prev))
1515 set_frame_buffer_list (frame,
1516 XCDR (frame_buffer_list (frame)));
1517 else
1518 XSETCDR (prev, XCDR (XCDR (prev)));
1520 XSETCDR (link, frame_buffer_list (frame));
1521 set_frame_buffer_list (frame, link);
1523 else
1524 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1527 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1528 doc: /* Set an appropriate major mode for BUFFER.
1529 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1530 according to `default-major-mode'.
1531 Use this function before selecting the buffer, since it may need to inspect
1532 the current buffer's major mode. */)
1533 (buffer)
1534 Lisp_Object buffer;
1536 int count;
1537 Lisp_Object function;
1539 if (STRINGP (XBUFFER (buffer)->name)
1540 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1541 function = find_symbol_value (intern ("initial-major-mode"));
1542 else
1544 function = buffer_defaults.major_mode;
1545 if (NILP (function)
1546 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1547 function = current_buffer->major_mode;
1550 if (NILP (function) || EQ (function, Qfundamental_mode))
1551 return Qnil;
1553 count = SPECPDL_INDEX ();
1555 /* To select a nonfundamental mode,
1556 select the buffer temporarily and then call the mode function. */
1558 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1560 Fset_buffer (buffer);
1561 call0 (function);
1563 return unbind_to (count, Qnil);
1566 /* If switching buffers in WINDOW would be an error, return
1567 a C string saying what the error would be. */
1569 char *
1570 no_switch_window (window)
1571 Lisp_Object window;
1573 Lisp_Object tem;
1574 if (EQ (minibuf_window, window))
1575 return "Cannot switch buffers in minibuffer window";
1576 tem = Fwindow_dedicated_p (window);
1577 if (EQ (tem, Qt))
1578 return "Cannot switch buffers in a dedicated window";
1579 return NULL;
1582 /* Switch to buffer BUFFER in the selected window.
1583 If NORECORD is non-nil, don't call record_buffer. */
1585 Lisp_Object
1586 switch_to_buffer_1 (buffer, norecord)
1587 Lisp_Object buffer, norecord;
1589 register Lisp_Object buf;
1591 if (NILP (buffer))
1592 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1593 else
1595 buf = Fget_buffer (buffer);
1596 if (NILP (buf))
1598 buf = Fget_buffer_create (buffer);
1599 Fset_buffer_major_mode (buf);
1602 Fset_buffer (buf);
1603 if (NILP (norecord))
1604 record_buffer (buf);
1606 Fset_window_buffer (EQ (selected_window, minibuf_window)
1607 ? Fnext_window (minibuf_window, Qnil, Qnil)
1608 : selected_window,
1609 buf, Qnil);
1611 return buf;
1614 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1615 doc: /* Select buffer BUFFER in the current window.
1616 BUFFER may be a buffer or a buffer name.
1617 Optional second arg NORECORD non-nil means
1618 do not put this buffer at the front of the list of recently selected ones.
1620 WARNING: This is NOT the way to work on another buffer temporarily
1621 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1622 the window-buffer correspondences. */)
1623 (buffer, norecord)
1624 Lisp_Object buffer, norecord;
1626 char *err;
1628 err = no_switch_window (selected_window);
1629 if (err) error (err);
1631 return switch_to_buffer_1 (buffer, norecord);
1634 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1635 doc: /* Select buffer BUFFER in some window, preferably a different one.
1636 If BUFFER is nil, then some other buffer is chosen.
1637 If `pop-up-windows' is non-nil, windows can be split to do this.
1638 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1639 window even if BUFFER is already visible in the selected window.
1640 This uses the function `display-buffer' as a subroutine; see the documentation
1641 of `display-buffer' for additional customization information.
1643 Optional third arg NORECORD non-nil means
1644 do not put this buffer at the front of the list of recently selected ones. */)
1645 (buffer, other_window, norecord)
1646 Lisp_Object buffer, other_window, norecord;
1648 register Lisp_Object buf;
1649 if (NILP (buffer))
1650 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1651 else
1653 buf = Fget_buffer (buffer);
1654 if (NILP (buf))
1656 buf = Fget_buffer_create (buffer);
1657 Fset_buffer_major_mode (buf);
1660 Fset_buffer (buf);
1661 if (NILP (norecord))
1662 /* Why bother ? Fselect_window will do it for us anyway. -stef */
1663 record_buffer (buf);
1664 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1665 return buf;
1668 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1669 doc: /* Return the current buffer as a Lisp object. */)
1672 register Lisp_Object buf;
1673 XSETBUFFER (buf, current_buffer);
1674 return buf;
1677 /* Set the current buffer to B.
1679 We previously set windows_or_buffers_changed here to invalidate
1680 global unchanged information in beg_unchanged and end_unchanged.
1681 This is no longer necessary because we now compute unchanged
1682 information on a buffer-basis. Every action affecting other
1683 windows than the selected one requires a select_window at some
1684 time, and that increments windows_or_buffers_changed. */
1686 void
1687 set_buffer_internal (b)
1688 register struct buffer *b;
1690 if (current_buffer != b)
1691 set_buffer_internal_1 (b);
1694 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1695 This is used by redisplay. */
1697 void
1698 set_buffer_internal_1 (b)
1699 register struct buffer *b;
1701 register struct buffer *old_buf;
1702 register Lisp_Object tail, valcontents;
1703 Lisp_Object tem;
1705 #ifdef USE_MMAP_FOR_BUFFERS
1706 if (b->text->beg == NULL)
1707 enlarge_buffer_text (b, 0);
1708 #endif /* USE_MMAP_FOR_BUFFERS */
1710 if (current_buffer == b)
1711 return;
1713 old_buf = current_buffer;
1714 current_buffer = b;
1715 last_known_column_point = -1; /* invalidate indentation cache */
1717 if (old_buf)
1719 /* Put the undo list back in the base buffer, so that it appears
1720 that an indirect buffer shares the undo list of its base. */
1721 if (old_buf->base_buffer)
1722 old_buf->base_buffer->undo_list = old_buf->undo_list;
1724 /* If the old current buffer has markers to record PT, BEGV and ZV
1725 when it is not current, update them now. */
1726 if (! NILP (old_buf->pt_marker))
1728 Lisp_Object obuf;
1729 XSETBUFFER (obuf, old_buf);
1730 set_marker_both (old_buf->pt_marker, obuf,
1731 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1733 if (! NILP (old_buf->begv_marker))
1735 Lisp_Object obuf;
1736 XSETBUFFER (obuf, old_buf);
1737 set_marker_both (old_buf->begv_marker, obuf,
1738 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1740 if (! NILP (old_buf->zv_marker))
1742 Lisp_Object obuf;
1743 XSETBUFFER (obuf, old_buf);
1744 set_marker_both (old_buf->zv_marker, obuf,
1745 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1749 /* Get the undo list from the base buffer, so that it appears
1750 that an indirect buffer shares the undo list of its base. */
1751 if (b->base_buffer)
1752 b->undo_list = b->base_buffer->undo_list;
1754 /* If the new current buffer has markers to record PT, BEGV and ZV
1755 when it is not current, fetch them now. */
1756 if (! NILP (b->pt_marker))
1758 BUF_PT (b) = marker_position (b->pt_marker);
1759 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1761 if (! NILP (b->begv_marker))
1763 BUF_BEGV (b) = marker_position (b->begv_marker);
1764 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1766 if (! NILP (b->zv_marker))
1768 BUF_ZV (b) = marker_position (b->zv_marker);
1769 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1772 /* Look down buffer's list of local Lisp variables
1773 to find and update any that forward into C variables. */
1775 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1777 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1778 if ((BUFFER_LOCAL_VALUEP (valcontents)
1779 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1780 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1781 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1782 /* Just reference the variable
1783 to cause it to become set for this buffer. */
1784 Fsymbol_value (XCAR (XCAR (tail)));
1787 /* Do the same with any others that were local to the previous buffer */
1789 if (old_buf)
1790 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1792 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1793 if ((BUFFER_LOCAL_VALUEP (valcontents)
1794 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1795 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1796 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1797 /* Just reference the variable
1798 to cause it to become set for this buffer. */
1799 Fsymbol_value (XCAR (XCAR (tail)));
1803 /* Switch to buffer B temporarily for redisplay purposes.
1804 This avoids certain things that don't need to be done within redisplay. */
1806 void
1807 set_buffer_temp (b)
1808 struct buffer *b;
1810 register struct buffer *old_buf;
1812 if (current_buffer == b)
1813 return;
1815 old_buf = current_buffer;
1816 current_buffer = b;
1818 if (old_buf)
1820 /* If the old current buffer has markers to record PT, BEGV and ZV
1821 when it is not current, update them now. */
1822 if (! NILP (old_buf->pt_marker))
1824 Lisp_Object obuf;
1825 XSETBUFFER (obuf, old_buf);
1826 set_marker_both (old_buf->pt_marker, obuf,
1827 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1829 if (! NILP (old_buf->begv_marker))
1831 Lisp_Object obuf;
1832 XSETBUFFER (obuf, old_buf);
1833 set_marker_both (old_buf->begv_marker, obuf,
1834 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1836 if (! NILP (old_buf->zv_marker))
1838 Lisp_Object obuf;
1839 XSETBUFFER (obuf, old_buf);
1840 set_marker_both (old_buf->zv_marker, obuf,
1841 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1845 /* If the new current buffer has markers to record PT, BEGV and ZV
1846 when it is not current, fetch them now. */
1847 if (! NILP (b->pt_marker))
1849 BUF_PT (b) = marker_position (b->pt_marker);
1850 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1852 if (! NILP (b->begv_marker))
1854 BUF_BEGV (b) = marker_position (b->begv_marker);
1855 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1857 if (! NILP (b->zv_marker))
1859 BUF_ZV (b) = marker_position (b->zv_marker);
1860 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1864 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1865 doc: /* Make the buffer BUFFER current for editing operations.
1866 BUFFER may be a buffer or the name of an existing buffer.
1867 See also `save-excursion' when you want to make a buffer current temporarily.
1868 This function does not display the buffer, so its effect ends
1869 when the current command terminates.
1870 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1871 (buffer)
1872 register Lisp_Object buffer;
1874 register Lisp_Object buf;
1875 buf = Fget_buffer (buffer);
1876 if (NILP (buf))
1877 nsberror (buffer);
1878 if (NILP (XBUFFER (buf)->name))
1879 error ("Selecting deleted buffer");
1880 set_buffer_internal (XBUFFER (buf));
1881 return buf;
1884 /* Set the current buffer to BUFFER provided it is alive. */
1886 Lisp_Object
1887 set_buffer_if_live (buffer)
1888 Lisp_Object buffer;
1890 if (! NILP (XBUFFER (buffer)->name))
1891 Fset_buffer (buffer);
1892 return Qnil;
1895 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1896 Sbarf_if_buffer_read_only, 0, 0, 0,
1897 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1900 if (!NILP (current_buffer->read_only)
1901 && NILP (Vinhibit_read_only))
1902 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1903 return Qnil;
1906 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1907 doc: /* Put BUFFER at the end of the list of all buffers.
1908 There it is the least likely candidate for `other-buffer' to return;
1909 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1910 If BUFFER is nil or omitted, bury the current buffer.
1911 Also, if BUFFER is nil or omitted, remove the current buffer from the
1912 selected window if it is displayed there. */)
1913 (buffer)
1914 register Lisp_Object buffer;
1916 /* Figure out what buffer we're going to bury. */
1917 if (NILP (buffer))
1919 Lisp_Object tem;
1920 XSETBUFFER (buffer, current_buffer);
1922 tem = Fwindow_buffer (selected_window);
1923 /* If we're burying the current buffer, unshow it. */
1924 if (EQ (buffer, tem))
1926 if (NILP (Fwindow_dedicated_p (selected_window)))
1927 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1928 else if (NILP (XWINDOW (selected_window)->parent))
1929 Ficonify_frame (Fwindow_frame (selected_window));
1930 else
1931 Fdelete_window (selected_window);
1934 else
1936 Lisp_Object buf1;
1938 buf1 = Fget_buffer (buffer);
1939 if (NILP (buf1))
1940 nsberror (buffer);
1941 buffer = buf1;
1944 /* Move buffer to the end of the buffer list. Do nothing if the
1945 buffer is killed. */
1946 if (!NILP (XBUFFER (buffer)->name))
1948 Lisp_Object aelt, link;
1950 aelt = Frassq (buffer, Vbuffer_alist);
1951 link = Fmemq (aelt, Vbuffer_alist);
1952 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1953 XSETCDR (link, Qnil);
1954 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1956 /* Removing BUFFER from frame-specific lists
1957 has the effect of putting BUFFER at the end
1958 of the combined list in each frame. */
1959 frames_discard_buffer (buffer);
1962 return Qnil;
1965 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1966 doc: /* Delete the entire contents of the current buffer.
1967 Any narrowing restriction in effect (see `narrow-to-region') is removed,
1968 so the buffer is truly empty after this. */)
1971 Fwiden ();
1973 del_range (BEG, Z);
1975 current_buffer->last_window_start = 1;
1976 /* Prevent warnings, or suspension of auto saving, that would happen
1977 if future size is less than past size. Use of erase-buffer
1978 implies that the future text is not really related to the past text. */
1979 XSETFASTINT (current_buffer->save_length, 0);
1980 return Qnil;
1983 void
1984 validate_region (b, e)
1985 register Lisp_Object *b, *e;
1987 CHECK_NUMBER_COERCE_MARKER (*b);
1988 CHECK_NUMBER_COERCE_MARKER (*e);
1990 if (XINT (*b) > XINT (*e))
1992 Lisp_Object tem;
1993 tem = *b; *b = *e; *e = tem;
1996 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1997 && XINT (*e) <= ZV))
1998 args_out_of_range (*b, *e);
2001 /* Advance BYTE_POS up to a character boundary
2002 and return the adjusted position. */
2004 static int
2005 advance_to_char_boundary (byte_pos)
2006 int byte_pos;
2008 int c;
2010 if (byte_pos == BEG)
2011 /* Beginning of buffer is always a character boundary. */
2012 return BEG;
2014 c = FETCH_BYTE (byte_pos);
2015 if (! CHAR_HEAD_P (c))
2017 /* We should advance BYTE_POS only when C is a constituent of a
2018 multibyte sequence. */
2019 int orig_byte_pos = byte_pos;
2023 byte_pos--;
2024 c = FETCH_BYTE (byte_pos);
2026 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2027 INC_POS (byte_pos);
2028 if (byte_pos < orig_byte_pos)
2029 byte_pos = orig_byte_pos;
2030 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2031 surely advance to the correct character boundary. If C is
2032 not, BYTE_POS was unchanged. */
2035 return byte_pos;
2038 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2039 1, 1, 0,
2040 doc: /* Set the multibyte flag of the current buffer to FLAG.
2041 If FLAG is t, this makes the buffer a multibyte buffer.
2042 If FLAG is nil, this makes the buffer a single-byte buffer.
2043 The buffer contents remain unchanged as a sequence of bytes
2044 but the contents viewed as characters do change. */)
2045 (flag)
2046 Lisp_Object flag;
2048 struct Lisp_Marker *tail, *markers;
2049 struct buffer *other;
2050 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
2051 int begv, zv;
2052 int narrowed = (BEG != BEGV || Z != ZV);
2053 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2055 if (current_buffer->base_buffer)
2056 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2058 /* Do nothing if nothing actually changes. */
2059 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2060 return flag;
2062 /* It would be better to update the list,
2063 but this is good enough for now. */
2064 if (undo_enabled_p)
2065 current_buffer->undo_list = Qt;
2067 /* If the cached position is for this buffer, clear it out. */
2068 clear_charpos_cache (current_buffer);
2070 if (NILP (flag))
2071 begv = BEGV_BYTE, zv = ZV_BYTE;
2072 else
2073 begv = BEGV, zv = ZV;
2075 if (narrowed)
2076 Fwiden ();
2078 if (NILP (flag))
2080 int pos, stop;
2081 unsigned char *p;
2083 /* Do this first, so it can use CHAR_TO_BYTE
2084 to calculate the old correspondences. */
2085 set_intervals_multibyte (0);
2087 current_buffer->enable_multibyte_characters = Qnil;
2089 Z = Z_BYTE;
2090 BEGV = BEGV_BYTE;
2091 ZV = ZV_BYTE;
2092 GPT = GPT_BYTE;
2093 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2096 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2097 tail->charpos = tail->bytepos;
2099 /* Convert multibyte form of 8-bit characters to unibyte. */
2100 pos = BEG;
2101 stop = GPT;
2102 p = BEG_ADDR;
2103 while (1)
2105 int c, bytes;
2107 if (pos == stop)
2109 if (pos == Z)
2110 break;
2111 p = GAP_END_ADDR;
2112 stop = Z;
2114 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2115 p += bytes, pos += bytes;
2116 else
2118 c = STRING_CHAR (p, stop - pos);
2119 /* Delete all bytes for this 8-bit character but the
2120 last one, and change the last one to the charcter
2121 code. */
2122 bytes--;
2123 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2124 p = GAP_END_ADDR;
2125 *p++ = c;
2126 pos++;
2127 if (begv > pos)
2128 begv -= bytes;
2129 if (zv > pos)
2130 zv -= bytes;
2131 stop = Z;
2134 if (narrowed)
2135 Fnarrow_to_region (make_number (begv), make_number (zv));
2137 else
2139 int pt = PT;
2140 int pos, stop;
2141 unsigned char *p;
2143 /* Be sure not to have a multibyte sequence striding over the GAP.
2144 Ex: We change this: "...abc\201 _GAP_ \241def..."
2145 to: "...abc _GAP_ \201\241def..." */
2147 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2148 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2150 unsigned char *p = GPT_ADDR - 1;
2152 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2153 if (BASE_LEADING_CODE_P (*p))
2155 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2157 move_gap_both (new_gpt, new_gpt);
2161 /* Make the buffer contents valid as multibyte by converting
2162 8-bit characters to multibyte form. */
2163 pos = BEG;
2164 stop = GPT;
2165 p = BEG_ADDR;
2166 while (1)
2168 int bytes;
2170 if (pos == stop)
2172 if (pos == Z)
2173 break;
2174 p = GAP_END_ADDR;
2175 stop = Z;
2178 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2179 p += bytes, pos += bytes;
2180 else
2182 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2184 bytes = CHAR_STRING (*p, tmp);
2185 *p = tmp[0];
2186 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2187 bytes--;
2188 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2189 /* Now the gap is after the just inserted data. */
2190 pos = GPT;
2191 p = GAP_END_ADDR;
2192 if (pos <= begv)
2193 begv += bytes;
2194 if (pos <= zv)
2195 zv += bytes;
2196 if (pos <= pt)
2197 pt += bytes;
2198 stop = Z;
2202 if (pt != PT)
2203 TEMP_SET_PT (pt);
2205 if (narrowed)
2206 Fnarrow_to_region (make_number (begv), make_number (zv));
2208 /* Do this first, so that chars_in_text asks the right question.
2209 set_intervals_multibyte needs it too. */
2210 current_buffer->enable_multibyte_characters = Qt;
2212 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2213 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2215 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2217 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2218 if (BEGV_BYTE > GPT_BYTE)
2219 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2220 else
2221 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2223 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2224 if (ZV_BYTE > GPT_BYTE)
2225 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2226 else
2227 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2230 int pt_byte = advance_to_char_boundary (PT_BYTE);
2231 int pt;
2233 if (pt_byte > GPT_BYTE)
2234 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2235 else
2236 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2237 TEMP_SET_PT_BOTH (pt, pt_byte);
2240 tail = markers = BUF_MARKERS (current_buffer);
2242 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2243 getting confused by the markers that have not yet been updated.
2244 It is also a signal that it should never create a marker. */
2245 BUF_MARKERS (current_buffer) = NULL;
2247 for (; tail; tail = tail->next)
2249 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2250 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2253 /* Make sure no markers were put on the chain
2254 while the chain value was incorrect. */
2255 if (BUF_MARKERS (current_buffer))
2256 abort ();
2258 BUF_MARKERS (current_buffer) = markers;
2260 /* Do this last, so it can calculate the new correspondences
2261 between chars and bytes. */
2262 set_intervals_multibyte (1);
2265 if (undo_enabled_p)
2266 current_buffer->undo_list = Qnil;
2268 /* Changing the multibyteness of a buffer means that all windows
2269 showing that buffer must be updated thoroughly. */
2270 current_buffer->prevent_redisplay_optimizations_p = 1;
2271 ++windows_or_buffers_changed;
2273 /* Copy this buffer's new multibyte status
2274 into all of its indirect buffers. */
2275 for (other = all_buffers; other; other = other->next)
2276 if (other->base_buffer == current_buffer && !NILP (other->name))
2278 other->enable_multibyte_characters
2279 = current_buffer->enable_multibyte_characters;
2280 other->prevent_redisplay_optimizations_p = 1;
2283 /* Restore the modifiedness of the buffer. */
2284 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2285 Fset_buffer_modified_p (Qnil);
2287 #ifdef subprocesses
2288 /* Update coding systems of this buffer's process (if any). */
2290 Lisp_Object process;
2292 process = Fget_buffer_process (Fcurrent_buffer ());
2293 if (PROCESSP (process))
2294 setup_process_coding_systems (process);
2296 #endif /* subprocesses */
2298 return flag;
2301 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2302 0, 0, 0,
2303 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2304 Most local variable bindings are eliminated so that the default values
2305 become effective once more. Also, the syntax table is set from
2306 `standard-syntax-table', the local keymap is set to nil,
2307 and the abbrev table from `fundamental-mode-abbrev-table'.
2308 This function also forces redisplay of the mode line.
2310 Every function to select a new major mode starts by
2311 calling this function.
2313 As a special exception, local variables whose names have
2314 a non-nil `permanent-local' property are not eliminated by this function.
2316 The first thing this function does is run
2317 the normal hook `change-major-mode-hook'. */)
2320 register Lisp_Object alist, sym, tem;
2321 Lisp_Object oalist;
2323 if (!NILP (Vrun_hooks))
2324 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2325 oalist = current_buffer->local_var_alist;
2327 /* Make sure none of the bindings in oalist
2328 remain swapped in, in their symbols. */
2330 swap_out_buffer_local_variables (current_buffer);
2332 /* Actually eliminate all local bindings of this buffer. */
2334 reset_buffer_local_variables (current_buffer, 0);
2336 /* Any which are supposed to be permanent,
2337 make local again, with the same values they had. */
2339 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2341 sym = XCAR (XCAR (alist));
2342 tem = Fget (sym, Qpermanent_local);
2343 if (! NILP (tem))
2345 Fmake_local_variable (sym);
2346 Fset (sym, XCDR (XCAR (alist)));
2350 /* Force mode-line redisplay. Useful here because all major mode
2351 commands call this function. */
2352 update_mode_lines++;
2354 return Qnil;
2357 /* Make sure no local variables remain set up with buffer B
2358 for their current values. */
2360 static void
2361 swap_out_buffer_local_variables (b)
2362 struct buffer *b;
2364 Lisp_Object oalist, alist, sym, tem, buffer;
2366 XSETBUFFER (buffer, b);
2367 oalist = b->local_var_alist;
2369 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2371 sym = XCAR (XCAR (alist));
2373 /* Need not do anything if some other buffer's binding is now encached. */
2374 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2375 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2377 /* Symbol is set up for this buffer's old local value.
2378 Set it up for the current buffer with the default value. */
2380 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2381 /* Store the symbol's current value into the alist entry
2382 it is currently set up for. This is so that, if the
2383 local is marked permanent, and we make it local again
2384 later in Fkill_all_local_variables, we don't lose the value. */
2385 XSETCDR (XCAR (tem),
2386 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2387 /* Switch to the symbol's default-value alist entry. */
2388 XSETCAR (tem, tem);
2389 /* Mark it as current for buffer B. */
2390 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2391 /* Store the current value into any forwarding in the symbol. */
2392 store_symval_forwarding (sym,
2393 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2394 XCDR (tem), NULL);
2399 /* Find all the overlays in the current buffer that contain position POS.
2400 Return the number found, and store them in a vector in *VEC_PTR.
2401 Store in *LEN_PTR the size allocated for the vector.
2402 Store in *NEXT_PTR the next position after POS where an overlay starts,
2403 or ZV if there are no more overlays.
2404 Store in *PREV_PTR the previous position before POS where an overlay ends,
2405 or where an overlay starts which ends at or after POS;
2406 or BEGV if there are no such overlays.
2407 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2409 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2410 when this function is called.
2412 If EXTEND is non-zero, we make the vector bigger if necessary.
2413 If EXTEND is zero, we never extend the vector,
2414 and we store only as many overlays as will fit.
2415 But we still return the total number of overlays.
2417 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2418 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2419 default (BEGV or ZV). */
2422 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2423 EMACS_INT pos;
2424 int extend;
2425 Lisp_Object **vec_ptr;
2426 int *len_ptr;
2427 int *next_ptr;
2428 int *prev_ptr;
2429 int change_req;
2431 Lisp_Object tail, overlay, start, end;
2432 int idx = 0;
2433 int len = *len_ptr;
2434 Lisp_Object *vec = *vec_ptr;
2435 int next = ZV;
2436 int prev = BEGV;
2437 int inhibit_storing = 0;
2439 for (tail = current_buffer->overlays_before;
2440 GC_CONSP (tail);
2441 tail = XCDR (tail))
2443 int startpos, endpos;
2445 overlay = XCAR (tail);
2447 start = OVERLAY_START (overlay);
2448 end = OVERLAY_END (overlay);
2449 endpos = OVERLAY_POSITION (end);
2450 if (endpos < pos)
2452 if (prev < endpos)
2453 prev = endpos;
2454 break;
2456 startpos = OVERLAY_POSITION (start);
2457 /* This one ends at or after POS
2458 so its start counts for PREV_PTR if it's before POS. */
2459 if (prev < startpos && startpos < pos)
2460 prev = startpos;
2461 if (endpos == pos)
2462 continue;
2463 if (startpos <= pos)
2465 if (idx == len)
2467 /* The supplied vector is full.
2468 Either make it bigger, or don't store any more in it. */
2469 if (extend)
2471 /* Make it work with an initial len == 0. */
2472 len *= 2;
2473 if (len == 0)
2474 len = 4;
2475 *len_ptr = len;
2476 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2477 *vec_ptr = vec;
2479 else
2480 inhibit_storing = 1;
2483 if (!inhibit_storing)
2484 vec[idx] = overlay;
2485 /* Keep counting overlays even if we can't return them all. */
2486 idx++;
2488 else if (startpos < next)
2489 next = startpos;
2492 for (tail = current_buffer->overlays_after;
2493 GC_CONSP (tail);
2494 tail = XCDR (tail))
2496 int startpos, endpos;
2498 overlay = XCAR (tail);
2500 start = OVERLAY_START (overlay);
2501 end = OVERLAY_END (overlay);
2502 startpos = OVERLAY_POSITION (start);
2503 if (pos < startpos)
2505 if (startpos < next)
2506 next = startpos;
2507 break;
2509 endpos = OVERLAY_POSITION (end);
2510 if (pos < endpos)
2512 if (idx == len)
2514 if (extend)
2516 /* Make it work with an initial len == 0. */
2517 len *= 2;
2518 if (len == 0)
2519 len = 4;
2520 *len_ptr = len;
2521 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2522 *vec_ptr = vec;
2524 else
2525 inhibit_storing = 1;
2528 if (!inhibit_storing)
2529 vec[idx] = overlay;
2530 idx++;
2532 if (startpos < pos && startpos > prev)
2533 prev = startpos;
2535 else if (endpos < pos && endpos > prev)
2536 prev = endpos;
2537 else if (endpos == pos && startpos > prev
2538 && (!change_req || startpos < pos))
2539 prev = startpos;
2542 if (next_ptr)
2543 *next_ptr = next;
2544 if (prev_ptr)
2545 *prev_ptr = prev;
2546 return idx;
2549 /* Find all the overlays in the current buffer that overlap the range BEG-END
2550 or are empty at BEG.
2552 Return the number found, and store them in a vector in *VEC_PTR.
2553 Store in *LEN_PTR the size allocated for the vector.
2554 Store in *NEXT_PTR the next position after POS where an overlay starts,
2555 or ZV if there are no more overlays.
2556 Store in *PREV_PTR the previous position before POS where an overlay ends,
2557 or BEGV if there are no previous overlays.
2558 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2560 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2561 when this function is called.
2563 If EXTEND is non-zero, we make the vector bigger if necessary.
2564 If EXTEND is zero, we never extend the vector,
2565 and we store only as many overlays as will fit.
2566 But we still return the total number of overlays. */
2568 static int
2569 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2570 int beg, end;
2571 int extend;
2572 Lisp_Object **vec_ptr;
2573 int *len_ptr;
2574 int *next_ptr;
2575 int *prev_ptr;
2577 Lisp_Object tail, overlay, ostart, oend;
2578 int idx = 0;
2579 int len = *len_ptr;
2580 Lisp_Object *vec = *vec_ptr;
2581 int next = ZV;
2582 int prev = BEGV;
2583 int inhibit_storing = 0;
2585 for (tail = current_buffer->overlays_before;
2586 GC_CONSP (tail);
2587 tail = XCDR (tail))
2589 int startpos, endpos;
2591 overlay = XCAR (tail);
2593 ostart = OVERLAY_START (overlay);
2594 oend = OVERLAY_END (overlay);
2595 endpos = OVERLAY_POSITION (oend);
2596 if (endpos < beg)
2598 if (prev < endpos)
2599 prev = endpos;
2600 break;
2602 startpos = OVERLAY_POSITION (ostart);
2603 /* Count an interval if it either overlaps the range
2604 or is empty at the start of the range. */
2605 if ((beg < endpos && startpos < end)
2606 || (startpos == endpos && beg == endpos))
2608 if (idx == len)
2610 /* The supplied vector is full.
2611 Either make it bigger, or don't store any more in it. */
2612 if (extend)
2614 /* Make it work with an initial len == 0. */
2615 len *= 2;
2616 if (len == 0)
2617 len = 4;
2618 *len_ptr = len;
2619 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2620 *vec_ptr = vec;
2622 else
2623 inhibit_storing = 1;
2626 if (!inhibit_storing)
2627 vec[idx] = overlay;
2628 /* Keep counting overlays even if we can't return them all. */
2629 idx++;
2631 else if (startpos < next)
2632 next = startpos;
2635 for (tail = current_buffer->overlays_after;
2636 GC_CONSP (tail);
2637 tail = XCDR (tail))
2639 int startpos, endpos;
2641 overlay = XCAR (tail);
2643 ostart = OVERLAY_START (overlay);
2644 oend = OVERLAY_END (overlay);
2645 startpos = OVERLAY_POSITION (ostart);
2646 if (end < startpos)
2648 if (startpos < next)
2649 next = startpos;
2650 break;
2652 endpos = OVERLAY_POSITION (oend);
2653 /* Count an interval if it either overlaps the range
2654 or is empty at the start of the range. */
2655 if ((beg < endpos && startpos < end)
2656 || (startpos == endpos && beg == endpos))
2658 if (idx == len)
2660 if (extend)
2662 /* Make it work with an initial len == 0. */
2663 len *= 2;
2664 if (len == 0)
2665 len = 4;
2666 *len_ptr = len;
2667 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2668 *vec_ptr = vec;
2670 else
2671 inhibit_storing = 1;
2674 if (!inhibit_storing)
2675 vec[idx] = overlay;
2676 idx++;
2678 else if (endpos < beg && endpos > prev)
2679 prev = endpos;
2682 if (next_ptr)
2683 *next_ptr = next;
2684 if (prev_ptr)
2685 *prev_ptr = prev;
2686 return idx;
2690 /* Return non-zero if there exists an overlay with a non-nil
2691 `mouse-face' property overlapping OVERLAY. */
2694 mouse_face_overlay_overlaps (overlay)
2695 Lisp_Object overlay;
2697 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2698 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2699 int n, i, size;
2700 Lisp_Object *v, tem;
2702 size = 10;
2703 v = (Lisp_Object *) alloca (size * sizeof *v);
2704 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2705 if (n > size)
2707 v = (Lisp_Object *) alloca (n * sizeof *v);
2708 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2711 for (i = 0; i < n; ++i)
2712 if (!EQ (v[i], overlay)
2713 && (tem = Foverlay_get (overlay, Qmouse_face),
2714 !NILP (tem)))
2715 break;
2717 return i < n;
2722 /* Fast function to just test if we're at an overlay boundary. */
2724 overlay_touches_p (pos)
2725 int pos;
2727 Lisp_Object tail, overlay;
2729 for (tail = current_buffer->overlays_before; GC_CONSP (tail);
2730 tail = XCDR (tail))
2732 int endpos;
2734 overlay = XCAR (tail);
2735 if (!GC_OVERLAYP (overlay))
2736 abort ();
2738 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2739 if (endpos < pos)
2740 break;
2741 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2742 return 1;
2745 for (tail = current_buffer->overlays_after; GC_CONSP (tail);
2746 tail = XCDR (tail))
2748 int startpos;
2750 overlay = XCAR (tail);
2751 if (!GC_OVERLAYP (overlay))
2752 abort ();
2754 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2755 if (pos < startpos)
2756 break;
2757 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2758 return 1;
2760 return 0;
2763 struct sortvec
2765 Lisp_Object overlay;
2766 int beg, end;
2767 int priority;
2770 static int
2771 compare_overlays (v1, v2)
2772 const void *v1, *v2;
2774 const struct sortvec *s1 = (const struct sortvec *) v1;
2775 const struct sortvec *s2 = (const struct sortvec *) v2;
2776 if (s1->priority != s2->priority)
2777 return s1->priority - s2->priority;
2778 if (s1->beg != s2->beg)
2779 return s1->beg - s2->beg;
2780 if (s1->end != s2->end)
2781 return s2->end - s1->end;
2782 return 0;
2785 /* Sort an array of overlays by priority. The array is modified in place.
2786 The return value is the new size; this may be smaller than the original
2787 size if some of the overlays were invalid or were window-specific. */
2789 sort_overlays (overlay_vec, noverlays, w)
2790 Lisp_Object *overlay_vec;
2791 int noverlays;
2792 struct window *w;
2794 int i, j;
2795 struct sortvec *sortvec;
2796 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2798 /* Put the valid and relevant overlays into sortvec. */
2800 for (i = 0, j = 0; i < noverlays; i++)
2802 Lisp_Object tem;
2803 Lisp_Object overlay;
2805 overlay = overlay_vec[i];
2806 if (OVERLAY_VALID (overlay)
2807 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2808 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2810 /* If we're interested in a specific window, then ignore
2811 overlays that are limited to some other window. */
2812 if (w)
2814 Lisp_Object window;
2816 window = Foverlay_get (overlay, Qwindow);
2817 if (WINDOWP (window) && XWINDOW (window) != w)
2818 continue;
2821 /* This overlay is good and counts: put it into sortvec. */
2822 sortvec[j].overlay = overlay;
2823 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2824 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2825 tem = Foverlay_get (overlay, Qpriority);
2826 if (INTEGERP (tem))
2827 sortvec[j].priority = XINT (tem);
2828 else
2829 sortvec[j].priority = 0;
2830 j++;
2833 noverlays = j;
2835 /* Sort the overlays into the proper order: increasing priority. */
2837 if (noverlays > 1)
2838 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2840 for (i = 0; i < noverlays; i++)
2841 overlay_vec[i] = sortvec[i].overlay;
2842 return (noverlays);
2845 struct sortstr
2847 Lisp_Object string, string2;
2848 int size;
2849 int priority;
2852 struct sortstrlist
2854 struct sortstr *buf; /* An array that expands as needed; never freed. */
2855 int size; /* Allocated length of that array. */
2856 int used; /* How much of the array is currently in use. */
2857 int bytes; /* Total length of the strings in buf. */
2860 /* Buffers for storing information about the overlays touching a given
2861 position. These could be automatic variables in overlay_strings, but
2862 it's more efficient to hold onto the memory instead of repeatedly
2863 allocating and freeing it. */
2864 static struct sortstrlist overlay_heads, overlay_tails;
2865 static unsigned char *overlay_str_buf;
2867 /* Allocated length of overlay_str_buf. */
2868 static int overlay_str_len;
2870 /* A comparison function suitable for passing to qsort. */
2871 static int
2872 cmp_for_strings (as1, as2)
2873 char *as1, *as2;
2875 struct sortstr *s1 = (struct sortstr *)as1;
2876 struct sortstr *s2 = (struct sortstr *)as2;
2877 if (s1->size != s2->size)
2878 return s2->size - s1->size;
2879 if (s1->priority != s2->priority)
2880 return s1->priority - s2->priority;
2881 return 0;
2884 static void
2885 record_overlay_string (ssl, str, str2, pri, size)
2886 struct sortstrlist *ssl;
2887 Lisp_Object str, str2, pri;
2888 int size;
2890 int nbytes;
2892 if (ssl->used == ssl->size)
2894 if (ssl->buf)
2895 ssl->size *= 2;
2896 else
2897 ssl->size = 5;
2898 ssl->buf = ((struct sortstr *)
2899 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2901 ssl->buf[ssl->used].string = str;
2902 ssl->buf[ssl->used].string2 = str2;
2903 ssl->buf[ssl->used].size = size;
2904 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2905 ssl->used++;
2907 if (NILP (current_buffer->enable_multibyte_characters))
2908 nbytes = SCHARS (str);
2909 else if (! STRING_MULTIBYTE (str))
2910 nbytes = count_size_as_multibyte (SDATA (str),
2911 SBYTES (str));
2912 else
2913 nbytes = SBYTES (str);
2915 ssl->bytes += nbytes;
2917 if (STRINGP (str2))
2919 if (NILP (current_buffer->enable_multibyte_characters))
2920 nbytes = SCHARS (str2);
2921 else if (! STRING_MULTIBYTE (str2))
2922 nbytes = count_size_as_multibyte (SDATA (str2),
2923 SBYTES (str2));
2924 else
2925 nbytes = SBYTES (str2);
2927 ssl->bytes += nbytes;
2931 /* Return the concatenation of the strings associated with overlays that
2932 begin or end at POS, ignoring overlays that are specific to a window
2933 other than W. The strings are concatenated in the appropriate order:
2934 shorter overlays nest inside longer ones, and higher priority inside
2935 lower. Normally all of the after-strings come first, but zero-sized
2936 overlays have their after-strings ride along with the before-strings
2937 because it would look strange to print them inside-out.
2939 Returns the string length, and stores the contents indirectly through
2940 PSTR, if that variable is non-null. The string may be overwritten by
2941 subsequent calls. */
2944 overlay_strings (pos, w, pstr)
2945 EMACS_INT pos;
2946 struct window *w;
2947 unsigned char **pstr;
2949 Lisp_Object ov, overlay, window, str;
2950 int startpos, endpos;
2951 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
2953 overlay_heads.used = overlay_heads.bytes = 0;
2954 overlay_tails.used = overlay_tails.bytes = 0;
2955 for (ov = current_buffer->overlays_before; CONSP (ov); ov = XCDR (ov))
2957 overlay = XCAR (ov);
2958 eassert (OVERLAYP (overlay));
2960 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2961 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2962 if (endpos < pos)
2963 break;
2964 if (endpos != pos && startpos != pos)
2965 continue;
2966 window = Foverlay_get (overlay, Qwindow);
2967 if (WINDOWP (window) && XWINDOW (window) != w)
2968 continue;
2969 if (startpos == pos
2970 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2971 record_overlay_string (&overlay_heads, str,
2972 (startpos == endpos
2973 ? Foverlay_get (overlay, Qafter_string)
2974 : Qnil),
2975 Foverlay_get (overlay, Qpriority),
2976 endpos - startpos);
2977 else if (endpos == pos
2978 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
2979 record_overlay_string (&overlay_tails, str, Qnil,
2980 Foverlay_get (overlay, Qpriority),
2981 endpos - startpos);
2983 for (ov = current_buffer->overlays_after; CONSP (ov); ov = XCDR (ov))
2985 overlay = XCAR (ov);
2986 eassert (!OVERLAYP (overlay));
2988 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2989 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2990 if (startpos > pos)
2991 break;
2992 if (endpos != pos && startpos != pos)
2993 continue;
2994 window = Foverlay_get (overlay, Qwindow);
2995 if (WINDOWP (window) && XWINDOW (window) != w)
2996 continue;
2997 if (startpos == pos
2998 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
2999 record_overlay_string (&overlay_heads, str,
3000 (startpos == endpos
3001 ? Foverlay_get (overlay, Qafter_string)
3002 : Qnil),
3003 Foverlay_get (overlay, Qpriority),
3004 endpos - startpos);
3005 else if (endpos == pos
3006 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3007 record_overlay_string (&overlay_tails, str, Qnil,
3008 Foverlay_get (overlay, Qpriority),
3009 endpos - startpos);
3011 if (overlay_tails.used > 1)
3012 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3013 cmp_for_strings);
3014 if (overlay_heads.used > 1)
3015 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3016 cmp_for_strings);
3017 if (overlay_heads.bytes || overlay_tails.bytes)
3019 Lisp_Object tem;
3020 int i;
3021 unsigned char *p;
3022 int total = overlay_heads.bytes + overlay_tails.bytes;
3024 if (total > overlay_str_len)
3026 overlay_str_len = total;
3027 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3028 total);
3030 p = overlay_str_buf;
3031 for (i = overlay_tails.used; --i >= 0;)
3033 int nbytes;
3034 tem = overlay_tails.buf[i].string;
3035 nbytes = copy_text (SDATA (tem), p,
3036 SBYTES (tem),
3037 STRING_MULTIBYTE (tem), multibyte);
3038 p += nbytes;
3040 for (i = 0; i < overlay_heads.used; ++i)
3042 int nbytes;
3043 tem = overlay_heads.buf[i].string;
3044 nbytes = copy_text (SDATA (tem), p,
3045 SBYTES (tem),
3046 STRING_MULTIBYTE (tem), multibyte);
3047 p += nbytes;
3048 tem = overlay_heads.buf[i].string2;
3049 if (STRINGP (tem))
3051 nbytes = copy_text (SDATA (tem), p,
3052 SBYTES (tem),
3053 STRING_MULTIBYTE (tem), multibyte);
3054 p += nbytes;
3057 if (p != overlay_str_buf + total)
3058 abort ();
3059 if (pstr)
3060 *pstr = overlay_str_buf;
3061 return total;
3063 return 0;
3066 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3068 void
3069 recenter_overlay_lists (buf, pos)
3070 struct buffer *buf;
3071 EMACS_INT pos;
3073 Lisp_Object overlay, tail, next, prev, beg, end;
3075 /* See if anything in overlays_before should move to overlays_after. */
3077 /* We don't strictly need prev in this loop; it should always be nil.
3078 But we use it for symmetry and in case that should cease to be true
3079 with some future change. */
3080 prev = Qnil;
3081 for (tail = buf->overlays_before;
3082 CONSP (tail);
3083 prev = tail, tail = next)
3085 next = XCDR (tail);
3086 overlay = XCAR (tail);
3088 /* If the overlay is not valid, get rid of it. */
3089 if (!OVERLAY_VALID (overlay))
3090 #if 1
3091 abort ();
3092 #else
3094 /* Splice the cons cell TAIL out of overlays_before. */
3095 if (!NILP (prev))
3096 XCDR (prev) = next;
3097 else
3098 buf->overlays_before = next;
3099 tail = prev;
3100 continue;
3102 #endif
3104 beg = OVERLAY_START (overlay);
3105 end = OVERLAY_END (overlay);
3107 if (OVERLAY_POSITION (end) > pos)
3109 /* OVERLAY needs to be moved. */
3110 int where = OVERLAY_POSITION (beg);
3111 Lisp_Object other, other_prev;
3113 /* Splice the cons cell TAIL out of overlays_before. */
3114 if (!NILP (prev))
3115 XSETCDR (prev, next);
3116 else
3117 buf->overlays_before = next;
3119 /* Search thru overlays_after for where to put it. */
3120 other_prev = Qnil;
3121 for (other = buf->overlays_after;
3122 CONSP (other);
3123 other_prev = other, other = XCDR (other))
3125 Lisp_Object otherbeg, otheroverlay;
3127 otheroverlay = XCAR (other);
3128 eassert (! OVERLAY_VALID (otheroverlay));
3130 otherbeg = OVERLAY_START (otheroverlay);
3131 if (OVERLAY_POSITION (otherbeg) >= where)
3132 break;
3135 /* Add TAIL to overlays_after before OTHER. */
3136 XSETCDR (tail, other);
3137 if (!NILP (other_prev))
3138 XSETCDR (other_prev, tail);
3139 else
3140 buf->overlays_after = tail;
3141 tail = prev;
3143 else
3144 /* We've reached the things that should stay in overlays_before.
3145 All the rest of overlays_before must end even earlier,
3146 so stop now. */
3147 break;
3150 /* See if anything in overlays_after should be in overlays_before. */
3151 prev = Qnil;
3152 for (tail = buf->overlays_after;
3153 CONSP (tail);
3154 prev = tail, tail = next)
3156 next = XCDR (tail);
3157 overlay = XCAR (tail);
3159 /* If the overlay is not valid, get rid of it. */
3160 if (!OVERLAY_VALID (overlay))
3161 #if 1
3162 abort ();
3163 #else
3165 /* Splice the cons cell TAIL out of overlays_after. */
3166 if (!NILP (prev))
3167 XCDR (prev) = next;
3168 else
3169 buf->overlays_after = next;
3170 tail = prev;
3171 continue;
3173 #endif
3175 beg = OVERLAY_START (overlay);
3176 end = OVERLAY_END (overlay);
3178 /* Stop looking, when we know that nothing further
3179 can possibly end before POS. */
3180 if (OVERLAY_POSITION (beg) > pos)
3181 break;
3183 if (OVERLAY_POSITION (end) <= pos)
3185 /* OVERLAY needs to be moved. */
3186 int where = OVERLAY_POSITION (end);
3187 Lisp_Object other, other_prev;
3189 /* Splice the cons cell TAIL out of overlays_after. */
3190 if (!NILP (prev))
3191 XSETCDR (prev, next);
3192 else
3193 buf->overlays_after = next;
3195 /* Search thru overlays_before for where to put it. */
3196 other_prev = Qnil;
3197 for (other = buf->overlays_before;
3198 CONSP (other);
3199 other_prev = other, other = XCDR (other))
3201 Lisp_Object otherend, otheroverlay;
3203 otheroverlay = XCAR (other);
3204 eassert (! OVERLAY_VALID (otheroverlay));
3206 otherend = OVERLAY_END (otheroverlay);
3207 if (OVERLAY_POSITION (otherend) <= where)
3208 break;
3211 /* Add TAIL to overlays_before before OTHER. */
3212 XSETCDR (tail, other);
3213 if (!NILP (other_prev))
3214 XSETCDR (other_prev, tail);
3215 else
3216 buf->overlays_before = tail;
3217 tail = prev;
3221 buf->overlay_center = pos;
3224 void
3225 adjust_overlays_for_insert (pos, length)
3226 EMACS_INT pos;
3227 EMACS_INT length;
3229 /* After an insertion, the lists are still sorted properly,
3230 but we may need to update the value of the overlay center. */
3231 if (current_buffer->overlay_center >= pos)
3232 current_buffer->overlay_center += length;
3235 void
3236 adjust_overlays_for_delete (pos, length)
3237 EMACS_INT pos;
3238 EMACS_INT length;
3240 if (current_buffer->overlay_center < pos)
3241 /* The deletion was to our right. No change needed; the before- and
3242 after-lists are still consistent. */
3244 else if (current_buffer->overlay_center > pos + length)
3245 /* The deletion was to our left. We need to adjust the center value
3246 to account for the change in position, but the lists are consistent
3247 given the new value. */
3248 current_buffer->overlay_center -= length;
3249 else
3250 /* We're right in the middle. There might be things on the after-list
3251 that now belong on the before-list. Recentering will move them,
3252 and also update the center point. */
3253 recenter_overlay_lists (current_buffer, pos);
3256 /* Fix up overlays that were garbled as a result of permuting markers
3257 in the range START through END. Any overlay with at least one
3258 endpoint in this range will need to be unlinked from the overlay
3259 list and reinserted in its proper place.
3260 Such an overlay might even have negative size at this point.
3261 If so, we'll reverse the endpoints. Can you think of anything
3262 better to do in this situation? */
3263 void
3264 fix_overlays_in_range (start, end)
3265 register int start, end;
3267 Lisp_Object overlay;
3268 Lisp_Object before_list, after_list;
3269 /* These are either nil, indicating that before_list or after_list
3270 should be assigned, or the cons cell the cdr of which should be
3271 assigned. */
3272 Lisp_Object beforep = Qnil, afterp = Qnil;
3273 /* 'Parent', likewise, indicates a cons cell or
3274 current_buffer->overlays_before or overlays_after, depending
3275 which loop we're in. */
3276 Lisp_Object tail, parent;
3277 int startpos, endpos;
3279 /* This algorithm shifts links around instead of consing and GCing.
3280 The loop invariant is that before_list (resp. after_list) is a
3281 well-formed list except that its last element, the CDR of beforep
3282 (resp. afterp) if beforep (afterp) isn't nil or before_list
3283 (after_list) if it is, is still uninitialized. So it's not a bug
3284 that before_list isn't initialized, although it may look
3285 strange. */
3286 for (parent = Qnil, tail = current_buffer->overlays_before; CONSP (tail);)
3288 overlay = XCAR (tail);
3289 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3290 if (endpos < start)
3291 break;
3292 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3293 if (endpos < end
3294 || (startpos >= start && startpos < end))
3296 /* If the overlay is backwards, fix that now. */
3297 if (startpos > endpos)
3299 int tem;
3300 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3301 Qnil);
3302 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3303 Qnil);
3304 tem = startpos; startpos = endpos; endpos = tem;
3306 /* Add it to the end of the wrong list. Later on,
3307 recenter_overlay_lists will move it to the right place. */
3308 if (endpos < current_buffer->overlay_center)
3310 if (NILP (afterp))
3311 after_list = tail;
3312 else
3313 XSETCDR (afterp, tail);
3314 afterp = tail;
3316 else
3318 if (NILP (beforep))
3319 before_list = tail;
3320 else
3321 XSETCDR (beforep, tail);
3322 beforep = tail;
3324 if (NILP (parent))
3325 current_buffer->overlays_before = XCDR (tail);
3326 else
3327 XSETCDR (parent, XCDR (tail));
3328 tail = XCDR (tail);
3330 else
3331 parent = tail, tail = XCDR (parent);
3333 for (parent = Qnil, tail = current_buffer->overlays_after; CONSP (tail);)
3335 overlay = XCAR (tail);
3336 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3337 if (startpos >= end)
3338 break;
3339 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3340 if (startpos >= start
3341 || (endpos >= start && endpos < end))
3343 if (startpos > endpos)
3345 int tem;
3346 Fset_marker (OVERLAY_START (overlay), make_number (endpos),
3347 Qnil);
3348 Fset_marker (OVERLAY_END (overlay), make_number (startpos),
3349 Qnil);
3350 tem = startpos; startpos = endpos; endpos = tem;
3352 if (endpos < current_buffer->overlay_center)
3354 if (NILP (afterp))
3355 after_list = tail;
3356 else
3357 XSETCDR (afterp, tail);
3358 afterp = tail;
3360 else
3362 if (NILP (beforep))
3363 before_list = tail;
3364 else
3365 XSETCDR (beforep, tail);
3366 beforep = tail;
3368 if (NILP (parent))
3369 current_buffer->overlays_after = XCDR (tail);
3370 else
3371 XSETCDR (parent, XCDR (tail));
3372 tail = XCDR (tail);
3374 else
3375 parent = tail, tail = XCDR (parent);
3378 /* Splice the constructed (wrong) lists into the buffer's lists,
3379 and let the recenter function make it sane again. */
3380 if (!NILP (beforep))
3382 XSETCDR (beforep, current_buffer->overlays_before);
3383 current_buffer->overlays_before = before_list;
3385 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3387 if (!NILP (afterp))
3389 XSETCDR (afterp, current_buffer->overlays_after);
3390 current_buffer->overlays_after = after_list;
3392 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3395 /* We have two types of overlay: the one whose ending marker is
3396 after-insertion-marker (this is the usual case) and the one whose
3397 ending marker is before-insertion-marker. When `overlays_before'
3398 contains overlays of the latter type and the former type in this
3399 order and both overlays end at inserting position, inserting a text
3400 increases only the ending marker of the latter type, which results
3401 in incorrect ordering of `overlays_before'.
3403 This function fixes ordering of overlays in the slot
3404 `overlays_before' of the buffer *BP. Before the insertion, `point'
3405 was at PREV, and now is at POS. */
3407 void
3408 fix_overlays_before (bp, prev, pos)
3409 struct buffer *bp;
3410 EMACS_INT prev, pos;
3412 /* If parent is nil, replace overlays_before; otherwise, XCDR(parent). */
3413 Lisp_Object tail = bp->overlays_before, parent = Qnil;
3414 Lisp_Object right_pair;
3415 EMACS_INT end;
3417 /* After the insertion, the several overlays may be in incorrect
3418 order. The possibility is that, in the list `overlays_before',
3419 an overlay which ends at POS appears after an overlay which ends
3420 at PREV. Since POS is greater than PREV, we must fix the
3421 ordering of these overlays, by moving overlays ends at POS before
3422 the overlays ends at PREV. */
3424 /* At first, find a place where disordered overlays should be linked
3425 in. It is where an overlay which end before POS exists. (i.e. an
3426 overlay whose ending marker is after-insertion-marker if disorder
3427 exists). */
3428 while (!NILP (tail)
3429 && ((end = OVERLAY_POSITION (OVERLAY_END (XCAR (tail))))
3430 >= pos))
3432 parent = tail;
3433 tail = XCDR (tail);
3436 /* If we don't find such an overlay,
3437 or the found one ends before PREV,
3438 or the found one is the last one in the list,
3439 we don't have to fix anything. */
3440 if (NILP (tail)
3441 || end < prev
3442 || NILP (XCDR (tail)))
3443 return;
3445 right_pair = parent;
3446 parent = tail;
3447 tail = XCDR (tail);
3449 /* Now, end position of overlays in the list TAIL should be before
3450 or equal to PREV. In the loop, an overlay which ends at POS is
3451 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3452 we found an overlay which ends before PREV, the remaining
3453 overlays are in correct order. */
3454 while (!NILP (tail))
3456 end = OVERLAY_POSITION (OVERLAY_END (XCAR (tail)));
3458 if (end == pos)
3459 { /* This overlay is disordered. */
3460 Lisp_Object found = tail;
3462 /* Unlink the found overlay. */
3463 tail = XCDR (found);
3464 XSETCDR (parent, tail);
3465 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3466 and link it into the right place. */
3467 if (NILP (right_pair))
3469 XSETCDR (found, bp->overlays_before);
3470 bp->overlays_before = found;
3472 else
3474 XSETCDR (found, XCDR (right_pair));
3475 XSETCDR (right_pair, found);
3478 else if (end == prev)
3480 parent = tail;
3481 tail = XCDR (tail);
3483 else /* No more disordered overlay. */
3484 break;
3488 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3489 doc: /* Return t if OBJECT is an overlay. */)
3490 (object)
3491 Lisp_Object object;
3493 return (OVERLAYP (object) ? Qt : Qnil);
3496 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3497 doc: /* Create a new overlay with range BEG to END in BUFFER.
3498 If omitted, BUFFER defaults to the current buffer.
3499 BEG and END may be integers or markers.
3500 The fourth arg FRONT-ADVANCE, if non-nil, makes the
3501 front delimiter advance when text is inserted there.
3502 The fifth arg REAR-ADVANCE, if non-nil, makes the
3503 rear delimiter advance when text is inserted there. */)
3504 (beg, end, buffer, front_advance, rear_advance)
3505 Lisp_Object beg, end, buffer;
3506 Lisp_Object front_advance, rear_advance;
3508 Lisp_Object overlay;
3509 struct buffer *b;
3511 if (NILP (buffer))
3512 XSETBUFFER (buffer, current_buffer);
3513 else
3514 CHECK_BUFFER (buffer);
3515 if (MARKERP (beg)
3516 && ! EQ (Fmarker_buffer (beg), buffer))
3517 error ("Marker points into wrong buffer");
3518 if (MARKERP (end)
3519 && ! EQ (Fmarker_buffer (end), buffer))
3520 error ("Marker points into wrong buffer");
3522 CHECK_NUMBER_COERCE_MARKER (beg);
3523 CHECK_NUMBER_COERCE_MARKER (end);
3525 if (XINT (beg) > XINT (end))
3527 Lisp_Object temp;
3528 temp = beg; beg = end; end = temp;
3531 b = XBUFFER (buffer);
3533 beg = Fset_marker (Fmake_marker (), beg, buffer);
3534 end = Fset_marker (Fmake_marker (), end, buffer);
3536 if (!NILP (front_advance))
3537 XMARKER (beg)->insertion_type = 1;
3538 if (!NILP (rear_advance))
3539 XMARKER (end)->insertion_type = 1;
3541 overlay = allocate_misc ();
3542 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3543 XOVERLAY (overlay)->start = beg;
3544 XOVERLAY (overlay)->end = end;
3545 XOVERLAY (overlay)->plist = Qnil;
3547 /* Put the new overlay on the wrong list. */
3548 end = OVERLAY_END (overlay);
3549 if (OVERLAY_POSITION (end) < b->overlay_center)
3550 b->overlays_after = Fcons (overlay, b->overlays_after);
3551 else
3552 b->overlays_before = Fcons (overlay, b->overlays_before);
3554 /* This puts it in the right list, and in the right order. */
3555 recenter_overlay_lists (b, b->overlay_center);
3557 /* We don't need to redisplay the region covered by the overlay, because
3558 the overlay has no properties at the moment. */
3560 return overlay;
3563 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3565 static void
3566 modify_overlay (buf, start, end)
3567 struct buffer *buf;
3568 EMACS_INT start, end;
3570 if (start > end)
3572 int temp = start;
3573 start = end;
3574 end = temp;
3577 BUF_COMPUTE_UNCHANGED (buf, start, end);
3579 /* If this is a buffer not in the selected window,
3580 we must do other windows. */
3581 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3582 windows_or_buffers_changed = 1;
3583 /* If multiple windows show this buffer, we must do other windows. */
3584 else if (buffer_shared > 1)
3585 windows_or_buffers_changed = 1;
3587 ++BUF_OVERLAY_MODIFF (buf);
3591 Lisp_Object Fdelete_overlay ();
3593 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3594 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3595 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3596 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3597 buffer. */)
3598 (overlay, beg, end, buffer)
3599 Lisp_Object overlay, beg, end, buffer;
3601 struct buffer *b, *ob;
3602 Lisp_Object obuffer;
3603 int count = SPECPDL_INDEX ();
3605 CHECK_OVERLAY (overlay);
3606 if (NILP (buffer))
3607 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3608 if (NILP (buffer))
3609 XSETBUFFER (buffer, current_buffer);
3610 CHECK_BUFFER (buffer);
3612 if (MARKERP (beg)
3613 && ! EQ (Fmarker_buffer (beg), buffer))
3614 error ("Marker points into wrong buffer");
3615 if (MARKERP (end)
3616 && ! EQ (Fmarker_buffer (end), buffer))
3617 error ("Marker points into wrong buffer");
3619 CHECK_NUMBER_COERCE_MARKER (beg);
3620 CHECK_NUMBER_COERCE_MARKER (end);
3622 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3623 return Fdelete_overlay (overlay);
3625 if (XINT (beg) > XINT (end))
3627 Lisp_Object temp;
3628 temp = beg; beg = end; end = temp;
3631 specbind (Qinhibit_quit, Qt);
3633 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3634 b = XBUFFER (buffer);
3635 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3637 /* If the overlay has changed buffers, do a thorough redisplay. */
3638 if (!EQ (buffer, obuffer))
3640 /* Redisplay where the overlay was. */
3641 if (!NILP (obuffer))
3643 int o_beg;
3644 int o_end;
3646 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3647 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3649 modify_overlay (ob, o_beg, o_end);
3652 /* Redisplay where the overlay is going to be. */
3653 modify_overlay (b, XINT (beg), XINT (end));
3655 else
3656 /* Redisplay the area the overlay has just left, or just enclosed. */
3658 int o_beg, o_end;
3660 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3661 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3663 if (o_beg == XINT (beg))
3664 modify_overlay (b, o_end, XINT (end));
3665 else if (o_end == XINT (end))
3666 modify_overlay (b, o_beg, XINT (beg));
3667 else
3669 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3670 if (XINT (end) > o_end) o_end = XINT (end);
3671 modify_overlay (b, o_beg, o_end);
3675 if (!NILP (obuffer))
3677 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
3678 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
3681 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3682 Fset_marker (OVERLAY_END (overlay), end, buffer);
3684 /* Put the overlay on the wrong list. */
3685 end = OVERLAY_END (overlay);
3686 if (OVERLAY_POSITION (end) < b->overlay_center)
3687 b->overlays_after = Fcons (overlay, b->overlays_after);
3688 else
3689 b->overlays_before = Fcons (overlay, b->overlays_before);
3691 /* This puts it in the right list, and in the right order. */
3692 recenter_overlay_lists (b, b->overlay_center);
3694 return unbind_to (count, overlay);
3697 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3698 doc: /* Delete the overlay OVERLAY from its buffer. */)
3699 (overlay)
3700 Lisp_Object overlay;
3702 Lisp_Object buffer;
3703 struct buffer *b;
3704 int count = SPECPDL_INDEX ();
3706 CHECK_OVERLAY (overlay);
3708 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3709 if (NILP (buffer))
3710 return Qnil;
3712 b = XBUFFER (buffer);
3713 specbind (Qinhibit_quit, Qt);
3715 b->overlays_before = Fdelq (overlay, b->overlays_before);
3716 b->overlays_after = Fdelq (overlay, b->overlays_after);
3717 modify_overlay (b,
3718 marker_position (OVERLAY_START (overlay)),
3719 marker_position (OVERLAY_END (overlay)));
3720 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3721 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3723 /* When deleting an overlay with before or after strings, turn off
3724 display optimizations for the affected buffer, on the basis that
3725 these strings may contain newlines. This is easier to do than to
3726 check for that situation during redisplay. */
3727 if (!windows_or_buffers_changed
3728 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3729 || !NILP (Foverlay_get (overlay, Qafter_string))))
3730 b->prevent_redisplay_optimizations_p = 1;
3732 return unbind_to (count, Qnil);
3735 /* Overlay dissection functions. */
3737 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3738 doc: /* Return the position at which OVERLAY starts. */)
3739 (overlay)
3740 Lisp_Object overlay;
3742 CHECK_OVERLAY (overlay);
3744 return (Fmarker_position (OVERLAY_START (overlay)));
3747 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3748 doc: /* Return the position at which OVERLAY ends. */)
3749 (overlay)
3750 Lisp_Object overlay;
3752 CHECK_OVERLAY (overlay);
3754 return (Fmarker_position (OVERLAY_END (overlay)));
3757 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3758 doc: /* Return the buffer OVERLAY belongs to. */)
3759 (overlay)
3760 Lisp_Object overlay;
3762 CHECK_OVERLAY (overlay);
3764 return Fmarker_buffer (OVERLAY_START (overlay));
3767 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3768 doc: /* Return a list of the properties on OVERLAY.
3769 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3770 OVERLAY. */)
3771 (overlay)
3772 Lisp_Object overlay;
3774 CHECK_OVERLAY (overlay);
3776 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3780 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3781 doc: /* Return a list of the overlays that contain position POS. */)
3782 (pos)
3783 Lisp_Object pos;
3785 int noverlays;
3786 Lisp_Object *overlay_vec;
3787 int len;
3788 Lisp_Object result;
3790 CHECK_NUMBER_COERCE_MARKER (pos);
3792 len = 10;
3793 /* We can't use alloca here because overlays_at can call xrealloc. */
3794 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3796 /* Put all the overlays we want in a vector in overlay_vec.
3797 Store the length in len. */
3798 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3799 (int *) 0, (int *) 0, 0);
3801 /* Make a list of them all. */
3802 result = Flist (noverlays, overlay_vec);
3804 xfree (overlay_vec);
3805 return result;
3808 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3809 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3810 Overlap means that at least one character is contained within the overlay
3811 and also contained within the specified region.
3812 Empty overlays are included in the result if they are located at BEG
3813 or between BEG and END. */)
3814 (beg, end)
3815 Lisp_Object beg, end;
3817 int noverlays;
3818 Lisp_Object *overlay_vec;
3819 int len;
3820 Lisp_Object result;
3822 CHECK_NUMBER_COERCE_MARKER (beg);
3823 CHECK_NUMBER_COERCE_MARKER (end);
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 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3831 (int *) 0, (int *) 0);
3833 /* Make a list of them all. */
3834 result = Flist (noverlays, overlay_vec);
3836 xfree (overlay_vec);
3837 return result;
3840 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3841 1, 1, 0,
3842 doc: /* Return the next position after POS where an overlay starts or ends.
3843 If there are no more overlay boundaries after POS, return (point-max). */)
3844 (pos)
3845 Lisp_Object pos;
3847 int noverlays;
3848 int endpos;
3849 Lisp_Object *overlay_vec;
3850 int len;
3851 int i;
3853 CHECK_NUMBER_COERCE_MARKER (pos);
3855 len = 10;
3856 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3858 /* Put all the overlays we want in a vector in overlay_vec.
3859 Store the length in len.
3860 endpos gets the position where the next overlay starts. */
3861 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3862 &endpos, (int *) 0, 1);
3864 /* If any of these overlays ends before endpos,
3865 use its ending point instead. */
3866 for (i = 0; i < noverlays; i++)
3868 Lisp_Object oend;
3869 int oendpos;
3871 oend = OVERLAY_END (overlay_vec[i]);
3872 oendpos = OVERLAY_POSITION (oend);
3873 if (oendpos < endpos)
3874 endpos = oendpos;
3877 xfree (overlay_vec);
3878 return make_number (endpos);
3881 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3882 Sprevious_overlay_change, 1, 1, 0,
3883 doc: /* Return the previous position before POS where an overlay starts or ends.
3884 If there are no more overlay boundaries before POS, return (point-min). */)
3885 (pos)
3886 Lisp_Object pos;
3888 int noverlays;
3889 int prevpos;
3890 Lisp_Object *overlay_vec;
3891 int len;
3893 CHECK_NUMBER_COERCE_MARKER (pos);
3895 /* At beginning of buffer, we know the answer;
3896 avoid bug subtracting 1 below. */
3897 if (XINT (pos) == BEGV)
3898 return pos;
3900 len = 10;
3901 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3903 /* Put all the overlays we want in a vector in overlay_vec.
3904 Store the length in len.
3905 prevpos gets the position of the previous change. */
3906 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3907 (int *) 0, &prevpos, 1);
3909 xfree (overlay_vec);
3910 return make_number (prevpos);
3913 /* These functions are for debugging overlays. */
3915 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3916 doc: /* Return a pair of lists giving all the overlays of the current buffer.
3917 The car has all the overlays before the overlay center;
3918 the cdr has all the overlays after the overlay center.
3919 Recentering overlays moves overlays between these lists.
3920 The lists you get are copies, so that changing them has no effect.
3921 However, the overlays you get are the real objects that the buffer uses. */)
3924 Lisp_Object before, after;
3925 before = current_buffer->overlays_before;
3926 if (CONSP (before))
3927 before = Fcopy_sequence (before);
3928 after = current_buffer->overlays_after;
3929 if (CONSP (after))
3930 after = Fcopy_sequence (after);
3932 return Fcons (before, after);
3935 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
3936 doc: /* Recenter the overlays of the current buffer around position POS.
3937 That makes overlay lookup faster for positions near POS (but perhaps slower
3938 for positions far away from POS). */)
3939 (pos)
3940 Lisp_Object pos;
3942 CHECK_NUMBER_COERCE_MARKER (pos);
3944 recenter_overlay_lists (current_buffer, XINT (pos));
3945 return Qnil;
3948 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
3949 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
3950 (overlay, prop)
3951 Lisp_Object overlay, prop;
3953 CHECK_OVERLAY (overlay);
3954 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
3957 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
3958 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
3959 (overlay, prop, value)
3960 Lisp_Object overlay, prop, value;
3962 Lisp_Object tail, buffer;
3963 int changed;
3965 CHECK_OVERLAY (overlay);
3967 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3969 for (tail = XOVERLAY (overlay)->plist;
3970 CONSP (tail) && CONSP (XCDR (tail));
3971 tail = XCDR (XCDR (tail)))
3972 if (EQ (XCAR (tail), prop))
3974 changed = !EQ (XCAR (XCDR (tail)), value);
3975 XSETCAR (XCDR (tail), value);
3976 goto found;
3978 /* It wasn't in the list, so add it to the front. */
3979 changed = !NILP (value);
3980 XOVERLAY (overlay)->plist
3981 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
3982 found:
3983 if (! NILP (buffer))
3985 if (changed)
3986 modify_overlay (XBUFFER (buffer),
3987 marker_position (OVERLAY_START (overlay)),
3988 marker_position (OVERLAY_END (overlay)));
3989 if (EQ (prop, Qevaporate) && ! NILP (value)
3990 && (OVERLAY_POSITION (OVERLAY_START (overlay))
3991 == OVERLAY_POSITION (OVERLAY_END (overlay))))
3992 Fdelete_overlay (overlay);
3994 return value;
3997 /* Subroutine of report_overlay_modification. */
3999 /* Lisp vector holding overlay hook functions to call.
4000 Vector elements come in pairs.
4001 Each even-index element is a list of hook functions.
4002 The following odd-index element is the overlay they came from.
4004 Before the buffer change, we fill in this vector
4005 as we call overlay hook functions.
4006 After the buffer change, we get the functions to call from this vector.
4007 This way we always call the same functions before and after the change. */
4008 static Lisp_Object last_overlay_modification_hooks;
4010 /* Number of elements actually used in last_overlay_modification_hooks. */
4011 static int last_overlay_modification_hooks_used;
4013 /* Add one functionlist/overlay pair
4014 to the end of last_overlay_modification_hooks. */
4016 static void
4017 add_overlay_mod_hooklist (functionlist, overlay)
4018 Lisp_Object functionlist, overlay;
4020 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4022 if (last_overlay_modification_hooks_used == oldsize)
4024 Lisp_Object old;
4025 old = last_overlay_modification_hooks;
4026 last_overlay_modification_hooks
4027 = Fmake_vector (make_number (oldsize * 2), Qnil);
4028 bcopy (XVECTOR (old)->contents,
4029 XVECTOR (last_overlay_modification_hooks)->contents,
4030 sizeof (Lisp_Object) * oldsize);
4032 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = functionlist;
4033 XVECTOR (last_overlay_modification_hooks)->contents[last_overlay_modification_hooks_used++] = overlay;
4036 /* Run the modification-hooks of overlays that include
4037 any part of the text in START to END.
4038 If this change is an insertion, also
4039 run the insert-before-hooks of overlay starting at END,
4040 and the insert-after-hooks of overlay ending at START.
4042 This is called both before and after the modification.
4043 AFTER is nonzero when we call after the modification.
4045 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4046 When AFTER is nonzero, they are the start position,
4047 the position after the inserted new text,
4048 and the length of deleted or replaced old text. */
4050 void
4051 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4052 Lisp_Object start, end;
4053 int after;
4054 Lisp_Object arg1, arg2, arg3;
4056 Lisp_Object prop, overlay, tail;
4057 /* 1 if this change is an insertion. */
4058 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4059 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4061 overlay = Qnil;
4062 tail = Qnil;
4064 if (!after)
4066 /* We are being called before a change.
4067 Scan the overlays to find the functions to call. */
4068 last_overlay_modification_hooks_used = 0;
4069 for (tail = current_buffer->overlays_before;
4070 CONSP (tail);
4071 tail = XCDR (tail))
4073 int startpos, endpos;
4074 Lisp_Object ostart, oend;
4076 overlay = XCAR (tail);
4078 ostart = OVERLAY_START (overlay);
4079 oend = OVERLAY_END (overlay);
4080 endpos = OVERLAY_POSITION (oend);
4081 if (XFASTINT (start) > endpos)
4082 break;
4083 startpos = OVERLAY_POSITION (ostart);
4084 if (insertion && (XFASTINT (start) == startpos
4085 || XFASTINT (end) == startpos))
4087 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4088 if (!NILP (prop))
4089 add_overlay_mod_hooklist (prop, overlay);
4091 if (insertion && (XFASTINT (start) == endpos
4092 || XFASTINT (end) == endpos))
4094 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4095 if (!NILP (prop))
4096 add_overlay_mod_hooklist (prop, overlay);
4098 /* Test for intersecting intervals. This does the right thing
4099 for both insertion and deletion. */
4100 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4102 prop = Foverlay_get (overlay, Qmodification_hooks);
4103 if (!NILP (prop))
4104 add_overlay_mod_hooklist (prop, overlay);
4108 for (tail = current_buffer->overlays_after;
4109 CONSP (tail);
4110 tail = XCDR (tail))
4112 int startpos, endpos;
4113 Lisp_Object ostart, oend;
4115 overlay = XCAR (tail);
4117 ostart = OVERLAY_START (overlay);
4118 oend = OVERLAY_END (overlay);
4119 startpos = OVERLAY_POSITION (ostart);
4120 endpos = OVERLAY_POSITION (oend);
4121 if (XFASTINT (end) < startpos)
4122 break;
4123 if (insertion && (XFASTINT (start) == startpos
4124 || XFASTINT (end) == startpos))
4126 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4127 if (!NILP (prop))
4128 add_overlay_mod_hooklist (prop, overlay);
4130 if (insertion && (XFASTINT (start) == endpos
4131 || XFASTINT (end) == endpos))
4133 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4134 if (!NILP (prop))
4135 add_overlay_mod_hooklist (prop, overlay);
4137 /* Test for intersecting intervals. This does the right thing
4138 for both insertion and deletion. */
4139 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4141 prop = Foverlay_get (overlay, Qmodification_hooks);
4142 if (!NILP (prop))
4143 add_overlay_mod_hooklist (prop, overlay);
4148 GCPRO4 (overlay, arg1, arg2, arg3);
4150 /* Call the functions recorded in last_overlay_modification_hooks.
4151 First copy the vector contents, in case some of these hooks
4152 do subsequent modification of the buffer. */
4153 int size = last_overlay_modification_hooks_used;
4154 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4155 int i;
4157 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4158 copy, size * sizeof (Lisp_Object));
4159 gcpro1.var = copy;
4160 gcpro1.nvars = size;
4162 for (i = 0; i < size;)
4164 Lisp_Object prop, overlay;
4165 prop = copy[i++];
4166 overlay = copy[i++];
4167 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4170 UNGCPRO;
4173 static void
4174 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4175 Lisp_Object list, overlay;
4176 int after;
4177 Lisp_Object arg1, arg2, arg3;
4179 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4181 GCPRO4 (list, arg1, arg2, arg3);
4183 while (CONSP (list))
4185 if (NILP (arg3))
4186 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4187 else
4188 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4189 list = XCDR (list);
4191 UNGCPRO;
4194 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4195 property is set. */
4196 void
4197 evaporate_overlays (pos)
4198 EMACS_INT pos;
4200 Lisp_Object tail, overlay, hit_list;
4202 hit_list = Qnil;
4203 if (pos <= current_buffer->overlay_center)
4204 for (tail = current_buffer->overlays_before; CONSP (tail);
4205 tail = XCDR (tail))
4207 int endpos;
4208 overlay = XCAR (tail);
4209 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4210 if (endpos < pos)
4211 break;
4212 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4213 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4214 hit_list = Fcons (overlay, hit_list);
4216 else
4217 for (tail = current_buffer->overlays_after; CONSP (tail);
4218 tail = XCDR (tail))
4220 int startpos;
4221 overlay = XCAR (tail);
4222 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4223 if (startpos > pos)
4224 break;
4225 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4226 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4227 hit_list = Fcons (overlay, hit_list);
4229 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4230 Fdelete_overlay (XCAR (hit_list));
4233 /* Somebody has tried to store a value with an unacceptable type
4234 in the slot with offset OFFSET. */
4236 void
4237 buffer_slot_type_mismatch (offset)
4238 int offset;
4240 Lisp_Object sym;
4241 char *type_name;
4243 switch (XINT (PER_BUFFER_TYPE (offset)))
4245 case Lisp_Int:
4246 type_name = "integers";
4247 break;
4249 case Lisp_String:
4250 type_name = "strings";
4251 break;
4253 case Lisp_Symbol:
4254 type_name = "symbols";
4255 break;
4257 default:
4258 abort ();
4261 sym = PER_BUFFER_SYMBOL (offset);
4262 error ("Only %s should be stored in the buffer-local variable %s",
4263 type_name, SDATA (SYMBOL_NAME (sym)));
4267 /***********************************************************************
4268 Allocation with mmap
4269 ***********************************************************************/
4271 #ifdef USE_MMAP_FOR_BUFFERS
4273 #include <sys/types.h>
4274 #include <sys/mman.h>
4276 #ifndef MAP_ANON
4277 #ifdef MAP_ANONYMOUS
4278 #define MAP_ANON MAP_ANONYMOUS
4279 #else
4280 #define MAP_ANON 0
4281 #endif
4282 #endif
4284 #ifndef MAP_FAILED
4285 #define MAP_FAILED ((void *) -1)
4286 #endif
4288 #include <stdio.h>
4289 #include <errno.h>
4291 #if MAP_ANON == 0
4292 #include <fcntl.h>
4293 #endif
4295 #include "coding.h"
4298 /* Memory is allocated in regions which are mapped using mmap(2).
4299 The current implementation lets the system select mapped
4300 addresses; we're not using MAP_FIXED in general, except when
4301 trying to enlarge regions.
4303 Each mapped region starts with a mmap_region structure, the user
4304 area starts after that structure, aligned to MEM_ALIGN.
4306 +-----------------------+
4307 | struct mmap_info + |
4308 | padding |
4309 +-----------------------+
4310 | user data |
4313 +-----------------------+ */
4315 struct mmap_region
4317 /* User-specified size. */
4318 size_t nbytes_specified;
4320 /* Number of bytes mapped */
4321 size_t nbytes_mapped;
4323 /* Pointer to the location holding the address of the memory
4324 allocated with the mmap'd block. The variable actually points
4325 after this structure. */
4326 POINTER_TYPE **var;
4328 /* Next and previous in list of all mmap'd regions. */
4329 struct mmap_region *next, *prev;
4332 /* Doubly-linked list of mmap'd regions. */
4334 static struct mmap_region *mmap_regions;
4336 /* File descriptor for mmap. If we don't have anonymous mapping,
4337 /dev/zero will be opened on it. */
4339 static int mmap_fd;
4341 /* Temporary storage for mmap_set_vars, see there. */
4343 static struct mmap_region *mmap_regions_1;
4344 static int mmap_fd_1;
4346 /* Page size on this system. */
4348 static int mmap_page_size;
4350 /* 1 means mmap has been intialized. */
4352 static int mmap_initialized_p;
4354 /* Value is X rounded up to the next multiple of N. */
4356 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4358 /* Size of mmap_region structure plus padding. */
4360 #define MMAP_REGION_STRUCT_SIZE \
4361 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4363 /* Given a pointer P to the start of the user-visible part of a mapped
4364 region, return a pointer to the start of the region. */
4366 #define MMAP_REGION(P) \
4367 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4369 /* Given a pointer P to the start of a mapped region, return a pointer
4370 to the start of the user-visible part of the region. */
4372 #define MMAP_USER_AREA(P) \
4373 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4375 #define MEM_ALIGN sizeof (double)
4377 /* Predicate returning true if part of the address range [START .. END]
4378 is currently mapped. Used to prevent overwriting an existing
4379 memory mapping.
4381 Default is to conservativly assume the address range is occupied by
4382 something else. This can be overridden by system configuration
4383 files if system-specific means to determine this exists. */
4385 #ifndef MMAP_ALLOCATED_P
4386 #define MMAP_ALLOCATED_P(start, end) 1
4387 #endif
4389 /* Function prototypes. */
4391 static int mmap_free_1 P_ ((struct mmap_region *));
4392 static int mmap_enlarge P_ ((struct mmap_region *, int));
4393 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4394 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4395 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4396 static void mmap_free P_ ((POINTER_TYPE **ptr));
4397 static void mmap_init P_ ((void));
4400 /* Return a region overlapping address range START...END, or null if
4401 none. END is not including, i.e. the last byte in the range
4402 is at END - 1. */
4404 static struct mmap_region *
4405 mmap_find (start, end)
4406 POINTER_TYPE *start, *end;
4408 struct mmap_region *r;
4409 char *s = (char *) start, *e = (char *) end;
4411 for (r = mmap_regions; r; r = r->next)
4413 char *rstart = (char *) r;
4414 char *rend = rstart + r->nbytes_mapped;
4416 if (/* First byte of range, i.e. START, in this region? */
4417 (s >= rstart && s < rend)
4418 /* Last byte of range, i.e. END - 1, in this region? */
4419 || (e > rstart && e <= rend)
4420 /* First byte of this region in the range? */
4421 || (rstart >= s && rstart < e)
4422 /* Last byte of this region in the range? */
4423 || (rend > s && rend <= e))
4424 break;
4427 return r;
4431 /* Unmap a region. P is a pointer to the start of the user-araa of
4432 the region. Value is non-zero if successful. */
4434 static int
4435 mmap_free_1 (r)
4436 struct mmap_region *r;
4438 if (r->next)
4439 r->next->prev = r->prev;
4440 if (r->prev)
4441 r->prev->next = r->next;
4442 else
4443 mmap_regions = r->next;
4445 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4447 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4448 return 0;
4451 return 1;
4455 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4456 Value is non-zero if successful. */
4458 static int
4459 mmap_enlarge (r, npages)
4460 struct mmap_region *r;
4461 int npages;
4463 char *region_end = (char *) r + r->nbytes_mapped;
4464 size_t nbytes;
4465 int success = 0;
4467 if (npages < 0)
4469 /* Unmap pages at the end of the region. */
4470 nbytes = - npages * mmap_page_size;
4471 if (munmap (region_end - nbytes, nbytes) == -1)
4472 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4473 else
4475 r->nbytes_mapped -= nbytes;
4476 success = 1;
4479 else if (npages > 0)
4481 nbytes = npages * mmap_page_size;
4483 /* Try to map additional pages at the end of the region. We
4484 cannot do this if the address range is already occupied by
4485 something else because mmap deletes any previous mapping.
4486 I'm not sure this is worth doing, let's see. */
4487 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4489 POINTER_TYPE *p;
4491 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4492 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4493 if (p == MAP_FAILED)
4494 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4495 else if (p != (POINTER_TYPE *) region_end)
4497 /* Kernels are free to choose a different address. In
4498 that case, unmap what we've mapped above; we have
4499 no use for it. */
4500 if (munmap (p, nbytes) == -1)
4501 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4503 else
4505 r->nbytes_mapped += nbytes;
4506 success = 1;
4511 return success;
4515 /* Set or reset variables holding references to mapped regions. If
4516 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4517 non-zero, set all variables to the start of the user-areas
4518 of mapped regions.
4520 This function is called from Fdump_emacs to ensure that the dumped
4521 Emacs doesn't contain references to memory that won't be mapped
4522 when Emacs starts. */
4524 void
4525 mmap_set_vars (restore_p)
4526 int restore_p;
4528 struct mmap_region *r;
4530 if (restore_p)
4532 mmap_regions = mmap_regions_1;
4533 mmap_fd = mmap_fd_1;
4534 for (r = mmap_regions; r; r = r->next)
4535 *r->var = MMAP_USER_AREA (r);
4537 else
4539 for (r = mmap_regions; r; r = r->next)
4540 *r->var = NULL;
4541 mmap_regions_1 = mmap_regions;
4542 mmap_regions = NULL;
4543 mmap_fd_1 = mmap_fd;
4544 mmap_fd = -1;
4549 /* Allocate a block of storage large enough to hold NBYTES bytes of
4550 data. A pointer to the data is returned in *VAR. VAR is thus the
4551 address of some variable which will use the data area.
4553 The allocation of 0 bytes is valid.
4555 If we can't allocate the necessary memory, set *VAR to null, and
4556 return null. */
4558 static POINTER_TYPE *
4559 mmap_alloc (var, nbytes)
4560 POINTER_TYPE **var;
4561 size_t nbytes;
4563 void *p;
4564 size_t map;
4566 mmap_init ();
4568 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4569 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4570 mmap_fd, 0);
4572 if (p == MAP_FAILED)
4574 if (errno != ENOMEM)
4575 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4576 p = NULL;
4578 else
4580 struct mmap_region *r = (struct mmap_region *) p;
4582 r->nbytes_specified = nbytes;
4583 r->nbytes_mapped = map;
4584 r->var = var;
4585 r->prev = NULL;
4586 r->next = mmap_regions;
4587 if (r->next)
4588 r->next->prev = r;
4589 mmap_regions = r;
4591 p = MMAP_USER_AREA (p);
4594 return *var = p;
4598 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4599 resize it to size NBYTES. Change *VAR to reflect the new block,
4600 and return this value. If more memory cannot be allocated, then
4601 leave *VAR unchanged, and return null. */
4603 static POINTER_TYPE *
4604 mmap_realloc (var, nbytes)
4605 POINTER_TYPE **var;
4606 size_t nbytes;
4608 POINTER_TYPE *result;
4610 mmap_init ();
4612 if (*var == NULL)
4613 result = mmap_alloc (var, nbytes);
4614 else if (nbytes == 0)
4616 mmap_free (var);
4617 result = mmap_alloc (var, nbytes);
4619 else
4621 struct mmap_region *r = MMAP_REGION (*var);
4622 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4624 if (room < nbytes)
4626 /* Must enlarge. */
4627 POINTER_TYPE *old_ptr = *var;
4629 /* Try to map additional pages at the end of the region.
4630 If that fails, allocate a new region, copy data
4631 from the old region, then free it. */
4632 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4633 / mmap_page_size)))
4635 r->nbytes_specified = nbytes;
4636 *var = result = old_ptr;
4638 else if (mmap_alloc (var, nbytes))
4640 bcopy (old_ptr, *var, r->nbytes_specified);
4641 mmap_free_1 (MMAP_REGION (old_ptr));
4642 result = *var;
4643 r = MMAP_REGION (result);
4644 r->nbytes_specified = nbytes;
4646 else
4648 *var = old_ptr;
4649 result = NULL;
4652 else if (room - nbytes >= mmap_page_size)
4654 /* Shrinking by at least a page. Let's give some
4655 memory back to the system.
4657 The extra parens are to make the division happens first,
4658 on positive values, so we know it will round towards
4659 zero. */
4660 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4661 result = *var;
4662 r->nbytes_specified = nbytes;
4664 else
4666 /* Leave it alone. */
4667 result = *var;
4668 r->nbytes_specified = nbytes;
4672 return result;
4676 /* Free a block of relocatable storage whose data is pointed to by
4677 PTR. Store 0 in *PTR to show there's no block allocated. */
4679 static void
4680 mmap_free (var)
4681 POINTER_TYPE **var;
4683 mmap_init ();
4685 if (*var)
4687 mmap_free_1 (MMAP_REGION (*var));
4688 *var = NULL;
4693 /* Perform necessary intializations for the use of mmap. */
4695 static void
4696 mmap_init ()
4698 #if MAP_ANON == 0
4699 /* The value of mmap_fd is initially 0 in temacs, and -1
4700 in a dumped Emacs. */
4701 if (mmap_fd <= 0)
4703 /* No anonymous mmap -- we need the file descriptor. */
4704 mmap_fd = open ("/dev/zero", O_RDONLY);
4705 if (mmap_fd == -1)
4706 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4708 #endif /* MAP_ANON == 0 */
4710 if (mmap_initialized_p)
4711 return;
4712 mmap_initialized_p = 1;
4714 #if MAP_ANON != 0
4715 mmap_fd = -1;
4716 #endif
4718 mmap_page_size = getpagesize ();
4721 #endif /* USE_MMAP_FOR_BUFFERS */
4725 /***********************************************************************
4726 Buffer-text Allocation
4727 ***********************************************************************/
4729 #ifdef REL_ALLOC
4730 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4731 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4732 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4733 #endif /* REL_ALLOC */
4736 /* Allocate NBYTES bytes for buffer B's text buffer. */
4738 static void
4739 alloc_buffer_text (b, nbytes)
4740 struct buffer *b;
4741 size_t nbytes;
4743 POINTER_TYPE *p;
4745 BLOCK_INPUT;
4746 #if defined USE_MMAP_FOR_BUFFERS
4747 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4748 #elif defined REL_ALLOC
4749 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4750 #else
4751 p = xmalloc (nbytes);
4752 #endif
4754 if (p == NULL)
4756 UNBLOCK_INPUT;
4757 memory_full ();
4760 b->text->beg = (unsigned char *) p;
4761 UNBLOCK_INPUT;
4764 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4765 shrink it. */
4767 void
4768 enlarge_buffer_text (b, delta)
4769 struct buffer *b;
4770 int delta;
4772 POINTER_TYPE *p;
4773 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4774 + delta);
4775 BLOCK_INPUT;
4776 #if defined USE_MMAP_FOR_BUFFERS
4777 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4778 #elif defined REL_ALLOC
4779 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4780 #else
4781 p = xrealloc (b->text->beg, nbytes);
4782 #endif
4784 if (p == NULL)
4786 UNBLOCK_INPUT;
4787 memory_full ();
4790 BUF_BEG_ADDR (b) = (unsigned char *) p;
4791 UNBLOCK_INPUT;
4795 /* Free buffer B's text buffer. */
4797 static void
4798 free_buffer_text (b)
4799 struct buffer *b;
4801 BLOCK_INPUT;
4803 #if defined USE_MMAP_FOR_BUFFERS
4804 mmap_free ((POINTER_TYPE **) &b->text->beg);
4805 #elif defined REL_ALLOC
4806 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4807 #else
4808 xfree (b->text->beg);
4809 #endif
4811 BUF_BEG_ADDR (b) = NULL;
4812 UNBLOCK_INPUT;
4817 /***********************************************************************
4818 Initialization
4819 ***********************************************************************/
4821 void
4822 init_buffer_once ()
4824 int idx;
4826 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4828 /* Make sure all markable slots in buffer_defaults
4829 are initialized reasonably, so mark_buffer won't choke. */
4830 reset_buffer (&buffer_defaults);
4831 reset_buffer_local_variables (&buffer_defaults, 1);
4832 reset_buffer (&buffer_local_symbols);
4833 reset_buffer_local_variables (&buffer_local_symbols, 1);
4834 /* Prevent GC from getting confused. */
4835 buffer_defaults.text = &buffer_defaults.own_text;
4836 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4837 BUF_INTERVALS (&buffer_defaults) = 0;
4838 BUF_INTERVALS (&buffer_local_symbols) = 0;
4839 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4840 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4842 /* Set up the default values of various buffer slots. */
4843 /* Must do these before making the first buffer! */
4845 /* real setup is done in bindings.el */
4846 buffer_defaults.mode_line_format = build_string ("%-");
4847 buffer_defaults.header_line_format = Qnil;
4848 buffer_defaults.abbrev_mode = Qnil;
4849 buffer_defaults.overwrite_mode = Qnil;
4850 buffer_defaults.case_fold_search = Qt;
4851 buffer_defaults.auto_fill_function = Qnil;
4852 buffer_defaults.selective_display = Qnil;
4853 #ifndef old
4854 buffer_defaults.selective_display_ellipses = Qt;
4855 #endif
4856 buffer_defaults.abbrev_table = Qnil;
4857 buffer_defaults.display_table = Qnil;
4858 buffer_defaults.undo_list = Qnil;
4859 buffer_defaults.mark_active = Qnil;
4860 buffer_defaults.file_format = Qnil;
4861 buffer_defaults.overlays_before = Qnil;
4862 buffer_defaults.overlays_after = Qnil;
4863 buffer_defaults.overlay_center = BEG;
4865 XSETFASTINT (buffer_defaults.tab_width, 8);
4866 buffer_defaults.truncate_lines = Qnil;
4867 buffer_defaults.ctl_arrow = Qt;
4868 buffer_defaults.direction_reversed = Qnil;
4869 buffer_defaults.cursor_type = Qt;
4870 buffer_defaults.extra_line_spacing = Qnil;
4872 #ifdef DOS_NT
4873 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4874 #endif
4875 buffer_defaults.enable_multibyte_characters = Qt;
4876 buffer_defaults.buffer_file_coding_system = Qnil;
4877 XSETFASTINT (buffer_defaults.fill_column, 70);
4878 XSETFASTINT (buffer_defaults.left_margin, 0);
4879 buffer_defaults.cache_long_line_scans = Qnil;
4880 buffer_defaults.file_truename = Qnil;
4881 XSETFASTINT (buffer_defaults.display_count, 0);
4882 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
4883 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
4884 buffer_defaults.left_fringe_width = Qnil;
4885 buffer_defaults.right_fringe_width = Qnil;
4886 buffer_defaults.fringes_outside_margins = Qnil;
4887 buffer_defaults.scroll_bar_width = Qnil;
4888 buffer_defaults.vertical_scroll_bar_type = Qt;
4889 buffer_defaults.indicate_empty_lines = Qnil;
4890 buffer_defaults.scroll_up_aggressively = Qnil;
4891 buffer_defaults.scroll_down_aggressively = Qnil;
4892 buffer_defaults.display_time = Qnil;
4894 /* Assign the local-flags to the slots that have default values.
4895 The local flag is a bit that is used in the buffer
4896 to say that it has its own local value for the slot.
4897 The local flag bits are in the local_var_flags slot of the buffer. */
4899 /* Nothing can work if this isn't true */
4900 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4902 /* 0 means not a lisp var, -1 means always local, else mask */
4903 bzero (&buffer_local_flags, sizeof buffer_local_flags);
4904 XSETINT (buffer_local_flags.filename, -1);
4905 XSETINT (buffer_local_flags.directory, -1);
4906 XSETINT (buffer_local_flags.backed_up, -1);
4907 XSETINT (buffer_local_flags.save_length, -1);
4908 XSETINT (buffer_local_flags.auto_save_file_name, -1);
4909 XSETINT (buffer_local_flags.read_only, -1);
4910 XSETINT (buffer_local_flags.major_mode, -1);
4911 XSETINT (buffer_local_flags.mode_name, -1);
4912 XSETINT (buffer_local_flags.undo_list, -1);
4913 XSETINT (buffer_local_flags.mark_active, -1);
4914 XSETINT (buffer_local_flags.point_before_scroll, -1);
4915 XSETINT (buffer_local_flags.file_truename, -1);
4916 XSETINT (buffer_local_flags.invisibility_spec, -1);
4917 XSETINT (buffer_local_flags.file_format, -1);
4918 XSETINT (buffer_local_flags.display_count, -1);
4919 XSETINT (buffer_local_flags.display_time, -1);
4920 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
4922 idx = 1;
4923 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
4924 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
4925 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
4926 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
4927 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
4928 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
4929 #ifndef old
4930 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
4931 #endif
4932 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
4933 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
4934 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
4935 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
4936 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
4937 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
4938 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
4939 #ifdef DOS_NT
4940 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
4941 /* Make this one a permanent local. */
4942 buffer_permanent_local_flags[idx++] = 1;
4943 #endif
4944 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
4945 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
4946 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
4947 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
4948 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
4949 /* Make this one a permanent local. */
4950 buffer_permanent_local_flags[idx++] = 1;
4951 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
4952 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
4953 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
4954 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
4955 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
4956 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
4957 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
4958 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
4959 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
4960 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
4961 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
4962 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
4963 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
4965 /* Need more room? */
4966 if (idx >= MAX_PER_BUFFER_VARS)
4967 abort ();
4968 last_per_buffer_idx = idx;
4970 Vbuffer_alist = Qnil;
4971 current_buffer = 0;
4972 all_buffers = 0;
4974 QSFundamental = build_string ("Fundamental");
4976 Qfundamental_mode = intern ("fundamental-mode");
4977 buffer_defaults.major_mode = Qfundamental_mode;
4979 Qmode_class = intern ("mode-class");
4981 Qprotected_field = intern ("protected-field");
4983 Qpermanent_local = intern ("permanent-local");
4985 Qkill_buffer_hook = intern ("kill-buffer-hook");
4986 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
4988 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
4990 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
4992 /* super-magic invisible buffer */
4993 Vbuffer_alist = Qnil;
4995 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
4997 inhibit_modification_hooks = 0;
5000 void
5001 init_buffer ()
5003 char buf[MAXPATHLEN + 1];
5004 char *pwd;
5005 struct stat dotstat, pwdstat;
5006 Lisp_Object temp;
5007 int rc;
5009 #ifdef USE_MMAP_FOR_BUFFERS
5011 /* When using the ralloc implementation based on mmap(2), buffer
5012 text pointers will have been set to null in the dumped Emacs.
5013 Map new memory. */
5014 struct buffer *b;
5016 for (b = all_buffers; b; b = b->next)
5017 if (b->text->beg == NULL)
5018 enlarge_buffer_text (b, 0);
5020 #endif /* USE_MMAP_FOR_BUFFERS */
5022 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5023 if (NILP (buffer_defaults.enable_multibyte_characters))
5024 Fset_buffer_multibyte (Qnil);
5026 /* If PWD is accurate, use it instead of calling getwd. PWD is
5027 sometimes a nicer name, and using it may avoid a fatal error if a
5028 parent directory is searchable but not readable. */
5029 if ((pwd = getenv ("PWD")) != 0
5030 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5031 && stat (pwd, &pwdstat) == 0
5032 && stat (".", &dotstat) == 0
5033 && dotstat.st_ino == pwdstat.st_ino
5034 && dotstat.st_dev == pwdstat.st_dev
5035 && strlen (pwd) < MAXPATHLEN)
5036 strcpy (buf, pwd);
5037 #ifdef HAVE_GETCWD
5038 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5039 fatal ("`getcwd' failed: %s\n", strerror (errno));
5040 #else
5041 else if (getwd (buf) == 0)
5042 fatal ("`getwd' failed: %s\n", buf);
5043 #endif
5045 #ifndef VMS
5046 /* Maybe this should really use some standard subroutine
5047 whose definition is filename syntax dependent. */
5048 rc = strlen (buf);
5049 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5051 buf[rc] = DIRECTORY_SEP;
5052 buf[rc + 1] = '\0';
5054 #endif /* not VMS */
5056 current_buffer->directory = build_string (buf);
5058 /* Add /: to the front of the name
5059 if it would otherwise be treated as magic. */
5060 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5061 if (! NILP (temp)
5062 /* If the default dir is just /, TEMP is non-nil
5063 because of the ange-ftp completion handler.
5064 However, it is not necessary to turn / into /:/.
5065 So avoid doing that. */
5066 && strcmp ("/", SDATA (current_buffer->directory)))
5067 current_buffer->directory
5068 = concat2 (build_string ("/:"), current_buffer->directory);
5070 temp = get_minibuffer (0);
5071 XBUFFER (temp)->directory = current_buffer->directory;
5074 /* initialize the buffer routines */
5075 void
5076 syms_of_buffer ()
5078 staticpro (&last_overlay_modification_hooks);
5079 last_overlay_modification_hooks
5080 = Fmake_vector (make_number (10), Qnil);
5082 staticpro (&Vbuffer_defaults);
5083 staticpro (&Vbuffer_local_symbols);
5084 staticpro (&Qfundamental_mode);
5085 staticpro (&Qmode_class);
5086 staticpro (&QSFundamental);
5087 staticpro (&Vbuffer_alist);
5088 staticpro (&Qprotected_field);
5089 staticpro (&Qpermanent_local);
5090 staticpro (&Qkill_buffer_hook);
5091 Qoverlayp = intern ("overlayp");
5092 staticpro (&Qoverlayp);
5093 Qevaporate = intern ("evaporate");
5094 staticpro (&Qevaporate);
5095 Qmodification_hooks = intern ("modification-hooks");
5096 staticpro (&Qmodification_hooks);
5097 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5098 staticpro (&Qinsert_in_front_hooks);
5099 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5100 staticpro (&Qinsert_behind_hooks);
5101 Qget_file_buffer = intern ("get-file-buffer");
5102 staticpro (&Qget_file_buffer);
5103 Qpriority = intern ("priority");
5104 staticpro (&Qpriority);
5105 Qwindow = intern ("window");
5106 staticpro (&Qwindow);
5107 Qbefore_string = intern ("before-string");
5108 staticpro (&Qbefore_string);
5109 Qafter_string = intern ("after-string");
5110 staticpro (&Qafter_string);
5111 Qfirst_change_hook = intern ("first-change-hook");
5112 staticpro (&Qfirst_change_hook);
5113 Qbefore_change_functions = intern ("before-change-functions");
5114 staticpro (&Qbefore_change_functions);
5115 Qafter_change_functions = intern ("after-change-functions");
5116 staticpro (&Qafter_change_functions);
5117 staticpro (&Qucs_set_table_for_input);
5119 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5120 staticpro (&Qkill_buffer_query_functions);
5122 Fput (Qprotected_field, Qerror_conditions,
5123 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5124 Fput (Qprotected_field, Qerror_message,
5125 build_string ("Attempt to modify a protected field"));
5127 /* All these use DEFVAR_LISP_NOPRO because the slots in
5128 buffer_defaults will all be marked via Vbuffer_defaults. */
5130 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5131 &buffer_defaults.mode_line_format,
5132 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5133 This is the same as (default-value 'mode-line-format). */);
5135 DEFVAR_LISP_NOPRO ("default-header-line-format",
5136 &buffer_defaults.header_line_format,
5137 doc: /* Default value of `header-line-format' for buffers that don't override it.
5138 This is the same as (default-value 'header-line-format). */);
5140 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5141 doc: /* Default value of `cursor-type' for buffers that don't override it.
5142 This is the same as (default-value 'cursor-type). */);
5144 DEFVAR_LISP_NOPRO ("default-line-spacing",
5145 &buffer_defaults.extra_line_spacing,
5146 doc: /* Default value of `line-spacing' for buffers that don't override it.
5147 This is the same as (default-value 'line-spacing). */);
5149 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5150 &buffer_defaults.abbrev_mode,
5151 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5152 This is the same as (default-value 'abbrev-mode). */);
5154 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5155 &buffer_defaults.ctl_arrow,
5156 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5157 This is the same as (default-value 'ctl-arrow). */);
5159 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5160 &buffer_defaults.direction_reversed,
5161 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5162 This is the same as (default-value 'direction-reversed). */);
5164 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5165 &buffer_defaults.enable_multibyte_characters,
5166 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5167 This is the same as (default-value 'enable-multibyte-characters). */);
5169 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5170 &buffer_defaults.buffer_file_coding_system,
5171 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5172 This is the same as (default-value 'buffer-file-coding-system). */);
5174 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5175 &buffer_defaults.truncate_lines,
5176 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5177 This is the same as (default-value 'truncate-lines). */);
5179 DEFVAR_LISP_NOPRO ("default-fill-column",
5180 &buffer_defaults.fill_column,
5181 doc: /* Default value of `fill-column' for buffers that do not override it.
5182 This is the same as (default-value 'fill-column). */);
5184 DEFVAR_LISP_NOPRO ("default-left-margin",
5185 &buffer_defaults.left_margin,
5186 doc: /* Default value of `left-margin' for buffers that do not override it.
5187 This is the same as (default-value 'left-margin). */);
5189 DEFVAR_LISP_NOPRO ("default-tab-width",
5190 &buffer_defaults.tab_width,
5191 doc: /* Default value of `tab-width' for buffers that do not override it.
5192 This is the same as (default-value 'tab-width). */);
5194 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5195 &buffer_defaults.case_fold_search,
5196 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5197 This is the same as (default-value 'case-fold-search). */);
5199 #ifdef DOS_NT
5200 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5201 &buffer_defaults.buffer_file_type,
5202 doc: /* Default file type for buffers that do not override it.
5203 This is the same as (default-value 'buffer-file-type).
5204 The file type is nil for text, t for binary. */);
5205 #endif
5207 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5208 &buffer_defaults.left_margin_cols,
5209 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5210 This is the same as (default-value 'left-margin-width). */);
5212 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5213 &buffer_defaults.right_margin_cols,
5214 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5215 This is the same as (default-value 'right-margin-width). */);
5217 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5218 &buffer_defaults.left_fringe_width,
5219 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5220 This is the same as (default-value 'left-fringe-width). */);
5222 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5223 &buffer_defaults.right_fringe_width,
5224 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5225 This is the same as (default-value 'right-fringe-width). */);
5227 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5228 &buffer_defaults.fringes_outside_margins,
5229 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5230 This is the same as (default-value 'fringes-outside-margins). */);
5232 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5233 &buffer_defaults.scroll_bar_width,
5234 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5235 This is the same as (default-value 'scroll-bar-width). */);
5237 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5238 &buffer_defaults.vertical_scroll_bar_type,
5239 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5240 This is the same as (default-value 'vertical-scroll-bar). */);
5242 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5243 &buffer_defaults.indicate_empty_lines,
5244 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5245 This is the same as (default-value 'indicate-empty-lines). */);
5247 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5248 &buffer_defaults.scroll_up_aggressively,
5249 doc: /* Default value of `scroll-up-aggressively'.
5250 This value applies in buffers that don't have their own local values.
5251 This variable is an alias for (default-value 'scroll-up-aggressively). */);
5253 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5254 &buffer_defaults.scroll_down_aggressively,
5255 doc: /* Default value of `scroll-down-aggressively'.
5256 This value applies in buffers that don't have their own local values.
5257 This variable is an alias for (default-value 'scroll-down-aggressively). */);
5259 DEFVAR_PER_BUFFER ("header-line-format",
5260 &current_buffer->header_line_format,
5261 Qnil,
5262 doc: /* Analogous to `mode-line-format', but controls the header line.
5263 The header line appears, optionally, at the top of a window;
5264 the mode line appears at the bottom. */);
5266 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5267 Qnil,
5268 doc: /* Template for displaying mode line for current buffer.
5269 Each buffer has its own value of this variable.
5270 Value may be nil, a string, a symbol or a list or cons cell.
5271 A value of nil means don't display a mode line.
5272 For a symbol, its value is used (but it is ignored if t or nil).
5273 A string appearing directly as the value of a symbol is processed verbatim
5274 in that the %-constructs below are not recognized.
5275 Note that unless the symbol is marked as a `risky-local-variable', all
5276 properties in any strings, as well as all :eval and :propertize forms
5277 in the value of that symbol will be ignored.
5278 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5279 is used as a mode line element. Be careful--FORM should not load any files,
5280 because that can cause an infinite recursion.
5281 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5282 with the specified properties PROPS applied.
5283 For a list whose car is a symbol, the symbol's value is taken,
5284 and if that is non-nil, the cadr of the list is processed recursively.
5285 Otherwise, the caddr of the list (if there is one) is processed.
5286 For a list whose car is a string or list, each element is processed
5287 recursively and the results are effectively concatenated.
5288 For a list whose car is an integer, the cdr of the list is processed
5289 and padded (if the number is positive) or truncated (if negative)
5290 to the width specified by that number.
5291 A string is printed verbatim in the mode line except for %-constructs:
5292 (%-constructs are allowed when the string is the entire mode-line-format
5293 or when it is found in a cons-cell or a list)
5294 %b -- print buffer name. %f -- print visited file name.
5295 %F -- print frame name.
5296 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5297 %& is like %*, but ignore read-only-ness.
5298 % means buffer is read-only and * means it is modified.
5299 For a modified read-only buffer, %* gives % and %+ gives *.
5300 %s -- print process status. %l -- print the current line number.
5301 %c -- print the current column number (this makes editing slower).
5302 To make the column number update correctly in all cases,
5303 `column-number-mode' must be non-nil.
5304 %p -- print percent of buffer above top of window, or Top, Bot or All.
5305 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5306 or print Bottom or All.
5307 %m -- print the mode name.
5308 %n -- print Narrow if appropriate.
5309 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5310 %Z -- like %z, but including the end-of-line format.
5311 %[ -- print one [ for each recursive editing level. %] similar.
5312 %% -- print %. %- -- print infinitely many dashes.
5313 Decimal digits after the % specify field width to which to pad. */);
5315 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5316 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5317 nil here means use current buffer's major mode. */);
5319 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5320 make_number (Lisp_Symbol),
5321 doc: /* Symbol for current buffer's major mode. */);
5323 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5324 Qnil,
5325 doc: /* Pretty name of current buffer's major mode (a string). */);
5327 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5328 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5330 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5331 Qnil,
5332 doc: /* *Non-nil if searches and matches should ignore case. */);
5334 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5335 make_number (Lisp_Int),
5336 doc: /* *Column beyond which automatic line-wrapping should happen.
5337 Interactively, you can set this using \\[set-fill-column]. */);
5339 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5340 make_number (Lisp_Int),
5341 doc: /* *Column for the default indent-line-function to indent to.
5342 Linefeed indents to this column in Fundamental mode. */);
5344 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5345 make_number (Lisp_Int),
5346 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5348 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5349 doc: /* *Non-nil means display control chars with uparrow.
5350 A value of nil means use backslash and octal digits.
5351 This variable does not apply to characters whose display is specified
5352 in the current display table (if there is one). */);
5354 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5355 &current_buffer->enable_multibyte_characters,
5356 Qnil,
5357 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5358 Otherwise they are regarded as unibyte. This affects the display,
5359 file I/O and the behavior of various editing commands.
5361 This variable is buffer-local but you cannot set it directly;
5362 use the function `set-buffer-multibyte' to change a buffer's representation.
5363 Changing its default value with `setq-default' is supported.
5364 See also variable `default-enable-multibyte-characters' and Info node
5365 `(elisp)Text Representations'. */);
5366 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5368 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5369 &current_buffer->buffer_file_coding_system, Qnil,
5370 doc: /* Coding system to be used for encoding the buffer contents on saving.
5371 This variable applies to saving the buffer, and also to `write-region'
5372 and other functions that use `write-region'.
5373 It does not apply to sending output to subprocesses, however.
5375 If this is nil, the buffer is saved without any code conversion
5376 unless some coding system is specified in `file-coding-system-alist'
5377 for the buffer file.
5379 If the text to be saved cannot be encoded as specified by this variable,
5380 an alternative encoding is selected by `select-safe-coding-system', which see.
5382 The variable `coding-system-for-write', if non-nil, overrides this variable.
5384 This variable is never applied to a way of decoding a file while reading it. */);
5386 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5387 Qnil,
5388 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5390 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5391 doc: /* *Non-nil means do not display continuation lines.
5392 Instead, give each line of text just one screen line.
5394 Note that this is overridden by the variable
5395 `truncate-partial-width-windows' if that variable is non-nil
5396 and this buffer is not full-frame width. */);
5398 #ifdef DOS_NT
5399 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5400 Qnil,
5401 doc: /* Non-nil if the visited file is a binary file.
5402 This variable is meaningful on MS-DOG and Windows NT.
5403 On those systems, it is automatically local in every buffer.
5404 On other systems, this variable is normally always nil. */);
5405 #endif
5407 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5408 make_number (Lisp_String),
5409 doc: /* Name of default directory of current buffer. Should end with slash.
5410 To interactively change the default directory, use command `cd'. */);
5412 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5413 Qnil,
5414 doc: /* Function called (if non-nil) to perform auto-fill.
5415 It is called after self-inserting any character specified in
5416 the `auto-fill-chars' table.
5417 NOTE: This variable is not a hook;
5418 its value may not be a list of functions. */);
5420 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5421 make_number (Lisp_String),
5422 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5424 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5425 make_number (Lisp_String),
5426 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5427 The truename of a file is calculated by `file-truename'
5428 and then abbreviated with `abbreviate-file-name'. */);
5430 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5431 &current_buffer->auto_save_file_name,
5432 make_number (Lisp_String),
5433 doc: /* Name of file for auto-saving current buffer.
5434 If it is nil, that means don't auto-save this buffer. */);
5436 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5437 doc: /* Non-nil if this buffer is read-only. */);
5439 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5440 doc: /* Non-nil if this buffer's file has been backed up.
5441 Backing up is done before the first time the file is saved. */);
5443 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5444 make_number (Lisp_Int),
5445 doc: /* Length of current buffer when last read in, saved or auto-saved.
5446 0 initially. */);
5448 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5449 Qnil,
5450 doc: /* Non-nil enables selective display.
5451 An Integer N as value means display only lines
5452 that start with less than n columns of space.
5453 A value of t means that the character ^M makes itself and
5454 all the rest of the line invisible; also, when saving the buffer
5455 in a file, save the ^M as a newline. */);
5457 #ifndef old
5458 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5459 &current_buffer->selective_display_ellipses,
5460 Qnil,
5461 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5462 #endif
5464 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5465 doc: /* Non-nil if self-insertion should replace existing text.
5466 The value should be one of `overwrite-mode-textual',
5467 `overwrite-mode-binary', or nil.
5468 If it is `overwrite-mode-textual', self-insertion still
5469 inserts at the end of a line, and inserts when point is before a tab,
5470 until the tab is filled in.
5471 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5473 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5474 Qnil,
5475 doc: /* Display table that controls display of the contents of current buffer.
5477 If this variable is nil, the value of `standard-display-table' is used.
5478 Each window can have its own, overriding display table, see
5479 `set-window-display-table' and `window-display-table'.
5481 The display table is a char-table created with `make-display-table'.
5482 A char-table is an array indexed by character codes. Normal array
5483 primitives `aref' and `aset' can be used to access elements of a char-table.
5485 Each of the char-table elements control how to display the corresponding
5486 text character: the element at index C in the table says how to display
5487 the character whose code is C. Each element should be a vector of
5488 characters or nil. nil means display the character in the default fashion;
5489 otherwise, the characters from the vector are delivered to the screen
5490 instead of the original character.
5492 For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5493 a capital Y instead of each X character.
5495 In addition, a char-table has six extra slots to control the display of:
5497 the end of a truncated screen line (extra-slot 0, a single character);
5498 the end of a continued line (extra-slot 1, a single character);
5499 the escape character used to display character codes in octal
5500 (extra-slot 2, a single character);
5501 the character used as an arrow for control characters (extra-slot 3,
5502 a single character);
5503 the decoration indicating the presence of invisible lines (extra-slot 4,
5504 a vector of characters);
5505 the character used to draw the border between side-by-side windows
5506 (extra-slot 5, a single character).
5508 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5510 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5511 Qnil,
5512 doc: /* *Width of left marginal area for display of a buffer.
5513 A value of nil means no marginal area. */);
5515 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5516 Qnil,
5517 doc: /* *Width of right marginal area for display of a buffer.
5518 A value of nil means no marginal area. */);
5520 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5521 Qnil,
5522 doc: /* *Width of this buffer's left fringe (in pixels).
5523 A value of 0 means no left fringe is shown in this buffer's window.
5524 A value of nil means to use the left fringe width from the window's frame. */);
5526 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5527 Qnil,
5528 doc: /* *Width of this buffer's right fringe (in pixels).
5529 A value of 0 means no right fringe is shown in this buffer's window.
5530 A value of nil means to use the right fringe width from the window's frame. */);
5532 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5533 Qnil,
5534 doc: /* *Non-nil means to display fringes outside display margins.
5535 A value of nil means to display fringes between margins and buffer text. */);
5537 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5538 Qnil,
5539 doc: /* *Width of this buffer's scroll bars in pixels.
5540 A value of nil means to use the scroll bar width from the window's frame. */);
5542 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5543 Qnil,
5544 doc: /* *Position of this buffer's vertical scroll bar.
5545 A value of left or right means to place the vertical scroll bar at that side
5546 of the window; a value of nil means that this window has no vertical scroll bar.
5547 A value of t means to use the vertical scroll bar type from the window's frame. */);
5549 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5550 &current_buffer->indicate_empty_lines, Qnil,
5551 doc: /* *Visually indicate empty lines after the buffer end.
5552 If non-nil, a bitmap is displayed in the left fringe of a window on
5553 window-systems. */);
5555 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5556 &current_buffer->scroll_up_aggressively, Qnil,
5557 doc: /* How far to scroll windows upward.
5558 If you move point off the bottom, the window scrolls automatically.
5559 This variable controls how far it scrolls. nil, the default,
5560 means scroll to center point. A fraction means scroll to put point
5561 that fraction of the window's height from the bottom of the window.
5562 When the value is 0.0, point goes at the bottom line, which in the simple
5563 case that you moved off with C-f means scrolling just one line. 1.0 means
5564 point goes at the top, so that in that simple case, the window
5565 window scrolls by a full window height. Meaningful values are
5566 between 0.0 and 1.0, inclusive. */);
5568 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5569 &current_buffer->scroll_down_aggressively, Qnil,
5570 doc: /* How far to scroll windows downward.
5571 If you move point off the top, the window scrolls automatically.
5572 This variable controls how far it scrolls. nil, the default,
5573 means scroll to center point. A fraction means scroll to put point
5574 that fraction of the window's height from the top of the window.
5575 When the value is 0.0, point goes at the top line, which in the simple
5576 case that you moved off with C-b means scrolling just one line. 1.0 means
5577 point goes at the bottom, so that in that simple case, the window
5578 window scrolls by a full window height. Meaningful values are
5579 between 0.0 and 1.0, inclusive. */);
5581 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5582 "Don't ask.");
5585 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5586 doc: /* List of functions to call before each text change.
5587 Two arguments are passed to each function: the positions of
5588 the beginning and end of the range of old text to be changed.
5589 \(For an insertion, the beginning and end are at the same place.)
5590 No information is given about the length of the text after the change.
5592 Buffer changes made while executing the `before-change-functions'
5593 don't call any before-change or after-change functions.
5594 That's because these variables are temporarily set to nil.
5595 As a result, a hook function cannot straightforwardly alter the value of
5596 these variables. See the Emacs Lisp manual for a way of
5597 accomplishing an equivalent result by using other variables.
5599 If an unhandled error happens in running these functions,
5600 the variable's value remains nil. That prevents the error
5601 from happening repeatedly and making Emacs nonfunctional. */);
5602 Vbefore_change_functions = Qnil;
5604 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5605 doc: /* List of functions to call after each text change.
5606 Three arguments are passed to each function: the positions of
5607 the beginning and end of the range of changed text,
5608 and the length in bytes of the pre-change text replaced by that range.
5609 \(For an insertion, the pre-change length is zero;
5610 for a deletion, that length is the number of bytes deleted,
5611 and the post-change beginning and end are at the same place.)
5613 Buffer changes made while executing the `after-change-functions'
5614 don't call any before-change or after-change functions.
5615 That's because these variables are temporarily set to nil.
5616 As a result, a hook function cannot straightforwardly alter the value of
5617 these variables. See the Emacs Lisp manual for a way of
5618 accomplishing an equivalent result by using other variables.
5620 If an unhandled error happens in running these functions,
5621 the variable's value remains nil. That prevents the error
5622 from happening repeatedly and making Emacs nonfunctional. */);
5623 Vafter_change_functions = Qnil;
5625 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5626 doc: /* A list of functions to call before changing a buffer which is unmodified.
5627 The functions are run using the `run-hooks' function. */);
5628 Vfirst_change_hook = Qnil;
5630 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5631 doc: /* List of undo entries in current buffer.
5632 Recent changes come first; older changes follow newer.
5634 An entry (BEG . END) represents an insertion which begins at
5635 position BEG and ends at position END.
5637 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5638 from (abs POSITION). If POSITION is positive, point was at the front
5639 of the text being deleted; if negative, point was at the end.
5641 An entry (t HIGH . LOW) indicates that the buffer previously had
5642 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5643 of the visited file's modification time, as of that time. If the
5644 modification time of the most recent save is different, this entry is
5645 obsolete.
5647 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5648 was modified between BEG and END. PROPERTY is the property name,
5649 and VALUE is the old value.
5651 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5652 was adjusted in position by the offset DISTANCE (an integer).
5654 An entry of the form POSITION indicates that point was at the buffer
5655 location given by the integer. Undoing an entry of this form places
5656 point at POSITION.
5658 nil marks undo boundaries. The undo command treats the changes
5659 between two undo boundaries as a single step to be undone.
5661 If the value of the variable is t, undo information is not recorded. */);
5663 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5664 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5666 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5667 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5669 Normally, the line-motion functions work by scanning the buffer for
5670 newlines. Columnar operations (like move-to-column and
5671 compute-motion) also work by scanning the buffer, summing character
5672 widths as they go. This works well for ordinary text, but if the
5673 buffer's lines are very long (say, more than 500 characters), these
5674 motion functions will take longer to execute. Emacs may also take
5675 longer to update the display.
5677 If cache-long-line-scans is non-nil, these motion functions cache the
5678 results of their scans, and consult the cache to avoid rescanning
5679 regions of the buffer until the text is modified. The caches are most
5680 beneficial when they prevent the most searching---that is, when the
5681 buffer contains long lines and large regions of characters with the
5682 same, fixed screen width.
5684 When cache-long-line-scans is non-nil, processing short lines will
5685 become slightly slower (because of the overhead of consulting the
5686 cache), and the caches will use memory roughly proportional to the
5687 number of newlines and characters whose screen width varies.
5689 The caches require no explicit maintenance; their accuracy is
5690 maintained internally by the Emacs primitives. Enabling or disabling
5691 the cache should not affect the behavior of any of the motion
5692 functions; it should only affect their performance. */);
5694 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5695 doc: /* Value of point before the last series of scroll operations, or nil. */);
5697 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5698 doc: /* List of formats to use when saving this buffer.
5699 Formats are defined by `format-alist'. This variable is
5700 set when a file is visited. */);
5702 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5703 &current_buffer->invisibility_spec, Qnil,
5704 doc: /* Invisibility spec of this buffer.
5705 The default is t, which means that text is invisible
5706 if it has a non-nil `invisible' property.
5707 If the value is a list, a text character is invisible if its `invisible'
5708 property is an element in that list.
5709 If an element is a cons cell of the form (PROP . ELLIPSIS),
5710 then characters with property value PROP are invisible,
5711 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5713 DEFVAR_PER_BUFFER ("buffer-display-count",
5714 &current_buffer->display_count, Qnil,
5715 doc: /* A number incremented each time this buffer is displayed in a window.
5716 The function `set-window-buffer' increments it. */);
5718 DEFVAR_PER_BUFFER ("buffer-display-time",
5719 &current_buffer->display_time, Qnil,
5720 doc: /* Time stamp updated each time this buffer is displayed in a window.
5721 The function `set-window-buffer' updates this variable
5722 to the value obtained by calling `current-time'.
5723 If the buffer has never been shown in a window, the value is nil. */);
5725 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5726 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5727 Non-nil also enables highlighting of the region whenever the mark is active.
5728 The variable `highlight-nonselected-windows' controls whether to highlight
5729 all windows or just the selected window. */);
5730 Vtransient_mark_mode = Qnil;
5732 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5733 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5734 If the value is t, disregard `buffer-read-only' and all `read-only'
5735 text properties. If the value is a list, disregard `buffer-read-only'
5736 and disregard a `read-only' text property if the property value
5737 is a member of the list. */);
5738 Vinhibit_read_only = Qnil;
5740 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5741 doc: /* Cursor to use when this buffer is in the selected window.
5742 Values are interpreted as follows:
5744 t use the cursor specified for the frame
5745 nil don't display a cursor
5746 bar display a bar cursor with default width
5747 (bar . WIDTH) display a bar cursor with width WIDTH
5748 ANYTHING ELSE display a box cursor.
5750 When the buffer is displayed in a nonselected window,
5751 this variable has no effect; the cursor appears as a hollow box. */);
5753 DEFVAR_PER_BUFFER ("line-spacing",
5754 &current_buffer->extra_line_spacing, Qnil,
5755 doc: /* Additional space to put between lines when displaying a buffer.
5756 The space is measured in pixels, and put below lines on window systems. */);
5758 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5759 doc: /* List of functions called with no args to query before killing a buffer. */);
5760 Vkill_buffer_query_functions = Qnil;
5762 defsubr (&Sbuffer_live_p);
5763 defsubr (&Sbuffer_list);
5764 defsubr (&Sget_buffer);
5765 defsubr (&Sget_file_buffer);
5766 defsubr (&Sget_buffer_create);
5767 defsubr (&Smake_indirect_buffer);
5768 defsubr (&Sgenerate_new_buffer_name);
5769 defsubr (&Sbuffer_name);
5770 /*defsubr (&Sbuffer_number);*/
5771 defsubr (&Sbuffer_file_name);
5772 defsubr (&Sbuffer_base_buffer);
5773 defsubr (&Sbuffer_local_value);
5774 defsubr (&Sbuffer_local_variables);
5775 defsubr (&Sbuffer_modified_p);
5776 defsubr (&Sset_buffer_modified_p);
5777 defsubr (&Sbuffer_modified_tick);
5778 defsubr (&Srename_buffer);
5779 defsubr (&Sother_buffer);
5780 defsubr (&Sbuffer_disable_undo);
5781 defsubr (&Sbuffer_enable_undo);
5782 defsubr (&Skill_buffer);
5783 defsubr (&Sset_buffer_major_mode);
5784 defsubr (&Sswitch_to_buffer);
5785 defsubr (&Spop_to_buffer);
5786 defsubr (&Scurrent_buffer);
5787 defsubr (&Sset_buffer);
5788 defsubr (&Sbarf_if_buffer_read_only);
5789 defsubr (&Sbury_buffer);
5790 defsubr (&Serase_buffer);
5791 defsubr (&Sset_buffer_multibyte);
5792 defsubr (&Skill_all_local_variables);
5794 defsubr (&Soverlayp);
5795 defsubr (&Smake_overlay);
5796 defsubr (&Sdelete_overlay);
5797 defsubr (&Smove_overlay);
5798 defsubr (&Soverlay_start);
5799 defsubr (&Soverlay_end);
5800 defsubr (&Soverlay_buffer);
5801 defsubr (&Soverlay_properties);
5802 defsubr (&Soverlays_at);
5803 defsubr (&Soverlays_in);
5804 defsubr (&Snext_overlay_change);
5805 defsubr (&Sprevious_overlay_change);
5806 defsubr (&Soverlay_recenter);
5807 defsubr (&Soverlay_lists);
5808 defsubr (&Soverlay_get);
5809 defsubr (&Soverlay_put);
5810 defsubr (&Srestore_buffer_modified_p);
5813 void
5814 keys_of_buffer ()
5816 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5817 initial_define_key (control_x_map, 'k', "kill-buffer");
5819 /* This must not be in syms_of_buffer, because Qdisabled is not
5820 initialized when that function gets called. */
5821 Fput (intern ("erase-buffer"), Qdisabled, Qt);